projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Normal vs special files fixups
[fio.git] / init.c
... / ...
CommitLineData
1/*
2 * This file contains job initialization and setup functions.
3 */
4#include <stdio.h>
5#include <stdlib.h>
6#include <unistd.h>
7#include <fcntl.h>
8#include <ctype.h>
9#include <string.h>
10#include <errno.h>
11#include <getopt.h>
12#include <assert.h>
13#include <sys/ipc.h>
14#include <sys/shm.h>
15#include <sys/types.h>
16#include <sys/stat.h>
17
18#include "fio.h"
19#include "parse.h"
20
21#define FIO_RANDSEED (0xb1899bedUL)
22
23#define td_var_offset(var) ((size_t) &((struct thread_data *)0)->var)
24
25static int str_mem_cb(void *, const char *);
26static int str_lockmem_cb(void *, unsigned long *);
27#ifdef FIO_HAVE_IOPRIO
28static int str_prio_cb(void *, unsigned int *);
29static int str_prioclass_cb(void *, unsigned int *);
30#endif
31static int str_exitall_cb(void);
32static int str_cpumask_cb(void *, unsigned int *);
33static int str_fst_cb(void *, const char *);
34static int str_filename_cb(void *, const char *);
35static int str_directory_cb(void *, const char *);
36
37#define __stringify_1(x) #x
38#define __stringify(x) __stringify_1(x)
39
40/*
41 * Map of job/command line options
42 */
43static struct fio_option options[] = {
44 {
45 .name = "description",
46 .type = FIO_OPT_STR_STORE,
47 .off1 = td_var_offset(description),
48 .help = "Text job description",
49 },
50 {
51 .name = "name",
52 .type = FIO_OPT_STR_STORE,
53 .off1 = td_var_offset(name),
54 .help = "Name of this job",
55 },
56 {
57 .name = "directory",
58 .type = FIO_OPT_STR_STORE,
59 .off1 = td_var_offset(directory),
60 .cb = str_directory_cb,
61 .help = "Directory to store files in",
62 },
63 {
64 .name = "filename",
65 .type = FIO_OPT_STR_STORE,
66 .off1 = td_var_offset(filename),
67 .cb = str_filename_cb,
68 .help = "File(s) to use for the workload",
69 },
70 {
71 .name = "rw",
72 .type = FIO_OPT_STR,
73 .off1 = td_var_offset(td_ddir),
74 .help = "IO direction",
75 .def = "read",
76 .posval = {
77 { .ival = "read", .oval = TD_DDIR_READ },
78 { .ival = "write", .oval = TD_DDIR_WRITE },
79 { .ival = "randread", .oval = TD_DDIR_RANDREAD },
80 { .ival = "randwrite", .oval = TD_DDIR_RANDWRITE },
81 { .ival = "rw", .oval = TD_DDIR_RW },
82 { .ival = "randrw", .oval = TD_DDIR_RANDRW },
83 },
84 },
85 {
86 .name = "ioengine",
87 .type = FIO_OPT_STR_STORE,
88 .off1 = td_var_offset(ioengine),
89 .help = "IO engine to use",
90 .def = "sync",
91 .posval = {
92 { .ival = "sync", },
93#ifdef FIO_HAVE_LIBAIO
94 { .ival = "libaio", },
95#endif
96#ifdef FIO_HAVE_POSIXAIO
97 { .ival = "posixaio", },
98#endif
99 { .ival = "mmap", },
100#ifdef FIO_HAVE_SPLICE
101 { .ival = "splice", },
102#endif
103#ifdef FIO_HAVE_SGIO
104 { .ival = "sg", },
105#endif
106 { .ival = "null", }, { .ival = "net", },
107#ifdef FIO_HAVE_SYSLET
108 { .ival = "syslet-rw", },
109#endif
110 { .ival = "cpuio", },
111 { .ival = "external", },
112 },
113 },
114 {
115 .name = "iodepth",
116 .type = FIO_OPT_INT,
117 .off1 = td_var_offset(iodepth),
118 .help = "Amount of IO buffers to keep in flight",
119 .def = "1",
120 },
121 {
122 .name = "iodepth_batch",
123 .type = FIO_OPT_INT,
124 .off1 = td_var_offset(iodepth_batch),
125 .help = "Number of IO to submit in one go",
126 },
127 {
128 .name = "iodepth_low",
129 .type = FIO_OPT_INT,
130 .off1 = td_var_offset(iodepth_low),
131 .help = "Low water mark for queuing depth",
132 },
133 {
134 .name = "size",
135 .type = FIO_OPT_STR_VAL,
136 .off1 = td_var_offset(total_file_size),
137 .help = "Size of device or file",
138 },
139 {
140 .name = "bs",
141 .type = FIO_OPT_STR_VAL_INT,
142 .off1 = td_var_offset(bs[DDIR_READ]),
143 .off2 = td_var_offset(bs[DDIR_WRITE]),
144 .help = "Block size unit",
145 .def = "4k",
146 },
147 {
148 .name = "bsrange",
149 .type = FIO_OPT_RANGE,
150 .off1 = td_var_offset(min_bs[DDIR_READ]),
151 .off2 = td_var_offset(max_bs[DDIR_READ]),
152 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
153 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
154 .help = "Set block size range (in more detail than bs)",
155 },
156 {
157 .name = "bs_unaligned",
158 .type = FIO_OPT_STR_SET,
159 .off1 = td_var_offset(bs_unaligned),
160 .help = "Don't sector align IO buffer sizes",
161 },
162 {
163 .name = "offset",
164 .type = FIO_OPT_STR_VAL,
165 .off1 = td_var_offset(start_offset),
166 .help = "Start IO from this offset",
167 .def = "0",
168 },
169 {
170 .name = "randrepeat",
171 .type = FIO_OPT_BOOL,
172 .off1 = td_var_offset(rand_repeatable),
173 .help = "Use repeatable random IO pattern",
174 .def = "1",
175 },
176 {
177 .name = "norandommap",
178 .type = FIO_OPT_STR_SET,
179 .off1 = td_var_offset(norandommap),
180 .help = "Accept potential duplicate random blocks",
181 },
182 {
183 .name = "nrfiles",
184 .type = FIO_OPT_INT,
185 .off1 = td_var_offset(nr_files),
186 .help = "Split job workload between this number of files",
187 .def = "1",
188 },
189 {
190 .name = "openfiles",
191 .type = FIO_OPT_INT,
192 .off1 = td_var_offset(open_files),
193 .help = "Number of files to keep open at the same time",
194 },
195 {
196 .name = "file_service_type",
197 .type = FIO_OPT_STR,
198 .cb = str_fst_cb,
199 .off1 = td_var_offset(file_service_type),
200 .help = "How to select which file to service next",
201 .def = "roundrobin",
202 .posval = {
203 { .ival = "random", .oval = FIO_FSERVICE_RANDOM },
204 { .ival = "roundrobin", .oval = FIO_FSERVICE_RR },
205 },
206 },
207 {
208 .name = "fsync",
209 .type = FIO_OPT_INT,
210 .off1 = td_var_offset(fsync_blocks),
211 .help = "Issue fsync for writes every given number of blocks",
212 .def = "0",
213 },
214 {
215 .name = "direct",
216 .type = FIO_OPT_BOOL,
217 .off1 = td_var_offset(odirect),
218 .help = "Use O_DIRECT IO (negates buffered)",
219 .def = "0",
220 },
221 {
222 .name = "buffered",
223 .type = FIO_OPT_BOOL,
224 .off1 = td_var_offset(odirect),
225 .neg = 1,
226 .help = "Use buffered IO (negates direct)",
227 .def = "1",
228 },
229 {
230 .name = "overwrite",
231 .type = FIO_OPT_BOOL,
232 .off1 = td_var_offset(overwrite),
233 .help = "When writing, set whether to overwrite current data",
234 .def = "0",
235 },
236 {
237 .name = "loops",
238 .type = FIO_OPT_INT,
239 .off1 = td_var_offset(loops),
240 .help = "Number of times to run the job",
241 .def = "1",
242 },
243 {
244 .name = "numjobs",
245 .type = FIO_OPT_INT,
246 .off1 = td_var_offset(numjobs),
247 .help = "Duplicate this job this many times",
248 .def = "1",
249 },
250 {
251 .name = "startdelay",
252 .type = FIO_OPT_INT,
253 .off1 = td_var_offset(start_delay),
254 .help = "Only start job when this period has passed",
255 .def = "0",
256 },
257 {
258 .name = "runtime",
259 .alias = "timeout",
260 .type = FIO_OPT_STR_VAL_TIME,
261 .off1 = td_var_offset(timeout),
262 .help = "Stop workload when this amount of time has passed",
263 .def = "0",
264 },
265 {
266 .name = "mem",
267 .type = FIO_OPT_STR,
268 .cb = str_mem_cb,
269 .off1 = td_var_offset(mem_type),
270 .help = "Backing type for IO buffers",
271 .def = "malloc",
272 .posval = {
273 { .ival = "malloc", .oval = MEM_MALLOC },
274 { .ival = "shm", .oval = MEM_SHM },
275#ifdef FIO_HAVE_HUGETLB
276 { .ival = "shmhuge", .oval = MEM_SHMHUGE },
277#endif
278 { .ival = "mmap", .oval = MEM_MMAP },
279#ifdef FIO_HAVE_HUGETLB
280 { .ival = "mmaphuge", .oval = MEM_MMAPHUGE },
281#endif
282 },
283 },
284 {
285 .name = "verify",
286 .type = FIO_OPT_STR,
287 .off1 = td_var_offset(verify),
288 .help = "Verify sum function",
289 .def = "0",
290 .posval = {
291 { .ival = "0", .oval = VERIFY_NONE },
292 { .ival = "crc32", .oval = VERIFY_CRC32 },
293 { .ival = "md5", .oval = VERIFY_MD5 },
294 },
295 },
296 {
297 .name = "write_iolog",
298 .type = FIO_OPT_STR_STORE,
299 .off1 = td_var_offset(write_iolog_file),
300 .help = "Store IO pattern to file",
301 },
302 {
303 .name = "read_iolog",
304 .type = FIO_OPT_STR_STORE,
305 .off1 = td_var_offset(read_iolog_file),
306 .help = "Playback IO pattern from file",
307 },
308 {
309 .name = "exec_prerun",
310 .type = FIO_OPT_STR_STORE,
311 .off1 = td_var_offset(exec_prerun),
312 .help = "Execute this file prior to running job",
313 },
314 {
315 .name = "exec_postrun",
316 .type = FIO_OPT_STR_STORE,
317 .off1 = td_var_offset(exec_postrun),
318 .help = "Execute this file after running job",
319 },
320#ifdef FIO_HAVE_IOSCHED_SWITCH
321 {
322 .name = "ioscheduler",
323 .type = FIO_OPT_STR_STORE,
324 .off1 = td_var_offset(ioscheduler),
325 .help = "Use this IO scheduler on the backing device",
326 },
327#endif
328 {
329 .name = "zonesize",
330 .type = FIO_OPT_STR_VAL,
331 .off1 = td_var_offset(zone_size),
332 .help = "Give size of an IO zone",
333 .def = "0",
334 },
335 {
336 .name = "zoneskip",
337 .type = FIO_OPT_STR_VAL,
338 .off1 = td_var_offset(zone_skip),
339 .help = "Space between IO zones",
340 .def = "0",
341 },
342 {
343 .name = "lockmem",
344 .type = FIO_OPT_STR_VAL,
345 .cb = str_lockmem_cb,
346 .help = "Lock down this amount of memory",
347 .def = "0",
348 },
349 {
350 .name = "rwmixcycle",
351 .type = FIO_OPT_INT,
352 .off1 = td_var_offset(rwmixcycle),
353 .help = "Cycle period for mixed read/write workloads (msec)",
354 .def = "500",
355 },
356 {
357 .name = "rwmixread",
358 .type = FIO_OPT_INT,
359 .off1 = td_var_offset(rwmixread),
360 .maxval = 100,
361 .help = "Percentage of mixed workload that is reads",
362 .def = "50",
363 },
364 {
365 .name = "rwmixwrite",
366 .type = FIO_OPT_INT,
367 .off1 = td_var_offset(rwmixwrite),
368 .maxval = 100,
369 .help = "Percentage of mixed workload that is writes",
370 .def = "50",
371 },
372 {
373 .name = "nice",
374 .type = FIO_OPT_INT,
375 .off1 = td_var_offset(nice),
376 .help = "Set job CPU nice value",
377 .minval = -19,
378 .maxval = 20,
379 .def = "0",
380 },
381#ifdef FIO_HAVE_IOPRIO
382 {
383 .name = "prio",
384 .type = FIO_OPT_INT,
385 .cb = str_prio_cb,
386 .help = "Set job IO priority value",
387 .minval = 0,
388 .maxval = 7,
389 },
390 {
391 .name = "prioclass",
392 .type = FIO_OPT_INT,
393 .cb = str_prioclass_cb,
394 .help = "Set job IO priority class",
395 .minval = 0,
396 .maxval = 3,
397 },
398#endif
399 {
400 .name = "thinktime",
401 .type = FIO_OPT_INT,
402 .off1 = td_var_offset(thinktime),
403 .help = "Idle time between IO buffers (usec)",
404 .def = "0",
405 },
406 {
407 .name = "thinktime_spin",
408 .type = FIO_OPT_INT,
409 .off1 = td_var_offset(thinktime_spin),
410 .help = "Start think time by spinning this amount (usec)",
411 .def = "0",
412 },
413 {
414 .name = "thinktime_blocks",
415 .type = FIO_OPT_INT,
416 .off1 = td_var_offset(thinktime_blocks),
417 .help = "IO buffer period between 'thinktime'",
418 .def = "1",
419 },
420 {
421 .name = "rate",
422 .type = FIO_OPT_INT,
423 .off1 = td_var_offset(rate),
424 .help = "Set bandwidth rate",
425 },
426 {
427 .name = "ratemin",
428 .type = FIO_OPT_INT,
429 .off1 = td_var_offset(ratemin),
430 .help = "The bottom limit accepted",
431 },
432 {
433 .name = "ratecycle",
434 .type = FIO_OPT_INT,
435 .off1 = td_var_offset(ratecycle),
436 .help = "Window average for rate limits (msec)",
437 .def = "1000",
438 },
439 {
440 .name = "invalidate",
441 .type = FIO_OPT_BOOL,
442 .off1 = td_var_offset(invalidate_cache),
443 .help = "Invalidate buffer/page cache prior to running job",
444 .def = "1",
445 },
446 {
447 .name = "sync",
448 .type = FIO_OPT_BOOL,
449 .off1 = td_var_offset(sync_io),
450 .help = "Use O_SYNC for buffered writes",
451 .def = "0",
452 },
453 {
454 .name = "bwavgtime",
455 .type = FIO_OPT_INT,
456 .off1 = td_var_offset(bw_avg_time),
457 .help = "Time window over which to calculate bandwidth (msec)",
458 .def = "500",
459 },
460 {
461 .name = "create_serialize",
462 .type = FIO_OPT_BOOL,
463 .off1 = td_var_offset(create_serialize),
464 .help = "Serialize creating of job files",
465 .def = "1",
466 },
467 {
468 .name = "create_fsync",
469 .type = FIO_OPT_BOOL,
470 .off1 = td_var_offset(create_fsync),
471 .help = "Fsync file after creation",
472 .def = "1",
473 },
474 {
475 .name = "cpuload",
476 .type = FIO_OPT_INT,
477 .off1 = td_var_offset(cpuload),
478 .help = "Use this percentage of CPU",
479 },
480 {
481 .name = "cpuchunks",
482 .type = FIO_OPT_INT,
483 .off1 = td_var_offset(cpucycle),
484 .help = "Length of the CPU burn cycles (usecs)",
485 .def = "50000",
486 },
487#ifdef FIO_HAVE_CPU_AFFINITY
488 {
489 .name = "cpumask",
490 .type = FIO_OPT_INT,
491 .cb = str_cpumask_cb,
492 .help = "CPU affinity mask",
493 },
494#endif
495 {
496 .name = "end_fsync",
497 .type = FIO_OPT_BOOL,
498 .off1 = td_var_offset(end_fsync),
499 .help = "Include fsync at the end of job",
500 .def = "0",
501 },
502 {
503 .name = "unlink",
504 .type = FIO_OPT_BOOL,
505 .off1 = td_var_offset(unlink),
506 .help = "Unlink created files after job has completed",
507 .def = "0",
508 },
509 {
510 .name = "exitall",
511 .type = FIO_OPT_STR_SET,
512 .cb = str_exitall_cb,
513 .help = "Terminate all jobs when one exits",
514 },
515 {
516 .name = "stonewall",
517 .type = FIO_OPT_STR_SET,
518 .off1 = td_var_offset(stonewall),
519 .help = "Insert a hard barrier between this job and previous",
520 },
521 {
522 .name = "thread",
523 .type = FIO_OPT_STR_SET,
524 .off1 = td_var_offset(use_thread),
525 .help = "Use threads instead of forks",
526 },
527 {
528 .name = "write_bw_log",
529 .type = FIO_OPT_STR_SET,
530 .off1 = td_var_offset(write_bw_log),
531 .help = "Write log of bandwidth during run",
532 },
533 {
534 .name = "write_lat_log",
535 .type = FIO_OPT_STR_SET,
536 .off1 = td_var_offset(write_lat_log),
537 .help = "Write log of latency during run",
538 },
539 {
540 .name = "hugepage-size",
541 .type = FIO_OPT_STR_VAL,
542 .off1 = td_var_offset(hugepage_size),
543 .help = "When using hugepages, specify size of each page",
544 .def = __stringify(FIO_HUGE_PAGE),
545 },
546 {
547 .name = "group_reporting",
548 .type = FIO_OPT_STR_SET,
549 .off1 = td_var_offset(group_reporting),
550 .help = "Do reporting on a per-group basis",
551 },
552 {
553 .name = NULL,
554 },
555};
556
557#define FIO_JOB_OPTS (sizeof(options) / sizeof(struct fio_option))
558#define FIO_CMD_OPTS (16)
559#define FIO_GETOPT_JOB (0x89988998)
560
561/*
562 * Command line options. These will contain the above, plus a few
563 * extra that only pertain to fio itself and not jobs.
564 */
565static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
566 {
567 .name = "output",
568 .has_arg = required_argument,
569 .val = 'o',
570 },
571 {
572 .name = "timeout",
573 .has_arg = required_argument,
574 .val = 't',
575 },
576 {
577 .name = "latency-log",
578 .has_arg = required_argument,
579 .val = 'l',
580 },
581 {
582 .name = "bandwidth-log",
583 .has_arg = required_argument,
584 .val = 'b',
585 },
586 {
587 .name = "minimal",
588 .has_arg = optional_argument,
589 .val = 'm',
590 },
591 {
592 .name = "version",
593 .has_arg = no_argument,
594 .val = 'v',
595 },
596 {
597 .name = "help",
598 .has_arg = no_argument,
599 .val = 'h',
600 },
601 {
602 .name = "cmdhelp",
603 .has_arg = optional_argument,
604 .val = 'c',
605 },
606 {
607 .name = NULL,
608 },
609};
610
611static int def_timeout = 0;
612
613static char fio_version_string[] = "fio 1.13";
614
615static char **ini_file;
616static int max_jobs = MAX_JOBS;
617
618struct thread_data def_thread;
619struct thread_data *threads = NULL;
620
621int exitall_on_terminate = 0;
622int terse_output = 0;
623unsigned long long mlock_size = 0;
624FILE *f_out = NULL;
625FILE *f_err = NULL;
626
627static int write_lat_log = 0;
628int write_bw_log = 0;
629
630static int prev_group_jobs;
631
632FILE *get_f_out()
633{
634 return f_out;
635}
636
637FILE *get_f_err()
638{
639 return f_err;
640}
641
642/*
643 * Return a free job structure.
644 */
645static struct thread_data *get_new_job(int global, struct thread_data *parent)
646{
647 struct thread_data *td;
648
649 if (global)
650 return &def_thread;
651 if (thread_number >= max_jobs)
652 return NULL;
653
654 td = &threads[thread_number++];
655 *td = *parent;
656
657 td->thread_number = thread_number;
658 return td;
659}
660
661static void put_job(struct thread_data *td)
662{
663 if (td == &def_thread)
664 return;
665
666 if (td->error)
667 fprintf(f_out, "fio: %s\n", td->verror);
668
669 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
670 thread_number--;
671}
672
673/*
674 * Lazy way of fixing up options that depend on each other. We could also
675 * define option callback handlers, but this is easier.
676 */
677static void fixup_options(struct thread_data *td)
678{
679 if (!td->rwmixread && td->rwmixwrite)
680 td->rwmixread = 100 - td->rwmixwrite;
681
682 if (td->write_iolog_file && td->read_iolog_file) {
683 log_err("fio: read iolog overrides write_iolog\n");
684 free(td->write_iolog_file);
685 td->write_iolog_file = NULL;
686 }
687
688 if (td->io_ops->flags & FIO_SYNCIO)
689 td->iodepth = 1;
690 else {
691 if (!td->iodepth)
692 td->iodepth = td->open_files;
693 }
694
695 /*
696 * only really works for sequential io for now, and with 1 file
697 */
698 if (td->zone_size && td_random(td) && td->open_files == 1)
699 td->zone_size = 0;
700
701 /*
702 * Reads can do overwrites, we always need to pre-create the file
703 */
704 if (td_read(td) || td_rw(td))
705 td->overwrite = 1;
706
707 if (!td->min_bs[DDIR_READ])
708 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
709 if (!td->max_bs[DDIR_READ])
710 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
711 if (!td->min_bs[DDIR_WRITE])
712 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
713 if (!td->max_bs[DDIR_WRITE])
714 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
715
716 td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
717
718 if (td_read(td) && !td_rw(td))
719 td->verify = 0;
720
721 if (td->norandommap && td->verify != VERIFY_NONE) {
722 log_err("fio: norandommap given, verify disabled\n");
723 td->verify = VERIFY_NONE;
724 }
725 if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
726 log_err("fio: bs_unaligned may not work with raw io\n");
727
728 /*
729 * thinktime_spin must be less than thinktime
730 */
731 if (td->thinktime_spin > td->thinktime)
732 td->thinktime_spin = td->thinktime;
733
734 /*
735 * The low water mark cannot be bigger than the iodepth
736 */
737 if (td->iodepth_low > td->iodepth || !td->iodepth_low) {
738 /*
739 * syslet work around - if the workload is sequential,
740 * we want to let the queue drain all the way down to
741 * avoid seeking between async threads
742 */
743 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
744 td->iodepth_low = 1;
745 else
746 td->iodepth_low = td->iodepth;
747 }
748
749 /*
750 * If batch number isn't set, default to the same as iodepth
751 */
752 if (td->iodepth_batch > td->iodepth || !td->iodepth_batch)
753 td->iodepth_batch = td->iodepth;
754
755 if (!td->nr_files)
756 td->nr_files = td->open_files;
757 else if (td->open_files > td->nr_files || !td->open_files)
758 td->open_files = td->nr_files;
759}
760
761/*
762 * This function leaks the buffer
763 */
764static char *to_kmg(unsigned int val)
765{
766 char *buf = malloc(32);
767 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
768 char *p = post;
769
770 do {
771 if (val & 1023)
772 break;
773
774 val >>= 10;
775 p++;
776 } while (*p);
777
778 snprintf(buf, 31, "%u%c", val, *p);
779 return buf;
780}
781
782/* External engines are specified by "external:name.o") */
783static const char *get_engine_name(const char *str)
784{
785 char *p = strstr(str, ":");
786
787 if (!p)
788 return str;
789
790 p++;
791 strip_blank_front(&p);
792 strip_blank_end(p);
793 return p;
794}
795
796/*
797 * Adds a job to the list of things todo. Sanitizes the various options
798 * to make sure we don't have conflicts, and initializes various
799 * members of td.
800 */
801static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
802{
803 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
804 "randread", "randwrite", "randrw" };
805 unsigned int i;
806 struct fio_file *f;
807 const char *engine;
808 char fname[PATH_MAX];
809 int numjobs;
810
811 /*
812 * the def_thread is just for options, it's not a real job
813 */
814 if (td == &def_thread)
815 return 0;
816
817 engine = get_engine_name(td->ioengine);
818 td->io_ops = load_ioengine(td, engine);
819 if (!td->io_ops) {
820 log_err("fio: failed to load engine %s\n", engine);
821 return 1;
822 }
823
824 if (td->use_thread)
825 nr_thread++;
826 else
827 nr_process++;
828
829 if (td->odirect)
830 td->io_ops->flags |= FIO_RAWIO;
831
832 if (!td->filename) {
833 td->filename = strdup(jobname);
834
835 if (td->nr_files == 1)
836 add_file(td, td->filename);
837 else {
838 for (i = 0; i < td->nr_files; i++) {
839 sprintf(fname, "%s.%d.%d", td->filename, td->thread_number, i);
840 add_file(td, fname);
841 }
842 }
843 }
844
845 fixup_options(td);
846
847 for_each_file(td, f, i) {
848 if (td->directory && f->filetype == FIO_TYPE_FILE) {
849 sprintf(fname, "%s/%s", td->directory, f->file_name);
850 f->file_name = strdup(fname);
851 }
852 }
853
854 td->mutex = fio_sem_init(0);
855
856 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
857 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
858 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
859
860 if ((td->stonewall || td->numjobs > 1) && prev_group_jobs) {
861 prev_group_jobs = 0;
862 groupid++;
863 }
864
865 td->groupid = groupid;
866 prev_group_jobs++;
867
868 if (setup_rate(td))
869 goto err;
870
871 if (td->write_lat_log) {
872 setup_log(&td->ts.slat_log);
873 setup_log(&td->ts.clat_log);
874 }
875 if (td->write_bw_log)
876 setup_log(&td->ts.bw_log);
877
878 if (!td->name)
879 td->name = strdup(jobname);
880
881 if (!terse_output) {
882 if (!job_add_num) {
883 if (!strcmp(td->io_ops->name, "cpuio"))
884 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
885 else {
886 char *c1, *c2, *c3, *c4;
887
888 c1 = to_kmg(td->min_bs[DDIR_READ]);
889 c2 = to_kmg(td->max_bs[DDIR_READ]);
890 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
891 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
892
893 fprintf(f_out, "%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[td->td_ddir], c1, c2, c3, c4, td->io_ops->name, td->iodepth);
894
895 free(c1);
896 free(c2);
897 free(c3);
898 free(c4);
899 }
900 } else if (job_add_num == 1)
901 fprintf(f_out, "...\n");
902 }
903
904 /*
905 * recurse add identical jobs, clear numjobs and stonewall options
906 * as they don't apply to sub-jobs
907 */
908 numjobs = td->numjobs;
909 while (--numjobs) {
910 struct thread_data *td_new = get_new_job(0, td);
911
912 if (!td_new)
913 goto err;
914
915 td_new->numjobs = 1;
916 td_new->stonewall = 0;
917 job_add_num = numjobs - 1;
918
919 if (add_job(td_new, jobname, job_add_num))
920 goto err;
921 }
922
923 if (td->numjobs > 1) {
924 groupid++;
925 prev_group_jobs = 0;
926 }
927
928 return 0;
929err:
930 put_job(td);
931 return -1;
932}
933
934/*
935 * Initialize the various random states we need (random io, block size ranges,
936 * read/write mix, etc).
937 */
938int init_random_state(struct thread_data *td)
939{
940 unsigned long seeds[5];
941 int fd, num_maps, blocks;
942 struct fio_file *f;
943 unsigned int i;
944
945 if (td->io_ops->flags & FIO_DISKLESSIO)
946 return 0;
947
948 fd = open("/dev/urandom", O_RDONLY);
949 if (fd == -1) {
950 td_verror(td, errno, "open");
951 return 1;
952 }
953
954 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
955 td_verror(td, EIO, "read");
956 close(fd);
957 return 1;
958 }
959
960 close(fd);
961
962 os_random_seed(seeds[0], &td->bsrange_state);
963 os_random_seed(seeds[1], &td->verify_state);
964 os_random_seed(seeds[2], &td->rwmix_state);
965
966 if (td->file_service_type == FIO_FSERVICE_RANDOM)
967 os_random_seed(seeds[3], &td->next_file_state);
968
969 if (!td_random(td))
970 return 0;
971
972 if (td->rand_repeatable)
973 seeds[4] = FIO_RANDSEED * td->thread_number;
974
975 if (!td->norandommap) {
976 for_each_file(td, f, i) {
977 blocks = (f->real_file_size + td->rw_min_bs - 1) / td->rw_min_bs;
978 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
979 f->file_map = malloc(num_maps * sizeof(long));
980 if (!f->file_map) {
981 log_err("fio: failed allocating random map. If running a large number of jobs, try the 'norandommap' option\n");
982 return 1;
983 }
984 f->num_maps = num_maps;
985 memset(f->file_map, 0, num_maps * sizeof(long));
986 }
987 }
988
989 os_random_seed(seeds[4], &td->random_state);
990 return 0;
991}
992
993static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
994{
995#ifdef FIO_HAVE_CPU_AFFINITY
996 unsigned int i;
997
998 CPU_ZERO(&cpumask);
999
1000 for (i = 0; i < sizeof(int) * 8; i++) {
1001 if ((1 << i) & cpu)
1002 CPU_SET(i, &cpumask);
1003 }
1004#endif
1005}
1006
1007static int is_empty_or_comment(char *line)
1008{
1009 unsigned int i;
1010
1011 for (i = 0; i < strlen(line); i++) {
1012 if (line[i] == ';')
1013 return 1;
1014 if (line[i] == '#')
1015 return 1;
1016 if (!isspace(line[i]) && !iscntrl(line[i]))
1017 return 0;
1018 }
1019
1020 return 1;
1021}
1022
1023/*
1024 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
1025 */
1026static char *get_opt_postfix(const char *str)
1027{
1028 char *p = strstr(str, ":");
1029
1030 if (!p)
1031 return NULL;
1032
1033 p++;
1034 strip_blank_front(&p);
1035 strip_blank_end(p);
1036 return strdup(p);
1037}
1038
1039static int str_mem_cb(void *data, const char *mem)
1040{
1041 struct thread_data *td = data;
1042
1043 if (td->mem_type == MEM_MMAPHUGE || td->mem_type == MEM_MMAP) {
1044 td->mmapfile = get_opt_postfix(mem);
1045 if (td->mem_type == MEM_MMAPHUGE && !td->mmapfile) {
1046 log_err("fio: mmaphuge:/path/to/file\n");
1047 return 1;
1048 }
1049 }
1050
1051 return 0;
1052}
1053
1054static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
1055{
1056 mlock_size = *val;
1057 return 0;
1058}
1059
1060#ifdef FIO_HAVE_IOPRIO
1061static int str_prioclass_cb(void *data, unsigned int *val)
1062{
1063 struct thread_data *td = data;
1064
1065 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1066 return 0;
1067}
1068
1069static int str_prio_cb(void *data, unsigned int *val)
1070{
1071 struct thread_data *td = data;
1072
1073 td->ioprio |= *val;
1074 return 0;
1075}
1076#endif
1077
1078static int str_exitall_cb(void)
1079{
1080 exitall_on_terminate = 1;
1081 return 0;
1082}
1083
1084static int str_cpumask_cb(void *data, unsigned int *val)
1085{
1086 struct thread_data *td = data;
1087
1088 fill_cpu_mask(td->cpumask, *val);
1089 return 0;
1090}
1091
1092static int str_fst_cb(void *data, const char *str)
1093{
1094 struct thread_data *td = data;
1095 char *nr = get_opt_postfix(str);
1096
1097 td->file_service_nr = 1;
1098 if (nr)
1099 td->file_service_nr = atoi(nr);
1100
1101 return 0;
1102}
1103
1104static int str_filename_cb(void *data, const char *input)
1105{
1106 struct thread_data *td = data;
1107 char *fname, *str, *p;
1108
1109 if (!td->filename)
1110 td->nr_files = 0;
1111
1112 p = str = strdup(input);
1113
1114 strip_blank_front(&str);
1115 strip_blank_end(str);
1116
1117 while ((fname = strsep(&str, ":")) != NULL) {
1118 if (!strlen(fname))
1119 break;
1120 add_file(td, fname);
1121 td->nr_files++;
1122 }
1123
1124 free(p);
1125 return 0;
1126}
1127
1128static int str_directory_cb(void *data, const char fio_unused *str)
1129{
1130 struct thread_data *td = data;
1131 struct stat sb;
1132
1133 if (lstat(td->directory, &sb) < 0) {
1134 log_err("fio: %s is not a directory\n", td->directory);
1135 td_verror(td, errno, "lstat");
1136 return 1;
1137 }
1138 if (!S_ISDIR(sb.st_mode)) {
1139 log_err("fio: %s is not a directory\n", td->directory);
1140 return 1;
1141 }
1142
1143 return 0;
1144}
1145
1146/*
1147 * This is our [ini] type file parser.
1148 */
1149static int parse_jobs_ini(char *file, int stonewall_flag)
1150{
1151 unsigned int global;
1152 struct thread_data *td;
1153 char *string, *name;
1154 fpos_t off;
1155 FILE *f;
1156 char *p;
1157 int ret = 0, stonewall;
1158
1159 f = fopen(file, "r");
1160 if (!f) {
1161 perror("fopen job file");
1162 return 1;
1163 }
1164
1165 string = malloc(4096);
1166 name = malloc(256);
1167 memset(name, 0, 256);
1168
1169 stonewall = stonewall_flag;
1170 do {
1171 p = fgets(string, 4095, f);
1172 if (!p)
1173 break;
1174 if (is_empty_or_comment(p))
1175 continue;
1176 if (sscanf(p, "[%255s]", name) != 1)
1177 continue;
1178
1179 global = !strncmp(name, "global", 6);
1180
1181 name[strlen(name) - 1] = '\0';
1182
1183 td = get_new_job(global, &def_thread);
1184 if (!td) {
1185 ret = 1;
1186 break;
1187 }
1188
1189 /*
1190 * Seperate multiple job files by a stonewall
1191 */
1192 if (!global && stonewall) {
1193 td->stonewall = stonewall;
1194 stonewall = 0;
1195 }
1196
1197 fgetpos(f, &off);
1198 while ((p = fgets(string, 4096, f)) != NULL) {
1199 if (is_empty_or_comment(p))
1200 continue;
1201
1202 strip_blank_front(&p);
1203
1204 if (p[0] == '[')
1205 break;
1206
1207 strip_blank_end(p);
1208
1209 fgetpos(f, &off);
1210
1211 /*
1212 * Don't break here, continue parsing options so we
1213 * dump all the bad ones. Makes trial/error fixups
1214 * easier on the user.
1215 */
1216 ret |= parse_option(p, options, td);
1217 }
1218
1219 if (!ret) {
1220 fsetpos(f, &off);
1221 ret = add_job(td, name, 0);
1222 } else {
1223 log_err("fio: job %s dropped\n", name);
1224 put_job(td);
1225 }
1226 } while (!ret);
1227
1228 free(string);
1229 free(name);
1230 fclose(f);
1231 return ret;
1232}
1233
1234static int fill_def_thread(void)
1235{
1236 memset(&def_thread, 0, sizeof(def_thread));
1237
1238 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1239 perror("sched_getaffinity");
1240 return 1;
1241 }
1242
1243 /*
1244 * fill default options
1245 */
1246 fill_default_options(&def_thread, options);
1247
1248 def_thread.timeout = def_timeout;
1249 def_thread.write_bw_log = write_bw_log;
1250 def_thread.write_lat_log = write_lat_log;
1251
1252#ifdef FIO_HAVE_DISK_UTIL
1253 def_thread.do_disk_util = 1;
1254#endif
1255
1256 return 0;
1257}
1258
1259static void usage(void)
1260{
1261 printf("%s\n", fio_version_string);
1262 printf("\t--output\tWrite output to file\n");
1263 printf("\t--timeout\tRuntime in seconds\n");
1264 printf("\t--latency-log\tGenerate per-job latency logs\n");
1265 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1266 printf("\t--minimal\tMinimal (terse) output\n");
1267 printf("\t--version\tPrint version info and exit\n");
1268 printf("\t--help\t\tPrint this page\n");
1269 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
1270}
1271
1272static int parse_cmd_line(int argc, char *argv[])
1273{
1274 struct thread_data *td = NULL;
1275 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
1276
1277 while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
1278 switch (c) {
1279 case 't':
1280 def_timeout = atoi(optarg);
1281 break;
1282 case 'l':
1283 write_lat_log = 1;
1284 break;
1285 case 'w':
1286 write_bw_log = 1;
1287 break;
1288 case 'o':
1289 f_out = fopen(optarg, "w+");
1290 if (!f_out) {
1291 perror("fopen output");
1292 exit(1);
1293 }
1294 f_err = f_out;
1295 break;
1296 case 'm':
1297 terse_output = 1;
1298 break;
1299 case 'h':
1300 usage();
1301 exit(0);
1302 case 'c':
1303 ret = show_cmd_help(options, optarg);
1304 exit(ret);
1305 case 'v':
1306 printf("%s\n", fio_version_string);
1307 exit(0);
1308 case FIO_GETOPT_JOB: {
1309 const char *opt = long_options[lidx].name;
1310 char *val = optarg;
1311
1312 if (!strncmp(opt, "name", 4) && td) {
1313 ret = add_job(td, td->name ?: "fio", 0);
1314 if (ret) {
1315 put_job(td);
1316 return 0;
1317 }
1318 td = NULL;
1319 }
1320 if (!td) {
1321 int global = !strncmp(val, "global", 6);
1322
1323 td = get_new_job(global, &def_thread);
1324 if (!td)
1325 return 0;
1326 }
1327
1328 ret = parse_cmd_option(opt, val, options, td);
1329 if (ret)
1330 dont_add_job = 1;
1331 break;
1332 }
1333 default:
1334 break;
1335 }
1336 }
1337
1338 if (td) {
1339 if (dont_add_job)
1340 put_job(td);
1341 else {
1342 ret = add_job(td, td->name ?: "fio", 0);
1343 if (ret)
1344 put_job(td);
1345 }
1346 }
1347
1348 while (optind < argc) {
1349 ini_idx++;
1350 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1351 ini_file[ini_idx - 1] = strdup(argv[optind]);
1352 optind++;
1353 }
1354
1355 return ini_idx;
1356}
1357
1358static void free_shm(void)
1359{
1360 struct shmid_ds sbuf;
1361
1362 if (threads) {
1363 shmdt((void *) threads);
1364 threads = NULL;
1365 shmctl(shm_id, IPC_RMID, &sbuf);
1366 }
1367}
1368
1369/*
1370 * The thread area is shared between the main process and the job
1371 * threads/processes. So setup a shared memory segment that will hold
1372 * all the job info.
1373 */
1374static int setup_thread_area(void)
1375{
1376 /*
1377 * 1024 is too much on some machines, scale max_jobs if
1378 * we get a failure that looks like too large a shm segment
1379 */
1380 do {
1381 size_t size = max_jobs * sizeof(struct thread_data);
1382
1383 shm_id = shmget(0, size, IPC_CREAT | 0600);
1384 if (shm_id != -1)
1385 break;
1386 if (errno != EINVAL) {
1387 perror("shmget");
1388 break;
1389 }
1390
1391 max_jobs >>= 1;
1392 } while (max_jobs);
1393
1394 if (shm_id == -1)
1395 return 1;
1396
1397 threads = shmat(shm_id, NULL, 0);
1398 if (threads == (void *) -1) {
1399 perror("shmat");
1400 return 1;
1401 }
1402
1403 atexit(free_shm);
1404 return 0;
1405}
1406
1407/*
1408 * Copy the fio options into the long options map, so we mirror
1409 * job and cmd line options.
1410 */
1411static void dupe_job_options(void)
1412{
1413 struct fio_option *o;
1414 unsigned int i;
1415
1416 i = 0;
1417 while (long_options[i].name)
1418 i++;
1419
1420 o = &options[0];
1421 while (o->name) {
1422 long_options[i].name = o->name;
1423 long_options[i].val = FIO_GETOPT_JOB;
1424 if (o->type == FIO_OPT_STR_SET)
1425 long_options[i].has_arg = no_argument;
1426 else
1427 long_options[i].has_arg = required_argument;
1428
1429 i++;
1430 o++;
1431 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1432 }
1433}
1434
1435int parse_options(int argc, char *argv[])
1436{
1437 int job_files, i;
1438
1439 f_out = stdout;
1440 f_err = stderr;
1441
1442 options_init(options);
1443
1444 dupe_job_options();
1445
1446 if (setup_thread_area())
1447 return 1;
1448 if (fill_def_thread())
1449 return 1;
1450
1451 job_files = parse_cmd_line(argc, argv);
1452
1453 for (i = 0; i < job_files; i++) {
1454 if (fill_def_thread())
1455 return 1;
1456 if (parse_jobs_ini(ini_file[i], i))
1457 return 1;
1458 free(ini_file[i]);
1459 }
1460
1461 free(ini_file);
1462
1463 if (!thread_number) {
1464 log_err("No jobs defined(s)\n");
1465 return 1;
1466 }
1467
1468 return 0;
1469}
fio - Flexible IO Tester