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