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