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