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