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