Allow profiles to override internal io_u functions
[fio.git] / init.c
CommitLineData
906c8d75 1/*
cb2c86fd 2 * This file contains job initialization and setup functions.
906c8d75 3 */
ebac4655
JA
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>
b4692828 11#include <getopt.h>
ebac4655
JA
12#include <sys/ipc.h>
13#include <sys/shm.h>
14#include <sys/types.h>
15#include <sys/stat.h>
16
17#include "fio.h"
cb2c86fd 18#include "parse.h"
2e5cdb11 19#include "smalloc.h"
380065aa 20#include "filehash.h"
4f5af7b2 21#include "verify.h"
79d16311 22#include "profile.h"
ebac4655 23
d3e829b3 24static char fio_version_string[] = "fio 1.37";
214e1eca 25
ee738499 26#define FIO_RANDSEED (0xb1899bedUL)
ebac4655 27
214e1eca
JA
28static char **ini_file;
29static int max_jobs = MAX_JOBS;
cca73aa7 30static int dump_cmdline;
e1f36503 31
be4ecfdf 32static struct thread_data def_thread;
214e1eca 33struct thread_data *threads = NULL;
e1f36503 34
214e1eca
JA
35int exitall_on_terminate = 0;
36int terse_output = 0;
e592a06b 37int eta_print;
214e1eca
JA
38unsigned long long mlock_size = 0;
39FILE *f_out = NULL;
40FILE *f_err = NULL;
01f06b63 41char *job_section = NULL;
07b3232d 42char *exec_profile = NULL;
ee738499 43
214e1eca 44int write_bw_log = 0;
4241ea8f 45int read_only = 0;
214e1eca 46
5ec10eaa
JA
47static int def_timeout;
48static int write_lat_log;
e1f36503 49
214e1eca 50static int prev_group_jobs;
b4692828 51
ee56ad50 52unsigned long fio_debug = 0;
5e1d306e
JA
53unsigned int fio_debug_jobno = -1;
54unsigned int *fio_debug_jobp = NULL;
ee56ad50 55
b4692828
JA
56/*
57 * Command line options. These will contain the above, plus a few
58 * extra that only pertain to fio itself and not jobs.
59 */
5ec10eaa 60static struct option l_opts[FIO_NR_OPTIONS] = {
b4692828
JA
61 {
62 .name = "output",
63 .has_arg = required_argument,
64 .val = 'o',
65 },
66 {
67 .name = "timeout",
68 .has_arg = required_argument,
69 .val = 't',
70 },
71 {
72 .name = "latency-log",
73 .has_arg = required_argument,
74 .val = 'l',
75 },
76 {
77 .name = "bandwidth-log",
78 .has_arg = required_argument,
79 .val = 'b',
80 },
81 {
82 .name = "minimal",
83 .has_arg = optional_argument,
84 .val = 'm',
85 },
86 {
87 .name = "version",
88 .has_arg = no_argument,
89 .val = 'v',
90 },
fd28ca49
JA
91 {
92 .name = "help",
93 .has_arg = no_argument,
94 .val = 'h',
95 },
96 {
97 .name = "cmdhelp",
320beefe 98 .has_arg = optional_argument,
fd28ca49
JA
99 .val = 'c',
100 },
cca73aa7
JA
101 {
102 .name = "showcmd",
103 .has_arg = no_argument,
724e4435
JA
104 .val = 's',
105 },
106 {
107 .name = "readonly",
108 .has_arg = no_argument,
109 .val = 'r',
cca73aa7 110 },
e592a06b
AC
111 {
112 .name = "eta",
113 .has_arg = required_argument,
114 .val = 'e',
115 },
ee56ad50
JA
116 {
117 .name = "debug",
118 .has_arg = required_argument,
119 .val = 'd',
120 },
01f06b63
JA
121 {
122 .name = "section",
123 .has_arg = required_argument,
124 .val = 'x',
125 },
2b386d25
JA
126 {
127 .name = "alloc-size",
128 .has_arg = required_argument,
129 .val = 'a',
130 },
9ac8a797
JA
131 {
132 .name = "profile",
133 .has_arg = required_argument,
134 .val = 'p',
135 },
b4692828
JA
136 {
137 .name = NULL,
138 },
139};
140
9728ce37
JB
141FILE *get_f_out()
142{
143 return f_out;
144}
145
146FILE *get_f_err()
147{
148 return f_err;
149}
150
906c8d75
JA
151/*
152 * Return a free job structure.
153 */
ebac4655
JA
154static struct thread_data *get_new_job(int global, struct thread_data *parent)
155{
156 struct thread_data *td;
157
158 if (global)
159 return &def_thread;
160 if (thread_number >= max_jobs)
161 return NULL;
162
163 td = &threads[thread_number++];
ddaeaa5a 164 *td = *parent;
ebac4655 165
e0b0d892
JA
166 td->o.uid = td->o.gid = -1U;
167
cade3ef4 168 dup_files(td, parent);
d23bb327 169 options_mem_dupe(td);
cade3ef4 170
15dc1934
JA
171 profile_add_hooks(td);
172
ebac4655 173 td->thread_number = thread_number;
ebac4655
JA
174 return td;
175}
176
177static void put_job(struct thread_data *td)
178{
549577a7
JA
179 if (td == &def_thread)
180 return;
181
16edf25d 182 if (td->error)
6d86144d 183 log_info("fio: %s\n", td->verror);
16edf25d 184
ebac4655
JA
185 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
186 thread_number--;
187}
188
581e7141 189static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
127f6865 190{
581e7141 191 unsigned int bs = td->o.min_bs[ddir];
ba3e4e0c 192 unsigned long long bytes_per_sec;
127f6865 193
ba3e4e0c
RR
194 if (td->o.rate[ddir])
195 bytes_per_sec = td->o.rate[ddir];
196 else
197 bytes_per_sec = td->o.rate_iops[ddir] * bs;
127f6865 198
ba3e4e0c 199 if (!bytes_per_sec) {
127f6865
JA
200 log_err("rate lower than supported\n");
201 return -1;
202 }
203
ba3e4e0c 204 td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
581e7141 205 td->rate_pending_usleep[ddir] = 0;
127f6865
JA
206 return 0;
207}
208
581e7141
JA
209static int setup_rate(struct thread_data *td)
210{
211 int ret = 0;
212
213 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
214 ret = __setup_rate(td, DDIR_READ);
215 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
216 ret |= __setup_rate(td, DDIR_WRITE);
217
218 return ret;
219}
220
8347239a
JA
221static int fixed_block_size(struct thread_options *o)
222{
223 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
224 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
225 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE];
226}
227
dad915e3
JA
228/*
229 * Lazy way of fixing up options that depend on each other. We could also
230 * define option callback handlers, but this is easier.
231 */
4e991c23 232static int fixup_options(struct thread_data *td)
e1f36503 233{
2dc1bbeb 234 struct thread_options *o = &td->o;
dad915e3 235
f356d01d
JA
236#ifndef FIO_HAVE_PSHARED_MUTEX
237 if (!td->o.use_thread) {
238 log_info("fio: this platform does not support process shared"
239 " mutexes, forcing use of threads. Use the 'thread'"
240 " option to get rid of this warning.\n");
241 td->o.use_thread = 1;
242 }
243#endif
244
2dc1bbeb 245 if (o->write_iolog_file && o->read_iolog_file) {
076efc7c 246 log_err("fio: read iolog overrides write_iolog\n");
2dc1bbeb
JA
247 free(o->write_iolog_file);
248 o->write_iolog_file = NULL;
076efc7c 249 }
16b462ae 250
16b462ae
JA
251 /*
252 * only really works for sequential io for now, and with 1 file
253 */
2dc1bbeb
JA
254 if (o->zone_size && td_random(td) && o->open_files == 1)
255 o->zone_size = 0;
16b462ae
JA
256
257 /*
258 * Reads can do overwrites, we always need to pre-create the file
259 */
260 if (td_read(td) || td_rw(td))
2dc1bbeb 261 o->overwrite = 1;
16b462ae 262
2dc1bbeb 263 if (!o->min_bs[DDIR_READ])
5ec10eaa 264 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
2dc1bbeb
JA
265 if (!o->max_bs[DDIR_READ])
266 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
267 if (!o->min_bs[DDIR_WRITE])
5ec10eaa 268 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
2dc1bbeb
JA
269 if (!o->max_bs[DDIR_WRITE])
270 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
a00735e6 271
2dc1bbeb 272 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
a00735e6 273
2b7a01d0
JA
274 /*
275 * For random IO, allow blockalign offset other than min_bs.
276 */
277 if (!o->ba[DDIR_READ] || !td_random(td))
278 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
279 if (!o->ba[DDIR_WRITE] || !td_random(td))
280 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
281
282 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
283 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE]) &&
284 !td->o.norandommap) {
285 log_err("fio: Any use of blockalign= turns off randommap\n");
286 td->o.norandommap = 1;
287 }
288
2dc1bbeb
JA
289 if (!o->file_size_high)
290 o->file_size_high = o->file_size_low;
9c60ce64 291
8347239a
JA
292 if (o->norandommap && o->verify != VERIFY_NONE
293 && !fixed_block_size(o)) {
294 log_err("fio: norandommap given for variable block sizes, "
295 "verify disabled\n");
2dc1bbeb 296 o->verify = VERIFY_NONE;
bb8895e0 297 }
2dc1bbeb 298 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
690adba3 299 log_err("fio: bs_unaligned may not work with raw io\n");
e0a22335 300
48097d5c
JA
301 /*
302 * thinktime_spin must be less than thinktime
303 */
2dc1bbeb
JA
304 if (o->thinktime_spin > o->thinktime)
305 o->thinktime_spin = o->thinktime;
e916b390
JA
306
307 /*
308 * The low water mark cannot be bigger than the iodepth
309 */
2dc1bbeb 310 if (o->iodepth_low > o->iodepth || !o->iodepth_low) {
9467b77c
JA
311 /*
312 * syslet work around - if the workload is sequential,
313 * we want to let the queue drain all the way down to
314 * avoid seeking between async threads
315 */
316 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
2dc1bbeb 317 o->iodepth_low = 1;
9467b77c 318 else
2dc1bbeb 319 o->iodepth_low = o->iodepth;
9467b77c 320 }
cb5ab512
JA
321
322 /*
323 * If batch number isn't set, default to the same as iodepth
324 */
2dc1bbeb
JA
325 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
326 o->iodepth_batch = o->iodepth;
b5af8293 327
2dc1bbeb
JA
328 if (o->nr_files > td->files_index)
329 o->nr_files = td->files_index;
9f9214f2 330
2dc1bbeb
JA
331 if (o->open_files > o->nr_files || !o->open_files)
332 o->open_files = o->nr_files;
4e991c23 333
581e7141
JA
334 if (((o->rate[0] + o->rate[1]) && (o->rate_iops[0] + o->rate_iops[1]))||
335 ((o->ratemin[0] + o->ratemin[1]) && (o->rate_iops_min[0] +
336 o->rate_iops_min[1]))) {
4e991c23
JA
337 log_err("fio: rate and rate_iops are mutually exclusive\n");
338 return 1;
339 }
581e7141
JA
340 if ((o->rate[0] < o->ratemin[0]) || (o->rate[1] < o->ratemin[1]) ||
341 (o->rate_iops[0] < o->rate_iops_min[0]) ||
342 (o->rate_iops[1] < o->rate_iops_min[1])) {
4e991c23
JA
343 log_err("fio: minimum rate exceeds rate\n");
344 return 1;
345 }
346
cf4464ca
JA
347 if (!o->timeout && o->time_based) {
348 log_err("fio: time_based requires a runtime/timeout setting\n");
349 o->time_based = 0;
350 }
351
aa31f1f1 352 if (o->fill_device && !o->size)
5921e80c 353 o->size = -1ULL;
5ec10eaa 354
79713149
JA
355 if (td_rw(td) && td->o.verify != VERIFY_NONE)
356 log_info("fio: mixed read/write workload with verify. May not "
357 "work as expected, unless you pre-populated the file\n");
aa31f1f1 358
41ccd845
JA
359 if (td->o.verify != VERIFY_NONE)
360 td->o.refill_buffers = 1;
361
9c0d2241 362 if (td->o.pre_read) {
34f1c044 363 td->o.invalidate_cache = 0;
9c0d2241
JA
364 if (td->io_ops->flags & FIO_PIPEIO)
365 log_info("fio: cannot pre-read files with an IO engine"
366 " that isn't seekable. Pre-read disabled.\n");
367 }
34f1c044 368
e72fa4d4
JA
369#ifndef FIO_HAVE_FDATASYNC
370 if (td->o.fdatasync_blocks) {
371 log_info("fio: this platform does not support fdatasync()"
372 " falling back to using fsync(). Use the 'fsync'"
373 " option instead of 'fdatasync' to get rid of"
374 " this warning\n");
375 td->o.fsync_blocks = td->o.fdatasync_blocks;
376 td->o.fdatasync_blocks = 0;
377 }
378#endif
379
4e991c23 380 return 0;
e1f36503
JA
381}
382
f8977ee6
JA
383/*
384 * This function leaks the buffer
385 */
386static char *to_kmg(unsigned int val)
387{
388 char *buf = malloc(32);
f3502ba2 389 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
f8977ee6
JA
390 char *p = post;
391
245142ff 392 do {
f8977ee6
JA
393 if (val & 1023)
394 break;
395
396 val >>= 10;
397 p++;
245142ff 398 } while (*p);
f8977ee6
JA
399
400 snprintf(buf, 31, "%u%c", val, *p);
401 return buf;
402}
403
09629a90
JA
404/* External engines are specified by "external:name.o") */
405static const char *get_engine_name(const char *str)
406{
407 char *p = strstr(str, ":");
408
409 if (!p)
410 return str;
411
412 p++;
413 strip_blank_front(&p);
414 strip_blank_end(p);
415 return p;
416}
417
e132cbae
JA
418static int exists_and_not_file(const char *filename)
419{
420 struct stat sb;
421
422 if (lstat(filename, &sb) == -1)
423 return 0;
424
425 if (S_ISREG(sb.st_mode))
426 return 0;
427
428 return 1;
429}
430
5bfc35d7
JA
431void td_fill_rand_seeds(struct thread_data *td)
432{
433 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
434 os_random_seed(td->rand_seeds[1], &td->verify_state);
435 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
436
437 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
438 os_random_seed(td->rand_seeds[3], &td->next_file_state);
439
440 os_random_seed(td->rand_seeds[5], &td->file_size_state);
441
442 if (!td_random(td))
443 return;
444
445 if (td->o.rand_repeatable)
446 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
447
448 os_random_seed(td->rand_seeds[4], &td->random_state);
449}
450
9c60ce64
JA
451/*
452 * Initialize the various random states we need (random io, block size ranges,
453 * read/write mix, etc).
454 */
455static int init_random_state(struct thread_data *td)
456{
68727076 457 int fd;
9c60ce64
JA
458
459 fd = open("/dev/urandom", O_RDONLY);
460 if (fd == -1) {
461 td_verror(td, errno, "open");
462 return 1;
463 }
464
5bfc35d7
JA
465 if (read(fd, td->rand_seeds, sizeof(td->rand_seeds)) <
466 (int) sizeof(td->rand_seeds)) {
9c60ce64
JA
467 td_verror(td, EIO, "read");
468 close(fd);
469 return 1;
470 }
471
472 close(fd);
5bfc35d7 473 td_fill_rand_seeds(td);
9c60ce64
JA
474 return 0;
475}
476
906c8d75
JA
477/*
478 * Adds a job to the list of things todo. Sanitizes the various options
479 * to make sure we don't have conflicts, and initializes various
480 * members of td.
481 */
75154845 482static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
ebac4655 483{
413dd459
JA
484 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
485 "randread", "randwrite", "randrw" };
af52b345 486 unsigned int i;
09629a90 487 const char *engine;
af52b345 488 char fname[PATH_MAX];
e132cbae 489 int numjobs, file_alloced;
ebac4655 490
ebac4655
JA
491 /*
492 * the def_thread is just for options, it's not a real job
493 */
494 if (td == &def_thread)
495 return 0;
496
cca73aa7
JA
497 /*
498 * if we are just dumping the output command line, don't add the job
499 */
500 if (dump_cmdline) {
501 put_job(td);
502 return 0;
503 }
504
2dc1bbeb 505 engine = get_engine_name(td->o.ioengine);
09629a90
JA
506 td->io_ops = load_ioengine(td, engine);
507 if (!td->io_ops) {
508 log_err("fio: failed to load engine %s\n", engine);
205927a3 509 goto err;
09629a90 510 }
df64119d 511
2dc1bbeb 512 if (td->o.use_thread)
9cedf167
JA
513 nr_thread++;
514 else
515 nr_process++;
516
2dc1bbeb 517 if (td->o.odirect)
690adba3
JA
518 td->io_ops->flags |= FIO_RAWIO;
519
e132cbae 520 file_alloced = 0;
691c8fb0 521 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
e132cbae 522 file_alloced = 1;
80be24f4 523
2dc1bbeb 524 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
e132cbae 525 add_file(td, jobname);
7b05a215 526 else {
2dc1bbeb 527 for (i = 0; i < td->o.nr_files; i++) {
5ec10eaa
JA
528 sprintf(fname, "%s.%d.%d", jobname,
529 td->thread_number, i);
7b05a215
JA
530 add_file(td, fname);
531 }
af52b345 532 }
0af7b542 533 }
ebac4655 534
4e991c23
JA
535 if (fixup_options(td))
536 goto err;
e0a22335 537
07eb79df
JA
538 if (td->io_ops->flags & FIO_DISKLESSIO) {
539 struct fio_file *f;
540
541 for_each_file(td, f, i)
542 f->real_file_size = -1ULL;
543 }
544
cdd18ad8 545 td->mutex = fio_mutex_init(0);
ebac4655 546
756867bd
JA
547 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
548 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
549 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
1e3d53ac 550 td->ddir_nr = td->o.ddir_nr;
ebac4655 551
755c3189 552 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
3c5df6fa 553 prev_group_jobs = 0;
ebac4655 554 groupid++;
3c5df6fa 555 }
ebac4655
JA
556
557 td->groupid = groupid;
3c5df6fa 558 prev_group_jobs++;
ebac4655 559
9c60ce64
JA
560 if (init_random_state(td))
561 goto err;
562
ebac4655
JA
563 if (setup_rate(td))
564 goto err;
565
2dc1bbeb 566 if (td->o.write_lat_log) {
756867bd
JA
567 setup_log(&td->ts.slat_log);
568 setup_log(&td->ts.clat_log);
ebac4655 569 }
2dc1bbeb 570 if (td->o.write_bw_log)
756867bd 571 setup_log(&td->ts.bw_log);
ebac4655 572
2dc1bbeb
JA
573 if (!td->o.name)
574 td->o.name = strdup(jobname);
01452055 575
c6ae0a5b 576 if (!terse_output) {
b990b5c0 577 if (!job_add_num) {
5ec10eaa
JA
578 if (!strcmp(td->io_ops->name, "cpuio")) {
579 log_info("%s: ioengine=cpu, cpuload=%u,"
580 " cpucycle=%u\n", td->o.name,
581 td->o.cpuload,
582 td->o.cpucycle);
583 } else {
f8977ee6
JA
584 char *c1, *c2, *c3, *c4;
585
2dc1bbeb
JA
586 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
587 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
588 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
589 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
f8977ee6 590
5ec10eaa
JA
591 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
592 " ioengine=%s, iodepth=%u\n",
593 td->o.name, td->groupid,
594 ddir_str[td->o.td_ddir],
595 c1, c2, c3, c4,
596 td->io_ops->name,
597 td->o.iodepth);
f8977ee6
JA
598
599 free(c1);
600 free(c2);
601 free(c3);
602 free(c4);
603 }
b990b5c0 604 } else if (job_add_num == 1)
6d86144d 605 log_info("...\n");
c6ae0a5b 606 }
ebac4655
JA
607
608 /*
609 * recurse add identical jobs, clear numjobs and stonewall options
610 * as they don't apply to sub-jobs
611 */
2dc1bbeb 612 numjobs = td->o.numjobs;
ebac4655
JA
613 while (--numjobs) {
614 struct thread_data *td_new = get_new_job(0, td);
615
616 if (!td_new)
617 goto err;
618
2dc1bbeb
JA
619 td_new->o.numjobs = 1;
620 td_new->o.stonewall = 0;
92c1d41f 621 td_new->o.new_group = 0;
e132cbae
JA
622
623 if (file_alloced) {
2dc1bbeb 624 td_new->o.filename = NULL;
e132cbae 625 td_new->files_index = 0;
4e6ea2f1 626 td_new->files_size = 0;
e132cbae
JA
627 td_new->files = NULL;
628 }
629
75154845 630 job_add_num = numjobs - 1;
ebac4655 631
75154845 632 if (add_job(td_new, jobname, job_add_num))
ebac4655
JA
633 goto err;
634 }
3c5df6fa 635
ebac4655
JA
636 return 0;
637err:
638 put_job(td);
639 return -1;
640}
641
79d16311
JA
642/*
643 * Parse as if 'o' was a command line
644 */
645void add_job_opts(const char **o)
646{
647 struct thread_data *td, *td_parent;
648 int i, in_global = 1;
649 char jobname[32];
650
651 i = 0;
652 td_parent = td = NULL;
653 while (o[i]) {
654 if (!strncmp(o[i], "name", 4)) {
655 in_global = 0;
656 if (td)
657 add_job(td, jobname, 0);
658 td = NULL;
659 sprintf(jobname, "%s", o[i] + 5);
660 }
661 if (in_global && !td_parent)
662 td_parent = get_new_job(1, &def_thread);
663 else if (!in_global && !td) {
664 if (!td_parent)
665 td_parent = &def_thread;
666 td = get_new_job(0, td_parent);
667 }
668 if (in_global)
669 fio_options_parse(td_parent, (char **) &o[i], 1);
670 else
671 fio_options_parse(td, (char **) &o[i], 1);
672 i++;
673 }
674
675 if (td)
676 add_job(td, jobname, 0);
677}
678
01f06b63
JA
679static int skip_this_section(const char *name)
680{
681 if (!job_section)
682 return 0;
683 if (!strncmp(name, "global", 6))
684 return 0;
685
b36beb6e 686 return strcmp(job_section, name);
01f06b63
JA
687}
688
ebac4655
JA
689static int is_empty_or_comment(char *line)
690{
691 unsigned int i;
692
693 for (i = 0; i < strlen(line); i++) {
694 if (line[i] == ';')
695 return 1;
5cc2da30
IM
696 if (line[i] == '#')
697 return 1;
ebac4655
JA
698 if (!isspace(line[i]) && !iscntrl(line[i]))
699 return 0;
700 }
701
702 return 1;
703}
704
07261983
JA
705/*
706 * This is our [ini] type file parser.
707 */
1e97cce9 708static int parse_jobs_ini(char *file, int stonewall_flag)
ebac4655 709{
e1f36503 710 unsigned int global;
ebac4655 711 struct thread_data *td;
fee3bb48 712 char *string, *name;
ebac4655
JA
713 FILE *f;
714 char *p;
0c7e37a0 715 int ret = 0, stonewall;
097b2991 716 int first_sect = 1;
ccf8f127 717 int skip_fgets = 0;
01f06b63 718 int inside_skip = 0;
3b8b7135
JA
719 char **opts;
720 int i, alloc_opts, num_opts;
ebac4655 721
5a729cbe
AC
722 if (!strcmp(file, "-"))
723 f = stdin;
724 else
725 f = fopen(file, "r");
726
ebac4655 727 if (!f) {
aea47d44 728 perror("fopen job file");
ebac4655
JA
729 return 1;
730 }
731
732 string = malloc(4096);
7f7e6e59
JA
733
734 /*
735 * it's really 256 + small bit, 280 should suffice
736 */
737 name = malloc(280);
738 memset(name, 0, 280);
ebac4655 739
3b8b7135
JA
740 alloc_opts = 8;
741 opts = malloc(sizeof(char *) * alloc_opts);
b7c6302d 742 num_opts = 0;
3b8b7135 743
0c7e37a0 744 stonewall = stonewall_flag;
7c124ac1 745 do {
ccf8f127
JA
746 /*
747 * if skip_fgets is set, we already have loaded a line we
748 * haven't handled.
749 */
750 if (!skip_fgets) {
751 p = fgets(string, 4095, f);
752 if (!p)
753 break;
754 }
cdc7f193 755
ccf8f127 756 skip_fgets = 0;
cdc7f193 757 strip_blank_front(&p);
6c7c7da1 758 strip_blank_end(p);
cdc7f193 759
ebac4655
JA
760 if (is_empty_or_comment(p))
761 continue;
6c7c7da1 762 if (sscanf(p, "[%255s]", name) != 1) {
01f06b63
JA
763 if (inside_skip)
764 continue;
5ec10eaa
JA
765 log_err("fio: option <%s> outside of [] job section\n",
766 p);
088b4207 767 break;
6c7c7da1 768 }
ebac4655 769
01f06b63
JA
770 if (skip_this_section(name)) {
771 inside_skip = 1;
772 continue;
773 } else
774 inside_skip = 0;
775
ebac4655
JA
776 global = !strncmp(name, "global", 6);
777
778 name[strlen(name) - 1] = '\0';
779
cca73aa7 780 if (dump_cmdline) {
097b2991
JA
781 if (first_sect)
782 log_info("fio ");
cca73aa7
JA
783 if (!global)
784 log_info("--name=%s ", name);
097b2991 785 first_sect = 0;
cca73aa7
JA
786 }
787
ebac4655 788 td = get_new_job(global, &def_thread);
45410acb
JA
789 if (!td) {
790 ret = 1;
791 break;
792 }
ebac4655 793
972cfd25
JA
794 /*
795 * Seperate multiple job files by a stonewall
796 */
f9481919 797 if (!global && stonewall) {
2dc1bbeb 798 td->o.stonewall = stonewall;
972cfd25
JA
799 stonewall = 0;
800 }
801
3b8b7135
JA
802 num_opts = 0;
803 memset(opts, 0, alloc_opts * sizeof(char *));
804
ebac4655
JA
805 while ((p = fgets(string, 4096, f)) != NULL) {
806 if (is_empty_or_comment(p))
807 continue;
e1f36503 808
b6754f9d 809 strip_blank_front(&p);
7c124ac1 810
ccf8f127
JA
811 /*
812 * new section, break out and make sure we don't
813 * fgets() a new line at the top.
814 */
815 if (p[0] == '[') {
816 skip_fgets = 1;
7c124ac1 817 break;
ccf8f127 818 }
7c124ac1 819
4ae3f763 820 strip_blank_end(p);
aea47d44 821
3b8b7135
JA
822 if (num_opts == alloc_opts) {
823 alloc_opts <<= 1;
824 opts = realloc(opts,
825 alloc_opts * sizeof(char *));
826 }
827
828 opts[num_opts] = strdup(p);
829 num_opts++;
ebac4655 830 }
ebac4655 831
3b8b7135
JA
832 ret = fio_options_parse(td, opts, num_opts);
833 if (!ret) {
834 if (dump_cmdline)
835 for (i = 0; i < num_opts; i++)
836 log_info("--%s ", opts[i]);
837
45410acb 838 ret = add_job(td, name, 0);
3b8b7135 839 } else {
b1508cf9
JA
840 log_err("fio: job %s dropped\n", name);
841 put_job(td);
45410acb 842 }
3b8b7135
JA
843
844 for (i = 0; i < num_opts; i++)
845 free(opts[i]);
846 num_opts = 0;
7c124ac1 847 } while (!ret);
ebac4655 848
cca73aa7
JA
849 if (dump_cmdline)
850 log_info("\n");
851
3b8b7135
JA
852 for (i = 0; i < num_opts; i++)
853 free(opts[i]);
854
ebac4655
JA
855 free(string);
856 free(name);
2577594d 857 free(opts);
5a729cbe
AC
858 if (f != stdin)
859 fclose(f);
45410acb 860 return ret;
ebac4655
JA
861}
862
863static int fill_def_thread(void)
864{
865 memset(&def_thread, 0, sizeof(def_thread));
866
375b2695 867 fio_getaffinity(getpid(), &def_thread.o.cpumask);
ebac4655
JA
868
869 /*
ee738499 870 * fill default options
ebac4655 871 */
214e1eca 872 fio_fill_default_options(&def_thread);
ee738499 873
2dc1bbeb
JA
874 def_thread.o.timeout = def_timeout;
875 def_thread.o.write_bw_log = write_bw_log;
876 def_thread.o.write_lat_log = write_lat_log;
ee738499 877
ebac4655
JA
878 return 0;
879}
880
214e1eca
JA
881static void free_shm(void)
882{
883 struct shmid_ds sbuf;
884
885 if (threads) {
5e1d306e
JA
886 void *tp = threads;
887
214e1eca 888 threads = NULL;
5e1d306e
JA
889 file_hash_exit();
890 fio_debug_jobp = NULL;
891 shmdt(tp);
214e1eca
JA
892 shmctl(shm_id, IPC_RMID, &sbuf);
893 }
2e5cdb11
JA
894
895 scleanup();
214e1eca
JA
896}
897
898/*
899 * The thread area is shared between the main process and the job
900 * threads/processes. So setup a shared memory segment that will hold
380065aa
JA
901 * all the job info. We use the end of the region for keeping track of
902 * open files across jobs, for file sharing.
214e1eca
JA
903 */
904static int setup_thread_area(void)
905{
380065aa
JA
906 void *hash;
907
214e1eca
JA
908 /*
909 * 1024 is too much on some machines, scale max_jobs if
910 * we get a failure that looks like too large a shm segment
911 */
912 do {
913 size_t size = max_jobs * sizeof(struct thread_data);
914
380065aa 915 size += file_hash_size;
5e1d306e 916 size += sizeof(unsigned int);
380065aa 917
214e1eca
JA
918 shm_id = shmget(0, size, IPC_CREAT | 0600);
919 if (shm_id != -1)
920 break;
921 if (errno != EINVAL) {
922 perror("shmget");
923 break;
924 }
925
926 max_jobs >>= 1;
927 } while (max_jobs);
928
929 if (shm_id == -1)
930 return 1;
931
932 threads = shmat(shm_id, NULL, 0);
933 if (threads == (void *) -1) {
934 perror("shmat");
935 return 1;
936 }
937
1f809d15 938 memset(threads, 0, max_jobs * sizeof(struct thread_data));
380065aa 939 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
5e1d306e
JA
940 fio_debug_jobp = (void *) hash + file_hash_size;
941 *fio_debug_jobp = -1;
380065aa 942 file_hash_init(hash);
214e1eca
JA
943 atexit(free_shm);
944 return 0;
945}
946
45378b35 947static void usage(const char *name)
4785f995
JA
948{
949 printf("%s\n", fio_version_string);
45378b35 950 printf("%s [options] [job options] <job file(s)>\n", name);
ee56ad50 951 printf("\t--debug=options\tEnable debug logging\n");
b4692828
JA
952 printf("\t--output\tWrite output to file\n");
953 printf("\t--timeout\tRuntime in seconds\n");
954 printf("\t--latency-log\tGenerate per-job latency logs\n");
955 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
956 printf("\t--minimal\tMinimal (terse) output\n");
957 printf("\t--version\tPrint version info and exit\n");
fd28ca49 958 printf("\t--help\t\tPrint this page\n");
5ec10eaa
JA
959 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
960 " them\n");
cca73aa7 961 printf("\t--showcmd\tTurn a job file into command line options\n");
e592a06b
AC
962 printf("\t--eta=when\tWhen ETA estimate should be printed\n");
963 printf("\t \tMay be \"always\", \"never\" or \"auto\"\n");
5ec10eaa
JA
964 printf("\t--readonly\tTurn on safety read-only checks, preventing"
965 " writes\n");
01f06b63 966 printf("\t--section=name\tOnly run specified section in job file\n");
2b386d25
JA
967 printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
968 " (def 1024)\n");
fd4442b8 969 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>\n");
4785f995
JA
970}
971
79e48f72 972#ifdef FIO_INC_DEBUG
ee56ad50 973struct debug_level debug_levels[] = {
bd6f78b2
JA
974 { .name = "process", .shift = FD_PROCESS, },
975 { .name = "file", .shift = FD_FILE, },
976 { .name = "io", .shift = FD_IO, },
977 { .name = "mem", .shift = FD_MEM, },
978 { .name = "blktrace", .shift = FD_BLKTRACE },
979 { .name = "verify", .shift = FD_VERIFY },
84422acd 980 { .name = "random", .shift = FD_RANDOM },
a3d741fa 981 { .name = "parse", .shift = FD_PARSE },
cd991b9e 982 { .name = "diskutil", .shift = FD_DISKUTIL },
5e1d306e 983 { .name = "job", .shift = FD_JOB },
29adda3c 984 { .name = "mutex", .shift = FD_MUTEX },
79d16311 985 { .name = "profile", .shift = FD_PROFILE },
02444ad1 986 { .name = NULL, },
ee56ad50
JA
987};
988
c09823ab 989static int set_debug(const char *string)
ee56ad50
JA
990{
991 struct debug_level *dl;
992 char *p = (char *) string;
993 char *opt;
994 int i;
995
996 if (!strcmp(string, "?") || !strcmp(string, "help")) {
997 int i;
998
999 log_info("fio: dumping debug options:");
1000 for (i = 0; debug_levels[i].name; i++) {
1001 dl = &debug_levels[i];
1002 log_info("%s,", dl->name);
1003 }
bd6f78b2 1004 log_info("all\n");
c09823ab 1005 return 1;
ee56ad50
JA
1006 }
1007
1008 while ((opt = strsep(&p, ",")) != NULL) {
1009 int found = 0;
1010
5e1d306e
JA
1011 if (!strncmp(opt, "all", 3)) {
1012 log_info("fio: set all debug options\n");
1013 fio_debug = ~0UL;
1014 continue;
1015 }
1016
ee56ad50
JA
1017 for (i = 0; debug_levels[i].name; i++) {
1018 dl = &debug_levels[i];
5e1d306e
JA
1019 found = !strncmp(opt, dl->name, strlen(dl->name));
1020 if (!found)
1021 continue;
1022
1023 if (dl->shift == FD_JOB) {
1024 opt = strchr(opt, ':');
1025 if (!opt) {
1026 log_err("fio: missing job number\n");
1027 break;
1028 }
1029 opt++;
1030 fio_debug_jobno = atoi(opt);
1031 log_info("fio: set debug jobno %d\n",
1032 fio_debug_jobno);
1033 } else {
ee56ad50 1034 log_info("fio: set debug option %s\n", opt);
bd6f78b2 1035 fio_debug |= (1UL << dl->shift);
ee56ad50 1036 }
5e1d306e 1037 break;
ee56ad50
JA
1038 }
1039
1040 if (!found)
1041 log_err("fio: debug mask %s not found\n", opt);
1042 }
c09823ab 1043 return 0;
ee56ad50 1044}
79e48f72 1045#else
69b98d4c 1046static int set_debug(const char *string)
79e48f72
JA
1047{
1048 log_err("fio: debug tracing not included in build\n");
c09823ab 1049 return 1;
79e48f72
JA
1050}
1051#endif
9ac8a797 1052
972cfd25 1053static int parse_cmd_line(int argc, char *argv[])
ebac4655 1054{
b4692828 1055 struct thread_data *td = NULL;
c09823ab 1056 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
ebac4655 1057
5ec10eaa 1058 while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
ebac4655 1059 switch (c) {
2b386d25
JA
1060 case 'a':
1061 smalloc_pool_size = atoi(optarg);
1062 break;
b4692828
JA
1063 case 't':
1064 def_timeout = atoi(optarg);
1065 break;
1066 case 'l':
1067 write_lat_log = 1;
1068 break;
1069 case 'w':
1070 write_bw_log = 1;
1071 break;
1072 case 'o':
1073 f_out = fopen(optarg, "w+");
1074 if (!f_out) {
1075 perror("fopen output");
1076 exit(1);
1077 }
1078 f_err = f_out;
1079 break;
1080 case 'm':
1081 terse_output = 1;
1082 break;
1083 case 'h':
45378b35 1084 usage(argv[0]);
b4692828 1085 exit(0);
fd28ca49 1086 case 'c':
214e1eca 1087 exit(fio_show_option_help(optarg));
cca73aa7
JA
1088 case 's':
1089 dump_cmdline = 1;
1090 break;
724e4435
JA
1091 case 'r':
1092 read_only = 1;
1093 break;
b4692828
JA
1094 case 'v':
1095 printf("%s\n", fio_version_string);
1096 exit(0);
e592a06b
AC
1097 case 'e':
1098 if (!strcmp("always", optarg))
1099 eta_print = FIO_ETA_ALWAYS;
1100 else if (!strcmp("never", optarg))
1101 eta_print = FIO_ETA_NEVER;
1102 break;
ee56ad50 1103 case 'd':
c09823ab
JA
1104 if (set_debug(optarg))
1105 do_exit++;
ee56ad50 1106 break;
01f06b63
JA
1107 case 'x':
1108 if (!strcmp(optarg, "global")) {
5ec10eaa
JA
1109 log_err("fio: can't use global as only "
1110 "section\n");
c09823ab
JA
1111 do_exit++;
1112 exit_val = 1;
01f06b63
JA
1113 break;
1114 }
1115 if (job_section)
1116 free(job_section);
1117 job_section = strdup(optarg);
1118 break;
9ac8a797 1119 case 'p':
07b3232d 1120 exec_profile = strdup(optarg);
9ac8a797 1121 break;
b4692828 1122 case FIO_GETOPT_JOB: {
5ec10eaa 1123 const char *opt = l_opts[lidx].name;
b4692828
JA
1124 char *val = optarg;
1125
c2b1e753 1126 if (!strncmp(opt, "name", 4) && td) {
2dc1bbeb 1127 ret = add_job(td, td->o.name ?: "fio", 0);
c2b1e753
JA
1128 if (ret) {
1129 put_job(td);
1130 return 0;
1131 }
1132 td = NULL;
1133 }
b4692828 1134 if (!td) {
01f06b63 1135 int is_section = !strncmp(opt, "name", 4);
3106f220
JA
1136 int global = 0;
1137
01f06b63 1138 if (!is_section || !strncmp(val, "global", 6))
3106f220 1139 global = 1;
c2b1e753 1140
01f06b63
JA
1141 if (is_section && skip_this_section(val))
1142 continue;
1143
c2b1e753 1144 td = get_new_job(global, &def_thread);
b4692828
JA
1145 if (!td)
1146 return 0;
1147 }
38d0adb0 1148
214e1eca 1149 ret = fio_cmd_option_parse(td, opt, val);
b4692828
JA
1150 break;
1151 }
1152 default:
c09823ab
JA
1153 do_exit++;
1154 exit_val = 1;
b4692828 1155 break;
ebac4655
JA
1156 }
1157 }
c9fad893 1158
c09823ab
JA
1159 if (do_exit)
1160 exit(exit_val);
536582bf 1161
b4692828 1162 if (td) {
7d6a8904 1163 if (!ret)
2dc1bbeb 1164 ret = add_job(td, td->o.name ?: "fio", 0);
7d6a8904
JA
1165 if (ret)
1166 put_job(td);
972cfd25 1167 }
774a6177 1168
b4692828
JA
1169 while (optind < argc) {
1170 ini_idx++;
1171 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1172 ini_file[ini_idx - 1] = strdup(argv[optind]);
1173 optind++;
eb8bbf48 1174 }
972cfd25
JA
1175
1176 return ini_idx;
ebac4655
JA
1177}
1178
ebac4655
JA
1179int parse_options(int argc, char *argv[])
1180{
972cfd25
JA
1181 int job_files, i;
1182
b4692828
JA
1183 f_out = stdout;
1184 f_err = stderr;
1185
5ec10eaa 1186 fio_options_dup_and_init(l_opts);
b4692828 1187
ebac4655
JA
1188 if (setup_thread_area())
1189 return 1;
1190 if (fill_def_thread())
1191 return 1;
1192
972cfd25 1193 job_files = parse_cmd_line(argc, argv);
ebac4655 1194
972cfd25
JA
1195 for (i = 0; i < job_files; i++) {
1196 if (fill_def_thread())
1197 return 1;
0c7e37a0 1198 if (parse_jobs_ini(ini_file[i], i))
972cfd25 1199 return 1;
88c6ed80 1200 free(ini_file[i]);
972cfd25 1201 }
ebac4655 1202
88c6ed80 1203 free(ini_file);
d23bb327 1204 options_mem_free(&def_thread);
b4692828
JA
1205
1206 if (!thread_number) {
cca73aa7
JA
1207 if (dump_cmdline)
1208 return 0;
07b3232d
JA
1209 if (exec_profile)
1210 return 0;
cca73aa7 1211
fd4442b8 1212 log_err("No jobs defined(s)\n\n");
45378b35 1213 usage(argv[0]);
b4692828
JA
1214 return 1;
1215 }
1216
be4ecfdf
JA
1217 if (def_thread.o.gtod_offload) {
1218 fio_gtod_init();
1219 fio_gtod_offload = 1;
1220 fio_gtod_cpu = def_thread.o.gtod_cpu;
1221 }
1222
ebac4655
JA
1223 return 0;
1224}