client/server: fixup "All clients" reporting
[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
a9523c6f 599 return ret;
e1f36503
JA
600}
601
f8977ee6
JA
602/*
603 * This function leaks the buffer
604 */
605static char *to_kmg(unsigned int val)
606{
607 char *buf = malloc(32);
f3502ba2 608 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
f8977ee6
JA
609 char *p = post;
610
245142ff 611 do {
f8977ee6
JA
612 if (val & 1023)
613 break;
614
615 val >>= 10;
616 p++;
245142ff 617 } while (*p);
f8977ee6
JA
618
619 snprintf(buf, 31, "%u%c", val, *p);
620 return buf;
621}
622
09629a90
JA
623/* External engines are specified by "external:name.o") */
624static const char *get_engine_name(const char *str)
625{
626 char *p = strstr(str, ":");
627
628 if (!p)
629 return str;
630
631 p++;
632 strip_blank_front(&p);
633 strip_blank_end(p);
634 return p;
635}
636
e132cbae
JA
637static int exists_and_not_file(const char *filename)
638{
639 struct stat sb;
640
641 if (lstat(filename, &sb) == -1)
642 return 0;
643
ecc314ba
BC
644 /* \\.\ is the device namespace in Windows, where every file
645 * is a device node */
646 if (S_ISREG(sb.st_mode) && strncmp(filename, "\\\\.\\", 4) != 0)
e132cbae
JA
647 return 0;
648
649 return 1;
650}
651
4c07ad86 652static void td_fill_rand_seeds_os(struct thread_data *td)
5bfc35d7
JA
653{
654 os_random_seed(td->rand_seeds[0], &td->bsrange_state);
655 os_random_seed(td->rand_seeds[1], &td->verify_state);
656 os_random_seed(td->rand_seeds[2], &td->rwmix_state);
657
658 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
659 os_random_seed(td->rand_seeds[3], &td->next_file_state);
660
661 os_random_seed(td->rand_seeds[5], &td->file_size_state);
0d29de83 662 os_random_seed(td->rand_seeds[6], &td->trim_state);
5bfc35d7
JA
663
664 if (!td_random(td))
665 return;
666
667 if (td->o.rand_repeatable)
668 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
669
670 os_random_seed(td->rand_seeds[4], &td->random_state);
4c07ad86
JA
671}
672
673static void td_fill_rand_seeds_internal(struct thread_data *td)
674{
675 init_rand_seed(&td->__bsrange_state, td->rand_seeds[0]);
676 init_rand_seed(&td->__verify_state, td->rand_seeds[1]);
677 init_rand_seed(&td->__rwmix_state, td->rand_seeds[2]);
678
679 if (td->o.file_service_type == FIO_FSERVICE_RANDOM)
680 init_rand_seed(&td->__next_file_state, td->rand_seeds[3]);
681
682 init_rand_seed(&td->__file_size_state, td->rand_seeds[5]);
683 init_rand_seed(&td->__trim_state, td->rand_seeds[6]);
684
685 if (!td_random(td))
686 return;
687
688 if (td->o.rand_repeatable)
689 td->rand_seeds[4] = FIO_RANDSEED * td->thread_number;
690
2615cc4b 691 init_rand_seed(&td->__random_state, td->rand_seeds[4]);
5bfc35d7
JA
692}
693
4c07ad86
JA
694void td_fill_rand_seeds(struct thread_data *td)
695{
696 if (td->o.use_os_rand)
697 td_fill_rand_seeds_os(td);
698 else
699 td_fill_rand_seeds_internal(td);
3545a109
JA
700
701 init_rand_seed(&td->buf_state, td->rand_seeds[7]);
4c07ad86
JA
702}
703
9c60ce64 704
de890a1e
SL
705/*
706 * Initializes the ioengine configured for a job, if it has not been done so
707 * already.
708 */
709int ioengine_load(struct thread_data *td)
710{
711 const char *engine;
712
713 /*
714 * Engine has already been loaded.
715 */
716 if (td->io_ops)
717 return 0;
718
719 engine = get_engine_name(td->o.ioengine);
720 td->io_ops = load_ioengine(td, engine);
721 if (!td->io_ops) {
722 log_err("fio: failed to load engine %s\n", engine);
723 return 1;
724 }
725
726 if (td->io_ops->option_struct_size && td->io_ops->options) {
727 /*
728 * In cases where td->eo is set, clone it for a child thread.
729 * This requires that the parent thread has the same ioengine,
730 * but that requirement must be enforced by the code which
731 * cloned the thread.
732 */
733 void *origeo = td->eo;
734 /*
735 * Otherwise use the default thread options.
736 */
737 if (!origeo && td != &def_thread && def_thread.eo &&
738 def_thread.io_ops->options == td->io_ops->options)
739 origeo = def_thread.eo;
740
741 options_init(td->io_ops->options);
742 td->eo = malloc(td->io_ops->option_struct_size);
743 /*
744 * Use the default thread as an option template if this uses the
745 * same options structure and there are non-default options
746 * used.
747 */
748 if (origeo) {
749 memcpy(td->eo, origeo, td->io_ops->option_struct_size);
750 options_mem_dupe(td->eo, td->io_ops->options);
751 } else {
752 memset(td->eo, 0, td->io_ops->option_struct_size);
753 fill_default_options(td->eo, td->io_ops->options);
754 }
755 *(struct thread_data **)td->eo = td;
756 }
757
758 return 0;
759}
760
906c8d75
JA
761/*
762 * Adds a job to the list of things todo. Sanitizes the various options
763 * to make sure we don't have conflicts, and initializes various
764 * members of td.
765 */
75154845 766static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
ebac4655 767{
413dd459 768 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
6eaf09d6
SL
769 "randread", "randwrite", "randrw",
770 "trim", NULL, NULL, NULL, "randtrim" };
af52b345 771 unsigned int i;
af52b345 772 char fname[PATH_MAX];
e132cbae 773 int numjobs, file_alloced;
ebac4655 774
ebac4655
JA
775 /*
776 * the def_thread is just for options, it's not a real job
777 */
778 if (td == &def_thread)
779 return 0;
780
cca73aa7
JA
781 /*
782 * if we are just dumping the output command line, don't add the job
783 */
784 if (dump_cmdline) {
785 put_job(td);
786 return 0;
787 }
788
58c55ba0 789 if (profile_td_init(td))
66251554 790 goto err;
58c55ba0 791
de890a1e 792 if (ioengine_load(td))
205927a3 793 goto err;
df64119d 794
2dc1bbeb 795 if (td->o.use_thread)
9cedf167
JA
796 nr_thread++;
797 else
798 nr_process++;
799
2dc1bbeb 800 if (td->o.odirect)
690adba3
JA
801 td->io_ops->flags |= FIO_RAWIO;
802
e132cbae 803 file_alloced = 0;
691c8fb0 804 if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
e132cbae 805 file_alloced = 1;
80be24f4 806
2dc1bbeb 807 if (td->o.nr_files == 1 && exists_and_not_file(jobname))
e132cbae 808 add_file(td, jobname);
7b05a215 809 else {
2dc1bbeb 810 for (i = 0; i < td->o.nr_files; i++) {
5ec10eaa
JA
811 sprintf(fname, "%s.%d.%d", jobname,
812 td->thread_number, i);
7b05a215
JA
813 add_file(td, fname);
814 }
af52b345 815 }
0af7b542 816 }
ebac4655 817
4e991c23
JA
818 if (fixup_options(td))
819 goto err;
e0a22335 820
9e684a49
DE
821 flow_init_job(td);
822
de890a1e
SL
823 /*
824 * IO engines only need this for option callbacks, and the address may
825 * change in subprocesses.
826 */
827 if (td->eo)
828 *(struct thread_data **)td->eo = NULL;
829
07eb79df
JA
830 if (td->io_ops->flags & FIO_DISKLESSIO) {
831 struct fio_file *f;
832
833 for_each_file(td, f, i)
834 f->real_file_size = -1ULL;
835 }
836
521da527 837 td->mutex = fio_mutex_init(FIO_MUTEX_LOCKED);
ebac4655 838
83349190
YH
839 td->ts.clat_percentiles = td->o.clat_percentiles;
840 if (td->o.overwrite_plist)
802ad4a8 841 memcpy(td->ts.percentile_list, td->o.percentile_list, sizeof(td->o.percentile_list));
83349190 842 else
802ad4a8 843 memcpy(td->ts.percentile_list, def_percentile_list, sizeof(def_percentile_list));
83349190 844
6eaf09d6
SL
845 for (i = 0; i < DDIR_RWDIR_CNT; i++) {
846 td->ts.clat_stat[i].min_val = ULONG_MAX;
847 td->ts.slat_stat[i].min_val = ULONG_MAX;
848 td->ts.lat_stat[i].min_val = ULONG_MAX;
849 td->ts.bw_stat[i].min_val = ULONG_MAX;
850 }
cdd5411e 851 td->ddir_seq_nr = td->o.ddir_seq_nr;
ebac4655 852
755c3189 853 if ((td->o.stonewall || td->o.new_group) && prev_group_jobs) {
3c5df6fa 854 prev_group_jobs = 0;
ebac4655 855 groupid++;
3c5df6fa 856 }
ebac4655
JA
857
858 td->groupid = groupid;
3c5df6fa 859 prev_group_jobs++;
ebac4655 860
93bcfd20
BC
861 if (init_random_state(td, td->rand_seeds, sizeof(td->rand_seeds))) {
862 td_verror(td, errno, "init_random_state");
9c60ce64 863 goto err;
93bcfd20 864 }
9c60ce64 865
ebac4655
JA
866 if (setup_rate(td))
867 goto err;
868
2dc1bbeb 869 if (td->o.write_lat_log) {
b8bc8cba
JA
870 setup_log(&td->lat_log, td->o.log_avg_msec);
871 setup_log(&td->slat_log, td->o.log_avg_msec);
872 setup_log(&td->clat_log, td->o.log_avg_msec);
ebac4655 873 }
2dc1bbeb 874 if (td->o.write_bw_log)
b8bc8cba 875 setup_log(&td->bw_log, td->o.log_avg_msec);
c8eeb9df 876 if (td->o.write_iops_log)
b8bc8cba 877 setup_log(&td->iops_log, td->o.log_avg_msec);
ebac4655 878
2dc1bbeb
JA
879 if (!td->o.name)
880 td->o.name = strdup(jobname);
01452055 881
f3afa57e 882 if (output_format == FIO_OUTPUT_NORMAL) {
b990b5c0 883 if (!job_add_num) {
5ec10eaa
JA
884 if (!strcmp(td->io_ops->name, "cpuio")) {
885 log_info("%s: ioengine=cpu, cpuload=%u,"
886 " cpucycle=%u\n", td->o.name,
887 td->o.cpuload,
888 td->o.cpucycle);
889 } else {
6eaf09d6 890 char *c1, *c2, *c3, *c4, *c5, *c6;
f8977ee6 891
2dc1bbeb
JA
892 c1 = to_kmg(td->o.min_bs[DDIR_READ]);
893 c2 = to_kmg(td->o.max_bs[DDIR_READ]);
894 c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
895 c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
6eaf09d6
SL
896 c5 = to_kmg(td->o.min_bs[DDIR_TRIM]);
897 c6 = to_kmg(td->o.max_bs[DDIR_TRIM]);
f8977ee6 898
6eaf09d6 899 log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s/%s-%s,"
5ec10eaa
JA
900 " ioengine=%s, iodepth=%u\n",
901 td->o.name, td->groupid,
902 ddir_str[td->o.td_ddir],
6eaf09d6 903 c1, c2, c3, c4, c5, c6,
5ec10eaa
JA
904 td->io_ops->name,
905 td->o.iodepth);
f8977ee6
JA
906
907 free(c1);
908 free(c2);
909 free(c3);
910 free(c4);
6eaf09d6
SL
911 free(c5);
912 free(c6);
f8977ee6 913 }
b990b5c0 914 } else if (job_add_num == 1)
6d86144d 915 log_info("...\n");
c6ae0a5b 916 }
ebac4655
JA
917
918 /*
919 * recurse add identical jobs, clear numjobs and stonewall options
920 * as they don't apply to sub-jobs
921 */
2dc1bbeb 922 numjobs = td->o.numjobs;
ebac4655 923 while (--numjobs) {
de890a1e 924 struct thread_data *td_new = get_new_job(0, td, 1);
ebac4655
JA
925
926 if (!td_new)
927 goto err;
928
2dc1bbeb
JA
929 td_new->o.numjobs = 1;
930 td_new->o.stonewall = 0;
92c1d41f 931 td_new->o.new_group = 0;
e132cbae
JA
932
933 if (file_alloced) {
2dc1bbeb 934 td_new->o.filename = NULL;
e132cbae 935 td_new->files_index = 0;
4e6ea2f1 936 td_new->files_size = 0;
e132cbae
JA
937 td_new->files = NULL;
938 }
939
75154845 940 job_add_num = numjobs - 1;
ebac4655 941
75154845 942 if (add_job(td_new, jobname, job_add_num))
ebac4655
JA
943 goto err;
944 }
3c5df6fa 945
ebac4655
JA
946 return 0;
947err:
948 put_job(td);
949 return -1;
950}
951
79d16311
JA
952/*
953 * Parse as if 'o' was a command line
954 */
955void add_job_opts(const char **o)
956{
957 struct thread_data *td, *td_parent;
958 int i, in_global = 1;
959 char jobname[32];
960
961 i = 0;
962 td_parent = td = NULL;
963 while (o[i]) {
964 if (!strncmp(o[i], "name", 4)) {
965 in_global = 0;
966 if (td)
967 add_job(td, jobname, 0);
968 td = NULL;
969 sprintf(jobname, "%s", o[i] + 5);
970 }
971 if (in_global && !td_parent)
de890a1e 972 td_parent = get_new_job(1, &def_thread, 0);
79d16311
JA
973 else if (!in_global && !td) {
974 if (!td_parent)
975 td_parent = &def_thread;
de890a1e 976 td = get_new_job(0, td_parent, 0);
79d16311
JA
977 }
978 if (in_global)
979 fio_options_parse(td_parent, (char **) &o[i], 1);
980 else
981 fio_options_parse(td, (char **) &o[i], 1);
982 i++;
983 }
984
985 if (td)
986 add_job(td, jobname, 0);
987}
988
01f06b63
JA
989static int skip_this_section(const char *name)
990{
ad0a2735
JA
991 int i;
992
993 if (!nr_job_sections)
01f06b63
JA
994 return 0;
995 if (!strncmp(name, "global", 6))
996 return 0;
997
ad0a2735
JA
998 for (i = 0; i < nr_job_sections; i++)
999 if (!strcmp(job_sections[i], name))
1000 return 0;
1001
1002 return 1;
01f06b63
JA
1003}
1004
ebac4655
JA
1005static int is_empty_or_comment(char *line)
1006{
1007 unsigned int i;
1008
1009 for (i = 0; i < strlen(line); i++) {
1010 if (line[i] == ';')
1011 return 1;
5cc2da30
IM
1012 if (line[i] == '#')
1013 return 1;
76cd9378 1014 if (!isspace((int) line[i]) && !iscntrl((int) line[i]))
ebac4655
JA
1015 return 0;
1016 }
1017
1018 return 1;
1019}
1020
07261983
JA
1021/*
1022 * This is our [ini] type file parser.
1023 */
50d16976 1024int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
ebac4655 1025{
e1f36503 1026 unsigned int global;
ebac4655 1027 struct thread_data *td;
fee3bb48 1028 char *string, *name;
ebac4655
JA
1029 FILE *f;
1030 char *p;
0c7e37a0 1031 int ret = 0, stonewall;
097b2991 1032 int first_sect = 1;
ccf8f127 1033 int skip_fgets = 0;
01f06b63 1034 int inside_skip = 0;
3b8b7135
JA
1035 char **opts;
1036 int i, alloc_opts, num_opts;
ebac4655 1037
50d16976
JA
1038 if (is_buf)
1039 f = NULL;
1040 else {
1041 if (!strcmp(file, "-"))
1042 f = stdin;
1043 else
1044 f = fopen(file, "r");
5a729cbe 1045
50d16976
JA
1046 if (!f) {
1047 perror("fopen job file");
1048 return 1;
1049 }
ebac4655
JA
1050 }
1051
1052 string = malloc(4096);
7f7e6e59
JA
1053
1054 /*
1055 * it's really 256 + small bit, 280 should suffice
1056 */
1057 name = malloc(280);
1058 memset(name, 0, 280);
ebac4655 1059
3b8b7135
JA
1060 alloc_opts = 8;
1061 opts = malloc(sizeof(char *) * alloc_opts);
b7c6302d 1062 num_opts = 0;
3b8b7135 1063
0c7e37a0 1064 stonewall = stonewall_flag;
7c124ac1 1065 do {
ccf8f127
JA
1066 /*
1067 * if skip_fgets is set, we already have loaded a line we
1068 * haven't handled.
1069 */
1070 if (!skip_fgets) {
50d16976
JA
1071 if (is_buf)
1072 p = strsep(&file, "\n");
1073 else
43f74792 1074 p = fgets(string, 4096, f);
ccf8f127
JA
1075 if (!p)
1076 break;
1077 }
cdc7f193 1078
ccf8f127 1079 skip_fgets = 0;
cdc7f193 1080 strip_blank_front(&p);
6c7c7da1 1081 strip_blank_end(p);
cdc7f193 1082
ebac4655
JA
1083 if (is_empty_or_comment(p))
1084 continue;
84dd1886 1085 if (sscanf(p, "[%255[^\n]]", name) != 1) {
01f06b63
JA
1086 if (inside_skip)
1087 continue;
5ec10eaa
JA
1088 log_err("fio: option <%s> outside of [] job section\n",
1089 p);
088b4207 1090 break;
6c7c7da1 1091 }
ebac4655 1092
7a4b80a1
JA
1093 name[strlen(name) - 1] = '\0';
1094
01f06b63
JA
1095 if (skip_this_section(name)) {
1096 inside_skip = 1;
1097 continue;
1098 } else
1099 inside_skip = 0;
1100
ebac4655
JA
1101 global = !strncmp(name, "global", 6);
1102
cca73aa7 1103 if (dump_cmdline) {
097b2991
JA
1104 if (first_sect)
1105 log_info("fio ");
cca73aa7
JA
1106 if (!global)
1107 log_info("--name=%s ", name);
097b2991 1108 first_sect = 0;
cca73aa7
JA
1109 }
1110
de890a1e 1111 td = get_new_job(global, &def_thread, 0);
45410acb
JA
1112 if (!td) {
1113 ret = 1;
1114 break;
1115 }
ebac4655 1116
972cfd25
JA
1117 /*
1118 * Seperate multiple job files by a stonewall
1119 */
f9481919 1120 if (!global && stonewall) {
2dc1bbeb 1121 td->o.stonewall = stonewall;
972cfd25
JA
1122 stonewall = 0;
1123 }
1124
3b8b7135
JA
1125 num_opts = 0;
1126 memset(opts, 0, alloc_opts * sizeof(char *));
1127
50d16976
JA
1128 while (1) {
1129 if (is_buf)
1130 p = strsep(&file, "\n");
1131 else
1132 p = fgets(string, 4096, f);
1133 if (!p)
1134 break;
1135
ebac4655
JA
1136 if (is_empty_or_comment(p))
1137 continue;
e1f36503 1138
b6754f9d 1139 strip_blank_front(&p);
7c124ac1 1140
ccf8f127
JA
1141 /*
1142 * new section, break out and make sure we don't
1143 * fgets() a new line at the top.
1144 */
1145 if (p[0] == '[') {
1146 skip_fgets = 1;
7c124ac1 1147 break;
ccf8f127 1148 }
7c124ac1 1149
4ae3f763 1150 strip_blank_end(p);
aea47d44 1151
3b8b7135
JA
1152 if (num_opts == alloc_opts) {
1153 alloc_opts <<= 1;
1154 opts = realloc(opts,
1155 alloc_opts * sizeof(char *));
1156 }
1157
1158 opts[num_opts] = strdup(p);
1159 num_opts++;
ebac4655 1160 }
ebac4655 1161
3b8b7135
JA
1162 ret = fio_options_parse(td, opts, num_opts);
1163 if (!ret) {
1164 if (dump_cmdline)
1165 for (i = 0; i < num_opts; i++)
1166 log_info("--%s ", opts[i]);
1167
45410acb 1168 ret = add_job(td, name, 0);
3b8b7135 1169 } else {
b1508cf9
JA
1170 log_err("fio: job %s dropped\n", name);
1171 put_job(td);
45410acb 1172 }
3b8b7135
JA
1173
1174 for (i = 0; i < num_opts; i++)
1175 free(opts[i]);
1176 num_opts = 0;
7c124ac1 1177 } while (!ret);
ebac4655 1178
cca73aa7
JA
1179 if (dump_cmdline)
1180 log_info("\n");
1181
7e356b2d
JA
1182 i = 0;
1183 while (i < nr_job_sections) {
1184 free(job_sections[i]);
1185 i++;
1186 }
1187
3b8b7135
JA
1188 for (i = 0; i < num_opts; i++)
1189 free(opts[i]);
1190
ebac4655
JA
1191 free(string);
1192 free(name);
2577594d 1193 free(opts);
50d16976 1194 if (!is_buf && f != stdin)
5a729cbe 1195 fclose(f);
45410acb 1196 return ret;
ebac4655
JA
1197}
1198
1199static int fill_def_thread(void)
1200{
1201 memset(&def_thread, 0, sizeof(def_thread));
1202
375b2695 1203 fio_getaffinity(getpid(), &def_thread.o.cpumask);
8c029376 1204 def_thread.o.timeout = def_timeout;
8b28bd41 1205 def_thread.o.error_dump = 1;
ebac4655 1206 /*
ee738499 1207 * fill default options
ebac4655 1208 */
214e1eca 1209 fio_fill_default_options(&def_thread);
ebac4655
JA
1210 return 0;
1211}
1212
45378b35 1213static void usage(const char *name)
4785f995 1214{
692a5d22 1215 printf("%s\n", fio_version_string);
45378b35 1216 printf("%s [options] [job options] <job file(s)>\n", name);
83881283
JA
1217 printf(" --debug=options\tEnable debug logging. May be one/more of:\n"
1218 "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
1219 "\t\t\tdiskutil,job,mutex,profile,time,net\n");
1220 printf(" --output\t\tWrite output to file\n");
b2cecdc2 1221 printf(" --runtime\t\tRuntime in seconds\n");
83881283
JA
1222 printf(" --latency-log\t\tGenerate per-job latency logs\n");
1223 printf(" --bandwidth-log\tGenerate per-job bandwidth logs\n");
1224 printf(" --minimal\t\tMinimal (terse) output\n");
f3afa57e 1225 printf(" --output-format=x\tOutput format (terse,json,normal)\n");
75db6e2c 1226 printf(" --terse-version=x\tSet terse version output format to 'x'\n");
f3afa57e 1227 printf(" --version\t\tPrint version info and exit\n");
83881283
JA
1228 printf(" --help\t\tPrint this page\n");
1229 printf(" --cmdhelp=cmd\t\tPrint command help, \"all\" for all of"
5ec10eaa 1230 " them\n");
de890a1e
SL
1231 printf(" --enghelp=engine\tPrint ioengine help, or list"
1232 " available ioengines\n");
1233 printf(" --enghelp=engine,cmd\tPrint help for an ioengine"
1234 " cmd\n");
83881283
JA
1235 printf(" --showcmd\t\tTurn a job file into command line options\n");
1236 printf(" --eta=when\t\tWhen ETA estimate should be printed\n");
1237 printf(" \t\tMay be \"always\", \"never\" or \"auto\"\n");
1238 printf(" --readonly\t\tTurn on safety read-only checks, preventing"
5ec10eaa 1239 " writes\n");
83881283
JA
1240 printf(" --section=name\tOnly run specified section in job file\n");
1241 printf(" --alloc-size=kb\tSet smalloc pool to this size in kb"
2b386d25 1242 " (def 1024)\n");
83881283
JA
1243 printf(" --warnings-fatal\tFio parser warnings are fatal\n");
1244 printf(" --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
1245 printf(" --server=args\t\tStart a backend fio server\n");
1246 printf(" --daemonize=pidfile\tBackground fio server, write pid to file\n");
1247 printf(" --client=hostname\tTalk to remote backend fio server at hostname\n");
aa58d252 1248 printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
83881283 1249 printf("\n Jens Axboe <jaxboe@fusionio.com>\n");
4785f995
JA
1250}
1251
79e48f72 1252#ifdef FIO_INC_DEBUG
ee56ad50 1253struct debug_level debug_levels[] = {
bd6f78b2
JA
1254 { .name = "process", .shift = FD_PROCESS, },
1255 { .name = "file", .shift = FD_FILE, },
1256 { .name = "io", .shift = FD_IO, },
1257 { .name = "mem", .shift = FD_MEM, },
1258 { .name = "blktrace", .shift = FD_BLKTRACE },
1259 { .name = "verify", .shift = FD_VERIFY },
84422acd 1260 { .name = "random", .shift = FD_RANDOM },
a3d741fa 1261 { .name = "parse", .shift = FD_PARSE },
cd991b9e 1262 { .name = "diskutil", .shift = FD_DISKUTIL },
5e1d306e 1263 { .name = "job", .shift = FD_JOB },
29adda3c 1264 { .name = "mutex", .shift = FD_MUTEX },
79d16311 1265 { .name = "profile", .shift = FD_PROFILE },
c223da83 1266 { .name = "time", .shift = FD_TIME },
eb7976ef 1267 { .name = "net", .shift = FD_NET },
02444ad1 1268 { .name = NULL, },
ee56ad50
JA
1269};
1270
c09823ab 1271static int set_debug(const char *string)
ee56ad50
JA
1272{
1273 struct debug_level *dl;
1274 char *p = (char *) string;
1275 char *opt;
1276 int i;
1277
1278 if (!strcmp(string, "?") || !strcmp(string, "help")) {
ee56ad50
JA
1279 log_info("fio: dumping debug options:");
1280 for (i = 0; debug_levels[i].name; i++) {
1281 dl = &debug_levels[i];
1282 log_info("%s,", dl->name);
1283 }
bd6f78b2 1284 log_info("all\n");
c09823ab 1285 return 1;
ee56ad50
JA
1286 }
1287
1288 while ((opt = strsep(&p, ",")) != NULL) {
1289 int found = 0;
1290
5e1d306e
JA
1291 if (!strncmp(opt, "all", 3)) {
1292 log_info("fio: set all debug options\n");
1293 fio_debug = ~0UL;
1294 continue;
1295 }
1296
ee56ad50
JA
1297 for (i = 0; debug_levels[i].name; i++) {
1298 dl = &debug_levels[i];
5e1d306e
JA
1299 found = !strncmp(opt, dl->name, strlen(dl->name));
1300 if (!found)
1301 continue;
1302
1303 if (dl->shift == FD_JOB) {
1304 opt = strchr(opt, ':');
1305 if (!opt) {
1306 log_err("fio: missing job number\n");
1307 break;
1308 }
1309 opt++;
1310 fio_debug_jobno = atoi(opt);
1311 log_info("fio: set debug jobno %d\n",
1312 fio_debug_jobno);
1313 } else {
ee56ad50 1314 log_info("fio: set debug option %s\n", opt);
bd6f78b2 1315 fio_debug |= (1UL << dl->shift);
ee56ad50 1316 }
5e1d306e 1317 break;
ee56ad50
JA
1318 }
1319
1320 if (!found)
1321 log_err("fio: debug mask %s not found\n", opt);
1322 }
c09823ab 1323 return 0;
ee56ad50 1324}
79e48f72 1325#else
69b98d4c 1326static int set_debug(const char *string)
79e48f72
JA
1327{
1328 log_err("fio: debug tracing not included in build\n");
c09823ab 1329 return 1;
79e48f72
JA
1330}
1331#endif
9ac8a797 1332
4c6107ff
JA
1333static void fio_options_fill_optstring(void)
1334{
1335 char *ostr = cmd_optstr;
1336 int i, c;
1337
1338 c = i = 0;
1339 while (l_opts[i].name) {
1340 ostr[c++] = l_opts[i].val;
1341 if (l_opts[i].has_arg == required_argument)
1342 ostr[c++] = ':';
1343 else if (l_opts[i].has_arg == optional_argument) {
1344 ostr[c++] = ':';
1345 ostr[c++] = ':';
1346 }
1347 i++;
1348 }
1349 ostr[c] = '\0';
1350}
1351
c2c94585
JA
1352static int client_flag_set(char c)
1353{
1354 int i;
1355
1356 i = 0;
1357 while (l_opts[i].name) {
1358 int val = l_opts[i].val;
1359
1360 if (c == (val & 0xff))
1361 return (val & FIO_CLIENT_FLAG);
1362
1363 i++;
1364 }
1365
1366 return 0;
1367}
1368
fa2ea806 1369void parse_cmd_client(void *client, char *opt)
7a4b8240 1370{
fa2ea806 1371 fio_client_add_cmd_option(client, opt);
7a4b8240
JA
1372}
1373
81179eec 1374int parse_cmd_line(int argc, char *argv[])
ebac4655 1375{
b4692828 1376 struct thread_data *td = NULL;
c09823ab 1377 int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
4c6107ff 1378 char *ostr = cmd_optstr;
402668f3 1379 void *pid_file = NULL;
9bae26e8 1380 void *cur_client = NULL;
81179eec 1381 int backend = 0;
ebac4655 1382
c2c94585
JA
1383 /*
1384 * Reset optind handling, since we may call this multiple times
1385 * for the backend.
1386 */
1387 optind = 1;
7a4b8240 1388
c2c94585 1389 while ((c = getopt_long_only(argc, argv, ostr, l_opts, &lidx)) != -1) {
085399db
JA
1390 did_arg = 1;
1391
c2c94585 1392 if ((c & FIO_CLIENT_FLAG) || client_flag_set(c)) {
fa2ea806 1393 parse_cmd_client(cur_client, argv[optind - 1]);
7a4b8240
JA
1394 c &= ~FIO_CLIENT_FLAG;
1395 }
1396
ebac4655 1397 switch (c) {
2b386d25
JA
1398 case 'a':
1399 smalloc_pool_size = atoi(optarg);
1400 break;
b4692828 1401 case 't':
8c029376 1402 def_timeout = atoi(optarg);
b4692828
JA
1403 break;
1404 case 'l':
1405 write_lat_log = 1;
1406 break;
3d73e5a9 1407 case 'b':
b4692828
JA
1408 write_bw_log = 1;
1409 break;
1410 case 'o':
1411 f_out = fopen(optarg, "w+");
1412 if (!f_out) {
1413 perror("fopen output");
1414 exit(1);
1415 }
1416 f_err = f_out;
1417 break;
1418 case 'm':
f3afa57e 1419 output_format = FIO_OUTPUT_TERSE;
b4692828 1420 break;
f3afa57e
JA
1421 case 'F':
1422 if (!strcmp(optarg, "minimal") ||
1423 !strcmp(optarg, "terse") ||
1424 !strcmp(optarg, "csv"))
1425 output_format = FIO_OUTPUT_TERSE;
1426 else if (!strcmp(optarg, "json"))
1427 output_format = FIO_OUTPUT_JSON;
1428 else
1429 output_format = FIO_OUTPUT_NORMAL;
cc372b17 1430 break;
b4692828 1431 case 'h':
7874f8b7 1432 if (!cur_client) {
c2c94585 1433 usage(argv[0]);
7874f8b7
JA
1434 do_exit++;
1435 }
c2c94585 1436 break;
fd28ca49 1437 case 'c':
7874f8b7 1438 if (!cur_client) {
c2c94585 1439 fio_show_option_help(optarg);
7874f8b7
JA
1440 do_exit++;
1441 }
c2c94585 1442 break;
de890a1e
SL
1443 case 'i':
1444 if (!cur_client) {
1445 fio_show_ioengine_help(optarg);
1446 do_exit++;
1447 }
1448 break;
cca73aa7
JA
1449 case 's':
1450 dump_cmdline = 1;
1451 break;
724e4435
JA
1452 case 'r':
1453 read_only = 1;
1454 break;
b4692828 1455 case 'v':
7874f8b7 1456 if (!cur_client) {
692a5d22 1457 log_info("%s\n", fio_version_string);
7874f8b7
JA
1458 do_exit++;
1459 }
c2c94585 1460 break;
f57a9c59
JA
1461 case 'V':
1462 terse_version = atoi(optarg);
67b77039
JA
1463 if (!(terse_version == 2 || terse_version == 3 ||
1464 terse_version == 4)) {
f57a9c59
JA
1465 log_err("fio: bad terse version format\n");
1466 exit_val = 1;
1467 do_exit++;
1468 }
1469 break;
e592a06b
AC
1470 case 'e':
1471 if (!strcmp("always", optarg))
1472 eta_print = FIO_ETA_ALWAYS;
1473 else if (!strcmp("never", optarg))
1474 eta_print = FIO_ETA_NEVER;
1475 break;
ee56ad50 1476 case 'd':
c09823ab
JA
1477 if (set_debug(optarg))
1478 do_exit++;
ee56ad50 1479 break;
ad0a2735
JA
1480 case 'x': {
1481 size_t new_size;
1482
01f06b63 1483 if (!strcmp(optarg, "global")) {
5ec10eaa
JA
1484 log_err("fio: can't use global as only "
1485 "section\n");
c09823ab
JA
1486 do_exit++;
1487 exit_val = 1;
01f06b63
JA
1488 break;
1489 }
ad0a2735
JA
1490 new_size = (nr_job_sections + 1) * sizeof(char *);
1491 job_sections = realloc(job_sections, new_size);
1492 job_sections[nr_job_sections] = strdup(optarg);
1493 nr_job_sections++;
01f06b63 1494 break;
ad0a2735 1495 }
9ac8a797 1496 case 'p':
07b3232d 1497 exec_profile = strdup(optarg);
9ac8a797 1498 break;
b4692828 1499 case FIO_GETOPT_JOB: {
5ec10eaa 1500 const char *opt = l_opts[lidx].name;
b4692828
JA
1501 char *val = optarg;
1502
c2b1e753 1503 if (!strncmp(opt, "name", 4) && td) {
2dc1bbeb 1504 ret = add_job(td, td->o.name ?: "fio", 0);
66251554 1505 if (ret)
c2b1e753 1506 return 0;
c2b1e753
JA
1507 td = NULL;
1508 }
b4692828 1509 if (!td) {
01f06b63 1510 int is_section = !strncmp(opt, "name", 4);
3106f220
JA
1511 int global = 0;
1512
01f06b63 1513 if (!is_section || !strncmp(val, "global", 6))
3106f220 1514 global = 1;
c2b1e753 1515
01f06b63
JA
1516 if (is_section && skip_this_section(val))
1517 continue;
1518
de890a1e
SL
1519 td = get_new_job(global, &def_thread, 1);
1520 if (!td || ioengine_load(td))
b4692828 1521 return 0;
de890a1e 1522 fio_options_set_ioengine_opts(l_opts, td);
b4692828 1523 }
38d0adb0 1524
214e1eca 1525 ret = fio_cmd_option_parse(td, opt, val);
de890a1e
SL
1526
1527 if (!ret && !strcmp(opt, "ioengine")) {
1528 free_ioengine(td);
1529 if (ioengine_load(td))
1530 return 0;
1531 fio_options_set_ioengine_opts(l_opts, td);
1532 }
1533 break;
1534 }
1535 case FIO_GETOPT_IOENGINE: {
1536 const char *opt = l_opts[lidx].name;
1537 char *val = optarg;
1538 opt = l_opts[lidx].name;
1539 val = optarg;
1540 ret = fio_cmd_ioengine_option_parse(td, opt, val);
b4692828
JA
1541 break;
1542 }
a9523c6f
JA
1543 case 'w':
1544 warnings_fatal = 1;
1545 break;
fca70358
JA
1546 case 'j':
1547 max_jobs = atoi(optarg);
1548 if (!max_jobs || max_jobs > REAL_MAX_JOBS) {
1549 log_err("fio: invalid max jobs: %d\n", max_jobs);
1550 do_exit++;
1551 exit_val = 1;
1552 }
1553 break;
50d16976 1554 case 'S':
a37f69b7 1555 if (nr_clients) {
132159a5
JA
1556 log_err("fio: can't be both client and server\n");
1557 do_exit++;
1558 exit_val = 1;
1559 break;
1560 }
87aa8f19 1561 if (optarg)
bebe6398 1562 fio_server_set_arg(optarg);
50d16976 1563 is_backend = 1;
81179eec 1564 backend = 1;
50d16976 1565 break;
e46d8091 1566 case 'D':
402668f3 1567 pid_file = strdup(optarg);
e46d8091 1568 break;
132159a5
JA
1569 case 'C':
1570 if (is_backend) {
1571 log_err("fio: can't be both client and server\n");
1572 do_exit++;
1573 exit_val = 1;
1574 break;
1575 }
bebe6398
JA
1576 if (fio_client_add(optarg, &cur_client)) {
1577 log_err("fio: failed adding client %s\n", optarg);
1578 do_exit++;
1579 exit_val = 1;
1580 break;
1581 }
bd023601
JA
1582 /*
1583 * If the next argument exists and isn't an option,
1584 * assume it's a job file for this client only.
1585 */
1586 while (optind < argc) {
1587 if (!strncmp(argv[optind], "--", 2) ||
1588 !strncmp(argv[optind], "-", 1))
1589 break;
1590
1591 fio_client_add_ini_file(cur_client, argv[optind]);
1592 optind++;
1593 }
132159a5 1594 break;
b4692828 1595 default:
c09823ab
JA
1596 do_exit++;
1597 exit_val = 1;
b4692828 1598 break;
ebac4655 1599 }
c7d5c941
JA
1600 if (do_exit)
1601 break;
ebac4655 1602 }
c9fad893 1603
c2c94585
JA
1604 if (do_exit) {
1605 if (exit_val && !(is_backend || nr_clients))
1606 exit(exit_val);
1607 }
536582bf 1608
a37f69b7 1609 if (nr_clients && fio_clients_connect()) {
132159a5
JA
1610 do_exit++;
1611 exit_val = 1;
cdf54d85 1612 return -1;
132159a5
JA
1613 }
1614
81179eec 1615 if (is_backend && backend)
402668f3 1616 return fio_start_server(pid_file);
50d16976 1617
b4692828 1618 if (td) {
7d6a8904 1619 if (!ret)
2dc1bbeb 1620 ret = add_job(td, td->o.name ?: "fio", 0);
972cfd25 1621 }
774a6177 1622
7874f8b7 1623 while (!ret && optind < argc) {
b4692828
JA
1624 ini_idx++;
1625 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1626 ini_file[ini_idx - 1] = strdup(argv[optind]);
1627 optind++;
eb8bbf48 1628 }
972cfd25
JA
1629
1630 return ini_idx;
ebac4655
JA
1631}
1632
ebac4655
JA
1633int parse_options(int argc, char *argv[])
1634{
972cfd25
JA
1635 int job_files, i;
1636
b4692828
JA
1637 f_out = stdout;
1638 f_err = stderr;
1639
4c6107ff 1640 fio_options_fill_optstring();
5ec10eaa 1641 fio_options_dup_and_init(l_opts);
b4692828 1642
9d9eb2e7
JA
1643 atexit(free_shm);
1644
ebac4655
JA
1645 if (fill_def_thread())
1646 return 1;
1647
972cfd25 1648 job_files = parse_cmd_line(argc, argv);
ebac4655 1649
cdf54d85
JA
1650 if (job_files > 0) {
1651 for (i = 0; i < job_files; i++) {
1652 if (fill_def_thread())
132159a5 1653 return 1;
cdf54d85
JA
1654 if (nr_clients) {
1655 if (fio_clients_send_ini(ini_file[i]))
1656 return 1;
1657 free(ini_file[i]);
1658 } else if (!is_backend) {
1659 if (parse_jobs_ini(ini_file[i], 0, i))
1660 return 1;
1661 free(ini_file[i]);
1662 }
132159a5 1663 }
bd023601
JA
1664 } else if (nr_clients) {
1665 if (fill_def_thread())
1666 return 1;
1667 if (fio_clients_send_ini(NULL))
1668 return 1;
972cfd25 1669 }
ebac4655 1670
88c6ed80 1671 free(ini_file);
7e356b2d 1672 fio_options_free(&def_thread);
b4692828
JA
1673
1674 if (!thread_number) {
cca73aa7
JA
1675 if (dump_cmdline)
1676 return 0;
07b3232d
JA
1677 if (exec_profile)
1678 return 0;
a37f69b7 1679 if (is_backend || nr_clients)
5c341e9a 1680 return 0;
085399db
JA
1681 if (did_arg)
1682 return 0;
cca73aa7 1683
d65e11c6 1684 log_err("No jobs(s) defined\n\n");
085399db
JA
1685
1686 if (!did_arg) {
1687 usage(argv[0]);
1688 return 1;
1689 }
1690
1691 return 0;
b4692828
JA
1692 }
1693
be4ecfdf
JA
1694 if (def_thread.o.gtod_offload) {
1695 fio_gtod_init();
1696 fio_gtod_offload = 1;
1697 fio_gtod_cpu = def_thread.o.gtod_cpu;
1698 }
1699
f3afa57e 1700 if (output_format == FIO_OUTPUT_NORMAL)
692a5d22 1701 log_info("%s\n", fio_version_string);
f6dea4d3 1702
ebac4655
JA
1703 return 0;
1704}