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