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