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