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