server: error handling and probe command
[fio.git] / filesetup.c
1 #include <unistd.h>
2 #include <fcntl.h>
3 #include <string.h>
4 #include <assert.h>
5 #include <dirent.h>
6 #include <libgen.h>
7 #include <sys/stat.h>
8 #include <sys/mman.h>
9 #include <sys/types.h>
10
11 #include "fio.h"
12 #include "smalloc.h"
13 #include "filehash.h"
14 #include "os/os.h"
15
16 #ifdef FIO_HAVE_LINUX_FALLOCATE
17 #include <linux/falloc.h>
18 #endif
19
20 static int root_warn;
21
22 static inline void clear_error(struct thread_data *td)
23 {
24         td->error = 0;
25         td->verror[0] = '\0';
26 }
27
28 /*
29  * Leaves f->fd open on success, caller must close
30  */
31 static int extend_file(struct thread_data *td, struct fio_file *f)
32 {
33         int r, new_layout = 0, unlink_file = 0, flags;
34         unsigned long long left;
35         unsigned int bs;
36         char *b;
37
38         if (read_only) {
39                 log_err("fio: refusing extend of file due to read-only\n");
40                 return 0;
41         }
42
43         /*
44          * check if we need to lay the file out complete again. fio
45          * does that for operations involving reads, or for writes
46          * where overwrite is set
47          */
48         if (td_read(td) || (td_write(td) && td->o.overwrite) ||
49             (td_write(td) && td->io_ops->flags & FIO_NOEXTEND))
50                 new_layout = 1;
51         if (td_write(td) && !td->o.overwrite)
52                 unlink_file = 1;
53
54         if (unlink_file || new_layout) {
55                 dprint(FD_FILE, "layout unlink %s\n", f->file_name);
56                 if ((unlink(f->file_name) < 0) && (errno != ENOENT)) {
57                         td_verror(td, errno, "unlink");
58                         return 1;
59                 }
60         }
61
62         flags = O_WRONLY | O_CREAT;
63         if (new_layout)
64                 flags |= O_TRUNC;
65
66         dprint(FD_FILE, "open file %s, flags %x\n", f->file_name, flags);
67         f->fd = open(f->file_name, flags, 0644);
68         if (f->fd < 0) {
69                 td_verror(td, errno, "open");
70                 return 1;
71         }
72
73 #ifdef FIO_HAVE_FALLOCATE
74         if (!td->o.fill_device) {
75                 switch (td->o.fallocate_mode) {
76                 case FIO_FALLOCATE_NONE:
77                         break;
78                 case FIO_FALLOCATE_POSIX:
79                         dprint(FD_FILE, "posix_fallocate file %s size %llu\n",
80                                  f->file_name, f->real_file_size);
81
82                         r = posix_fallocate(f->fd, 0, f->real_file_size);
83                         if (r > 0) {
84                                 log_err("fio: posix_fallocate fails: %s\n",
85                                                 strerror(r));
86                         }
87                         break;
88 #ifdef FIO_HAVE_LINUX_FALLOCATE
89                 case FIO_FALLOCATE_KEEP_SIZE:
90                         dprint(FD_FILE,
91                                 "fallocate(FALLOC_FL_KEEP_SIZE) "
92                                 "file %s size %llu\n",
93                                 f->file_name, f->real_file_size);
94
95                         r = fallocate(f->fd, FALLOC_FL_KEEP_SIZE, 0,
96                                         f->real_file_size);
97                         if (r != 0) {
98                                 td_verror(td, errno, "fallocate");
99                         }
100                         break;
101 #endif /* FIO_HAVE_LINUX_FALLOCATE */
102                 default:
103                         log_err("fio: unknown fallocate mode: %d\n",
104                                 td->o.fallocate_mode);
105                         assert(0);
106                 }
107         }
108 #endif /* FIO_HAVE_FALLOCATE */
109
110         if (!new_layout)
111                 goto done;
112
113         /*
114          * The size will be -1ULL when fill_device is used, so don't truncate
115          * or fallocate this file, just write it
116          */
117         if (!td->o.fill_device) {
118                 dprint(FD_FILE, "truncate file %s, size %llu\n", f->file_name,
119                                                         f->real_file_size);
120                 if (ftruncate(f->fd, f->real_file_size) == -1) {
121                         td_verror(td, errno, "ftruncate");
122                         goto err;
123                 }
124         }
125
126         b = malloc(td->o.max_bs[DDIR_WRITE]);
127         memset(b, 0, td->o.max_bs[DDIR_WRITE]);
128
129         left = f->real_file_size;
130         while (left && !td->terminate) {
131                 bs = td->o.max_bs[DDIR_WRITE];
132                 if (bs > left)
133                         bs = left;
134
135                 r = write(f->fd, b, bs);
136
137                 if (r > 0) {
138                         left -= r;
139                         continue;
140                 } else {
141                         if (r < 0) {
142                                 int __e = errno;
143
144                                 if (__e == ENOSPC) {
145                                         if (td->o.fill_device)
146                                                 break;
147                                         log_info("fio: ENOSPC on laying out "
148                                                  "file, stopping\n");
149                                         break;
150                                 }
151                                 td_verror(td, errno, "write");
152                         } else
153                                 td_verror(td, EIO, "write");
154
155                         break;
156                 }
157         }
158
159         if (td->terminate) {
160                 dprint(FD_FILE, "terminate unlink %s\n", f->file_name);
161                 unlink(f->file_name);
162         } else if (td->o.create_fsync) {
163                 if (fsync(f->fd) < 0) {
164                         td_verror(td, errno, "fsync");
165                         goto err;
166                 }
167         }
168         if (td->o.fill_device && !td_write(td)) {
169                 fio_file_clear_size_known(f);
170                 if (td_io_get_file_size(td, f))
171                         goto err;
172                 if (f->io_size > f->real_file_size)
173                         f->io_size = f->real_file_size;
174         }
175
176         free(b);
177 done:
178         return 0;
179 err:
180         close(f->fd);
181         f->fd = -1;
182         return 1;
183 }
184
185 static int pre_read_file(struct thread_data *td, struct fio_file *f)
186 {
187         int r, did_open = 0, old_runstate;
188         unsigned long long left;
189         unsigned int bs;
190         char *b;
191
192         if (td->io_ops->flags & FIO_PIPEIO)
193                 return 0;
194
195         if (!fio_file_open(f)) {
196                 if (td->io_ops->open_file(td, f)) {
197                         log_err("fio: cannot pre-read, failed to open file\n");
198                         return 1;
199                 }
200                 did_open = 1;
201         }
202
203         old_runstate = td->runstate;
204         td_set_runstate(td, TD_PRE_READING);
205
206         bs = td->o.max_bs[DDIR_READ];
207         b = malloc(bs);
208         memset(b, 0, bs);
209
210         lseek(f->fd, f->file_offset, SEEK_SET);
211         left = f->io_size;
212
213         while (left && !td->terminate) {
214                 if (bs > left)
215                         bs = left;
216
217                 r = read(f->fd, b, bs);
218
219                 if (r == (int) bs) {
220                         left -= bs;
221                         continue;
222                 } else {
223                         td_verror(td, EIO, "pre_read");
224                         break;
225                 }
226         }
227
228         td_set_runstate(td, old_runstate);
229
230         if (did_open)
231                 td->io_ops->close_file(td, f);
232         free(b);
233         return 0;
234 }
235
236 static unsigned long long get_rand_file_size(struct thread_data *td)
237 {
238         unsigned long long ret, sized;
239         unsigned long r;
240
241         if (td->o.use_os_rand) {
242                 r = os_random_long(&td->file_size_state);
243                 sized = td->o.file_size_high - td->o.file_size_low;
244                 ret = (unsigned long long) ((double) sized * (r / (OS_RAND_MAX + 1.0)));
245         } else {
246                 r = __rand(&td->__file_size_state);
247                 sized = td->o.file_size_high - td->o.file_size_low;
248                 ret = (unsigned long long) ((double) sized * (r / (FRAND_MAX + 1.0)));
249         }
250
251         ret += td->o.file_size_low;
252         ret -= (ret % td->o.rw_min_bs);
253         return ret;
254 }
255
256 static int file_size(struct thread_data *td, struct fio_file *f)
257 {
258         struct stat st;
259
260         if (stat(f->file_name, &st) == -1) {
261                 td_verror(td, errno, "fstat");
262                 return 1;
263         }
264
265         f->real_file_size = st.st_size;
266         return 0;
267 }
268
269 static int bdev_size(struct thread_data *td, struct fio_file *f)
270 {
271         unsigned long long bytes = 0;
272         int r;
273
274         if (td->io_ops->open_file(td, f)) {
275                 log_err("fio: failed opening blockdev %s for size check\n",
276                         f->file_name);
277                 return 1;
278         }
279
280         r = blockdev_size(f, &bytes);
281         if (r) {
282                 td_verror(td, r, "blockdev_size");
283                 goto err;
284         }
285
286         if (!bytes) {
287                 log_err("%s: zero sized block device?\n", f->file_name);
288                 goto err;
289         }
290
291         f->real_file_size = bytes;
292         td->io_ops->close_file(td, f);
293         return 0;
294 err:
295         td->io_ops->close_file(td, f);
296         return 1;
297 }
298
299 static int char_size(struct thread_data *td, struct fio_file *f)
300 {
301 #ifdef FIO_HAVE_CHARDEV_SIZE
302         unsigned long long bytes = 0;
303         int r;
304
305         if (td->io_ops->open_file(td, f)) {
306                 log_err("fio: failed opening blockdev %s for size check\n",
307                         f->file_name);
308                 return 1;
309         }
310
311         r = chardev_size(f, &bytes);
312         if (r) {
313                 td_verror(td, r, "chardev_size");
314                 goto err;
315         }
316
317         if (!bytes) {
318                 log_err("%s: zero sized char device?\n", f->file_name);
319                 goto err;
320         }
321
322         f->real_file_size = bytes;
323         td->io_ops->close_file(td, f);
324         return 0;
325 err:
326         td->io_ops->close_file(td, f);
327         return 1;
328 #else
329         f->real_file_size = -1ULL;
330         return 0;
331 #endif
332 }
333
334 static int get_file_size(struct thread_data *td, struct fio_file *f)
335 {
336         int ret = 0;
337
338         if (fio_file_size_known(f))
339                 return 0;
340
341         if (f->filetype == FIO_TYPE_FILE)
342                 ret = file_size(td, f);
343         else if (f->filetype == FIO_TYPE_BD)
344                 ret = bdev_size(td, f);
345         else if (f->filetype == FIO_TYPE_CHAR)
346                 ret = char_size(td, f);
347         else
348                 f->real_file_size = -1;
349
350         if (ret)
351                 return ret;
352
353         if (f->file_offset > f->real_file_size) {
354                 log_err("%s: offset extends end (%llu > %llu)\n", td->o.name,
355                                         f->file_offset, f->real_file_size);
356                 return 1;
357         }
358
359         fio_file_set_size_known(f);
360         return 0;
361 }
362
363 static int __file_invalidate_cache(struct thread_data *td, struct fio_file *f,
364                                    unsigned long long off,
365                                    unsigned long long len)
366 {
367         int ret = 0;
368
369         if (len == -1ULL)
370                 len = f->io_size;
371         if (off == -1ULL)
372                 off = f->file_offset;
373
374         if (len == -1ULL || off == -1ULL)
375                 return 0;
376
377         dprint(FD_IO, "invalidate cache %s: %llu/%llu\n", f->file_name, off,
378                                                                 len);
379
380         /*
381          * FIXME: add blockdev flushing too
382          */
383         if (f->mmap_ptr) {
384                 ret = posix_madvise(f->mmap_ptr, f->mmap_sz, POSIX_MADV_DONTNEED);
385 #ifdef FIO_MADV_FREE
386                 (void) posix_madvise(f->mmap_ptr, f->mmap_sz, FIO_MADV_FREE);
387 #endif
388         } else if (f->filetype == FIO_TYPE_FILE) {
389                 ret = posix_fadvise(f->fd, off, len, POSIX_FADV_DONTNEED);
390         } else if (f->filetype == FIO_TYPE_BD) {
391                 ret = blockdev_invalidate_cache(f);
392                 if (ret < 0 && errno == EACCES && geteuid()) {
393                         if (!root_warn) {
394                                 log_err("fio: only root may flush block "
395                                         "devices. Cache flush bypassed!\n");
396                                 root_warn = 1;
397                         }
398                         ret = 0;
399                 }
400         } else if (f->filetype == FIO_TYPE_CHAR || f->filetype == FIO_TYPE_PIPE)
401                 ret = 0;
402
403         if (ret < 0) {
404                 td_verror(td, errno, "invalidate_cache");
405                 return 1;
406         } else if (ret > 0) {
407                 td_verror(td, ret, "invalidate_cache");
408                 return 1;
409         }
410
411         return ret;
412
413 }
414
415 int file_invalidate_cache(struct thread_data *td, struct fio_file *f)
416 {
417         if (!fio_file_open(f))
418                 return 0;
419
420         return __file_invalidate_cache(td, f, -1ULL, -1ULL);
421 }
422
423 int generic_close_file(struct thread_data fio_unused *td, struct fio_file *f)
424 {
425         int ret = 0;
426
427         dprint(FD_FILE, "fd close %s\n", f->file_name);
428
429         remove_file_hash(f);
430
431         if (close(f->fd) < 0)
432                 ret = errno;
433
434         f->fd = -1;
435         return ret;
436 }
437
438 static int file_lookup_open(struct fio_file *f, int flags)
439 {
440         struct fio_file *__f;
441         int from_hash;
442
443         __f = lookup_file_hash(f->file_name);
444         if (__f) {
445                 dprint(FD_FILE, "found file in hash %s\n", f->file_name);
446                 /*
447                  * racy, need the __f->lock locked
448                  */
449                 f->lock = __f->lock;
450                 f->lock_owner = __f->lock_owner;
451                 f->lock_batch = __f->lock_batch;
452                 f->lock_ddir = __f->lock_ddir;
453                 from_hash = 1;
454         } else {
455                 dprint(FD_FILE, "file not found in hash %s\n", f->file_name);
456                 from_hash = 0;
457         }
458
459         f->fd = open(f->file_name, flags, 0600);
460         return from_hash;
461 }
462
463 int generic_open_file(struct thread_data *td, struct fio_file *f)
464 {
465         int is_std = 0;
466         int flags = 0;
467         int from_hash = 0;
468
469         dprint(FD_FILE, "fd open %s\n", f->file_name);
470
471         if (!strcmp(f->file_name, "-")) {
472                 if (td_rw(td)) {
473                         log_err("fio: can't read/write to stdin/out\n");
474                         return 1;
475                 }
476                 is_std = 1;
477
478                 /*
479                  * move output logging to stderr, if we are writing to stdout
480                  */
481                 if (td_write(td))
482                         f_out = stderr;
483         }
484
485         if (td->o.odirect)
486                 flags |= OS_O_DIRECT;
487         if (td->o.sync_io)
488                 flags |= O_SYNC;
489         if (f->filetype != FIO_TYPE_FILE)
490                 flags |= FIO_O_NOATIME;
491         if (td->o.create_on_open)
492                 flags |= O_CREAT;
493
494 open_again:
495         if (td_write(td)) {
496                 if (!read_only)
497                         flags |= O_RDWR;
498
499                 if (f->filetype == FIO_TYPE_FILE)
500                         flags |= O_CREAT;
501
502                 if (is_std)
503                         f->fd = dup(STDOUT_FILENO);
504                 else
505                         from_hash = file_lookup_open(f, flags);
506         } else {
507                 if (f->filetype == FIO_TYPE_CHAR && !read_only)
508                         flags |= O_RDWR;
509                 else
510                         flags |= O_RDONLY;
511
512                 if (is_std)
513                         f->fd = dup(STDIN_FILENO);
514                 else
515                         from_hash = file_lookup_open(f, flags);
516         }
517
518         if (f->fd == -1) {
519                 char buf[FIO_VERROR_SIZE];
520                 int __e = errno;
521
522                 if (__e == EPERM && (flags & FIO_O_NOATIME)) {
523                         flags &= ~FIO_O_NOATIME;
524                         goto open_again;
525                 }
526
527                 snprintf(buf, sizeof(buf) - 1, "open(%s)", f->file_name);
528
529                 td_verror(td, __e, buf);
530         }
531
532         if (!from_hash && f->fd != -1) {
533                 if (add_file_hash(f)) {
534                         int fio_unused ret;
535
536                         /*
537                          * OK to ignore, we haven't done anything with it
538                          */
539                         ret = generic_close_file(td, f);
540                         goto open_again;
541                 }
542         }
543
544         return 0;
545 }
546
547 int generic_get_file_size(struct thread_data *td, struct fio_file *f)
548 {
549         return get_file_size(td, f);
550 }
551
552 /*
553  * open/close all files, so that ->real_file_size gets set
554  */
555 static int get_file_sizes(struct thread_data *td)
556 {
557         struct fio_file *f;
558         unsigned int i;
559         int err = 0;
560
561         for_each_file(td, f, i) {
562                 dprint(FD_FILE, "get file size for %p/%d/%p\n", f, i,
563                                                                 f->file_name);
564
565                 if (td_io_get_file_size(td, f)) {
566                         if (td->error != ENOENT) {
567                                 log_err("%s\n", td->verror);
568                                 err = 1;
569                         }
570                         clear_error(td);
571                 }
572
573                 if (f->real_file_size == -1ULL && td->o.size)
574                         f->real_file_size = td->o.size / td->o.nr_files;
575         }
576
577         return err;
578 }
579
580 struct fio_mount {
581         struct flist_head list;
582         const char *base;
583         char __base[256];
584         unsigned int key;
585 };
586
587 /*
588  * Get free number of bytes for each file on each unique mount.
589  */
590 static unsigned long long get_fs_free_counts(struct thread_data *td)
591 {
592         struct flist_head *n, *tmp;
593         unsigned long long ret = 0;
594         struct fio_mount *fm;
595         FLIST_HEAD(list);
596         struct fio_file *f;
597         unsigned int i;
598
599         for_each_file(td, f, i) {
600                 struct stat sb;
601                 char buf[256];
602
603                 if (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_CHAR) {
604                         if (f->real_file_size != -1ULL)
605                                 ret += f->real_file_size;
606                         continue;
607                 } else if (f->filetype != FIO_TYPE_FILE)
608                         continue;
609
610                 strcpy(buf, f->file_name);
611
612                 if (stat(buf, &sb) < 0) {
613                         if (errno != ENOENT)
614                                 break;
615                         strcpy(buf, ".");
616                         if (stat(buf, &sb) < 0)
617                                 break;
618                 }
619
620                 fm = NULL;
621                 flist_for_each(n, &list) {
622                         fm = flist_entry(n, struct fio_mount, list);
623                         if (fm->key == sb.st_dev)
624                                 break;
625
626                         fm = NULL;
627                 }
628
629                 if (fm)
630                         continue;
631
632                 fm = malloc(sizeof(*fm));
633                 strcpy(fm->__base, buf);
634                 fm->base = basename(fm->__base);
635                 fm->key = sb.st_dev;
636                 flist_add(&fm->list, &list);
637         }
638
639         flist_for_each_safe(n, tmp, &list) {
640                 unsigned long long sz;
641
642                 fm = flist_entry(n, struct fio_mount, list);
643                 flist_del(&fm->list);
644
645                 sz = get_fs_size(fm->base);
646                 if (sz && sz != -1ULL)
647                         ret += sz;
648
649                 free(fm);
650         }
651
652         return ret;
653 }
654
655 /*
656  * Open the files and setup files sizes, creating files if necessary.
657  */
658 int setup_files(struct thread_data *td)
659 {
660         unsigned long long total_size, extend_size;
661         struct fio_file *f;
662         unsigned int i;
663         int err = 0, need_extend;
664
665         dprint(FD_FILE, "setup files\n");
666
667         if (td->o.read_iolog_file)
668                 return 0;
669
670         /*
671          * if ioengine defines a setup() method, it's responsible for
672          * opening the files and setting f->real_file_size to indicate
673          * the valid range for that file.
674          */
675         if (td->io_ops->setup)
676                 err = td->io_ops->setup(td);
677         else
678                 err = get_file_sizes(td);
679
680         if (err)
681                 return err;
682
683         /*
684          * check sizes. if the files/devices do not exist and the size
685          * isn't passed to fio, abort.
686          */
687         total_size = 0;
688         for_each_file(td, f, i) {
689                 if (f->real_file_size == -1ULL)
690                         total_size = -1ULL;
691                 else
692                         total_size += f->real_file_size;
693         }
694
695         if (td->o.fill_device)
696                 td->fill_device_size = get_fs_free_counts(td);
697
698         /*
699          * device/file sizes are zero and no size given, punt
700          */
701         if ((!total_size || total_size == -1ULL) && !td->o.size &&
702             !(td->io_ops->flags & FIO_NOIO) && !td->o.fill_device) {
703                 log_err("%s: you need to specify size=\n", td->o.name);
704                 td_verror(td, EINVAL, "total_file_size");
705                 return 1;
706         }
707
708         /*
709          * now file sizes are known, so we can set ->io_size. if size= is
710          * not given, ->io_size is just equal to ->real_file_size. if size
711          * is given, ->io_size is size / nr_files.
712          */
713         extend_size = total_size = 0;
714         need_extend = 0;
715         for_each_file(td, f, i) {
716                 f->file_offset = td->o.start_offset;
717
718                 if (!td->o.file_size_low) {
719                         /*
720                          * no file size range given, file size is equal to
721                          * total size divided by number of files. if that is
722                          * zero, set it to the real file size.
723                          */
724                         f->io_size = td->o.size / td->o.nr_files;
725                         if (!f->io_size)
726                                 f->io_size = f->real_file_size - f->file_offset;
727                 } else if (f->real_file_size < td->o.file_size_low ||
728                            f->real_file_size > td->o.file_size_high) {
729                         if (f->file_offset > td->o.file_size_low)
730                                 goto err_offset;
731                         /*
732                          * file size given. if it's fixed, use that. if it's a
733                          * range, generate a random size in-between.
734                          */
735                         if (td->o.file_size_low == td->o.file_size_high) {
736                                 f->io_size = td->o.file_size_low
737                                                 - f->file_offset;
738                         } else {
739                                 f->io_size = get_rand_file_size(td)
740                                                 - f->file_offset;
741                         }
742                 } else
743                         f->io_size = f->real_file_size - f->file_offset;
744
745                 if (f->io_size == -1ULL)
746                         total_size = -1ULL;
747                 else
748                         total_size += f->io_size;
749
750                 if (f->filetype == FIO_TYPE_FILE &&
751                     (f->io_size + f->file_offset) > f->real_file_size &&
752                     !(td->io_ops->flags & FIO_DISKLESSIO)) {
753                         if (!td->o.create_on_open) {
754                                 need_extend++;
755                                 extend_size += (f->io_size + f->file_offset);
756                         } else
757                                 f->real_file_size = f->io_size + f->file_offset;
758                         fio_file_set_extend(f);
759                 }
760         }
761
762         if (td->o.size_percent)
763                 total_size = (total_size * td->o.size_percent) / 100;
764
765         if (!td->o.size || td->o.size > total_size)
766                 td->o.size = total_size;
767
768         /*
769          * See if we need to extend some files
770          */
771         if (need_extend) {
772                 temp_stall_ts = 1;
773                 if (!terse_output)
774                         log_info("%s: Laying out IO file(s) (%u file(s) /"
775                                  " %lluMB)\n", td->o.name, need_extend,
776                                         extend_size >> 20);
777
778                 for_each_file(td, f, i) {
779                         unsigned long long old_len = -1ULL, extend_len = -1ULL;
780
781                         if (!fio_file_extend(f))
782                                 continue;
783
784                         assert(f->filetype == FIO_TYPE_FILE);
785                         fio_file_clear_extend(f);
786                         if (!td->o.fill_device) {
787                                 old_len = f->real_file_size;
788                                 extend_len = f->io_size + f->file_offset -
789                                                 old_len;
790                         }
791                         f->real_file_size = (f->io_size + f->file_offset);
792                         err = extend_file(td, f);
793                         if (err)
794                                 break;
795
796                         err = __file_invalidate_cache(td, f, old_len,
797                                                                 extend_len);
798                         close(f->fd);
799                         f->fd = -1;
800                         if (err)
801                                 break;
802                 }
803                 temp_stall_ts = 0;
804         }
805
806         if (err)
807                 return err;
808
809         if (!td->o.zone_size)
810                 td->o.zone_size = td->o.size;
811
812         /*
813          * iolog already set the total io size, if we read back
814          * stored entries.
815          */
816         if (!td->o.read_iolog_file)
817                 td->total_io_size = td->o.size * td->o.loops;
818         return 0;
819 err_offset:
820         log_err("%s: you need to specify valid offset=\n", td->o.name);
821         return 1;
822 }
823
824 int pre_read_files(struct thread_data *td)
825 {
826         struct fio_file *f;
827         unsigned int i;
828
829         dprint(FD_FILE, "pre_read files\n");
830
831         for_each_file(td, f, i) {
832                 pre_read_file(td, f);
833         }
834
835         return 1;
836 }
837
838 int init_random_map(struct thread_data *td)
839 {
840         unsigned long long blocks, num_maps;
841         struct fio_file *f;
842         unsigned int i;
843
844         if (td->o.norandommap || !td_random(td))
845                 return 0;
846
847         for_each_file(td, f, i) {
848                 blocks = (f->real_file_size + td->o.rw_min_bs - 1) /
849                                 (unsigned long long) td->o.rw_min_bs;
850                 num_maps = (blocks + BLOCKS_PER_MAP - 1) /
851                                 (unsigned long long) BLOCKS_PER_MAP;
852                 f->file_map = smalloc(num_maps * sizeof(unsigned long));
853                 if (f->file_map) {
854                         f->num_maps = num_maps;
855                         continue;
856                 }
857                 if (!td->o.softrandommap) {
858                         log_err("fio: failed allocating random map. If running"
859                                 " a large number of jobs, try the 'norandommap'"
860                                 " option or set 'softrandommap'. Or give"
861                                 " a larger --alloc-size to fio.\n");
862                         return 1;
863                 }
864
865                 log_info("fio: file %s failed allocating random map. Running "
866                          "job without.\n", f->file_name);
867                 f->num_maps = 0;
868         }
869
870         return 0;
871 }
872
873 void close_files(struct thread_data *td)
874 {
875         struct fio_file *f;
876         unsigned int i;
877
878         for_each_file(td, f, i) {
879                 if (fio_file_open(f))
880                         td_io_close_file(td, f);
881         }
882 }
883
884 void close_and_free_files(struct thread_data *td)
885 {
886         struct fio_file *f;
887         unsigned int i;
888
889         dprint(FD_FILE, "close files\n");
890
891         for_each_file(td, f, i) {
892                 if (td->o.unlink && f->filetype == FIO_TYPE_FILE) {
893                         dprint(FD_FILE, "free unlink %s\n", f->file_name);
894                         unlink(f->file_name);
895                 }
896
897                 if (fio_file_open(f))
898                         td_io_close_file(td, f);
899
900                 remove_file_hash(f);
901
902                 sfree(f->file_name);
903                 f->file_name = NULL;
904                 sfree(f->file_map);
905                 f->file_map = NULL;
906                 sfree(f);
907         }
908
909         td->o.filename = NULL;
910         free(td->files);
911         td->files_index = 0;
912         td->files = NULL;
913         td->o.nr_files = 0;
914 }
915
916 static void get_file_type(struct fio_file *f)
917 {
918         struct stat sb;
919
920         if (!strcmp(f->file_name, "-"))
921                 f->filetype = FIO_TYPE_PIPE;
922         else
923                 f->filetype = FIO_TYPE_FILE;
924
925         if (!stat(f->file_name, &sb)) {
926                 /* \\.\ is the device namespace in Windows, where every file is
927                  * a block device */
928                 if (S_ISBLK(sb.st_mode) || strncmp(f->file_name, "\\\\.\\", 4) == 0)
929                         f->filetype = FIO_TYPE_BD;
930                 else if (S_ISCHR(sb.st_mode))
931                         f->filetype = FIO_TYPE_CHAR;
932                 else if (S_ISFIFO(sb.st_mode))
933                         f->filetype = FIO_TYPE_PIPE;
934         }
935 }
936
937 int add_file(struct thread_data *td, const char *fname)
938 {
939         int cur_files = td->files_index;
940         char file_name[PATH_MAX];
941         struct fio_file *f;
942         int len = 0;
943
944         dprint(FD_FILE, "add file %s\n", fname);
945
946         f = smalloc(sizeof(*f));
947         if (!f) {
948                 log_err("fio: smalloc OOM\n");
949                 assert(0);
950         }
951
952         f->fd = -1;
953         fio_file_reset(f);
954
955         if (td->files_size <= td->files_index) {
956                 int new_size = td->o.nr_files + 1;
957
958                 dprint(FD_FILE, "resize file array to %d files\n", new_size);
959
960                 td->files = realloc(td->files, new_size * sizeof(f));
961                 td->files_size = new_size;
962         }
963         td->files[cur_files] = f;
964
965         /*
966          * init function, io engine may not be loaded yet
967          */
968         if (td->io_ops && (td->io_ops->flags & FIO_DISKLESSIO))
969                 f->real_file_size = -1ULL;
970
971         if (td->o.directory)
972                 len = sprintf(file_name, "%s/", td->o.directory);
973
974         sprintf(file_name + len, "%s", fname);
975         f->file_name = smalloc_strdup(file_name);
976         if (!f->file_name) {
977                 log_err("fio: smalloc OOM\n");
978                 assert(0);
979         }
980
981         get_file_type(f);
982
983         switch (td->o.file_lock_mode) {
984         case FILE_LOCK_NONE:
985                 break;
986         case FILE_LOCK_READWRITE:
987                 f->lock = fio_mutex_rw_init();
988                 break;
989         case FILE_LOCK_EXCLUSIVE:
990                 f->lock = fio_mutex_init(1);
991                 break;
992         default:
993                 log_err("fio: unknown lock mode: %d\n", td->o.file_lock_mode);
994                 assert(0);
995         }
996
997         td->files_index++;
998         if (f->filetype == FIO_TYPE_FILE)
999                 td->nr_normal_files++;
1000
1001         dprint(FD_FILE, "file %p \"%s\" added at %d\n", f, f->file_name,
1002                                                         cur_files);
1003
1004         return cur_files;
1005 }
1006
1007 int add_file_exclusive(struct thread_data *td, const char *fname)
1008 {
1009         struct fio_file *f;
1010         unsigned int i;
1011
1012         for_each_file(td, f, i) {
1013                 if (!strcmp(f->file_name, fname))
1014                         return i;
1015         }
1016
1017         return add_file(td, fname);
1018 }
1019
1020 void get_file(struct fio_file *f)
1021 {
1022         dprint(FD_FILE, "get file %s, ref=%d\n", f->file_name, f->references);
1023         assert(fio_file_open(f));
1024         f->references++;
1025 }
1026
1027 int put_file(struct thread_data *td, struct fio_file *f)
1028 {
1029         int f_ret = 0, ret = 0;
1030
1031         dprint(FD_FILE, "put file %s, ref=%d\n", f->file_name, f->references);
1032
1033         if (!fio_file_open(f)) {
1034                 assert(f->fd == -1);
1035                 return 0;
1036         }
1037
1038         assert(f->references);
1039         if (--f->references)
1040                 return 0;
1041
1042         if (should_fsync(td) && td->o.fsync_on_close)
1043                 f_ret = fsync(f->fd);
1044
1045         if (td->io_ops->close_file)
1046                 ret = td->io_ops->close_file(td, f);
1047
1048         if (!ret)
1049                 ret = f_ret;
1050
1051         td->nr_open_files--;
1052         fio_file_clear_open(f);
1053         assert(f->fd == -1);
1054         return ret;
1055 }
1056
1057 void lock_file(struct thread_data *td, struct fio_file *f, enum fio_ddir ddir)
1058 {
1059         if (!f->lock || td->o.file_lock_mode == FILE_LOCK_NONE)
1060                 return;
1061
1062         if (f->lock_owner == td && f->lock_batch--)
1063                 return;
1064
1065         if (td->o.file_lock_mode == FILE_LOCK_READWRITE) {
1066                 if (ddir == DDIR_READ)
1067                         fio_mutex_down_read(f->lock);
1068                 else
1069                         fio_mutex_down_write(f->lock);
1070         } else if (td->o.file_lock_mode == FILE_LOCK_EXCLUSIVE)
1071                 fio_mutex_down(f->lock);
1072
1073         f->lock_owner = td;
1074         f->lock_batch = td->o.lockfile_batch;
1075         f->lock_ddir = ddir;
1076 }
1077
1078 void unlock_file(struct thread_data *td, struct fio_file *f)
1079 {
1080         if (!f->lock || td->o.file_lock_mode == FILE_LOCK_NONE)
1081                 return;
1082         if (f->lock_batch)
1083                 return;
1084
1085         if (td->o.file_lock_mode == FILE_LOCK_READWRITE) {
1086                 const int is_read = f->lock_ddir == DDIR_READ;
1087                 int val = fio_mutex_getval(f->lock);
1088
1089                 if ((is_read && val == 1) || (!is_read && val == -1))
1090                         f->lock_owner = NULL;
1091
1092                 if (is_read)
1093                         fio_mutex_up_read(f->lock);
1094                 else
1095                         fio_mutex_up_write(f->lock);
1096         } else if (td->o.file_lock_mode == FILE_LOCK_EXCLUSIVE) {
1097                 int val = fio_mutex_getval(f->lock);
1098
1099                 if (val == 0)
1100                         f->lock_owner = NULL;
1101
1102                 fio_mutex_up(f->lock);
1103         }
1104 }
1105
1106 void unlock_file_all(struct thread_data *td, struct fio_file *f)
1107 {
1108         if (f->lock_owner != td)
1109                 return;
1110
1111         f->lock_batch = 0;
1112         unlock_file(td, f);
1113 }
1114
1115 static int recurse_dir(struct thread_data *td, const char *dirname)
1116 {
1117         struct dirent *dir;
1118         int ret = 0;
1119         DIR *D;
1120
1121         D = opendir(dirname);
1122         if (!D) {
1123                 char buf[FIO_VERROR_SIZE];
1124
1125                 snprintf(buf, FIO_VERROR_SIZE - 1, "opendir(%s)", dirname);
1126                 td_verror(td, errno, buf);
1127                 return 1;
1128         }
1129
1130         while ((dir = readdir(D)) != NULL) {
1131                 char full_path[PATH_MAX];
1132                 struct stat sb;
1133
1134                 if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."))
1135                         continue;
1136
1137                 sprintf(full_path, "%s/%s", dirname, dir->d_name);
1138
1139                 if (lstat(full_path, &sb) == -1) {
1140                         if (errno != ENOENT) {
1141                                 td_verror(td, errno, "stat");
1142                                 return 1;
1143                         }
1144                 }
1145
1146                 if (S_ISREG(sb.st_mode)) {
1147                         add_file(td, full_path);
1148                         td->o.nr_files++;
1149                         continue;
1150                 }
1151                 if (!S_ISDIR(sb.st_mode))
1152                         continue;
1153
1154                 ret = recurse_dir(td, full_path);
1155                 if (ret)
1156                         break;
1157         }
1158
1159         closedir(D);
1160         return ret;
1161 }
1162
1163 int add_dir_files(struct thread_data *td, const char *path)
1164 {
1165         int ret = recurse_dir(td, path);
1166
1167         if (!ret)
1168                 log_info("fio: opendir added %d files\n", td->o.nr_files);
1169
1170         return ret;
1171 }
1172
1173 void dup_files(struct thread_data *td, struct thread_data *org)
1174 {
1175         struct fio_file *f;
1176         unsigned int i;
1177
1178         dprint(FD_FILE, "dup files: %d\n", org->files_index);
1179
1180         if (!org->files)
1181                 return;
1182
1183         td->files = malloc(org->files_index * sizeof(f));
1184
1185         for_each_file(org, f, i) {
1186                 struct fio_file *__f;
1187
1188                 __f = smalloc(sizeof(*__f));
1189                 if (!__f) {
1190                         log_err("fio: smalloc OOM\n");
1191                         assert(0);
1192                 }
1193                 __f->fd = -1;
1194                 fio_file_reset(__f);
1195
1196                 if (f->file_name) {
1197                         __f->file_name = smalloc_strdup(f->file_name);
1198                         if (!__f->file_name) {
1199                                 log_err("fio: smalloc OOM\n");
1200                                 assert(0);
1201                         }
1202
1203                         __f->filetype = f->filetype;
1204                 }
1205
1206                 td->files[i] = __f;
1207         }
1208 }
1209
1210 /*
1211  * Returns the index that matches the filename, or -1 if not there
1212  */
1213 int get_fileno(struct thread_data *td, const char *fname)
1214 {
1215         struct fio_file *f;
1216         unsigned int i;
1217
1218         for_each_file(td, f, i)
1219                 if (!strcmp(f->file_name, fname))
1220                         return i;
1221
1222         return -1;
1223 }
1224
1225 /*
1226  * For log usage, where we add/open/close files automatically
1227  */
1228 void free_release_files(struct thread_data *td)
1229 {
1230         close_files(td);
1231         td->files_index = 0;
1232         td->nr_normal_files = 0;
1233 }