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