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