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