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