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