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