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