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