15 #include "lib/axmap.h"
19 #ifdef CONFIG_LINUX_FALLOCATE
20 #include <linux/falloc.h>
23 static FLIST_HEAD(filename_list);
26 * List entry for filename_list
29 struct flist_head list;
33 static inline void clear_error(struct thread_data *td)
39 static int native_fallocate(struct thread_data *td, struct fio_file *f)
43 success = fio_fallocate(f, 0, f->real_file_size);
44 dprint(FD_FILE, "native fallocate of file %s size %llu was "
45 "%ssuccessful\n", f->file_name,
46 (unsigned long long) f->real_file_size,
53 dprint(FD_FILE, "native fallocate is not implemented\n");
58 static void fallocate_file(struct thread_data *td, struct fio_file *f)
60 if (td->o.fill_device)
63 switch (td->o.fallocate_mode) {
64 case FIO_FALLOCATE_NATIVE:
65 native_fallocate(td, f);
67 case FIO_FALLOCATE_NONE:
69 #ifdef CONFIG_POSIX_FALLOCATE
70 case FIO_FALLOCATE_POSIX: {
73 dprint(FD_FILE, "posix_fallocate file %s size %llu\n",
75 (unsigned long long) f->real_file_size);
77 r = posix_fallocate(f->fd, 0, f->real_file_size);
79 log_err("fio: posix_fallocate fails: %s\n", strerror(r));
82 #endif /* CONFIG_POSIX_FALLOCATE */
83 #ifdef CONFIG_LINUX_FALLOCATE
84 case FIO_FALLOCATE_KEEP_SIZE: {
87 dprint(FD_FILE, "fallocate(FALLOC_FL_KEEP_SIZE) "
88 "file %s size %llu\n", f->file_name,
89 (unsigned long long) f->real_file_size);
91 r = fallocate(f->fd, FALLOC_FL_KEEP_SIZE, 0, f->real_file_size);
93 td_verror(td, errno, "fallocate");
97 #endif /* CONFIG_LINUX_FALLOCATE */
98 case FIO_FALLOCATE_TRUNCATE: {
101 dprint(FD_FILE, "ftruncate file %s size %llu\n",
103 (unsigned long long) f->real_file_size);
104 r = ftruncate(f->fd, f->real_file_size);
106 td_verror(td, errno, "ftruncate");
111 log_err("fio: unknown fallocate mode: %d\n", td->o.fallocate_mode);
117 * Leaves f->fd open on success, caller must close
119 static int extend_file(struct thread_data *td, struct fio_file *f)
121 int new_layout = 0, unlink_file = 0, flags;
122 unsigned long long left;
123 unsigned long long bs;
127 log_err("fio: refusing extend of file due to read-only\n");
132 * check if we need to lay the file out complete again. fio
133 * does that for operations involving reads, or for writes
134 * where overwrite is set
137 (td_write(td) && td->o.overwrite && !td->o.file_append) ||
138 (td_write(td) && td_ioengine_flagged(td, FIO_NOEXTEND)))
140 if (td_write(td) && !td->o.overwrite && !td->o.file_append)
143 if (unlink_file || new_layout) {
146 dprint(FD_FILE, "layout %d unlink %d %s\n", new_layout, unlink_file, f->file_name);
148 ret = td_io_unlink_file(td, f);
149 if (ret != 0 && ret != ENOENT) {
150 td_verror(td, errno, "unlink");
156 if (td->o.allow_create)
165 dprint(FD_FILE, "open file %s, flags %x\n", f->file_name, flags);
166 f->fd = open(f->file_name, flags, 0644);
170 if (err == ENOENT && !td->o.allow_create)
171 log_err("fio: file creation disallowed by "
172 "allow_file_create=0\n");
174 td_verror(td, err, "open");
178 fallocate_file(td, f);
181 * If our jobs don't require regular files initially, we're done.
187 * The size will be -1ULL when fill_device is used, so don't truncate
188 * or fallocate this file, just write it
190 if (!td->o.fill_device) {
191 dprint(FD_FILE, "truncate file %s, size %llu\n", f->file_name,
192 (unsigned long long) f->real_file_size);
193 if (ftruncate(f->fd, f->real_file_size) == -1) {
194 if (errno != EFBIG) {
195 td_verror(td, errno, "ftruncate");
202 dprint(FD_FILE, "fill file %s, size %llu\n", f->file_name, (unsigned long long) f->real_file_size);
204 left = f->real_file_size;
205 bs = td->o.max_bs[DDIR_WRITE];
211 td_verror(td, errno, "malloc");
215 while (left && !td->terminate) {
221 fill_io_buffer(td, b, bs, bs);
223 r = write(f->fd, b, bs);
232 if (__e == ENOSPC || __e == EDQUOT) {
233 const char *__e_name;
234 if (td->o.fill_device)
240 log_info("fio: %s on laying out "
241 "file, stopping\n", __e_name);
243 td_verror(td, errno, "write");
245 td_verror(td, EIO, "write");
252 dprint(FD_FILE, "terminate unlink %s\n", f->file_name);
253 td_io_unlink_file(td, f);
254 } else if (td->o.create_fsync) {
255 if (fsync(f->fd) < 0) {
256 td_verror(td, errno, "fsync");
260 if (td->o.fill_device && !td_write(td)) {
261 fio_file_clear_size_known(f);
262 if (td_io_get_file_size(td, f))
264 if (f->io_size > f->real_file_size)
265 f->io_size = f->real_file_size;
279 static bool pre_read_file(struct thread_data *td, struct fio_file *f)
281 int r, did_open = 0, old_runstate;
282 unsigned long long left;
283 unsigned long long bs;
287 if (td_ioengine_flagged(td, FIO_PIPEIO) ||
288 td_ioengine_flagged(td, FIO_NOIO))
291 if (f->filetype == FIO_TYPE_CHAR)
294 if (!fio_file_open(f)) {
295 if (td->io_ops->open_file(td, f)) {
296 log_err("fio: cannot pre-read, failed to open file\n");
302 old_runstate = td_bump_runstate(td, TD_PRE_READING);
305 bs = td->o.max_bs[DDIR_READ];
311 td_verror(td, errno, "malloc");
317 if (lseek(f->fd, f->file_offset, SEEK_SET) < 0) {
318 td_verror(td, errno, "lseek");
319 log_err("fio: failed to lseek pre-read file\n");
324 while (left && !td->terminate) {
328 r = read(f->fd, b, bs);
334 td_verror(td, EIO, "pre_read");
340 td_restore_runstate(td, old_runstate);
343 td->io_ops->close_file(td, f);
350 * Generic function to prepopulate regular file with data.
351 * Useful if you want to make sure I/O engine has data to read.
352 * Leaves f->fd open on success, caller must close.
354 int generic_prepopulate_file(struct thread_data *td, struct fio_file *f)
357 unsigned long long left, bs;
360 /* generic function for regular files only */
361 assert(f->filetype == FIO_TYPE_FILE);
364 log_err("fio: refusing to write a file due to read-only\n");
369 if (td->o.allow_create)
376 dprint(FD_FILE, "open file %s, flags %x\n", f->file_name, flags);
377 f->fd = open(f->file_name, flags, 0644);
381 if (err == ENOENT && !td->o.allow_create)
382 log_err("fio: file creation disallowed by "
383 "allow_file_create=0\n");
385 td_verror(td, err, "open");
389 left = f->real_file_size;
390 bs = td->o.max_bs[DDIR_WRITE];
396 td_verror(td, errno, "malloc");
400 while (left && !td->terminate) {
406 fill_io_buffer(td, b, bs, bs);
408 r = write(f->fd, b, bs);
413 td_verror(td, errno, "write");
419 dprint(FD_FILE, "terminate unlink %s\n", f->file_name);
420 td_io_unlink_file(td, f);
421 } else if (td->o.create_fsync) {
422 if (fsync(f->fd) < 0) {
423 td_verror(td, errno, "fsync");
438 unsigned long long get_rand_file_size(struct thread_data *td)
440 unsigned long long ret, sized;
444 frand_max = rand_max(&td->file_size_state);
445 r = __rand(&td->file_size_state);
446 sized = td->o.file_size_high - td->o.file_size_low;
447 ret = (unsigned long long) ((double) sized * (r / (frand_max + 1.0)));
448 ret += td->o.file_size_low;
449 ret -= (ret % td->o.rw_min_bs);
453 static int file_size(struct thread_data *td, struct fio_file *f)
457 if (stat(f->file_name, &st) == -1) {
458 td_verror(td, errno, "fstat");
462 f->real_file_size = st.st_size;
466 static int bdev_size(struct thread_data *td, struct fio_file *f)
468 unsigned long long bytes = 0;
471 if (td->io_ops->open_file(td, f)) {
472 log_err("fio: failed opening blockdev %s for size check\n",
477 r = blockdev_size(f, &bytes);
479 td_verror(td, r, "blockdev_size");
484 log_err("%s: zero sized block device?\n", f->file_name);
488 f->real_file_size = bytes;
489 td->io_ops->close_file(td, f);
492 td->io_ops->close_file(td, f);
496 static int char_size(struct thread_data *td, struct fio_file *f)
498 #ifdef FIO_HAVE_CHARDEV_SIZE
499 unsigned long long bytes = 0;
502 if (td->io_ops->open_file(td, f)) {
503 log_err("fio: failed opening chardev %s for size check\n",
508 r = chardev_size(f, &bytes);
510 td_verror(td, r, "chardev_size");
515 log_err("%s: zero sized char device?\n", f->file_name);
519 f->real_file_size = bytes;
520 td->io_ops->close_file(td, f);
523 td->io_ops->close_file(td, f);
526 f->real_file_size = -1ULL;
531 static int get_file_size(struct thread_data *td, struct fio_file *f)
535 if (fio_file_size_known(f))
538 if (f->filetype == FIO_TYPE_FILE)
539 ret = file_size(td, f);
540 else if (f->filetype == FIO_TYPE_BLOCK)
541 ret = bdev_size(td, f);
542 else if (f->filetype == FIO_TYPE_CHAR)
543 ret = char_size(td, f);
545 f->real_file_size = -1;
546 log_info("%s: failed to get file size of %s\n", td->o.name,
548 return 1; /* avoid offset extends end error message */
552 * Leave ->real_file_size with 0 since it could be expectation
553 * of initial setup for regular files.
559 * ->file_offset normally hasn't been initialized yet, so this
560 * is basically always false unless ->real_file_size is -1, but
561 * if ->real_file_size is -1 this message doesn't make sense.
562 * As a result, this message is basically useless.
564 if (f->file_offset > f->real_file_size) {
565 log_err("%s: offset extends end (%llu > %llu)\n", td->o.name,
566 (unsigned long long) f->file_offset,
567 (unsigned long long) f->real_file_size);
571 fio_file_set_size_known(f);
575 static int __file_invalidate_cache(struct thread_data *td, struct fio_file *f,
576 unsigned long long off,
577 unsigned long long len)
579 int errval = 0, ret = 0;
588 off = f->file_offset;
590 if (len == -1ULL || off == -1ULL)
593 if (td->io_ops->invalidate) {
594 dprint(FD_IO, "invalidate %s cache %s\n", td->io_ops->name,
596 ret = td->io_ops->invalidate(td, f);
599 } else if (td_ioengine_flagged(td, FIO_DISKLESSIO)) {
600 dprint(FD_IO, "invalidate not supported by ioengine %s\n",
602 } else if (f->filetype == FIO_TYPE_FILE) {
603 dprint(FD_IO, "declare unneeded cache %s: %llu/%llu\n",
604 f->file_name, off, len);
605 ret = posix_fadvise(f->fd, off, len, POSIX_FADV_DONTNEED);
608 } else if (f->filetype == FIO_TYPE_BLOCK) {
611 dprint(FD_IO, "drop page cache %s\n", f->file_name);
612 ret = blockdev_invalidate_cache(f);
613 while (ret < 0 && errno == EAGAIN && retry_count++ < 25) {
615 * Linux multipath devices reject ioctl while
616 * the maps are being updated. That window can
617 * last tens of milliseconds; we'll try up to
618 * a quarter of a second.
621 ret = blockdev_invalidate_cache(f);
623 if (ret < 0 && errno == EACCES && geteuid()) {
624 if (!fio_did_warn(FIO_WARN_ROOT_FLUSH)) {
625 log_err("fio: only root may flush block "
626 "devices. Cache flush bypassed!\n");
631 } else if (f->filetype == FIO_TYPE_CHAR ||
632 f->filetype == FIO_TYPE_PIPE) {
633 dprint(FD_IO, "invalidate not supported %s\n", f->file_name);
637 * Cache flushing isn't a fatal condition, and we know it will
638 * happen on some platforms where we don't have the proper
639 * function to flush eg block device caches. So just warn and
640 * continue on our way.
643 log_info("fio: cache invalidation of %s failed: %s\n",
644 f->file_name, strerror(errval));
650 int file_invalidate_cache(struct thread_data *td, struct fio_file *f)
652 if (!fio_file_open(f))
655 return __file_invalidate_cache(td, f, -1ULL, -1ULL);
658 int generic_close_file(struct thread_data fio_unused *td, struct fio_file *f)
662 dprint(FD_FILE, "fd close %s\n", f->file_name);
666 if (close(f->fd) < 0)
671 if (f->shadow_fd != -1) {
680 int file_lookup_open(struct fio_file *f, int flags)
682 struct fio_file *__f;
685 __f = lookup_file_hash(f->file_name);
687 dprint(FD_FILE, "found file in hash %s\n", f->file_name);
691 dprint(FD_FILE, "file not found in hash %s\n", f->file_name);
699 f->fd = open(f->file_name, flags, 0600);
703 static int file_close_shadow_fds(struct thread_data *td)
709 for_each_file(td, f, i) {
710 if (f->shadow_fd == -1)
721 int generic_open_file(struct thread_data *td, struct fio_file *f)
727 dprint(FD_FILE, "fd open %s\n", f->file_name);
729 if (!strcmp(f->file_name, "-")) {
731 log_err("fio: can't read/write to stdin/out\n");
737 * move output logging to stderr, if we are writing to stdout
746 flags |= OS_O_DIRECT;
749 td_verror(td, EINVAL, "OS does not support atomic IO");
752 flags |= OS_O_DIRECT | FIO_O_ATOMIC;
754 flags |= td->o.sync_io;
755 if (td->o.create_on_open && td->o.allow_create)
758 if (f->filetype != FIO_TYPE_FILE)
759 flags |= FIO_O_NOATIME;
766 if (f->filetype == FIO_TYPE_FILE && td->o.allow_create)
770 f->fd = dup(STDOUT_FILENO);
772 from_hash = file_lookup_open(f, flags);
773 } else if (td_read(td)) {
774 if (f->filetype == FIO_TYPE_CHAR && !read_only)
780 f->fd = dup(STDIN_FILENO);
782 from_hash = file_lookup_open(f, flags);
783 } else if (td_trim(td)) {
784 assert(!td_rw(td)); /* should have matched above */
787 from_hash = file_lookup_open(f, flags);
791 char buf[FIO_VERROR_SIZE];
794 if (__e == EPERM && (flags & FIO_O_NOATIME)) {
795 flags &= ~FIO_O_NOATIME;
798 if (__e == EMFILE && file_close_shadow_fds(td))
801 snprintf(buf, sizeof(buf), "open(%s)", f->file_name);
803 if (__e == EINVAL && (flags & OS_O_DIRECT)) {
804 log_err("fio: looks like your file system does not " \
805 "support direct=1/buffered=0\n");
808 td_verror(td, __e, buf);
812 if (!from_hash && f->fd != -1) {
813 if (add_file_hash(f)) {
817 * Stash away descriptor for later close. This is to
818 * work-around a "feature" on Linux, where a close of
819 * an fd that has been opened for write will trigger
820 * udev to call blkid to check partitions, fs id, etc.
821 * That pollutes the device cache, which can slow down
822 * unbuffered accesses.
824 if (f->shadow_fd == -1)
825 f->shadow_fd = f->fd;
828 * OK to ignore, we haven't done anything
831 ret = generic_close_file(td, f);
841 * This function i.e. get_file_size() is the default .get_file_size
842 * implementation of majority of I/O engines.
844 int generic_get_file_size(struct thread_data *td, struct fio_file *f)
846 return get_file_size(td, f);
850 * open/close all files, so that ->real_file_size gets set
852 static int get_file_sizes(struct thread_data *td)
858 for_each_file(td, f, i) {
859 dprint(FD_FILE, "get file size for %p/%d/%s\n", f, i,
862 if (td_io_get_file_size(td, f)) {
863 if (td->error != ENOENT) {
864 log_err("%s\n", td->verror);
872 * There are corner cases where we end up with -1 for
873 * ->real_file_size due to unsupported file type, etc.
874 * We then just set to size option value divided by number
875 * of files, similar to the way file ->io_size is set.
876 * stat(2) failure doesn't set ->real_file_size to -1.
878 if (f->real_file_size == -1ULL && td->o.size)
879 f->real_file_size = td->o.size / td->o.nr_files;
886 struct flist_head list;
893 * Get free number of bytes for each file on each unique mount.
895 static unsigned long long get_fs_free_counts(struct thread_data *td)
897 struct flist_head *n, *tmp;
898 unsigned long long ret = 0;
899 struct fio_mount *fm;
904 for_each_file(td, f, i) {
908 if (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_CHAR) {
909 if (f->real_file_size != -1ULL)
910 ret += f->real_file_size;
912 } else if (f->filetype != FIO_TYPE_FILE)
915 snprintf(buf, FIO_ARRAY_SIZE(buf), "%s", f->file_name);
917 if (stat(buf, &sb) < 0) {
921 if (stat(buf, &sb) < 0)
926 flist_for_each(n, &list) {
927 fm = flist_entry(n, struct fio_mount, list);
928 if (fm->key == sb.st_dev)
937 fm = calloc(1, sizeof(*fm));
938 snprintf(fm->__base, FIO_ARRAY_SIZE(fm->__base), "%s", buf);
939 fm->base = basename(fm->__base);
941 flist_add(&fm->list, &list);
944 flist_for_each_safe(n, tmp, &list) {
945 unsigned long long sz;
947 fm = flist_entry(n, struct fio_mount, list);
948 flist_del(&fm->list);
950 sz = get_fs_free_size(fm->base);
951 if (sz && sz != -1ULL)
960 uint64_t get_start_offset(struct thread_data *td, struct fio_file *f)
963 struct thread_options *o = &td->o;
964 unsigned long long align_bs;
965 unsigned long long offset;
966 unsigned long long increment;
968 if (o->file_append && f->filetype == FIO_TYPE_FILE)
969 return f->real_file_size;
971 if (o->offset_increment_percent) {
972 assert(!o->offset_increment);
973 increment = o->offset_increment_percent * f->real_file_size / 100;
976 increment = o->offset_increment;
978 if (o->start_offset_percent > 0) {
979 /* calculate the raw offset */
980 offset = (f->real_file_size * o->start_offset_percent / 100) +
981 (td->subjob_number * increment);
985 /* start_offset_percent not set */
986 offset = o->start_offset +
987 td->subjob_number * increment;
992 * if offset_align is provided, use it
994 if (fio_option_is_set(o, start_offset_align)) {
995 align_bs = o->start_offset_align;
997 /* else take the minimum block size */
998 align_bs = td_min_bs(td);
1002 * block align the offset at the next available boundary at
1003 * ceiling(offset / align_bs) * align_bs
1005 offset = (offset / align_bs + (offset % align_bs != 0)) * align_bs;
1012 * Find longest path component that exists and return its length
1014 int longest_existing_path(char *path) {
1025 sprintf(buf, "%s", path);
1028 buf_pos = strrchr(buf, FIO_OS_PATH_SEPARATOR);
1034 *(buf_pos + 1) = '\0';
1037 dwAttr = GetFileAttributesA(buf);
1038 if (dwAttr != INVALID_FILE_ATTRIBUTES) {
1042 if (stat(buf, &sb) == 0)
1046 offset = buf_pos - buf;
1054 static bool create_work_dirs(struct thread_data *td, const char *fname)
1056 char path[PATH_MAX];
1060 snprintf(path, PATH_MAX, "%s", fname);
1063 offset = longest_existing_path(path);
1064 end = start + offset;
1065 while ((end = strchr(end, FIO_OS_PATH_SEPARATOR)) != NULL) {
1072 if (fio_mkdir(path, 0700) && errno != EEXIST) {
1073 log_err("fio: failed to create dir (%s): %s\n",
1074 start, strerror(errno));
1077 *end = FIO_OS_PATH_SEPARATOR;
1080 td->flags |= TD_F_DIRS_CREATED;
1084 int setup_shared_file(struct thread_data *td)
1090 if (td->o.nr_files > 1) {
1091 log_err("fio: shared file setup called for multiple files\n");
1100 log_err("fio: NULL shared file\n");
1104 file_size = thread_number * td->o.size;
1105 dprint(FD_FILE, "shared setup %s real_file_size=%llu, desired=%llu\n",
1106 f->file_name, (unsigned long long)f->real_file_size, (unsigned long long)file_size);
1108 if (f->real_file_size < file_size) {
1109 dprint(FD_FILE, "fio: extending shared file\n");
1110 f->real_file_size = file_size;
1111 err = extend_file(td, f);
1113 err = __file_invalidate_cache(td, f, 0, f->real_file_size);
1116 dprint(FD_FILE, "shared setup new real_file_size=%llu\n",
1117 (unsigned long long)f->real_file_size);
1124 * Open the files and setup files sizes, creating files if necessary.
1126 int setup_files(struct thread_data *td)
1128 unsigned long long total_size, extend_size;
1129 struct thread_options *o = &td->o;
1131 unsigned int i, nr_fs_extra = 0;
1132 int err = 0, need_extend;
1134 const unsigned long long bs = td_min_bs(td);
1137 dprint(FD_FILE, "setup files (thread_number=%d, subjob_number=%d)\n", td->thread_number, td->subjob_number);
1139 old_state = td_bump_runstate(td, TD_SETTING_UP);
1141 for_each_file(td, f, i) {
1142 if (!td_ioengine_flagged(td, FIO_DISKLESSIO) &&
1143 strchr(f->file_name, FIO_OS_PATH_SEPARATOR) &&
1144 !(td->flags & TD_F_DIRS_CREATED) &&
1145 !create_work_dirs(td, f->file_name))
1150 * Find out physical size of files or devices for this thread,
1151 * before we determine I/O size and range of our targets.
1152 * If ioengine defines a setup() method, it's responsible for
1153 * opening the files and setting f->real_file_size to indicate
1154 * the valid range for that file.
1156 if (td->io_ops->setup)
1157 err = td->io_ops->setup(td);
1159 err = get_file_sizes(td);
1164 if (td->o.zone_mode == ZONE_MODE_ZBD) {
1165 err = zbd_init_files(td);
1169 zbd_recalc_options_with_zone_granularity(td);
1171 if (o->read_iolog_file)
1175 * check sizes. if the files/devices do not exist and the size
1176 * isn't passed to fio, abort.
1179 for_each_file(td, f, i) {
1181 if (f->real_file_size == -1ULL)
1184 total_size += f->real_file_size;
1188 td->fill_device_size = get_fs_free_counts(td);
1191 * device/file sizes are zero and no size given, punt
1193 if ((!total_size || total_size == -1ULL) && !o->size &&
1194 !td_ioengine_flagged(td, FIO_NOIO) && !o->fill_device &&
1195 !(o->nr_files && (o->file_size_low || o->file_size_high))) {
1196 log_err("%s: you need to specify size=\n", o->name);
1197 td_verror(td, EINVAL, "total_file_size");
1202 * Calculate per-file size and potential extra size for the
1203 * first files, if needed (i.e. if we don't have a fixed size).
1205 if (!o->file_size_low && o->nr_files) {
1208 fs = o->size / o->nr_files;
1209 all_fs = fs * o->nr_files;
1211 if (all_fs < o->size)
1212 nr_fs_extra = (o->size - all_fs) / bs;
1216 * now file sizes are known, so we can set ->io_size. if size= is
1217 * not given, ->io_size is just equal to ->real_file_size. if size
1218 * is given, ->io_size is size / nr_files.
1220 extend_size = total_size = 0;
1222 for_each_file(td, f, i) {
1223 f->file_offset = get_start_offset(td, f);
1226 * Update ->io_size depending on options specified.
1227 * ->file_size_low being 0 means filesize option isn't set.
1228 * Non zero ->file_size_low equals ->file_size_high means
1229 * filesize option is set in a fixed size format.
1230 * Non zero ->file_size_low not equals ->file_size_high means
1231 * filesize option is set in a range format.
1233 if (!o->file_size_low) {
1235 * no file size or range given, file size is equal to
1236 * total size divided by number of files. If the size
1237 * doesn't divide nicely with the min blocksize,
1238 * make the first files bigger.
1247 * We normally don't come here for regular files, but
1248 * if the result is 0 for a regular file, set it to the
1249 * real file size. This could be size of the existing
1250 * one if it already exists, but otherwise will be set
1251 * to 0. A new file won't be created because
1252 * ->io_size + ->file_offset equals ->real_file_size.
1255 if (f->file_offset > f->real_file_size)
1257 f->io_size = f->real_file_size - f->file_offset;
1259 log_info("fio: file %s may be ignored\n",
1262 } else if (f->real_file_size < o->file_size_low ||
1263 f->real_file_size > o->file_size_high) {
1264 if (f->file_offset > o->file_size_low)
1267 * file size given. if it's fixed, use that. if it's a
1268 * range, generate a random size in-between.
1270 if (o->file_size_low == o->file_size_high)
1271 f->io_size = o->file_size_low - f->file_offset;
1273 f->io_size = get_rand_file_size(td)
1277 f->io_size = f->real_file_size - f->file_offset;
1279 if (f->io_size == -1ULL)
1284 if (o->size_percent && o->size_percent != 100) {
1287 file_size = f->io_size + f->file_offset;
1288 f->io_size = (file_size *
1289 o->size_percent) / 100;
1290 if (f->io_size > (file_size - f->file_offset))
1291 f->io_size = file_size - f->file_offset;
1293 f->io_size -= (f->io_size % td_min_bs(td));
1296 io_size = f->io_size;
1297 if (o->io_size_percent && o->io_size_percent != 100) {
1298 io_size *= o->io_size_percent;
1302 total_size += io_size;
1305 if (f->filetype == FIO_TYPE_FILE &&
1306 (f->io_size + f->file_offset) > f->real_file_size) {
1307 if (!td_ioengine_flagged(td, FIO_DISKLESSIO) &&
1308 !o->create_on_open) {
1310 extend_size += (f->io_size + f->file_offset);
1311 fio_file_set_extend(f);
1312 } else if (!td_ioengine_flagged(td, FIO_DISKLESSIO) ||
1313 (td_ioengine_flagged(td, FIO_DISKLESSIO) &&
1314 td_ioengine_flagged(td, FIO_FAKEIO)))
1315 f->real_file_size = f->io_size + f->file_offset;
1319 if (td->o.block_error_hist) {
1322 assert(td->o.nr_files == 1); /* checked in fixup_options */
1324 len = f->io_size / td->o.bs[DDIR_TRIM];
1325 if (len > MAX_NR_BLOCK_INFOS || len <= 0) {
1326 log_err("fio: cannot calculate block histogram with "
1327 "%d trim blocks, maximum %d\n",
1328 len, MAX_NR_BLOCK_INFOS);
1329 td_verror(td, EINVAL, "block_error_hist");
1333 td->ts.nr_block_infos = len;
1334 for (i = 0; i < len; i++)
1335 td->ts.block_infos[i] =
1336 BLOCK_INFO(0, BLOCK_STATE_UNINIT);
1338 td->ts.nr_block_infos = 0;
1340 if (!o->size || (total_size && o->size > total_size))
1341 o->size = total_size;
1343 if (o->size < td_min_bs(td)) {
1344 log_err("fio: blocksize is larger than data set range\n");
1349 * See if we need to extend some files, typically needed when our
1350 * target regular files don't exist yet, but our jobs require them
1351 * initially due to read I/Os.
1355 if (output_format & FIO_OUTPUT_NORMAL) {
1356 log_info("%s: Laying out IO file%s (%u file%s / %s%lluMiB)\n",
1358 need_extend > 1 ? "s" : "",
1360 need_extend > 1 ? "s" : "",
1361 need_extend > 1 ? "total " : "",
1365 for_each_file(td, f, i) {
1366 unsigned long long old_len = -1ULL, extend_len = -1ULL;
1368 if (!fio_file_extend(f))
1371 assert(f->filetype == FIO_TYPE_FILE);
1372 fio_file_clear_extend(f);
1373 if (!o->fill_device) {
1374 old_len = f->real_file_size;
1375 extend_len = f->io_size + f->file_offset -
1378 f->real_file_size = (f->io_size + f->file_offset);
1379 err = extend_file(td, f);
1383 err = __file_invalidate_cache(td, f, old_len,
1387 * Shut up static checker
1403 * Prepopulate files with data. It might be expected to read some
1404 * "real" data instead of zero'ed files (if no writes to file occurred
1405 * prior to a read job). Engine has to provide a way to do that.
1407 if (td->io_ops->prepopulate_file) {
1410 for_each_file(td, f, i) {
1411 if (output_format & FIO_OUTPUT_NORMAL) {
1412 log_info("%s: Prepopulating IO file (%s)\n",
1413 o->name, f->file_name);
1416 err = td->io_ops->prepopulate_file(td, f);
1420 err = __file_invalidate_cache(td, f, f->file_offset,
1424 * Shut up static checker
1440 * iolog already set the total io size, if we read back
1443 if (!o->read_iolog_file) {
1445 td->total_io_size = o->io_size * o->loops;
1447 td->total_io_size = o->size * o->loops;
1451 if (td->o.zone_mode == ZONE_MODE_ZBD) {
1452 err = zbd_setup_files(td);
1460 td_restore_runstate(td, old_state);
1465 log_err("%s: you need to specify valid offset=\n", o->name);
1467 td_restore_runstate(td, old_state);
1471 bool pre_read_files(struct thread_data *td)
1476 dprint(FD_FILE, "pre_read files\n");
1478 for_each_file(td, f, i) {
1479 if (!pre_read_file(td, f))
1486 static void __init_rand_distribution(struct thread_data *td, struct fio_file *f)
1488 unsigned int range_size, seed;
1492 range_size = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
1493 fsize = min(f->real_file_size, f->io_size);
1495 nranges = (fsize + range_size - 1ULL) / range_size;
1497 seed = jhash(f->file_name, strlen(f->file_name), 0) * td->thread_number;
1498 if (!td->o.rand_repeatable)
1499 seed = td->rand_seeds[4];
1501 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
1502 zipf_init(&f->zipf, nranges, td->o.zipf_theta.u.f, td->o.random_center.u.f, seed);
1503 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
1504 pareto_init(&f->zipf, nranges, td->o.pareto_h.u.f, td->o.random_center.u.f, seed);
1505 else if (td->o.random_distribution == FIO_RAND_DIST_GAUSS)
1506 gauss_init(&f->gauss, nranges, td->o.gauss_dev.u.f, td->o.random_center.u.f, seed);
1509 static bool init_rand_distribution(struct thread_data *td)
1515 if (td->o.random_distribution == FIO_RAND_DIST_RANDOM ||
1516 td->o.random_distribution == FIO_RAND_DIST_ZONED ||
1517 td->o.random_distribution == FIO_RAND_DIST_ZONED_ABS)
1520 state = td_bump_runstate(td, TD_SETTING_UP);
1522 for_each_file(td, f, i)
1523 __init_rand_distribution(td, f);
1525 td_restore_runstate(td, state);
1530 * Check if the number of blocks exceeds the randomness capability of
1531 * the selected generator. Tausworthe is 32-bit, the others are fully
1534 static int check_rand_gen_limits(struct thread_data *td, struct fio_file *f,
1537 if (blocks <= FRAND32_MAX)
1539 if (td->o.random_generator != FIO_RAND_GEN_TAUSWORTHE)
1543 * If the user hasn't specified a random generator, switch
1544 * to tausworthe64 with informational warning. If the user did
1545 * specify one, just warn.
1547 log_info("fio: file %s exceeds 32-bit tausworthe random generator.\n",
1550 if (!fio_option_is_set(&td->o, random_generator)) {
1551 log_info("fio: Switching to tausworthe64. Use the "
1552 "random_generator= option to get rid of this "
1554 td->o.random_generator = FIO_RAND_GEN_TAUSWORTHE64;
1559 * Just make this information to avoid breaking scripts.
1561 log_info("fio: Use the random_generator= option to switch to lfsr or "
1566 bool init_random_map(struct thread_data *td)
1568 unsigned long long blocks;
1572 if (init_rand_distribution(td))
1577 for_each_file(td, f, i) {
1578 uint64_t fsize = min(f->real_file_size, f->io_size);
1580 if (td->o.zone_mode == ZONE_MODE_STRIDED)
1581 fsize = td->o.zone_range;
1583 blocks = fsize / (unsigned long long) td->o.rw_min_bs;
1585 if (check_rand_gen_limits(td, f, blocks))
1588 if (td->o.random_generator == FIO_RAND_GEN_LFSR) {
1591 seed = td->rand_seeds[FIO_RAND_BLOCK_OFF];
1593 if (!lfsr_init(&f->lfsr, blocks, seed, 0)) {
1594 fio_file_set_lfsr(f);
1597 log_err("fio: failed initializing LFSR\n");
1600 } else if (!td->o.norandommap) {
1601 f->io_axmap = axmap_new(blocks);
1603 fio_file_set_axmap(f);
1606 } else if (td->o.norandommap)
1609 if (!td->o.softrandommap) {
1610 log_err("fio: failed allocating random map. If running"
1611 " a large number of jobs, try the 'norandommap'"
1612 " option or set 'softrandommap'. Or give"
1613 " a larger --alloc-size to fio.\n");
1617 log_info("fio: file %s failed allocating random map. Running "
1618 "job without.\n", f->file_name);
1624 void close_files(struct thread_data *td)
1629 for_each_file(td, f, i) {
1630 if (fio_file_open(f))
1631 td_io_close_file(td, f);
1635 void fio_file_free(struct fio_file *f)
1637 if (fio_file_axmap(f))
1638 axmap_free(f->io_axmap);
1639 if (!fio_file_smalloc(f)) {
1643 sfree(f->file_name);
1648 void close_and_free_files(struct thread_data *td)
1653 dprint(FD_FILE, "close files\n");
1655 for_each_file(td, f, i) {
1656 if (td->o.unlink && f->filetype == FIO_TYPE_FILE) {
1657 dprint(FD_FILE, "free unlink %s\n", f->file_name);
1658 td_io_unlink_file(td, f);
1661 if (fio_file_open(f))
1662 td_io_close_file(td, f);
1664 remove_file_hash(f);
1666 if (td->o.unlink && f->filetype == FIO_TYPE_FILE) {
1667 dprint(FD_FILE, "free unlink %s\n", f->file_name);
1668 td_io_unlink_file(td, f);
1675 td->o.filename = NULL;
1677 free(td->file_locks);
1678 td->files_index = 0;
1680 td->file_locks = NULL;
1681 td->o.file_lock_mode = FILE_LOCK_NONE;
1685 static void get_file_type(struct fio_file *f)
1689 if (!strcmp(f->file_name, "-"))
1690 f->filetype = FIO_TYPE_PIPE;
1692 f->filetype = FIO_TYPE_FILE;
1695 /* \\.\ is the device namespace in Windows, where every file is
1697 if (strncmp(f->file_name, "\\\\.\\", 4) == 0)
1698 f->filetype = FIO_TYPE_BLOCK;
1701 if (!stat(f->file_name, &sb)) {
1702 if (S_ISBLK(sb.st_mode))
1703 f->filetype = FIO_TYPE_BLOCK;
1704 else if (S_ISCHR(sb.st_mode))
1705 f->filetype = FIO_TYPE_CHAR;
1706 else if (S_ISFIFO(sb.st_mode))
1707 f->filetype = FIO_TYPE_PIPE;
1711 static bool __is_already_allocated(const char *fname, bool set)
1713 struct flist_head *entry;
1716 ret = file_bloom_exists(fname, set);
1720 flist_for_each(entry, &filename_list) {
1721 struct file_name *fn;
1723 fn = flist_entry(entry, struct file_name, list);
1725 if (!strcmp(fn->filename, fname))
1732 static bool is_already_allocated(const char *fname)
1736 fio_file_hash_lock();
1737 ret = __is_already_allocated(fname, false);
1738 fio_file_hash_unlock();
1743 static void set_already_allocated(const char *fname)
1745 struct file_name *fn;
1747 fn = malloc(sizeof(struct file_name));
1748 fn->filename = strdup(fname);
1750 fio_file_hash_lock();
1751 if (!__is_already_allocated(fname, true)) {
1752 flist_add_tail(&fn->list, &filename_list);
1755 fio_file_hash_unlock();
1763 static void free_already_allocated(void)
1765 struct flist_head *entry, *tmp;
1766 struct file_name *fn;
1768 if (flist_empty(&filename_list))
1771 fio_file_hash_lock();
1772 flist_for_each_safe(entry, tmp, &filename_list) {
1773 fn = flist_entry(entry, struct file_name, list);
1775 flist_del(&fn->list);
1779 fio_file_hash_unlock();
1782 static struct fio_file *alloc_new_file(struct thread_data *td)
1786 if (td_ioengine_flagged(td, FIO_NOFILEHASH))
1787 f = calloc(1, sizeof(*f));
1789 f = scalloc(1, sizeof(*f));
1797 fio_file_reset(td, f);
1798 if (!td_ioengine_flagged(td, FIO_NOFILEHASH))
1799 fio_file_set_smalloc(f);
1803 bool exists_and_not_regfile(const char *filename)
1807 if (lstat(filename, &sb) == -1)
1810 #ifndef WIN32 /* NOT Windows */
1811 if (S_ISREG(sb.st_mode))
1814 /* \\.\ is the device namespace in Windows, where every file
1815 * is a device node */
1816 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
1823 int add_file(struct thread_data *td, const char *fname, int numjob, int inc)
1825 int cur_files = td->files_index;
1826 char file_name[PATH_MAX];
1830 dprint(FD_FILE, "add file %s\n", fname);
1832 if (td->o.directory)
1833 len = set_name_idx(file_name, PATH_MAX, td->o.directory, numjob,
1834 td->o.unique_filename);
1836 sprintf(file_name + len, "%s", fname);
1838 /* clean cloned siblings using existing files */
1839 if (numjob && is_already_allocated(file_name) &&
1840 !exists_and_not_regfile(fname))
1843 f = alloc_new_file(td);
1845 if (td->files_size <= td->files_index) {
1846 unsigned int new_size = td->o.nr_files + 1;
1848 dprint(FD_FILE, "resize file array to %d files\n", new_size);
1850 td->files = realloc(td->files, new_size * sizeof(f));
1851 if (td->files == NULL) {
1852 log_err("fio: realloc OOM\n");
1855 if (td->o.file_lock_mode != FILE_LOCK_NONE) {
1856 td->file_locks = realloc(td->file_locks, new_size);
1857 if (!td->file_locks) {
1858 log_err("fio: realloc OOM\n");
1861 td->file_locks[cur_files] = FILE_LOCK_NONE;
1863 td->files_size = new_size;
1865 td->files[cur_files] = f;
1866 f->fileno = cur_files;
1869 * init function, io engine may not be loaded yet
1871 if (td->io_ops && td_ioengine_flagged(td, FIO_DISKLESSIO))
1872 f->real_file_size = -1ULL;
1874 if (td_ioengine_flagged(td, FIO_NOFILEHASH))
1875 f->file_name = strdup(file_name);
1877 f->file_name = smalloc_strdup(file_name);
1879 /* can't handle smalloc failure from here */
1880 assert(f->file_name);
1884 switch (td->o.file_lock_mode) {
1885 case FILE_LOCK_NONE:
1887 case FILE_LOCK_READWRITE:
1888 f->rwlock = fio_rwlock_init();
1890 case FILE_LOCK_EXCLUSIVE:
1891 f->lock = fio_sem_init(FIO_SEM_UNLOCKED);
1894 log_err("fio: unknown lock mode: %d\n", td->o.file_lock_mode);
1900 if (td->o.numjobs > 1)
1901 set_already_allocated(file_name);
1906 dprint(FD_FILE, "file %p \"%s\" added at %d\n", f, f->file_name,
1912 int add_file_exclusive(struct thread_data *td, const char *fname)
1917 for_each_file(td, f, i) {
1918 if (!strcmp(f->file_name, fname))
1922 return add_file(td, fname, 0, 1);
1925 void get_file(struct fio_file *f)
1927 dprint(FD_FILE, "get file %s, ref=%d\n", f->file_name, f->references);
1928 assert(fio_file_open(f));
1932 int put_file(struct thread_data *td, struct fio_file *f)
1934 int f_ret = 0, ret = 0;
1936 dprint(FD_FILE, "put file %s, ref=%d\n", f->file_name, f->references);
1938 if (!fio_file_open(f)) {
1939 assert(f->fd == -1);
1943 assert(f->references);
1944 if (--f->references)
1947 disk_util_dec(f->du);
1949 if (td->o.file_lock_mode != FILE_LOCK_NONE)
1950 unlock_file_all(td, f);
1952 if (should_fsync(td) && td->o.fsync_on_close) {
1953 f_ret = fsync(f->fd);
1958 if (td->io_ops->close_file)
1959 ret = td->io_ops->close_file(td, f);
1964 td->nr_open_files--;
1965 fio_file_clear_closing(f);
1966 fio_file_clear_open(f);
1967 assert(f->fd == -1);
1971 void lock_file(struct thread_data *td, struct fio_file *f, enum fio_ddir ddir)
1973 if (!f->lock || td->o.file_lock_mode == FILE_LOCK_NONE)
1976 if (td->o.file_lock_mode == FILE_LOCK_READWRITE) {
1977 if (ddir == DDIR_READ)
1978 fio_rwlock_read(f->rwlock);
1980 fio_rwlock_write(f->rwlock);
1981 } else if (td->o.file_lock_mode == FILE_LOCK_EXCLUSIVE)
1982 fio_sem_down(f->lock);
1984 td->file_locks[f->fileno] = td->o.file_lock_mode;
1987 void unlock_file(struct thread_data *td, struct fio_file *f)
1989 if (!f->lock || td->o.file_lock_mode == FILE_LOCK_NONE)
1992 if (td->o.file_lock_mode == FILE_LOCK_READWRITE)
1993 fio_rwlock_unlock(f->rwlock);
1994 else if (td->o.file_lock_mode == FILE_LOCK_EXCLUSIVE)
1995 fio_sem_up(f->lock);
1997 td->file_locks[f->fileno] = FILE_LOCK_NONE;
2000 void unlock_file_all(struct thread_data *td, struct fio_file *f)
2002 if (td->o.file_lock_mode == FILE_LOCK_NONE || !td->file_locks)
2004 if (td->file_locks[f->fileno] != FILE_LOCK_NONE)
2008 static bool recurse_dir(struct thread_data *td, const char *dirname)
2014 D = opendir(dirname);
2016 char buf[FIO_VERROR_SIZE];
2018 snprintf(buf, FIO_VERROR_SIZE, "opendir(%s)", dirname);
2019 td_verror(td, errno, buf);
2023 while ((dir = readdir(D)) != NULL) {
2024 char full_path[PATH_MAX];
2027 if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."))
2030 sprintf(full_path, "%s%c%s", dirname, FIO_OS_PATH_SEPARATOR, dir->d_name);
2032 if (lstat(full_path, &sb) == -1) {
2033 if (errno != ENOENT) {
2034 td_verror(td, errno, "stat");
2040 if (S_ISREG(sb.st_mode)) {
2041 add_file(td, full_path, 0, 1);
2044 if (!S_ISDIR(sb.st_mode))
2047 ret = recurse_dir(td, full_path);
2056 int add_dir_files(struct thread_data *td, const char *path)
2058 int ret = recurse_dir(td, path);
2061 log_info("fio: opendir added %d files\n", td->o.nr_files);
2066 void dup_files(struct thread_data *td, struct thread_data *org)
2071 dprint(FD_FILE, "dup files: %d\n", org->files_index);
2076 td->files = calloc(org->files_index, sizeof(f));
2078 if (td->o.file_lock_mode != FILE_LOCK_NONE)
2079 td->file_locks = malloc(org->files_index);
2081 assert(org->files_index >= org->o.nr_files);
2082 for_each_file(org, f, i) {
2083 struct fio_file *__f;
2085 __f = alloc_new_file(td);
2088 if (td_ioengine_flagged(td, FIO_NOFILEHASH))
2089 __f->file_name = strdup(f->file_name);
2091 __f->file_name = smalloc_strdup(f->file_name);
2093 /* can't handle smalloc failure from here */
2094 assert(__f->file_name);
2095 __f->filetype = f->filetype;
2098 if (td->o.file_lock_mode == FILE_LOCK_EXCLUSIVE)
2099 __f->lock = f->lock;
2100 else if (td->o.file_lock_mode == FILE_LOCK_READWRITE)
2101 __f->rwlock = f->rwlock;
2108 * Returns the index that matches the filename, or -1 if not there
2110 int get_fileno(struct thread_data *td, const char *fname)
2115 for_each_file(td, f, i)
2116 if (!strcmp(f->file_name, fname))
2123 * For log usage, where we add/open/close files automatically
2125 void free_release_files(struct thread_data *td)
2129 td->o.open_files = 0;
2130 td->files_index = 0;
2133 void fio_file_reset(struct thread_data *td, struct fio_file *f)
2137 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
2138 f->last_pos[i] = f->file_offset;
2139 f->last_start[i] = -1ULL;
2142 if (fio_file_axmap(f))
2143 axmap_reset(f->io_axmap);
2144 else if (fio_file_lfsr(f))
2145 lfsr_reset(&f->lfsr, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
2147 zbd_file_reset(td, f);
2150 bool fio_files_done(struct thread_data *td)
2155 for_each_file(td, f, i)
2156 if (!fio_file_done(f))
2162 /* free memory used in initialization phase only */
2163 void filesetup_mem_free(void)
2165 free_already_allocated();
2169 * This function is for platforms which support direct I/O but not O_DIRECT.
2171 int fio_set_directio(struct thread_data *td, struct fio_file *f)
2173 #ifdef FIO_OS_DIRECTIO
2174 int ret = fio_set_odirect(f);
2177 td_verror(td, ret, "fio_set_directio");
2178 #if defined(__sun__)
2179 if (ret == ENOTTY) { /* ENOTTY suggests RAW device or ZFS */
2180 log_err("fio: doing directIO to RAW devices or ZFS not supported\n");
2182 log_err("fio: the file system does not seem to support direct IO\n");
2185 log_err("fio: the file system does not seem to support direct IO\n");
2192 log_err("fio: direct IO is not supported on this host operating system\n");