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