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