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