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