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