syslet: we have fls(), use it for rounding ring size up
[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 <sys/stat.h>
7 #include <sys/mman.h>
8 #include <sys/types.h>
9
10 #include "fio.h"
11
12 static int root_warn;
13
14 static int extend_file(struct thread_data *td, struct fio_file *f)
15 {
16         int r, new_layout = 0, unlink_file = 0, flags;
17         unsigned long long left;
18         unsigned int bs;
19         char *b;
20
21         if (read_only) {
22                 log_err("fio: refusing extend of file due to read-only\n");
23                 return 0;
24         }
25
26         /*
27          * check if we need to lay the file out complete again. fio
28          * does that for operations involving reads, or for writes
29          * where overwrite is set
30          */
31         if (td_read(td) || (td_write(td) && td->o.overwrite))
32                 new_layout = 1;
33         if (td_write(td) && !td->o.overwrite)
34                 unlink_file = 1;
35
36         if ((unlink_file || new_layout) && (f->flags & FIO_FILE_EXISTS)) {
37                 if (unlink(f->file_name) < 0) {
38                         td_verror(td, errno, "unlink");
39                         return 1;
40                 }
41         }
42
43         flags = O_WRONLY | O_CREAT;
44         if (new_layout)
45                 flags |= O_TRUNC;
46
47         f->fd = open(f->file_name, flags, 0644);
48         if (f->fd < 0) {
49                 td_verror(td, errno, "open");
50                 return 1;
51         }
52
53         if (ftruncate(f->fd, f->real_file_size) == -1) {
54                 td_verror(td, errno, "ftruncate");
55                 goto err;
56         }
57
58         if (!new_layout)
59                 goto done;
60
61         if (posix_fallocate(f->fd, 0, f->real_file_size) < 0) {
62                 td_verror(td, errno, "posix_fallocate");
63                 goto err;
64         }
65
66         b = malloc(td->o.max_bs[DDIR_WRITE]);
67         memset(b, 0, td->o.max_bs[DDIR_WRITE]);
68
69         left = f->real_file_size;
70         while (left && !td->terminate) {
71                 bs = td->o.max_bs[DDIR_WRITE];
72                 if (bs > left)
73                         bs = left;
74
75                 r = write(f->fd, b, bs);
76
77                 if (r == (int) bs) {
78                         left -= bs;
79                         continue;
80                 } else {
81                         if (r < 0)
82                                 td_verror(td, errno, "write");
83                         else
84                                 td_verror(td, EIO, "write");
85
86                         break;
87                 }
88         }
89
90         if (td->terminate)
91                 unlink(f->file_name);
92         else if (td->o.create_fsync)
93                 fsync(f->fd);
94
95         free(b);
96 done:
97         close(f->fd);
98         f->fd = -1;
99         return 0;
100 err:
101         close(f->fd);
102         f->fd = -1;
103         return 1;
104 }
105
106 static unsigned long long get_rand_file_size(struct thread_data *td)
107 {
108         unsigned long long ret;
109         long r;
110
111         r = os_random_long(&td->file_size_state);
112         ret = td->o.file_size_low + (unsigned long long) ((double) (td->o.file_size_high - td->o.file_size_low) * (r / (RAND_MAX + 1.0)));
113         ret -= (ret % td->o.rw_min_bs);
114         return ret;
115 }
116
117 static int file_size(struct thread_data *td, struct fio_file *f)
118 {
119         struct stat st;
120
121         if (fstat(f->fd, &st) == -1) {
122                 td_verror(td, errno, "fstat");
123                 return 1;
124         }
125
126         f->real_file_size = st.st_size;
127         return 0;
128 }
129
130 static int bdev_size(struct thread_data *td, struct fio_file *f)
131 {
132         unsigned long long bytes;
133         int r;
134
135         r = blockdev_size(f->fd, &bytes);
136         if (r) {
137                 td_verror(td, r, "blockdev_size");
138                 return 1;
139         }
140
141         f->real_file_size = bytes;
142         return 0;
143 }
144
145 static int get_file_size(struct thread_data *td, struct fio_file *f)
146 {
147         int ret = 0;
148
149         if (f->flags & FIO_SIZE_KNOWN)
150                 return 0;
151
152         if (f->filetype == FIO_TYPE_FILE)
153                 ret = file_size(td, f);
154         else if (f->filetype == FIO_TYPE_BD)
155                 ret = bdev_size(td, f);
156         else
157                 f->real_file_size = -1;
158
159         if (ret)
160                 return ret;
161
162         if (f->file_offset > f->real_file_size) {
163                 log_err("%s: offset extends end (%Lu > %Lu)\n", td->o.name, f->file_offset, f->real_file_size);
164                 return 1;
165         }
166
167         f->flags |= FIO_SIZE_KNOWN;
168         return 0;
169 }
170
171 int file_invalidate_cache(struct thread_data *td, struct fio_file *f)
172 {
173         int ret = 0;
174
175         if (td->o.odirect)
176                 return 0;
177
178         /*
179          * FIXME: add blockdev flushing too
180          */
181         if (f->mmap)
182                 ret = madvise(f->mmap, f->io_size, MADV_DONTNEED);
183         else if (f->filetype == FIO_TYPE_FILE)
184                 ret = fadvise(f->fd, f->file_offset, f->io_size, POSIX_FADV_DONTNEED);
185         else if (f->filetype == FIO_TYPE_BD) {
186                 ret = blockdev_invalidate_cache(f->fd);
187                 if (ret < 0 && errno == EACCES && geteuid()) {
188                         if (!root_warn) {
189                                 log_err("fio: only root may flush block devices. Cache flush bypassed!\n");
190                                 root_warn = 1;
191                         }
192                         ret = 0;
193                 }
194         } else if (f->filetype == FIO_TYPE_CHAR || f->filetype == FIO_TYPE_PIPE)
195                 ret = 0;
196
197         if (ret < 0) {
198                 td_verror(td, errno, "invalidate_cache");
199                 return 1;
200         }
201
202         return ret;
203 }
204
205 void generic_close_file(struct thread_data fio_unused *td, struct fio_file *f)
206 {
207         close(f->fd);
208         f->fd = -1;
209 }
210
211 int generic_open_file(struct thread_data *td, struct fio_file *f)
212 {
213         int is_std = 0;
214         int flags = 0;
215
216         if (!strcmp(f->file_name, "-")) {
217                 if (td_rw(td)) {
218                         log_err("fio: can't read/write to stdin/out\n");
219                         return 1;
220                 }
221                 is_std = 1;
222
223                 /*
224                  * move output logging to stderr, if we are writing to stdout
225                  */
226                 if (td_write(td))
227                         f_out = stderr;
228         }
229
230         if (td->o.odirect)
231                 flags |= OS_O_DIRECT;
232         if (td->o.sync_io)
233                 flags |= O_SYNC;
234         if (f->filetype != FIO_TYPE_FILE)
235                 flags |= O_NOATIME;
236
237 open_again:
238         if (td_write(td)) {
239                 assert(!read_only);
240
241                 flags |= O_RDWR;
242
243                 if (f->filetype == FIO_TYPE_FILE)
244                         flags |= O_CREAT;
245
246                 if (is_std)
247                         f->fd = dup(STDOUT_FILENO);
248                 else
249                         f->fd = open(f->file_name, flags, 0600);
250         } else {
251                 if (f->filetype == FIO_TYPE_CHAR && !read_only)
252                         flags |= O_RDWR;
253                 else
254                         flags |= O_RDONLY;
255
256                 if (is_std)
257                         f->fd = dup(STDIN_FILENO);
258                 else
259                         f->fd = open(f->file_name, flags);
260         }
261
262         if (f->fd == -1) {
263                 char buf[FIO_VERROR_SIZE];
264                 int __e = errno;
265
266                 if (errno == EPERM && (flags & O_NOATIME)) {
267                         flags &= ~O_NOATIME;
268                         goto open_again;
269                 }
270
271                 snprintf(buf, sizeof(buf) - 1, "open(%s)", f->file_name);
272
273                 td_verror(td, __e, buf);
274         }
275
276         if (get_file_size(td, f))
277                 goto err;
278
279         return 0;
280 err:
281         close(f->fd);
282         return 1;
283 }
284
285 int open_files(struct thread_data *td)
286 {
287         struct fio_file *f;
288         unsigned int i;
289         int err = 0;
290
291         for_each_file(td, f, i) {
292                 err = td_io_open_file(td, f);
293                 if (err) {
294                         if (td->error == EMFILE) {
295                                 log_err("fio: limited open files to: %d\n", td->nr_open_files);
296                                 td->o.open_files = td->nr_open_files;
297                                 err = 0;
298                                 clear_error(td);
299                         }
300                         break;
301                 }
302
303                 if (td->o.open_files == td->nr_open_files)
304                         break;
305         }
306
307         if (!err)
308                 return 0;
309
310         for_each_file(td, f, i)
311                 td_io_close_file(td, f);
312
313         return err;
314 }
315
316 /*
317  * open/close all files, so that ->real_file_size gets set
318  */
319 static int get_file_sizes(struct thread_data *td)
320 {
321         struct fio_file *f;
322         unsigned int i;
323         int err = 0;
324
325         for_each_file(td, f, i) {
326                 if (td->io_ops->open_file(td, f)) {
327                         if (td->error != ENOENT) {
328                                 log_err("%s\n", td->verror);
329                                 err = 1;
330                         }
331                         clear_error(td);
332                 } else {
333                         if (td->io_ops->close_file)
334                                 td->io_ops->close_file(td, f);
335                 }
336
337                 if (f->real_file_size == -1ULL && td->o.size)
338                         f->real_file_size = td->o.size / td->o.nr_files;
339         }
340
341         return err;
342 }
343
344 /*
345  * Open the files and setup files sizes, creating files if necessary.
346  */
347 int setup_files(struct thread_data *td)
348 {
349         unsigned long long total_size, extend_size;
350         struct fio_file *f;
351         unsigned int i;
352         int err = 0, need_extend;
353
354         /*
355          * if ioengine defines a setup() method, it's responsible for
356          * opening the files and setting f->real_file_size to indicate
357          * the valid range for that file.
358          */
359         if (td->io_ops->setup)
360                 err = td->io_ops->setup(td);
361         else
362                 err = get_file_sizes(td);
363
364         if (err)
365                 return err;
366
367         /*
368          * check sizes. if the files/devices do not exist and the size
369          * isn't passed to fio, abort.
370          */
371         total_size = 0;
372         for_each_file(td, f, i) {
373                 if (f->real_file_size == -1ULL)
374                         total_size = -1ULL;
375                 else
376                         total_size += f->real_file_size;
377         }
378
379         /*
380          * device/file sizes are zero and no size given, punt
381          */
382         if ((!total_size || total_size == -1ULL) && !td->o.size &&
383             !(td->io_ops->flags & FIO_NOIO)) {
384                 log_err("%s: you need to specify size=\n", td->o.name);
385                 td_verror(td, EINVAL, "total_file_size");
386                 return 1;
387         }
388
389         /*
390          * now file sizes are known, so we can set ->io_size. if size= is
391          * not given, ->io_size is just equal to ->real_file_size. if size
392          * is given, ->io_size is size / nr_files.
393          */
394         extend_size = total_size = 0;
395         need_extend = 0;
396         for_each_file(td, f, i) {
397                 f->file_offset = td->o.start_offset;
398
399                 if (!td->o.file_size_low) {
400                         /*
401                          * no file size range given, file size is equal to
402                          * total size divided by number of files. if that is
403                          * zero, set it to the real file size.
404                          */
405                         f->io_size = td->o.size / td->o.nr_files;
406                         if (!f->io_size) {
407                                 if (f->file_offset > f->real_file_size)
408                                         goto err_offset;
409                                 f->io_size = f->real_file_size - f->file_offset;
410                         }
411                 } else if (f->real_file_size < td->o.file_size_low ||
412                            f->real_file_size > td->o.file_size_high) {
413                         if (f->file_offset > td->o.file_size_low) 
414                                 goto err_offset;
415                         /*
416                          * file size given. if it's fixed, use that. if it's a
417                          * range, generate a random size in-between.
418                          */
419                         if (td->o.file_size_low == td->o.file_size_high)
420                                 f->io_size = td->o.file_size_low - f->file_offset;
421                         else
422                                 f->io_size = get_rand_file_size(td) - f->file_offset;
423                 } else if (f->file_offset > f->real_file_size)
424                         goto err_offset;
425                 else
426                         f->io_size = f->real_file_size - f->file_offset;
427
428                 if (f->io_size == -1ULL)
429                         total_size = -1ULL;
430                 else
431                         total_size += f->io_size;
432
433                 if (f->filetype == FIO_TYPE_FILE &&
434                     (f->io_size + f->file_offset) > f->real_file_size &&
435                     !(td->io_ops->flags & FIO_DISKLESSIO)) {
436                         need_extend++;
437                         extend_size += (f->io_size + f->file_offset);
438                         f->flags |= FIO_FILE_EXTEND;
439                 }       
440         }
441
442         if (!td->o.size || td->o.size > total_size)
443                 td->o.size = total_size;
444
445         /*
446          * See if we need to extend some files
447          */
448         if (need_extend) {
449                 temp_stall_ts = 1;
450                 log_info("%s: Laying out IO file(s) (%u file(s) / %LuMiB)\n",
451                         td->o.name, need_extend, extend_size >> 20);
452
453                 for_each_file(td, f, i) {
454                         if (!(f->flags & FIO_FILE_EXTEND))
455                                 continue;
456
457                         assert(f->filetype == FIO_TYPE_FILE);
458                         f->flags &= ~FIO_FILE_EXTEND;
459                         f->real_file_size = (f->io_size + f->file_offset);
460                         err = extend_file(td, f);
461                         if (err)
462                                 break;
463                 }
464                 temp_stall_ts = 0;
465         }
466
467         if (err)
468                 return err;
469
470         if (!td->o.zone_size)
471                 td->o.zone_size = td->o.size;
472
473         /*
474          * iolog already set the total io size, if we read back
475          * stored entries.
476          */
477         if (!td->o.read_iolog_file)
478                 td->total_io_size = td->o.size * td->o.loops;
479         return 0;
480 err_offset:
481         log_err("%s: you need to specify valid offset=\n", td->o.name);
482         return 1;
483 }
484
485 int init_random_map(struct thread_data *td)
486 {
487         int num_maps, blocks;
488         struct fio_file *f;
489         unsigned int i;
490
491         if (td->o.norandommap)
492                 return 0;
493
494         for_each_file(td, f, i) {
495                 blocks = (f->real_file_size + td->o.rw_min_bs - 1) / td->o.rw_min_bs;
496                 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
497                 f->file_map = malloc(num_maps * sizeof(long));
498                 if (!f->file_map) {
499                         log_err("fio: failed allocating random map. If running a large number of jobs, try the 'norandommap' option\n");
500                         return 1;
501                 }
502                 f->num_maps = num_maps;
503                 memset(f->file_map, 0, num_maps * sizeof(long));
504         }
505
506         return 0;
507 }
508
509 void close_files(struct thread_data *td)
510 {
511         struct fio_file *f;
512         unsigned int i;
513
514         for_each_file(td, f, i) {
515                 if (td->o.unlink && f->filetype == FIO_TYPE_FILE)
516                         unlink(f->file_name);
517
518                 td_io_close_file(td, f);
519
520                 free(f->file_name);
521                 f->file_name = NULL;
522
523                 if (f->file_map) {
524                         free(f->file_map);
525                         f->file_map = NULL;
526                 }
527         }
528
529         td->o.filename = NULL;
530         free(td->files);
531         td->files = NULL;
532         td->o.nr_files = 0;
533 }
534
535 static void get_file_type(struct fio_file *f)
536 {
537         struct stat sb;
538
539         if (!strcmp(f->file_name, "-"))
540                 f->filetype = FIO_TYPE_PIPE;
541         else
542                 f->filetype = FIO_TYPE_FILE;
543
544         if (!lstat(f->file_name, &sb)) {
545                 if (S_ISBLK(sb.st_mode))
546                         f->filetype = FIO_TYPE_BD;
547                 else if (S_ISCHR(sb.st_mode))
548                         f->filetype = FIO_TYPE_CHAR;
549                 else if (S_ISFIFO(sb.st_mode))
550                         f->filetype = FIO_TYPE_PIPE;
551         }
552 }
553
554 int add_file(struct thread_data *td, const char *fname)
555 {
556         int cur_files = td->files_index;
557         char file_name[PATH_MAX];
558         struct fio_file *f;
559         int len = 0;
560
561         td->files = realloc(td->files, (cur_files + 1) * sizeof(*f));
562
563         f = &td->files[cur_files];
564         memset(f, 0, sizeof(*f));
565         f->fd = -1;
566
567         /*
568          * init function, io engine may not be loaded yet
569          */
570         if (td->io_ops && (td->io_ops->flags & FIO_DISKLESSIO))
571                 f->real_file_size = -1ULL;
572
573         if (td->o.directory)
574                 len = sprintf(file_name, "%s/", td->o.directory);
575
576         sprintf(file_name + len, "%s", fname);
577         f->file_name = strdup(file_name);
578
579         get_file_type(f);
580
581         td->files_index++;
582         if (f->filetype == FIO_TYPE_FILE)
583                 td->nr_normal_files++;
584
585         return cur_files;
586 }
587
588 void get_file(struct fio_file *f)
589 {
590         assert(f->flags & FIO_FILE_OPEN);
591         f->references++;
592 }
593
594 void put_file(struct thread_data *td, struct fio_file *f)
595 {
596         if (!(f->flags & FIO_FILE_OPEN))
597                 return;
598
599         assert(f->references);
600         if (--f->references)
601                 return;
602
603         if (should_fsync(td) && td->o.fsync_on_close)
604                 fsync(f->fd);
605
606         if (td->io_ops->close_file)
607                 td->io_ops->close_file(td, f);
608
609         td->nr_open_files--;
610         f->flags &= ~FIO_FILE_OPEN;
611 }
612
613 static int recurse_dir(struct thread_data *td, const char *dirname)
614 {
615         struct dirent *dir;
616         int ret = 0;
617         DIR *D;
618
619         D = opendir(dirname);
620         if (!D) {
621                 char buf[FIO_VERROR_SIZE];
622
623                 snprintf(buf, FIO_VERROR_SIZE - 1, "opendir(%s)", dirname);
624                 td_verror(td, errno, buf);
625                 return 1;
626         }
627
628         while ((dir = readdir(D)) != NULL) {
629                 char full_path[PATH_MAX];
630                 struct stat sb;
631
632                 if (!strcmp(dir->d_name, ".") || !strcmp(dir->d_name, ".."))
633                         continue;
634
635                 sprintf(full_path, "%s/%s", dirname, dir->d_name);
636
637                 if (lstat(full_path, &sb) == -1) {
638                         if (errno != ENOENT) {
639                                 td_verror(td, errno, "stat");
640                                 return 1;
641                         }
642                 }
643
644                 if (S_ISREG(sb.st_mode)) {
645                         add_file(td, full_path);
646                         td->o.nr_files++;
647                         continue;
648                 }
649                 if (!S_ISDIR(sb.st_mode))
650                         continue;
651
652                 if ((ret = recurse_dir(td, full_path)) != 0)
653                         break;
654         }
655
656         closedir(D);
657         return ret;
658 }
659
660 int add_dir_files(struct thread_data *td, const char *path)
661 {
662         int ret = recurse_dir(td, path);
663
664         if (!ret)
665                 log_info("fio: opendir added %d files\n", td->o.nr_files);
666
667         return ret;
668 }
669
670 void dup_files(struct thread_data *td, struct thread_data *org)
671 {
672         struct fio_file *f;
673         unsigned int i;
674         size_t bytes;
675
676         if (!org->files)
677                 return;
678
679         bytes = org->files_index * sizeof(*f);
680         td->files = malloc(bytes);
681         memcpy(td->files, org->files, bytes);
682
683         for_each_file(td, f, i) {
684                 if (f->file_name)
685                         f->file_name = strdup(f->file_name);
686         }
687 }
688
689 /*
690  * Returns the index that matches the filename, or -1 if not there
691  */
692 int get_fileno(struct thread_data *td, const char *fname)
693 {
694         struct fio_file *f;
695         unsigned int i;
696
697         for_each_file(td, f, i)
698                 if (!strcmp(f->file_name, fname))
699                         return i;
700
701         return -1;
702 }
703
704 /*
705  * For log usage, where we add/open/close files automatically
706  */
707 void free_release_files(struct thread_data *td)
708 {
709         close_files(td);
710         td->files_index = 0;
711         td->nr_normal_files = 0;
712 }