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