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