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