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