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