Make lockmem a per job option
[fio.git] / init.c
CommitLineData
906c8d75 1/*
cb2c86fd 2 * This file contains job initialization and setup functions.
906c8d75 3 */
ebac4655
JA
4#include <stdio.h>
5#include <stdlib.h>
6#include <unistd.h>
7#include <fcntl.h>
8#include <ctype.h>
9#include <string.h>
10#include <errno.h>
11#include <sys/ipc.h>
ebac4655
JA
12#include <sys/types.h>
13#include <sys/stat.h>
14
15#include "fio.h"
a5e0ee11
O
16#ifndef FIO_NO_HAVE_SHM_H
17#include <sys/shm.h>
18#endif
19
cb2c86fd 20#include "parse.h"
2e5cdb11 21#include "smalloc.h"
380065aa 22#include "filehash.h"
4f5af7b2 23#include "verify.h"
79d16311 24#include "profile.h"
50d16976 25#include "server.h"
f2a2ce0e 26#include "idletime.h"
ebac4655 27
bf2e821a 28#include "lib/getopt.h"
e25b6d5a 29#include "lib/strcasestr.h"
bf2e821a 30
692a5d22 31const char fio_version_string[] = FIO_VERSION;
214e1eca 32
ee738499 33#define FIO_RANDSEED (0xb1899bedUL)
ebac4655 34
214e1eca 35static char **ini_file;
fca70358 36static int max_jobs = FIO_MAX_JOBS;
cca73aa7 37static int dump_cmdline;
8c029376 38static int def_timeout;
111e032d 39static int parse_only;
e1f36503 40
be4ecfdf 41static struct thread_data def_thread;
214e1eca 42struct thread_data *threads = NULL;
e1f36503 43
214e1eca 44int exitall_on_terminate = 0;
f3afa57e 45int output_format = FIO_OUTPUT_NORMAL;
5be4c944 46int eta_print = FIO_ETA_AUTO;
e382e661 47int eta_new_line = 0;
214e1eca
JA
48FILE *f_out = NULL;
49FILE *f_err = NULL;
ad0a2735
JA
50char **job_sections = NULL;
51int nr_job_sections = 0;
07b3232d 52char *exec_profile = NULL;
a9523c6f 53int warnings_fatal = 0;
4d658652 54int terse_version = 3;
50d16976 55int is_backend = 0;
a37f69b7 56int nr_clients = 0;
e46d8091 57int log_syslog = 0;
ee738499 58
214e1eca 59int write_bw_log = 0;
4241ea8f 60int read_only = 0;
214e1eca 61
5ec10eaa 62static int write_lat_log;
e1f36503 63
214e1eca 64static int prev_group_jobs;
b4692828 65
ee56ad50 66unsigned long fio_debug = 0;
5e1d306e
JA
67unsigned int fio_debug_jobno = -1;
68unsigned int *fio_debug_jobp = NULL;
ee56ad50 69
4c6107ff 70static char cmd_optstr[256];
085399db 71static int did_arg;
4c6107ff 72
7a4b8240
JA
73#define FIO_CLIENT_FLAG (1 << 16)
74
b4692828
JA
75/*
76 * Command line options. These will contain the above, plus a few
77 * extra that only pertain to fio itself and not jobs.
78 */
5ec10eaa 79static struct option l_opts[FIO_NR_OPTIONS] = {
b4692828 80 {
08d2a19c 81 .name = (char *) "output",
b4692828 82 .has_arg = required_argument,
7a4b8240 83 .val = 'o' | FIO_CLIENT_FLAG,
b4692828
JA
84 },
85 {
08d2a19c 86 .name = (char *) "timeout",
b4692828 87 .has_arg = required_argument,
7a4b8240 88 .val = 't' | FIO_CLIENT_FLAG,
b4692828
JA
89 },
90 {
08d2a19c 91 .name = (char *) "latency-log",
b4692828 92 .has_arg = required_argument,
7a4b8240 93 .val = 'l' | FIO_CLIENT_FLAG,
b4692828
JA
94 },
95 {
08d2a19c 96 .name = (char *) "bandwidth-log",
b4692828 97 .has_arg = required_argument,
7a4b8240 98 .val = 'b' | FIO_CLIENT_FLAG,
b4692828
JA
99 },
100 {
08d2a19c 101 .name = (char *) "minimal",
b4692828 102 .has_arg = optional_argument,
7a4b8240 103 .val = 'm' | FIO_CLIENT_FLAG,
b4692828 104 },
cc372b17 105 {
f3afa57e 106 .name = (char *) "output-format",
cc372b17 107 .has_arg = optional_argument,
f3afa57e 108 .val = 'F' | FIO_CLIENT_FLAG,
cc372b17 109 },
b4692828 110 {
08d2a19c 111 .name = (char *) "version",
b4692828 112 .has_arg = no_argument,
7a4b8240 113 .val = 'v' | FIO_CLIENT_FLAG,
b4692828 114 },
fd28ca49 115 {
08d2a19c 116 .name = (char *) "help",
fd28ca49 117 .has_arg = no_argument,
7a4b8240 118 .val = 'h' | FIO_CLIENT_FLAG,
fd28ca49
JA
119 },
120 {
08d2a19c 121 .name = (char *) "cmdhelp",
320beefe 122 .has_arg = optional_argument,
7a4b8240 123 .val = 'c' | FIO_CLIENT_FLAG,
fd28ca49 124 },
de890a1e
SL
125 {
126 .name = (char *) "enghelp",
127 .has_arg = optional_argument,
128 .val = 'i' | FIO_CLIENT_FLAG,
129 },
cca73aa7 130 {
08d2a19c 131 .name = (char *) "showcmd",
cca73aa7 132 .has_arg = no_argument,
7a4b8240 133 .val = 's' | FIO_CLIENT_FLAG,
724e4435
JA
134 },
135 {
08d2a19c 136 .name = (char *) "readonly",
724e4435 137 .has_arg = no_argument,
7a4b8240 138 .val = 'r' | FIO_CLIENT_FLAG,
cca73aa7 139 },
e592a06b 140 {
08d2a19c 141 .name = (char *) "eta",
e592a06b 142 .has_arg = required_argument,
7a4b8240 143 .val = 'e' | FIO_CLIENT_FLAG,
e592a06b 144 },
e382e661
JA
145 {
146 .name = (char *) "eta-newline",
147 .has_arg = required_argument,
148 .val = 'E' | FIO_CLIENT_FLAG,
149 },
ee56ad50 150 {
08d2a19c 151 .name = (char *) "debug",
ee56ad50 152 .has_arg = required_argument,
7a4b8240 153 .val = 'd' | FIO_CLIENT_FLAG,
ee56ad50 154 },
111e032d
JA
155 {
156 .name = (char *) "parse-only",
157 .has_arg = no_argument,
158 .val = 'P' | FIO_CLIENT_FLAG,
159 },
01f06b63 160 {
08d2a19c 161 .name = (char *) "section",
01f06b63 162 .has_arg = required_argument,
7a4b8240 163 .val = 'x' | FIO_CLIENT_FLAG,
01f06b63 164 },
2b386d25 165 {
08d2a19c 166 .name = (char *) "alloc-size",
2b386d25 167 .has_arg = required_argument,
7a4b8240 168 .val = 'a' | FIO_CLIENT_FLAG,
2b386d25 169 },
9ac8a797 170 {
08d2a19c 171 .name = (char *) "profile",
9ac8a797 172 .has_arg = required_argument,
7a4b8240 173 .val = 'p' | FIO_CLIENT_FLAG,
9ac8a797 174 },
a9523c6f 175 {
08d2a19c 176 .name = (char *) "warnings-fatal",
a9523c6f 177 .has_arg = no_argument,
7a4b8240 178 .val = 'w' | FIO_CLIENT_FLAG,
a9523c6f 179 },
fca70358
JA
180 {
181 .name = (char *) "max-jobs",
182 .has_arg = required_argument,
7a4b8240 183 .val = 'j' | FIO_CLIENT_FLAG,
fca70358 184 },
f57a9c59
JA
185 {
186 .name = (char *) "terse-version",
187 .has_arg = required_argument,
7a4b8240 188 .val = 'V' | FIO_CLIENT_FLAG,
f57a9c59 189 },
50d16976
JA
190 {
191 .name = (char *) "server",
87aa8f19 192 .has_arg = optional_argument,
50d16976
JA
193 .val = 'S',
194 },
e46d8091 195 { .name = (char *) "daemonize",
402668f3 196 .has_arg = required_argument,
e46d8091
JA
197 .val = 'D',
198 },
132159a5
JA
199 {
200 .name = (char *) "client",
201 .has_arg = required_argument,
202 .val = 'C',
203 },
7d11f871
JA
204 {
205 .name = (char *) "cpuclock-test",
206 .has_arg = no_argument,
207 .val = 'T',
208 },
f2a2ce0e
HL
209 {
210 .name = (char *) "idle-prof",
211 .has_arg = required_argument,
212 .val = 'I',
213 },
b4692828
JA
214 {
215 .name = NULL,
216 },
217};
218
9d9eb2e7
JA
219static void free_shm(void)
220{
221 struct shmid_ds sbuf;
222
223 if (threads) {
224 void *tp = threads;
225
226 threads = NULL;
227 file_hash_exit();
9e684a49 228 flow_exit();
9d9eb2e7
JA
229 fio_debug_jobp = NULL;
230 shmdt(tp);
231 shmctl(shm_id, IPC_RMID, &sbuf);
232 }
233
234 scleanup();
235}
236
237/*
238 * The thread area is shared between the main process and the job
239 * threads/processes. So setup a shared memory segment that will hold
240 * all the job info. We use the end of the region for keeping track of
241 * open files across jobs, for file sharing.
242 */
243static int setup_thread_area(void)
244{
245 void *hash;
246
247 if (threads)
248 return 0;
249
250 /*
251 * 1024 is too much on some machines, scale max_jobs if
252 * we get a failure that looks like too large a shm segment
253 */
254 do {
255 size_t size = max_jobs * sizeof(struct thread_data);
256
257 size += file_hash_size;
258 size += sizeof(unsigned int);
259
260 shm_id = shmget(0, size, IPC_CREAT | 0600);
261 if (shm_id != -1)
262 break;
f0c77f03 263 if (errno != EINVAL && errno != ENOMEM && errno != ENOSPC) {
9d9eb2e7
JA
264 perror("shmget");
265 break;
266 }
267
268 max_jobs >>= 1;
269 } while (max_jobs);
270
271 if (shm_id == -1)
272 return 1;
273
274 threads = shmat(shm_id, NULL, 0);
275 if (threads == (void *) -1) {
276 perror("shmat");
277 return 1;
278 }
279
280 memset(threads, 0, max_jobs * sizeof(struct thread_data));
281 hash = (void *) threads + max_jobs * sizeof(struct thread_data);
282 fio_debug_jobp = (void *) hash + file_hash_size;
283 *fio_debug_jobp = -1;
284 file_hash_init(hash);
9e684a49
DE
285
286 flow_init();
287
9d9eb2e7
JA
288 return 0;
289}
290
906c8d75
JA
291/*
292 * Return a free job structure.
293 */
de890a1e
SL
294static struct thread_data *get_new_job(int global, struct thread_data *parent,
295 int preserve_eo)
ebac4655
JA
296{
297 struct thread_data *td;
298
299 if (global)
300 return &def_thread;
9d9eb2e7
JA
301 if (setup_thread_area()) {
302 log_err("error: failed to setup shm segment\n");
303 return NULL;
304 }
e61f1ec8
BC
305 if (thread_number >= max_jobs) {
306 log_err("error: maximum number of jobs (%d) reached.\n",
307 max_jobs);
ebac4655 308 return NULL;
e61f1ec8 309 }
ebac4655
JA
310
311 td = &threads[thread_number++];
ddaeaa5a 312 *td = *parent;
ebac4655 313
de890a1e
SL
314 td->io_ops = NULL;
315 if (!preserve_eo)
316 td->eo = NULL;
317
e0b0d892
JA
318 td->o.uid = td->o.gid = -1U;
319
cade3ef4 320 dup_files(td, parent);
de890a1e 321 fio_options_mem_dupe(td);
cade3ef4 322
15dc1934
JA
323 profile_add_hooks(td);
324
ebac4655 325 td->thread_number = thread_number;
108fea77
JA
326
327 if (!parent || !parent->o.group_reporting)
328 stat_number++;
329
ebac4655
JA
330 return td;
331}
332
333static void put_job(struct thread_data *td)
334{
549577a7
JA
335 if (td == &def_thread)
336 return;
84dd1886 337
58c55ba0 338 profile_td_exit(td);
9e684a49 339 flow_exit_job(td);
549577a7 340
16edf25d 341 if (td->error)
6d86144d 342 log_info("fio: %s\n", td->verror);
16edf25d 343
7e356b2d 344 fio_options_free(td);
de890a1e
SL
345 if (td->io_ops)
346 free_ioengine(td);
7e356b2d 347
ebac4655
JA
348 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
349 thread_number--;
350}
351
581e7141 352static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
127f6865 353{
581e7141 354 unsigned int bs = td->o.min_bs[ddir];
127f6865 355
ff58fced
JA
356 assert(ddir_rw(ddir));
357
ba3e4e0c 358 if (td->o.rate[ddir])
1b8dbf25 359 td->rate_bps[ddir] = td->o.rate[ddir];
ba3e4e0c 360 else
1b8dbf25 361 td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
127f6865 362
1b8dbf25 363 if (!td->rate_bps[ddir]) {
127f6865
JA
364 log_err("rate lower than supported\n");
365 return -1;
366 }
367
581e7141 368 td->rate_pending_usleep[ddir] = 0;
127f6865
JA
369 return 0;
370}
371
581e7141
JA
372static int setup_rate(struct thread_data *td)
373{
374 int ret = 0;
375
376 if (td->o.rate[DDIR_READ] || td->o.rate_iops[DDIR_READ])
377 ret = __setup_rate(td, DDIR_READ);
378 if (td->o.rate[DDIR_WRITE] || td->o.rate_iops[DDIR_WRITE])
379 ret |= __setup_rate(td, DDIR_WRITE);
6eaf09d6
SL
380 if (td->o.rate[DDIR_TRIM] || td->o.rate_iops[DDIR_TRIM])
381 ret |= __setup_rate(td, DDIR_TRIM);
581e7141
JA
382
383 return ret;
384}
385
8347239a
JA
386static int fixed_block_size(struct thread_options *o)
387{
388 return o->min_bs[DDIR_READ] == o->max_bs[DDIR_READ] &&
389 o->min_bs[DDIR_WRITE] == o->max_bs[DDIR_WRITE] &&
6eaf09d6
SL
390 o->min_bs[DDIR_TRIM] == o->max_bs[DDIR_TRIM] &&
391 o->min_bs[DDIR_READ] == o->min_bs[DDIR_WRITE] &&
392 o->min_bs[DDIR_READ] == o->min_bs[DDIR_TRIM];
8347239a
JA
393}
394
dad915e3
JA
395/*
396 * Lazy way of fixing up options that depend on each other. We could also
397 * define option callback handlers, but this is easier.
398 */
4e991c23 399static int fixup_options(struct thread_data *td)
e1f36503 400{
2dc1bbeb 401 struct thread_options *o = &td->o;
ff217451 402 int ret = 0;
dad915e3 403
f356d01d 404#ifndef FIO_HAVE_PSHARED_MUTEX
9bbf57cc 405 if (!o->use_thread) {
f356d01d
JA
406 log_info("fio: this platform does not support process shared"
407 " mutexes, forcing use of threads. Use the 'thread'"
408 " option to get rid of this warning.\n");
9bbf57cc 409 o->use_thread = 1;
a9523c6f 410 ret = warnings_fatal;
f356d01d
JA
411 }
412#endif
413
2dc1bbeb 414 if (o->write_iolog_file && o->read_iolog_file) {
076efc7c 415 log_err("fio: read iolog overrides write_iolog\n");
2dc1bbeb
JA
416 free(o->write_iolog_file);
417 o->write_iolog_file = NULL;
a9523c6f 418 ret = warnings_fatal;
076efc7c 419 }
16b462ae 420
16b462ae 421 /*
ed335855 422 * only really works with 1 file
16b462ae 423 */
627aa1a8 424 if (o->zone_size && o->open_files > 1)
2dc1bbeb 425 o->zone_size = 0;
16b462ae 426
ed335855
SN
427 /*
428 * If zone_range isn't specified, backward compatibility dictates it
429 * should be made equal to zone_size.
430 */
431 if (o->zone_size && !o->zone_range)
432 o->zone_range = o->zone_size;
433
16b462ae
JA
434 /*
435 * Reads can do overwrites, we always need to pre-create the file
436 */
437 if (td_read(td) || td_rw(td))
2dc1bbeb 438 o->overwrite = 1;
16b462ae 439
2dc1bbeb 440 if (!o->min_bs[DDIR_READ])
5ec10eaa 441 o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
2dc1bbeb
JA
442 if (!o->max_bs[DDIR_READ])
443 o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
444 if (!o->min_bs[DDIR_WRITE])
5ec10eaa 445 o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
2dc1bbeb
JA
446 if (!o->max_bs[DDIR_WRITE])
447 o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
6eaf09d6
SL
448 if (!o->min_bs[DDIR_TRIM])
449 o->min_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
450 if (!o->max_bs[DDIR_TRIM])
451 o->max_bs[DDIR_TRIM] = o->bs[DDIR_TRIM];
452
a00735e6 453
2dc1bbeb 454 o->rw_min_bs = min(o->min_bs[DDIR_READ], o->min_bs[DDIR_WRITE]);
6eaf09d6 455 o->rw_min_bs = min(o->min_bs[DDIR_TRIM], o->rw_min_bs);
a00735e6 456
2b7a01d0
JA
457 /*
458 * For random IO, allow blockalign offset other than min_bs.
459 */
460 if (!o->ba[DDIR_READ] || !td_random(td))
461 o->ba[DDIR_READ] = o->min_bs[DDIR_READ];
462 if (!o->ba[DDIR_WRITE] || !td_random(td))
463 o->ba[DDIR_WRITE] = o->min_bs[DDIR_WRITE];
6eaf09d6
SL
464 if (!o->ba[DDIR_TRIM] || !td_random(td))
465 o->ba[DDIR_TRIM] = o->min_bs[DDIR_TRIM];
2b7a01d0
JA
466
467 if ((o->ba[DDIR_READ] != o->min_bs[DDIR_READ] ||
6eaf09d6
SL
468 o->ba[DDIR_WRITE] != o->min_bs[DDIR_WRITE] ||
469 o->ba[DDIR_TRIM] != o->min_bs[DDIR_TRIM]) &&
9bbf57cc 470 !o->norandommap) {
2b7a01d0 471 log_err("fio: Any use of blockalign= turns off randommap\n");
9bbf57cc 472 o->norandommap = 1;
a9523c6f 473 ret = warnings_fatal;
2b7a01d0
JA
474 }
475
2dc1bbeb
JA
476 if (!o->file_size_high)
477 o->file_size_high = o->file_size_low;
9c60ce64 478
8347239a
JA
479 if (o->norandommap && o->verify != VERIFY_NONE
480 && !fixed_block_size(o)) {
481 log_err("fio: norandommap given for variable block sizes, "
482 "verify disabled\n");
2dc1bbeb 483 o->verify = VERIFY_NONE;
a9523c6f 484 ret = warnings_fatal;
bb8895e0 485 }
2dc1bbeb 486 if (o->bs_unaligned && (o->odirect || td->io_ops->flags & FIO_RAWIO))
690adba3 487 log_err("fio: bs_unaligned may not work with raw io\n");
e0a22335 488
48097d5c
JA
489 /*
490 * thinktime_spin must be less than thinktime
491 */
2dc1bbeb
JA
492 if (o->thinktime_spin > o->thinktime)
493 o->thinktime_spin = o->thinktime;
e916b390
JA
494
495 /*
496 * The low water mark cannot be bigger than the iodepth
497 */
67bf9823
JA
498 if (o->iodepth_low > o->iodepth || !o->iodepth_low)
499 o->iodepth_low = o->iodepth;
cb5ab512
JA
500
501 /*
502 * If batch number isn't set, default to the same as iodepth
503 */
2dc1bbeb
JA
504 if (o->iodepth_batch > o->iodepth || !o->iodepth_batch)
505 o->iodepth_batch = o->iodepth;
b5af8293 506
2dc1bbeb
JA
507 if (o->nr_files > td->files_index)
508 o->nr_files = td->files_index;
9f9214f2 509
2dc1bbeb
JA
510 if (o->open_files > o->nr_files || !o->open_files)
511 o->open_files = o->nr_files;
4e991c23 512
6eaf09d6
SL
513 if (((o->rate[DDIR_READ] + o->rate[DDIR_WRITE] + o->rate[DDIR_TRIM]) &&
514 (o->rate_iops[DDIR_READ] + o->rate_iops[DDIR_WRITE] + o->rate_iops[DDIR_TRIM])) ||
515 ((o->ratemin[DDIR_READ] + o->ratemin[DDIR_WRITE] + o->ratemin[DDIR_TRIM]) &&
516 (o->rate_iops_min[DDIR_READ] + o->rate_iops_min[DDIR_WRITE] + o->rate_iops_min[DDIR_TRIM]))) {
4e991c23 517 log_err("fio: rate and rate_iops are mutually exclusive\n");
a9523c6f 518 ret = 1;
4e991c23 519 }
6eaf09d6
SL
520 if ((o->rate[DDIR_READ] < o->ratemin[DDIR_READ]) ||
521 (o->rate[DDIR_WRITE] < o->ratemin[DDIR_WRITE]) ||
522 (o->rate[DDIR_TRIM] < o->ratemin[DDIR_TRIM]) ||
523 (o->rate_iops[DDIR_READ] < o->rate_iops_min[DDIR_READ]) ||
524 (o->rate_iops[DDIR_WRITE] < o->rate_iops_min[DDIR_WRITE]) ||
525 (o->rate_iops[DDIR_TRIM] < o->rate_iops_min[DDIR_TRIM])) {
4e991c23 526 log_err("fio: minimum rate exceeds rate\n");
a9523c6f 527 ret = 1;
4e991c23
JA
528 }
529
cf4464ca
JA
530 if (!o->timeout && o->time_based) {
531 log_err("fio: time_based requires a runtime/timeout setting\n");
532 o->time_based = 0;
a9523c6f 533 ret = warnings_fatal;
cf4464ca
JA
534 }
535
aa31f1f1 536 if (o->fill_device && !o->size)
5921e80c 537 o->size = -1ULL;
5ec10eaa 538
9bbf57cc 539 if (o->verify != VERIFY_NONE) {
996936f9 540 if (td_write(td) && o->do_verify && o->numjobs > 1) {
a9523c6f
JA
541 log_info("Multiple writers may overwrite blocks that "
542 "belong to other jobs. This can cause "
543 "verification failures.\n");
544 ret = warnings_fatal;
545 }
546
9bbf57cc 547 o->refill_buffers = 1;
2f1b8e8b
JA
548 if (o->max_bs[DDIR_WRITE] != o->min_bs[DDIR_WRITE] &&
549 !o->verify_interval)
550 o->verify_interval = o->min_bs[DDIR_WRITE];
d990588e 551 }
41ccd845 552
9bbf57cc
JA
553 if (o->pre_read) {
554 o->invalidate_cache = 0;
a9523c6f 555 if (td->io_ops->flags & FIO_PIPEIO) {
9c0d2241
JA
556 log_info("fio: cannot pre-read files with an IO engine"
557 " that isn't seekable. Pre-read disabled.\n");
a9523c6f
JA
558 ret = warnings_fatal;
559 }
9c0d2241 560 }
34f1c044 561
ad705bcb
SN
562 if (!o->unit_base) {
563 if (td->io_ops->flags & FIO_BIT_BASED)
564 o->unit_base = 1;
565 else
566 o->unit_base = 8;
567 }
568
67bf9823 569#ifndef CONFIG_FDATASYNC
9bbf57cc 570 if (o->fdatasync_blocks) {
e72fa4d4
JA
571 log_info("fio: this platform does not support fdatasync()"
572 " falling back to using fsync(). Use the 'fsync'"
573 " option instead of 'fdatasync' to get rid of"
574 " this warning\n");
9bbf57cc
JA
575 o->fsync_blocks = o->fdatasync_blocks;
576 o->fdatasync_blocks = 0;
a9523c6f 577 ret = warnings_fatal;
e72fa4d4
JA
578 }
579#endif
580
93bcfd20
BC
581#ifdef WIN32
582 /*
583 * Windows doesn't support O_DIRECT or O_SYNC with the _open interface,
584 * so fail if we're passed those flags
585 */
586 if ((td->io_ops->flags & FIO_SYNCIO) && (td->o.odirect || td->o.sync_io)) {
587 log_err("fio: Windows does not support direct or non-buffered io with"
588 " the synchronous ioengines. Use the 'windowsaio' ioengine"
589 " with 'direct=1' and 'iodepth=1' instead.\n");
590 ret = 1;
591 }
592#endif
593
811ac503
JA
594 /*
595 * For fully compressible data, just zero them at init time.
596 * It's faster than repeatedly filling it.
597 */
598 if (td->o.compress_percentage == 100) {
599 td->o.zero_buffers = 1;
600 td->o.compress_percentage = 0;
601 }
602
5881fda4
JA
603 /*
604 * Using a non-uniform random distribution excludes usage of
605 * a random map
606 */
607 if (td->o.random_distribution != FIO_RAND_DIST_RANDOM)
608 td->o.norandommap = 1;
609
a9523c6f 610 return ret;
e1f36503
JA
611}
612
f8977ee6
JA
613/*
614 * This function leaks the buffer
615 */
616static char *to_kmg(unsigned int val)
617{
618 char *buf = malloc(32);
f3502ba2 619 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
f8977ee6
JA
620 char *p = post;
621
245142ff 622 do {
f8977ee6
JA
623 if (val & 1023)
624 break;
625
626 val >>= 10;
627 p++;
245142ff 628 } while (*p);
f8977ee6 629
98ffb8f3 630 snprintf(buf, 32, "%u%c", val, *p);
f8977ee6
JA
631 return buf;
632}
633
09629a90
JA
634/* External engines are specified by "external:name.o") */
635static const char *get_engine_name(const char *str)
636{
637 char *p = strstr(str, ":");
638
639 if (!p)
640 return str;
641
642 p++;
643 strip_blank_front(&p);
644 strip_blank_end(p);
645 return p;
646}
647
e132cbae
JA
648static int exists_and_not_file(const char *filename)
649{
650 struct stat sb;
651
652 if (lstat(filename, &sb) == -1)
653 return 0;
654
ecc314ba
BC
655 /* \\.\ is the device namespace in Windows, where every file
656 * is a device node */
657 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
e132cbae
JA
658 return 0;
659
660 return 1;
661}
662
4c07ad86 663static void td_fill_rand_seeds_os(struct thread_data *td)
5bfc35d7 664{
d24945f0
JA
665 os_random_seed(td->rand_seeds[FIO_RAND_BS_OFF], &td->bsrange_state);
666 os_random_seed(td->rand_seeds[FIO_RAND_VER_OFF], &td->verify_state);
667 os_random_seed(td->rand_seeds[FIO_RAND_MIX_OFF], &td->rwmix_state);
5bfc35d7
JA
668
669 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
d24945f0 670 os_random_seed(td->rand_seeds[FIO_RAND_FILE_OFF], &td->next_file_state);
5bfc35d7 671
d24945f0
JA
672 os_random_seed(td->rand_seeds[FIO_RAND_FILE_SIZE_OFF], &td->file_size_state);
673 os_random_seed(td->rand_seeds[FIO_RAND_TRIM_OFF], &td->trim_state);
5bfc35d7
JA
674
675 if (!td_random(td))
676 return;
677
678 if (td->o.rand_repeatable)
d24945f0 679 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
5bfc35d7 680
d24945f0 681 os_random_seed(td->rand_seeds[FIO_RAND_BLOCK_OFF], &td->random_state);
4c07ad86
JA
682}
683
684static void td_fill_rand_seeds_internal(struct thread_data *td)
685{
d24945f0
JA
686 init_rand_seed(&td->__bsrange_state, td->rand_seeds[FIO_RAND_BS_OFF]);
687 init_rand_seed(&td->__verify_state, td->rand_seeds[FIO_RAND_VER_OFF]);
688 init_rand_seed(&td->__rwmix_state, td->rand_seeds[FIO_RAND_MIX_OFF]);
4c07ad86
JA
689
690 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
d24945f0 691 init_rand_seed(&td->__next_file_state, td->rand_seeds[FIO_RAND_FILE_OFF]);
4c07ad86 692
d24945f0
JA
693 init_rand_seed(&td->__file_size_state, td->rand_seeds[FIO_RAND_FILE_SIZE_OFF]);
694 init_rand_seed(&td->__trim_state, td->rand_seeds[FIO_RAND_TRIM_OFF]);
4c07ad86
JA
695
696 if (!td_random(td))
697 return;
698
699 if (td->o.rand_repeatable)
d24945f0 700 td->rand_seeds[FIO_RAND_BLOCK_OFF] = FIO_RANDSEED * td->thread_number;
4c07ad86 701
d24945f0 702 init_rand_seed(&td->__random_state, td->rand_seeds[FIO_RAND_BLOCK_OFF]);
5bfc35d7
JA
703}
704
4c07ad86
JA
705void td_fill_rand_seeds(struct thread_data *td)
706{
707 if (td->o.use_os_rand)
708 td_fill_rand_seeds_os(td);
709 else
710 td_fill_rand_seeds_internal(td);
3545a109 711
d24945f0 712 init_rand_seed(&td->buf_state, td->rand_seeds[FIO_RAND_BUF_OFF]);
4c07ad86
JA
713}
714
de890a1e
SL
715/*
716 * Initializes the ioengine configured for a job, if it has not been done so
717 * already.
718 */
719int ioengine_load(struct thread_data *td)
720{
721 const char *engine;
722
723 /*
724 * Engine has already been loaded.
725 */
726 if (td->io_ops)
727 return 0;
728
729 engine = get_engine_name(td->o.ioengine);
730 td->io_ops = load_ioengine(td, engine);
731 if (!td->io_ops) {
732 log_err("fio: failed to load engine %s\n", engine);
733 return 1;
734 }
735
736 if (td->io_ops->option_struct_size && td->io_ops->options) {
737 /*
738 * In cases where td->eo is set, clone it for a child thread.
739 * This requires that the parent thread has the same ioengine,
740 * but that requirement must be enforced by the code which
741 * cloned the thread.
742 */
743 void *origeo = td->eo;
744 /*
745 * Otherwise use the default thread options.
746 */
747 if (!origeo && td != &def_thread && def_thread.eo &&
748 def_thread.io_ops->options == td->io_ops->options)
749 origeo = def_thread.eo;
750
751 options_init(td->io_ops->options);
752 td->eo = malloc(td->io_ops->option_struct_size);
753 /*
754 * Use the default thread as an option template if this uses the
755 * same options structure and there are non-default options
756 * used.
757 */
758 if (origeo) {
759 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
760 options_mem_dupe(td->eo, td->io_ops->options);
761 } else {
762 memset(td->eo, 0, td->io_ops->option_struct_size);
763 fill_default_options(td->eo, td->io_ops->options);
764 }
765 *(struct thread_data **)td->eo = td;
766 }
767
768 return 0;
769}
770
d72be545
JA
771static void init_flags(struct thread_data *td)
772{
773 struct thread_options *o = &td->o;
774
775 if (o->verify_backlog)
776 td->flags |= TD_F_VER_BACKLOG;
777 if (o->trim_backlog)
778 td->flags |= TD_F_TRIM_BACKLOG;
779 if (o->read_iolog_file)
780 td->flags |= TD_F_READ_IOLOG;
781 if (o->refill_buffers)
782 td->flags |= TD_F_REFILL_BUFFERS;
783 if (o->scramble_buffers)
784 td->flags |= TD_F_SCRAMBLE_BUFFERS;
785 if (o->verify != VERIFY_NONE)
786 td->flags |= TD_F_VER_NONE;
787}
788
9dbc7bfe
JA
789static int setup_random_seeds(struct thread_data *td)
790{
791 unsigned long seed;
792 unsigned int i;
793
794 if (!td->o.rand_repeatable)
795 return init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds));
796
797 for (seed = 0x89, i = 0; i < 4; i++)
798 seed *= 0x9e370001UL;
799
800 for (i = 0; i < FIO_RAND_NR_OFFS; i++) {
801 td->rand_seeds[i] = seed;
802 seed *= 0x9e370001UL;
803 }
804
805 td_fill_rand_seeds(td);
806 return 0;
807}
808
de98bd30
JA
809enum {
810 FPRE_NONE = 0,
811 FPRE_JOBNAME,
812 FPRE_JOBNUM,
813 FPRE_FILENUM
814};
815
816static struct fpre_keyword {
817 const char *keyword;
818 size_t strlen;
819 int key;
820} fpre_keywords[] = {
821 { .keyword = "$jobname", .key = FPRE_JOBNAME, },
822 { .keyword = "$jobnum", .key = FPRE_JOBNUM, },
823 { .keyword = "$filenum", .key = FPRE_FILENUM, },
824 { .keyword = NULL, },
825 };
826
827static char *make_filename(char *buf, struct thread_options *o,
828 const char *jobname, int jobnum, int filenum)
829{
830 struct fpre_keyword *f;
831 char copy[PATH_MAX];
832
833 if (!o->filename_format || !strlen(o->filename_format)) {
834 sprintf(buf, "%s.%d.%d", jobname, jobnum, filenum);
835 return NULL;
836 }
837
838 for (f = &fpre_keywords[0]; f->keyword; f++)
839 f->strlen = strlen(f->keyword);
840
841 strcpy(buf, o->filename_format);
842 memset(copy, 0, sizeof(copy));
843 for (f = &fpre_keywords[0]; f->keyword; f++) {
844 do {
845 size_t pre_len, post_start = 0;
846 char *str, *dst = copy;
847
e25b6d5a 848 str = strcasestr(buf, f->keyword);
de98bd30
JA
849 if (!str)
850 break;
851
852 pre_len = str - buf;
853 if (strlen(str) != f->strlen)
854 post_start = pre_len + f->strlen;
855
856 if (pre_len) {
857 strncpy(dst, buf, pre_len);
858 dst += pre_len;
859 }
860
861 switch (f->key) {
862 case FPRE_JOBNAME:
863 dst += sprintf(dst, "%s", jobname);
864 break;
865 case FPRE_JOBNUM:
866 dst += sprintf(dst, "%d", jobnum);
867 break;
868 case FPRE_FILENUM:
869 dst += sprintf(dst, "%d", filenum);
870 break;
871 default:
872 assert(0);
873 break;
874 }
875
876 if (post_start)
877 strcpy(dst, buf + post_start);
878
879 strcpy(buf, copy);
880 } while (1);
881 }
882
883 return buf;
884}
906c8d75
JA
885/*
886 * Adds a job to the list of things todo. Sanitizes the various options
887 * to make sure we don't have conflicts, and initializes various
888 * members of td.
889 */
75154845 890static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
ebac4655 891{
413dd459 892 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
6eaf09d6
SL
893 "randread", "randwrite", "randrw",
894 "trim", NULL, NULL, NULL, "randtrim" };
af52b345 895 unsigned int i;
af52b345 896 char fname[PATH_MAX];
e132cbae 897 int numjobs, file_alloced;
de98bd30 898 struct thread_options *o = &td->o;
ebac4655 899
ebac4655
JA
900 /*
901 * the def_thread is just for options, it's not a real job
902 */
903 if (td == &def_thread)
904 return 0;
905
d72be545
JA
906 init_flags(td);
907
cca73aa7
JA
908 /*
909 * if we are just dumping the output command line, don't add the job
910 */
111e032d 911 if (dump_cmdline || parse_only) {
cca73aa7
JA
912 put_job(td);
913 return 0;
914 }
915
58c55ba0 916 if (profile_td_init(td))
66251554 917 goto err;
58c55ba0 918
de890a1e 919 if (ioengine_load(td))
205927a3 920 goto err;
df64119d 921
de98bd30 922 if (o->use_thread)
9cedf167
JA
923 nr_thread++;
924 else
925 nr_process++;
926
de98bd30 927 if (o->odirect)
690adba3
JA
928 td->io_ops->flags |= FIO_RAWIO;
929
e132cbae 930 file_alloced = 0;
de98bd30 931 if (!o->filename && !td->files_index && !o->read_iolog_file) {
e132cbae 932 file_alloced = 1;
80be24f4 933
de98bd30 934 if (o->nr_files == 1 && exists_and_not_file(jobname))
e132cbae 935 add_file(td, jobname);
7b05a215 936 else {
de98bd30
JA
937 for (i = 0; i < o->nr_files; i++)
938 add_file(td, make_filename(fname, o, jobname, td->thread_number, i));
af52b345 939 }
0af7b542 940 }
ebac4655 941
4e991c23
JA
942 if (fixup_options(td))
943 goto err;
e0a22335 944
9e684a49
DE
945 flow_init_job(td);
946
de890a1e
SL
947 /*
948 * IO engines only need this for option callbacks, and the address may
949 * change in subprocesses.
950 */
951 if (td->eo)
952 *(struct thread_data **)td->eo = NULL;
953
07eb79df
JA
954 if (td->io_ops->flags & FIO_DISKLESSIO) {
955 struct fio_file *f;
956
957 for_each_file(td, f, i)
958 f->real_file_size = -1ULL;
959 }
960
521da527 961 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
ebac4655 962
de98bd30
JA
963 td->ts.clat_percentiles = o->clat_percentiles;
964 td->ts.percentile_precision = o->percentile_precision;
965 memcpy(td->ts.percentile_list, o->percentile_list, sizeof(o->percentile_list));
83349190 966
6eaf09d6
SL
967 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
968 td->ts.clat_stat[i].min_val = ULONG_MAX;
969 td->ts.slat_stat[i].min_val = ULONG_MAX;
970 td->ts.lat_stat[i].min_val = ULONG_MAX;
971 td->ts.bw_stat[i].min_val = ULONG_MAX;
972 }
de98bd30 973 td->ddir_seq_nr = o->ddir_seq_nr;
ebac4655 974
de98bd30 975 if ((o->stonewall || o->new_group) && prev_group_jobs) {
3c5df6fa 976 prev_group_jobs = 0;
ebac4655 977 groupid++;
3c5df6fa 978 }
ebac4655
JA
979
980 td->groupid = groupid;
3c5df6fa 981 prev_group_jobs++;
ebac4655 982
9dbc7bfe 983 if (setup_random_seeds(td)) {
93bcfd20 984 td_verror(td, errno, "init_random_state");
9c60ce64 985 goto err;
93bcfd20 986 }
9c60ce64 987
ebac4655
JA
988 if (setup_rate(td))
989 goto err;
990
de98bd30
JA
991 if (o->write_lat_log) {
992 setup_log(&td->lat_log, o->log_avg_msec);
993 setup_log(&td->slat_log, o->log_avg_msec);
994 setup_log(&td->clat_log, o->log_avg_msec);
ebac4655 995 }
de98bd30
JA
996 if (o->write_bw_log)
997 setup_log(&td->bw_log, o->log_avg_msec);
998 if (o->write_iops_log)
999 setup_log(&td->iops_log, o->log_avg_msec);
ebac4655 1000
de98bd30
JA
1001 if (!o->name)
1002 o->name = strdup(jobname);
01452055 1003
f3afa57e 1004 if (output_format == FIO_OUTPUT_NORMAL) {
b990b5c0 1005 if (!job_add_num) {
5ec10eaa
JA
1006 if (!strcmp(td->io_ops->name, "cpuio")) {
1007 log_info("%s: ioengine=cpu, cpuload=%u,"
de98bd30
JA
1008 " cpucycle=%u\n", o->name,
1009 o->cpuload, o->cpucycle);
5ec10eaa 1010 } else {
6eaf09d6 1011 char *c1, *c2, *c3, *c4, *c5, *c6;
f8977ee6 1012
de98bd30
JA
1013 c1 = to_kmg(o->min_bs[DDIR_READ]);
1014 c2 = to_kmg(o->max_bs[DDIR_READ]);
1015 c3 = to_kmg(o->min_bs[DDIR_WRITE]);
1016 c4 = to_kmg(o->max_bs[DDIR_WRITE]);
1017 c5 = to_kmg(o->min_bs[DDIR_TRIM]);
1018 c6 = to_kmg(o->max_bs[DDIR_TRIM]);
f8977ee6 1019
6eaf09d6 1020 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
5ec10eaa 1021 " ioengine=%s, iodepth=%u\n",
de98bd30
JA
1022 o->name, td->groupid,
1023 ddir_str[o->td_ddir],
6eaf09d6 1024 c1, c2, c3, c4, c5, c6,
de98bd30 1025 td->io_ops->name, o->iodepth);
f8977ee6
JA
1026
1027 free(c1);
1028 free(c2);
1029 free(c3);
1030 free(c4);
6eaf09d6
SL
1031 free(c5);
1032 free(c6);
f8977ee6 1033 }
b990b5c0 1034 } else if (job_add_num == 1)
6d86144d 1035 log_info("...\n");
c6ae0a5b 1036 }
ebac4655
JA
1037
1038 /*
1039 * recurse add identical jobs, clear numjobs and stonewall options
1040 * as they don't apply to sub-jobs
1041 */
de98bd30 1042 numjobs = o->numjobs;
ebac4655 1043 while (--numjobs) {
de890a1e 1044 struct thread_data *td_new = get_new_job(0, td, 1);
ebac4655
JA
1045
1046 if (!td_new)
1047 goto err;
1048
2dc1bbeb
JA
1049 td_new->o.numjobs = 1;
1050 td_new->o.stonewall = 0;
92c1d41f 1051 td_new->o.new_group = 0;
e132cbae
JA
1052
1053 if (file_alloced) {
2dc1bbeb 1054 td_new->o.filename = NULL;
e132cbae 1055 td_new->files_index = 0;
4e6ea2f1 1056 td_new->files_size = 0;
e132cbae
JA
1057 td_new->files = NULL;
1058 }
1059
75154845 1060 job_add_num = numjobs - 1;
ebac4655 1061
75154845 1062 if (add_job(td_new, jobname, job_add_num))
ebac4655
JA
1063 goto err;
1064 }
3c5df6fa 1065
ebac4655
JA
1066 return 0;
1067err:
1068 put_job(td);
1069 return -1;
1070}
1071
79d16311
JA
1072/*
1073 * Parse as if 'o' was a command line
1074 */
1075void add_job_opts(const char **o)
1076{
1077 struct thread_data *td, *td_parent;
1078 int i, in_global = 1;
1079 char jobname[32];
1080
1081 i = 0;
1082 td_parent = td = NULL;
1083 while (o[i]) {
1084 if (!strncmp(o[i], "name", 4)) {
1085 in_global = 0;
1086 if (td)
1087 add_job(td, jobname, 0);
1088 td = NULL;
1089 sprintf(jobname, "%s", o[i] + 5);
1090 }
1091 if (in_global && !td_parent)
de890a1e 1092 td_parent = get_new_job(1, &def_thread, 0);
79d16311
JA
1093 else if (!in_global && !td) {
1094 if (!td_parent)
1095 td_parent = &def_thread;
de890a1e 1096 td = get_new_job(0, td_parent, 0);
79d16311
JA
1097 }
1098 if (in_global)
1099 fio_options_parse(td_parent, (char **) &o[i], 1);
1100 else
1101 fio_options_parse(td, (char **) &o[i], 1);
1102 i++;
1103 }
1104
1105 if (td)
1106 add_job(td, jobname, 0);
1107}
1108
01f06b63
JA
1109static int skip_this_section(const char *name)
1110{
ad0a2735
JA
1111 int i;
1112
1113 if (!nr_job_sections)
01f06b63
JA
1114 return 0;
1115 if (!strncmp(name, "global", 6))
1116 return 0;
1117
ad0a2735
JA
1118 for (i = 0; i < nr_job_sections; i++)
1119 if (!strcmp(job_sections[i], name))
1120 return 0;
1121
1122 return 1;
01f06b63
JA
1123}
1124
ebac4655
JA
1125static int is_empty_or_comment(char *line)
1126{
1127 unsigned int i;
1128
1129 for (i = 0; i < strlen(line); i++) {
1130 if (line[i] == ';')
1131 return 1;
5cc2da30
IM
1132 if (line[i] == '#')
1133 return 1;
76cd9378 1134 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
ebac4655
JA
1135 return 0;
1136 }
1137
1138 return 1;
1139}
1140
07261983
JA
1141/*
1142 * This is our [ini] type file parser.
1143 */
50d16976 1144int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
ebac4655 1145{
e1f36503 1146 unsigned int global;
ebac4655 1147 struct thread_data *td;
fee3bb48 1148 char *string, *name;
ebac4655
JA
1149 FILE *f;
1150 char *p;
0c7e37a0 1151 int ret = 0, stonewall;
097b2991 1152 int first_sect = 1;
ccf8f127 1153 int skip_fgets = 0;
01f06b63 1154 int inside_skip = 0;
3b8b7135
JA
1155 char **opts;
1156 int i, alloc_opts, num_opts;
ebac4655 1157
50d16976
JA
1158 if (is_buf)
1159 f = NULL;
1160 else {
1161 if (!strcmp(file, "-"))
1162 f = stdin;
1163 else
1164 f = fopen(file, "r");
5a729cbe 1165
50d16976
JA
1166 if (!f) {
1167 perror("fopen job file");
1168 return 1;
1169 }
ebac4655
JA
1170 }
1171
1172 string = malloc(4096);
7f7e6e59
JA
1173
1174 /*
1175 * it's really 256 + small bit, 280 should suffice
1176 */
1177 name = malloc(280);
1178 memset(name, 0, 280);
ebac4655 1179
3b8b7135
JA
1180 alloc_opts = 8;
1181 opts = malloc(sizeof(char *) * alloc_opts);
b7c6302d 1182 num_opts = 0;
3b8b7135 1183
0c7e37a0 1184 stonewall = stonewall_flag;
7c124ac1 1185 do {
ccf8f127
JA
1186 /*
1187 * if skip_fgets is set, we already have loaded a line we
1188 * haven't handled.
1189 */
1190 if (!skip_fgets) {
50d16976
JA
1191 if (is_buf)
1192 p = strsep(&file, "\n");
1193 else
43f74792 1194 p = fgets(string, 4096, f);
ccf8f127
JA
1195 if (!p)
1196 break;
1197 }
cdc7f193 1198
ccf8f127 1199 skip_fgets = 0;
cdc7f193 1200 strip_blank_front(&p);
6c7c7da1 1201 strip_blank_end(p);
cdc7f193 1202
ebac4655
JA
1203 if (is_empty_or_comment(p))
1204 continue;
84dd1886 1205 if (sscanf(p, "[%255[^\n]]", name) != 1) {
01f06b63
JA
1206 if (inside_skip)
1207 continue;
5ec10eaa
JA
1208 log_err("fio: option <%s> outside of [] job section\n",
1209 p);
088b4207 1210 break;
6c7c7da1 1211 }
ebac4655 1212
7a4b80a1
JA
1213 name[strlen(name) - 1] = '\0';
1214
01f06b63
JA
1215 if (skip_this_section(name)) {
1216 inside_skip = 1;
1217 continue;
1218 } else
1219 inside_skip = 0;
1220
ebac4655
JA
1221 global = !strncmp(name, "global", 6);
1222
cca73aa7 1223 if (dump_cmdline) {
097b2991
JA
1224 if (first_sect)
1225 log_info("fio ");
cca73aa7
JA
1226 if (!global)
1227 log_info("--name=%s ", name);
097b2991 1228 first_sect = 0;
cca73aa7
JA
1229 }
1230
de890a1e 1231 td = get_new_job(global, &def_thread, 0);
45410acb
JA
1232 if (!td) {
1233 ret = 1;
1234 break;
1235 }
ebac4655 1236
972cfd25
JA
1237 /*
1238 * Seperate multiple job files by a stonewall
1239 */
f9481919 1240 if (!global && stonewall) {
2dc1bbeb 1241 td->o.stonewall = stonewall;
972cfd25
JA
1242 stonewall = 0;
1243 }
1244
3b8b7135
JA
1245 num_opts = 0;
1246 memset(opts, 0, alloc_opts * sizeof(char *));
1247
50d16976
JA
1248 while (1) {
1249 if (is_buf)
1250 p = strsep(&file, "\n");
1251 else
1252 p = fgets(string, 4096, f);
1253 if (!p)
1254 break;
1255
ebac4655
JA
1256 if (is_empty_or_comment(p))
1257 continue;
e1f36503 1258
b6754f9d 1259 strip_blank_front(&p);
7c124ac1 1260
ccf8f127
JA
1261 /*
1262 * new section, break out and make sure we don't
1263 * fgets() a new line at the top.
1264 */
1265 if (p[0] == '[') {
1266 skip_fgets = 1;
7c124ac1 1267 break;
ccf8f127 1268 }
7c124ac1 1269
4ae3f763 1270 strip_blank_end(p);
aea47d44 1271
3b8b7135
JA
1272 if (num_opts == alloc_opts) {
1273 alloc_opts <<= 1;
1274 opts = realloc(opts,
1275 alloc_opts * sizeof(char *));
1276 }
1277
1278 opts[num_opts] = strdup(p);
1279 num_opts++;
ebac4655 1280 }
ebac4655 1281
3b8b7135
JA
1282 ret = fio_options_parse(td, opts, num_opts);
1283 if (!ret) {
1284 if (dump_cmdline)
1285 for (i = 0; i < num_opts; i++)
1286 log_info("--%s ", opts[i]);
1287
45410acb 1288 ret = add_job(td, name, 0);
3b8b7135 1289 } else {
b1508cf9
JA
1290 log_err("fio: job %s dropped\n", name);
1291 put_job(td);
45410acb 1292 }
3b8b7135
JA
1293
1294 for (i = 0; i < num_opts; i++)
1295 free(opts[i]);
1296 num_opts = 0;
7c124ac1 1297 } while (!ret);
ebac4655 1298
cca73aa7
JA
1299 if (dump_cmdline)
1300 log_info("\n");
1301
7e356b2d
JA
1302 i = 0;
1303 while (i < nr_job_sections) {
1304 free(job_sections[i]);
1305 i++;
1306 }
1307
3b8b7135
JA
1308 for (i = 0; i < num_opts; i++)
1309 free(opts[i]);
1310
ebac4655
JA
1311 free(string);
1312 free(name);
2577594d 1313 free(opts);
50d16976 1314 if (!is_buf && f != stdin)
5a729cbe 1315 fclose(f);
45410acb 1316 return ret;
ebac4655
JA
1317}
1318
1319static int fill_def_thread(void)
1320{
1321 memset(&def_thread, 0, sizeof(def_thread));
1322
375b2695 1323 fio_getaffinity(getpid(), &def_thread.o.cpumask);
8c029376 1324 def_thread.o.timeout = def_timeout;
8b28bd41 1325 def_thread.o.error_dump = 1;
ebac4655 1326 /*
ee738499 1327 * fill default options
ebac4655 1328 */
214e1eca 1329 fio_fill_default_options(&def_thread);
ebac4655
JA
1330 return 0;
1331}
1332
45378b35 1333static void usage(const char *name)
4785f995 1334{
692a5d22 1335 printf("%s\n", fio_version_string);
45378b35 1336 printf("%s [options] [job options] <job file(s)>\n", name);
83881283
JA
1337 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1338 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1339 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
111e032d 1340 printf(" --parse-only\t\tParse options only, don't start any IO\n");
83881283 1341 printf(" --output\t\tWrite output to file\n");
b2cecdc2 1342 printf(" --runtime\t\tRuntime in seconds\n");
83881283
JA
1343 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1344 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1345 printf(" --minimal\t\tMinimal (terse) output\n");
f3afa57e 1346 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
75db6e2c 1347 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
f3afa57e 1348 printf(" --version\t\tPrint version info and exit\n");
83881283 1349 printf(" --help\t\tPrint this page\n");
23893646 1350 printf(" --cpuclock-test\tPerform test/validation of CPU clock\n");
83881283 1351 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
5ec10eaa 1352 " them\n");
de890a1e
SL
1353 printf(" --enghelp=engine\tPrint ioengine help, or list"
1354 " available ioengines\n");
1355 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1356 " cmd\n");
83881283
JA
1357 printf(" --showcmd\t\tTurn a job file into command line options\n");
1358 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1359 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
e382e661
JA
1360 printf(" --eta-newline=time\tForce a new line for every 'time'");
1361 printf(" period passed\n");
83881283 1362 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
5ec10eaa 1363 " writes\n");
83881283
JA
1364 printf(" --section=name\tOnly run specified section in job file\n");
1365 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2b386d25 1366 " (def 1024)\n");
83881283
JA
1367 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1368 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1369 printf(" --server=args\t\tStart a backend fio server\n");
1370 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1371 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
f2a2ce0e
HL
1372 printf(" --idle-prof=option\tReport cpu idleness on a system or percpu basis\n"
1373 "\t\t\t(option=system,percpu) or run unit work\n"
1374 "\t\t\tcalibration only (option=calibrate)\n");
aa58d252 1375 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
23893646 1376 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
4785f995
JA
1377}
1378
79e48f72 1379#ifdef FIO_INC_DEBUG
ee56ad50 1380struct debug_level debug_levels[] = {
bd6f78b2
JA
1381 { .name = "process", .shift = FD_PROCESS, },
1382 { .name = "file", .shift = FD_FILE, },
1383 { .name = "io", .shift = FD_IO, },
1384 { .name = "mem", .shift = FD_MEM, },
1385 { .name = "blktrace", .shift = FD_BLKTRACE },
1386 { .name = "verify", .shift = FD_VERIFY },
84422acd 1387 { .name = "random", .shift = FD_RANDOM },
a3d741fa 1388 { .name = "parse", .shift = FD_PARSE },
cd991b9e 1389 { .name = "diskutil", .shift = FD_DISKUTIL },
5e1d306e 1390 { .name = "job", .shift = FD_JOB },
29adda3c 1391 { .name = "mutex", .shift = FD_MUTEX },
79d16311 1392 { .name = "profile", .shift = FD_PROFILE },
c223da83 1393 { .name = "time", .shift = FD_TIME },
eb7976ef 1394 { .name = "net", .shift = FD_NET },
02444ad1 1395 { .name = NULL, },
ee56ad50
JA
1396};
1397
c09823ab 1398static int set_debug(const char *string)
ee56ad50
JA
1399{
1400 struct debug_level *dl;
1401 char *p = (char *) string;
1402 char *opt;
1403 int i;
1404
1405 if (!strcmp(string, "?") || !strcmp(string, "help")) {
ee56ad50
JA
1406 log_info("fio: dumping debug options:");
1407 for (i = 0; debug_levels[i].name; i++) {
1408 dl = &debug_levels[i];
1409 log_info("%s,", dl->name);
1410 }
bd6f78b2 1411 log_info("all\n");
c09823ab 1412 return 1;
ee56ad50
JA
1413 }
1414
1415 while ((opt = strsep(&p, ",")) != NULL) {
1416 int found = 0;
1417
5e1d306e
JA
1418 if (!strncmp(opt, "all", 3)) {
1419 log_info("fio: set all debug options\n");
1420 fio_debug = ~0UL;
1421 continue;
1422 }
1423
ee56ad50
JA
1424 for (i = 0; debug_levels[i].name; i++) {
1425 dl = &debug_levels[i];
5e1d306e
JA
1426 found = !strncmp(opt, dl->name, strlen(dl->name));
1427 if (!found)
1428 continue;
1429
1430 if (dl->shift == FD_JOB) {
1431 opt = strchr(opt, ':');
1432 if (!opt) {
1433 log_err("fio: missing job number\n");
1434 break;
1435 }
1436 opt++;
1437 fio_debug_jobno = atoi(opt);
1438 log_info("fio: set debug jobno %d\n",
1439 fio_debug_jobno);
1440 } else {
ee56ad50 1441 log_info("fio: set debug option %s\n", opt);
bd6f78b2 1442 fio_debug |= (1UL << dl->shift);
ee56ad50 1443 }
5e1d306e 1444 break;
ee56ad50
JA
1445 }
1446
1447 if (!found)
1448 log_err("fio: debug mask %s not found\n", opt);
1449 }
c09823ab 1450 return 0;
ee56ad50 1451}
79e48f72 1452#else
69b98d4c 1453static int set_debug(const char *string)
79e48f72
JA
1454{
1455 log_err("fio: debug tracing not included in build\n");
c09823ab 1456 return 1;
79e48f72
JA
1457}
1458#endif
9ac8a797 1459
4c6107ff
JA
1460static void fio_options_fill_optstring(void)
1461{
1462 char *ostr = cmd_optstr;
1463 int i, c;
1464
1465 c = i = 0;
1466 while (l_opts[i].name) {
1467 ostr[c++] = l_opts[i].val;
1468 if (l_opts[i].has_arg == required_argument)
1469 ostr[c++] = ':';
1470 else if (l_opts[i].has_arg == optional_argument) {
1471 ostr[c++] = ':';
1472 ostr[c++] = ':';
1473 }
1474 i++;
1475 }
1476 ostr[c] = '\0';
1477}
1478
c2c94585
JA
1479static int client_flag_set(char c)
1480{
1481 int i;
1482
1483 i = 0;
1484 while (l_opts[i].name) {
1485 int val = l_opts[i].val;
1486
1487 if (c == (val & 0xff))
1488 return (val & FIO_CLIENT_FLAG);
1489
1490 i++;
1491 }
1492
1493 return 0;
1494}
1495
fa2ea806 1496void parse_cmd_client(void *client, char *opt)
7a4b8240 1497{
fa2ea806 1498 fio_client_add_cmd_option(client, opt);
7a4b8240
JA
1499}
1500
81179eec 1501int parse_cmd_line(int argc, char *argv[])
ebac4655 1502{
b4692828 1503 struct thread_data *td = NULL;
c09823ab 1504 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
4c6107ff 1505 char *ostr = cmd_optstr;
402668f3 1506 void *pid_file = NULL;
9bae26e8 1507 void *cur_client = NULL;
81179eec 1508 int backend = 0;
ebac4655 1509
c2c94585
JA
1510 /*
1511 * Reset optind handling, since we may call this multiple times
1512 * for the backend.
1513 */
1514 optind = 1;
7a4b8240 1515
c2c94585 1516 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
085399db
JA
1517 did_arg = 1;
1518
c2c94585 1519 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
fa2ea806 1520 parse_cmd_client(cur_client, argv[optind - 1]);
7a4b8240
JA
1521 c &= ~FIO_CLIENT_FLAG;
1522 }
1523
ebac4655 1524 switch (c) {
2b386d25
JA
1525 case 'a':
1526 smalloc_pool_size = atoi(optarg);
1527 break;
b4692828 1528 case 't':
8c029376 1529 def_timeout = atoi(optarg);
b4692828
JA
1530 break;
1531 case 'l':
1532 write_lat_log = 1;
1533 break;
3d73e5a9 1534 case 'b':
b4692828
JA
1535 write_bw_log = 1;
1536 break;
1537 case 'o':
1538 f_out = fopen(optarg, "w+");
1539 if (!f_out) {
1540 perror("fopen output");
1541 exit(1);
1542 }
1543 f_err = f_out;
1544 break;
1545 case 'm':
f3afa57e 1546 output_format = FIO_OUTPUT_TERSE;
b4692828 1547 break;
f3afa57e
JA
1548 case 'F':
1549 if (!strcmp(optarg, "minimal") ||
1550 !strcmp(optarg, "terse") ||
1551 !strcmp(optarg, "csv"))
1552 output_format = FIO_OUTPUT_TERSE;
1553 else if (!strcmp(optarg, "json"))
1554 output_format = FIO_OUTPUT_JSON;
1555 else
1556 output_format = FIO_OUTPUT_NORMAL;
cc372b17 1557 break;
b4692828 1558 case 'h':
7874f8b7 1559 if (!cur_client) {
c2c94585 1560 usage(argv[0]);
7874f8b7
JA
1561 do_exit++;
1562 }
c2c94585 1563 break;
fd28ca49 1564 case 'c':
7874f8b7 1565 if (!cur_client) {
c2c94585 1566 fio_show_option_help(optarg);
7874f8b7
JA
1567 do_exit++;
1568 }
c2c94585 1569 break;
de890a1e
SL
1570 case 'i':
1571 if (!cur_client) {
1572 fio_show_ioengine_help(optarg);
1573 do_exit++;
1574 }
1575 break;
cca73aa7
JA
1576 case 's':
1577 dump_cmdline = 1;
1578 break;
724e4435
JA
1579 case 'r':
1580 read_only = 1;
1581 break;
b4692828 1582 case 'v':
7874f8b7 1583 if (!cur_client) {
692a5d22 1584 log_info("%s\n", fio_version_string);
7874f8b7
JA
1585 do_exit++;
1586 }
c2c94585 1587 break;
f57a9c59
JA
1588 case 'V':
1589 terse_version = atoi(optarg);
67b77039
JA
1590 if (!(terse_version == 2 || terse_version == 3 ||
1591 terse_version == 4)) {
f57a9c59
JA
1592 log_err("fio: bad terse version format\n");
1593 exit_val = 1;
1594 do_exit++;
1595 }
1596 break;
e592a06b
AC
1597 case 'e':
1598 if (!strcmp("always", optarg))
1599 eta_print = FIO_ETA_ALWAYS;
1600 else if (!strcmp("never", optarg))
1601 eta_print = FIO_ETA_NEVER;
1602 break;
e382e661
JA
1603 case 'E': {
1604 long long t = 0;
1605
1606 if (str_to_decimal(optarg, &t, 0, NULL)) {
1607 log_err("fio: failed parsing eta time %s\n", optarg);
1608 exit_val = 1;
1609 do_exit++;
1610 }
1611 eta_new_line = t;
1612 break;
1613 }
ee56ad50 1614 case 'd':
c09823ab
JA
1615 if (set_debug(optarg))
1616 do_exit++;
ee56ad50 1617 break;
111e032d
JA
1618 case 'P':
1619 parse_only = 1;
1620 break;
ad0a2735
JA
1621 case 'x': {
1622 size_t new_size;
1623
01f06b63 1624 if (!strcmp(optarg, "global")) {
5ec10eaa
JA
1625 log_err("fio: can't use global as only "
1626 "section\n");
c09823ab
JA
1627 do_exit++;
1628 exit_val = 1;
01f06b63
JA
1629 break;
1630 }
ad0a2735
JA
1631 new_size = (nr_job_sections + 1) * sizeof(char *);
1632 job_sections = realloc(job_sections, new_size);
1633 job_sections[nr_job_sections] = strdup(optarg);
1634 nr_job_sections++;
01f06b63 1635 break;
ad0a2735 1636 }
9ac8a797 1637 case 'p':
07b3232d 1638 exec_profile = strdup(optarg);
9ac8a797 1639 break;
b4692828 1640 case FIO_GETOPT_JOB: {
5ec10eaa 1641 const char *opt = l_opts[lidx].name;
b4692828
JA
1642 char *val = optarg;
1643
c2b1e753 1644 if (!strncmp(opt, "name", 4) && td) {
2dc1bbeb 1645 ret = add_job(td, td->o.name ?: "fio", 0);
66251554 1646 if (ret)
c2b1e753 1647 return 0;
c2b1e753
JA
1648 td = NULL;
1649 }
b4692828 1650 if (!td) {
01f06b63 1651 int is_section = !strncmp(opt, "name", 4);
3106f220
JA
1652 int global = 0;
1653
01f06b63 1654 if (!is_section || !strncmp(val, "global", 6))
3106f220 1655 global = 1;
c2b1e753 1656
01f06b63
JA
1657 if (is_section && skip_this_section(val))
1658 continue;
1659
de890a1e
SL
1660 td = get_new_job(global, &def_thread, 1);
1661 if (!td || ioengine_load(td))
b4692828 1662 return 0;
de890a1e 1663 fio_options_set_ioengine_opts(l_opts, td);
b4692828 1664 }
38d0adb0 1665
214e1eca 1666 ret = fio_cmd_option_parse(td, opt, val);
de890a1e
SL
1667
1668 if (!ret && !strcmp(opt, "ioengine")) {
1669 free_ioengine(td);
1670 if (ioengine_load(td))
1671 return 0;
1672 fio_options_set_ioengine_opts(l_opts, td);
1673 }
1674 break;
1675 }
1676 case FIO_GETOPT_IOENGINE: {
1677 const char *opt = l_opts[lidx].name;
1678 char *val = optarg;
1679 opt = l_opts[lidx].name;
1680 val = optarg;
1681 ret = fio_cmd_ioengine_option_parse(td, opt, val);
b4692828
JA
1682 break;
1683 }
a9523c6f
JA
1684 case 'w':
1685 warnings_fatal = 1;
1686 break;
fca70358
JA
1687 case 'j':
1688 max_jobs = atoi(optarg);
1689 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1690 log_err("fio: invalid max jobs: %d\n", max_jobs);
1691 do_exit++;
1692 exit_val = 1;
1693 }
1694 break;
50d16976 1695 case 'S':
a37f69b7 1696 if (nr_clients) {
132159a5
JA
1697 log_err("fio: can't be both client and server\n");
1698 do_exit++;
1699 exit_val = 1;
1700 break;
1701 }
87aa8f19 1702 if (optarg)
bebe6398 1703 fio_server_set_arg(optarg);
50d16976 1704 is_backend = 1;
81179eec 1705 backend = 1;
50d16976 1706 break;
e46d8091 1707 case 'D':
402668f3 1708 pid_file = strdup(optarg);
e46d8091 1709 break;
f2a2ce0e
HL
1710 case 'I':
1711 if ((ret = fio_idle_prof_parse_opt(optarg))) {
1712 /* exit on error and calibration only */
1713 do_exit++;
1714 if (ret == -1)
1715 exit_val = 1;
1716 }
1717 break;
132159a5
JA
1718 case 'C':
1719 if (is_backend) {
1720 log_err("fio: can't be both client and server\n");
1721 do_exit++;
1722 exit_val = 1;
1723 break;
1724 }
bebe6398
JA
1725 if (fio_client_add(optarg, &cur_client)) {
1726 log_err("fio: failed adding client %s\n", optarg);
1727 do_exit++;
1728 exit_val = 1;
1729 break;
1730 }
bd023601
JA
1731 /*
1732 * If the next argument exists and isn't an option,
1733 * assume it's a job file for this client only.
1734 */
1735 while (optind < argc) {
1736 if (!strncmp(argv[optind], "--", 2) ||
1737 !strncmp(argv[optind], "-", 1))
1738 break;
1739
1740 fio_client_add_ini_file(cur_client, argv[optind]);
1741 optind++;
1742 }
132159a5 1743 break;
7d11f871
JA
1744 case 'T':
1745 do_exit++;
1746 exit_val = fio_monotonic_clocktest();
1747 break;
798827c8
JA
1748 case '?':
1749 log_err("%s: unrecognized option '%s'\n", argv[0],
1750 argv[optind - 1]);
b4692828 1751 default:
c09823ab
JA
1752 do_exit++;
1753 exit_val = 1;
b4692828 1754 break;
ebac4655 1755 }
c7d5c941
JA
1756 if (do_exit)
1757 break;
ebac4655 1758 }
c9fad893 1759
c2c94585
JA
1760 if (do_exit) {
1761 if (exit_val && !(is_backend || nr_clients))
1762 exit(exit_val);
1763 }
536582bf 1764
a37f69b7 1765 if (nr_clients && fio_clients_connect()) {
132159a5
JA
1766 do_exit++;
1767 exit_val = 1;
cdf54d85 1768 return -1;
132159a5
JA
1769 }
1770
81179eec 1771 if (is_backend && backend)
402668f3 1772 return fio_start_server(pid_file);
50d16976 1773
b4692828 1774 if (td) {
7d6a8904 1775 if (!ret)
2dc1bbeb 1776 ret = add_job(td, td->o.name ?: "fio", 0);
972cfd25 1777 }
774a6177 1778
7874f8b7 1779 while (!ret && optind < argc) {
b4692828
JA
1780 ini_idx++;
1781 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1782 ini_file[ini_idx - 1] = strdup(argv[optind]);
1783 optind++;
eb8bbf48 1784 }
972cfd25
JA
1785
1786 return ini_idx;
ebac4655
JA
1787}
1788
ebac4655
JA
1789int parse_options(int argc, char *argv[])
1790{
972cfd25
JA
1791 int job_files, i;
1792
b4692828
JA
1793 f_out = stdout;
1794 f_err = stderr;
1795
4c6107ff 1796 fio_options_fill_optstring();
5ec10eaa 1797 fio_options_dup_and_init(l_opts);
b4692828 1798
9d9eb2e7
JA
1799 atexit(free_shm);
1800
ebac4655
JA
1801 if (fill_def_thread())
1802 return 1;
1803
972cfd25 1804 job_files = parse_cmd_line(argc, argv);
ebac4655 1805
cdf54d85
JA
1806 if (job_files > 0) {
1807 for (i = 0; i < job_files; i++) {
1808 if (fill_def_thread())
132159a5 1809 return 1;
cdf54d85
JA
1810 if (nr_clients) {
1811 if (fio_clients_send_ini(ini_file[i]))
1812 return 1;
1813 free(ini_file[i]);
1814 } else if (!is_backend) {
1815 if (parse_jobs_ini(ini_file[i], 0, i))
1816 return 1;
1817 free(ini_file[i]);
1818 }
132159a5 1819 }
bd023601
JA
1820 } else if (nr_clients) {
1821 if (fill_def_thread())
1822 return 1;
1823 if (fio_clients_send_ini(NULL))
1824 return 1;
972cfd25 1825 }
ebac4655 1826
88c6ed80 1827 free(ini_file);
7e356b2d 1828 fio_options_free(&def_thread);
b4692828
JA
1829
1830 if (!thread_number) {
111e032d 1831 if (dump_cmdline || parse_only)
cca73aa7 1832 return 0;
07b3232d
JA
1833 if (exec_profile)
1834 return 0;
a37f69b7 1835 if (is_backend || nr_clients)
5c341e9a 1836 return 0;
085399db
JA
1837 if (did_arg)
1838 return 0;
cca73aa7 1839
d65e11c6 1840 log_err("No jobs(s) defined\n\n");
085399db
JA
1841
1842 if (!did_arg) {
1843 usage(argv[0]);
1844 return 1;
1845 }
1846
1847 return 0;
b4692828
JA
1848 }
1849
be4ecfdf
JA
1850 if (def_thread.o.gtod_offload) {
1851 fio_gtod_init();
1852 fio_gtod_offload = 1;
1853 fio_gtod_cpu = def_thread.o.gtod_cpu;
1854 }
1855
f3afa57e 1856 if (output_format == FIO_OUTPUT_NORMAL)
692a5d22 1857 log_info("%s\n", fio_version_string);
f6dea4d3 1858
ebac4655
JA
1859 return 0;
1860}