blob: 7cf5cab1eccc59b96d47f36e2e741dfdbe99f045 [file] [log] [blame]
Jens Axboe906c8d72006-06-13 09:37:56 +02001/*
Jens Axboecb2c86f2006-10-26 13:48:34 +02002 * This file contains job initialization and setup functions.
Jens Axboe906c8d72006-06-13 09:37:56 +02003 */
Jens Axboeebac4652005-12-08 15:25:21 +01004#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>
Jens Axboeb4692822006-10-27 13:43:22 +020011#include <getopt.h>
12#include <assert.h>
Jens Axboeebac4652005-12-08 15:25:21 +010013#include <sys/ipc.h>
14#include <sys/shm.h>
15#include <sys/types.h>
16#include <sys/stat.h>
17
18#include "fio.h"
Jens Axboecb2c86f2006-10-26 13:48:34 +020019#include "parse.h"
Jens Axboeebac4652005-12-08 15:25:21 +010020
Jens Axboeee738492007-01-10 11:23:16 +010021#define FIO_RANDSEED (0xb1899bedUL)
Jens Axboeebac4652005-12-08 15:25:21 +010022
Jens Axboee1f36502006-10-27 10:54:08 +020023#define td_var_offset(var) ((size_t) &((struct thread_data *)0)->var)
24
Jens Axboeb4692822006-10-27 13:43:22 +020025static int str_ioengine_cb(void *, const char *);
26static int str_mem_cb(void *, const char *);
Jens Axboee1f36502006-10-27 10:54:08 +020027static int str_lockmem_cb(void *, unsigned long *);
Jens Axboe34cfcda2006-11-03 14:00:45 +010028#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +020029static int str_prio_cb(void *, unsigned int *);
30static int str_prioclass_cb(void *, unsigned int *);
Jens Axboe34cfcda2006-11-03 14:00:45 +010031#endif
Jens Axboee1f36502006-10-27 10:54:08 +020032static int str_exitall_cb(void);
33static int str_cpumask_cb(void *, unsigned int *);
34
Jens Axboeee738492007-01-10 11:23:16 +010035#define __stringify_1(x) #x
36#define __stringify(x) __stringify_1(x)
37
Jens Axboee1f36502006-10-27 10:54:08 +020038/*
39 * Map of job/command line options
40 */
41static struct fio_option options[] = {
42 {
Jens Axboe61697c32007-02-05 15:04:46 +010043 .name = "description",
44 .type = FIO_OPT_STR_STORE,
45 .off1 = td_var_offset(description),
46 .help = "Text job description",
47 },
48 {
Jens Axboee1f36502006-10-27 10:54:08 +020049 .name = "name",
50 .type = FIO_OPT_STR_STORE,
51 .off1 = td_var_offset(name),
Jens Axboefd28ca42007-01-09 21:20:13 +010052 .help = "Name of this job",
Jens Axboee1f36502006-10-27 10:54:08 +020053 },
54 {
55 .name = "directory",
56 .type = FIO_OPT_STR_STORE,
57 .off1 = td_var_offset(directory),
Jens Axboefd28ca42007-01-09 21:20:13 +010058 .help = "Directory to store files in",
Jens Axboee1f36502006-10-27 10:54:08 +020059 },
60 {
61 .name = "filename",
62 .type = FIO_OPT_STR_STORE,
63 .off1 = td_var_offset(filename),
Jens Axboefd28ca42007-01-09 21:20:13 +010064 .help = "Force the use of a specific file",
Jens Axboee1f36502006-10-27 10:54:08 +020065 },
66 {
67 .name = "rw",
68 .type = FIO_OPT_STR,
Jens Axboeb1ec1da2007-02-23 10:29:16 +010069 .off1 = td_var_offset(td_ddir),
Jens Axboe15f79182007-01-10 12:26:18 +010070 .help = "IO direction",
Jens Axboeee738492007-01-10 11:23:16 +010071 .def = "read",
Jens Axboeb1ec1da2007-02-23 10:29:16 +010072 .posval = {
73 { .ival = "read", .oval = TD_DDIR_READ },
74 { .ival = "write", .oval = TD_DDIR_WRITE },
75 { .ival = "randread", .oval = TD_DDIR_RANDREAD },
76 { .ival = "randwrite", .oval = TD_DDIR_RANDWRITE },
77 { .ival = "rw", .oval = TD_DDIR_RW },
78 { .ival = "randrw", .oval = TD_DDIR_RANDRW },
79 },
Jens Axboee1f36502006-10-27 10:54:08 +020080 },
81 {
82 .name = "ioengine",
83 .type = FIO_OPT_STR,
84 .cb = str_ioengine_cb,
Jens Axboe15f79182007-01-10 12:26:18 +010085 .help = "IO engine to use",
Jens Axboeee738492007-01-10 11:23:16 +010086 .def = "sync",
Jens Axboeb1ec1da2007-02-23 10:29:16 +010087 .posval = {
Jens Axboe10cad1a2007-02-23 11:23:03 +010088 { .ival = "sync", },
89#ifdef FIO_HAVE_LIBAIO
90 { .ival = "libaio", },
91#endif
92#ifdef FIO_HAVE_POSIXAIO
93 { .ival = "posixaio", },
94#endif
95 { .ival = "mmap", },
96#ifdef FIO_HAVE_SPLICE
97 { .ival = "splice", },
98#endif
99#ifdef FIO_HAVE_SGIO
100 { .ival = "sg", },
101#endif
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100102 { .ival = "null", }, { .ival = "net", },
Jens Axboe10cad1a2007-02-23 11:23:03 +0100103#ifdef FIO_HAVE_SYSLET
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100104 { .ival = "syslet-rw", },
Jens Axboe10cad1a2007-02-23 11:23:03 +0100105#endif
Joel Becker7b395ca2007-02-28 11:10:58 +0100106 { .ival = "external", },
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100107 },
Jens Axboee1f36502006-10-27 10:54:08 +0200108 },
109 {
Jens Axboe03b74b32007-01-11 11:04:31 +0100110 .name = "iodepth",
111 .type = FIO_OPT_INT,
112 .off1 = td_var_offset(iodepth),
113 .help = "Amount of IO buffers to keep in flight",
114 .def = "1",
115 },
116 {
Jens Axboecb5ab512007-02-26 12:57:09 +0100117 .name = "iodepth_batch",
118 .type = FIO_OPT_INT,
119 .off1 = td_var_offset(iodepth_batch),
120 .help = "Number of IO to submit in one go",
121 },
122 {
Jens Axboee916b392007-02-20 14:37:26 +0100123 .name = "iodepth_low",
124 .type = FIO_OPT_INT,
125 .off1 = td_var_offset(iodepth_low),
126 .help = "Low water mark for queuing depth",
127 },
128 {
Jens Axboe03b74b32007-01-11 11:04:31 +0100129 .name = "size",
130 .type = FIO_OPT_STR_VAL,
131 .off1 = td_var_offset(total_file_size),
132 .help = "Size of device or file",
133 },
134 {
135 .name = "bs",
136 .type = FIO_OPT_STR_VAL_INT,
137 .off1 = td_var_offset(bs[DDIR_READ]),
138 .off2 = td_var_offset(bs[DDIR_WRITE]),
139 .help = "Block size unit",
140 .def = "4k",
141 },
142 {
143 .name = "bsrange",
144 .type = FIO_OPT_RANGE,
145 .off1 = td_var_offset(min_bs[DDIR_READ]),
146 .off2 = td_var_offset(max_bs[DDIR_READ]),
147 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
148 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
149 .help = "Set block size range (in more detail than bs)",
150 },
151 {
152 .name = "bs_unaligned",
153 .type = FIO_OPT_STR_SET,
154 .off1 = td_var_offset(bs_unaligned),
155 .help = "Don't sector align IO buffer sizes",
156 },
157 {
158 .name = "offset",
159 .type = FIO_OPT_STR_VAL,
160 .off1 = td_var_offset(start_offset),
161 .help = "Start IO from this offset",
162 .def = "0",
163 },
164 {
165 .name = "randrepeat",
166 .type = FIO_OPT_BOOL,
167 .off1 = td_var_offset(rand_repeatable),
168 .help = "Use repeatable random IO pattern",
169 .def = "1",
170 },
171 {
172 .name = "norandommap",
173 .type = FIO_OPT_STR_SET,
174 .off1 = td_var_offset(norandommap),
175 .help = "Accept potential duplicate random blocks",
176 },
177 {
178 .name = "nrfiles",
179 .type = FIO_OPT_INT,
180 .off1 = td_var_offset(nr_files),
181 .help = "Split job workload between this number of files",
182 .def = "1",
183 },
184 {
Jens Axboeb5af8292007-03-08 12:43:13 +0100185 .name = "openfiles",
186 .type = FIO_OPT_INT,
187 .off1 = td_var_offset(open_files),
188 .help = "Number of files to keep open at the same time",
189 },
190 {
Jens Axboe0aabe162007-02-23 08:45:55 +0100191 .name = "file_service_type",
192 .type = FIO_OPT_STR,
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100193 .off1 = td_var_offset(file_service_type),
Jens Axboe0aabe162007-02-23 08:45:55 +0100194 .help = "How to select which file to service next",
195 .def = "roundrobin",
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100196 .posval = {
197 { .ival = "random", .oval = FIO_FSERVICE_RANDOM },
198 { .ival = "roundrobin", .oval = FIO_FSERVICE_RR },
199 },
Jens Axboe0aabe162007-02-23 08:45:55 +0100200 },
201 {
Jens Axboe03b74b32007-01-11 11:04:31 +0100202 .name = "fsync",
203 .type = FIO_OPT_INT,
204 .off1 = td_var_offset(fsync_blocks),
205 .help = "Issue fsync for writes every given number of blocks",
206 .def = "0",
207 },
208 {
209 .name = "direct",
210 .type = FIO_OPT_BOOL,
211 .off1 = td_var_offset(odirect),
Jens Axboe76a43db2007-01-11 13:24:44 +0100212 .help = "Use O_DIRECT IO (negates buffered)",
213 .def = "0",
214 },
215 {
216 .name = "buffered",
217 .type = FIO_OPT_BOOL,
218 .off1 = td_var_offset(odirect),
219 .neg = 1,
220 .help = "Use buffered IO (negates direct)",
Jens Axboe03b74b32007-01-11 11:04:31 +0100221 .def = "1",
222 },
223 {
224 .name = "overwrite",
225 .type = FIO_OPT_BOOL,
226 .off1 = td_var_offset(overwrite),
227 .help = "When writing, set whether to overwrite current data",
228 .def = "0",
229 },
230 {
231 .name = "loops",
232 .type = FIO_OPT_INT,
233 .off1 = td_var_offset(loops),
234 .help = "Number of times to run the job",
235 .def = "1",
236 },
237 {
238 .name = "numjobs",
239 .type = FIO_OPT_INT,
240 .off1 = td_var_offset(numjobs),
241 .help = "Duplicate this job this many times",
242 .def = "1",
243 },
244 {
245 .name = "startdelay",
246 .type = FIO_OPT_INT,
247 .off1 = td_var_offset(start_delay),
248 .help = "Only start job when this period has passed",
249 .def = "0",
250 },
251 {
252 .name = "runtime",
253 .alias = "timeout",
254 .type = FIO_OPT_STR_VAL_TIME,
255 .off1 = td_var_offset(timeout),
256 .help = "Stop workload when this amount of time has passed",
257 .def = "0",
258 },
259 {
Jens Axboee1f36502006-10-27 10:54:08 +0200260 .name = "mem",
261 .type = FIO_OPT_STR,
262 .cb = str_mem_cb,
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100263 .off1 = td_var_offset(mem_type),
Jens Axboe15f79182007-01-10 12:26:18 +0100264 .help = "Backing type for IO buffers",
Jens Axboeee738492007-01-10 11:23:16 +0100265 .def = "malloc",
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100266 .posval = {
267 { .ival = "malloc", .oval = MEM_MALLOC },
268 { .ival = "shm", .oval = MEM_SHM },
269#ifdef FIO_HAVE_HUGETLB
270 { .ival = "shmhuge", .oval = MEM_SHMHUGE },
271#endif
272 { .ival = "mmap", .oval = MEM_MMAP },
273#ifdef FIO_HAVE_HUGETLB
274 { .ival = "mmaphuge", .oval = MEM_MMAPHUGE },
275#endif
276 },
Jens Axboee1f36502006-10-27 10:54:08 +0200277 },
278 {
279 .name = "verify",
280 .type = FIO_OPT_STR,
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100281 .off1 = td_var_offset(verify),
Jens Axboe15f79182007-01-10 12:26:18 +0100282 .help = "Verify sum function",
Jens Axboeee738492007-01-10 11:23:16 +0100283 .def = "0",
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100284 .posval = {
285 { .ival = "0", .oval = VERIFY_NONE },
286 { .ival = "crc32", .oval = VERIFY_CRC32 },
287 { .ival = "md5", .oval = VERIFY_MD5 },
288 },
Jens Axboee1f36502006-10-27 10:54:08 +0200289 },
290 {
291 .name = "write_iolog",
Jens Axboe076efc72006-10-27 11:24:25 +0200292 .type = FIO_OPT_STR_STORE,
293 .off1 = td_var_offset(write_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100294 .help = "Store IO pattern to file",
Jens Axboee1f36502006-10-27 10:54:08 +0200295 },
296 {
Jens Axboe076efc72006-10-27 11:24:25 +0200297 .name = "read_iolog",
Jens Axboee1f36502006-10-27 10:54:08 +0200298 .type = FIO_OPT_STR_STORE,
Jens Axboe076efc72006-10-27 11:24:25 +0200299 .off1 = td_var_offset(read_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100300 .help = "Playback IO pattern from file",
Jens Axboee1f36502006-10-27 10:54:08 +0200301 },
302 {
303 .name = "exec_prerun",
304 .type = FIO_OPT_STR_STORE,
305 .off1 = td_var_offset(exec_prerun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100306 .help = "Execute this file prior to running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200307 },
308 {
309 .name = "exec_postrun",
310 .type = FIO_OPT_STR_STORE,
311 .off1 = td_var_offset(exec_postrun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100312 .help = "Execute this file after running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200313 },
314#ifdef FIO_HAVE_IOSCHED_SWITCH
315 {
316 .name = "ioscheduler",
317 .type = FIO_OPT_STR_STORE,
318 .off1 = td_var_offset(ioscheduler),
Jens Axboefd28ca42007-01-09 21:20:13 +0100319 .help = "Use this IO scheduler on the backing device",
Jens Axboee1f36502006-10-27 10:54:08 +0200320 },
321#endif
322 {
Jens Axboee1f36502006-10-27 10:54:08 +0200323 .name = "zonesize",
324 .type = FIO_OPT_STR_VAL,
325 .off1 = td_var_offset(zone_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100326 .help = "Give size of an IO zone",
Jens Axboeee738492007-01-10 11:23:16 +0100327 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200328 },
329 {
330 .name = "zoneskip",
331 .type = FIO_OPT_STR_VAL,
332 .off1 = td_var_offset(zone_skip),
Jens Axboefd28ca42007-01-09 21:20:13 +0100333 .help = "Space between IO zones",
Jens Axboeee738492007-01-10 11:23:16 +0100334 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200335 },
336 {
337 .name = "lockmem",
338 .type = FIO_OPT_STR_VAL,
339 .cb = str_lockmem_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100340 .help = "Lock down this amount of memory",
Jens Axboeee738492007-01-10 11:23:16 +0100341 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200342 },
343 {
Jens Axboee1f36502006-10-27 10:54:08 +0200344 .name = "rwmixcycle",
345 .type = FIO_OPT_INT,
346 .off1 = td_var_offset(rwmixcycle),
Jens Axboeee738492007-01-10 11:23:16 +0100347 .help = "Cycle period for mixed read/write workloads (msec)",
348 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200349 },
350 {
351 .name = "rwmixread",
352 .type = FIO_OPT_INT,
353 .off1 = td_var_offset(rwmixread),
Jens Axboeee738492007-01-10 11:23:16 +0100354 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100355 .help = "Percentage of mixed workload that is reads",
Jens Axboeee738492007-01-10 11:23:16 +0100356 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200357 },
358 {
359 .name = "rwmixwrite",
360 .type = FIO_OPT_INT,
361 .off1 = td_var_offset(rwmixwrite),
Jens Axboeee738492007-01-10 11:23:16 +0100362 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100363 .help = "Percentage of mixed workload that is writes",
Jens Axboeee738492007-01-10 11:23:16 +0100364 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200365 },
366 {
367 .name = "nice",
368 .type = FIO_OPT_INT,
369 .off1 = td_var_offset(nice),
Jens Axboefd28ca42007-01-09 21:20:13 +0100370 .help = "Set job CPU nice value",
Jens Axboe15f79182007-01-10 12:26:18 +0100371 .minval = -19,
Jens Axboeee738492007-01-10 11:23:16 +0100372 .maxval = 20,
373 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200374 },
375#ifdef FIO_HAVE_IOPRIO
376 {
377 .name = "prio",
378 .type = FIO_OPT_INT,
379 .cb = str_prio_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100380 .help = "Set job IO priority value",
Jens Axboe15f79182007-01-10 12:26:18 +0100381 .minval = 0,
382 .maxval = 7,
Jens Axboee1f36502006-10-27 10:54:08 +0200383 },
384 {
385 .name = "prioclass",
386 .type = FIO_OPT_INT,
387 .cb = str_prioclass_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100388 .help = "Set job IO priority class",
Jens Axboe15f79182007-01-10 12:26:18 +0100389 .minval = 0,
390 .maxval = 3,
Jens Axboee1f36502006-10-27 10:54:08 +0200391 },
392#endif
393 {
394 .name = "thinktime",
395 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100396 .off1 = td_var_offset(thinktime),
Jens Axboe5fa0f812007-01-11 14:06:35 +0100397 .help = "Idle time between IO buffers (usec)",
Jens Axboeee738492007-01-10 11:23:16 +0100398 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200399 },
400 {
Jens Axboe48097d52007-02-17 06:30:44 +0100401 .name = "thinktime_spin",
402 .type = FIO_OPT_INT,
403 .off1 = td_var_offset(thinktime_spin),
Jens Axboe34403fb2007-03-02 21:43:25 +0100404 .help = "Start think time by spinning this amount (usec)",
Jens Axboe48097d52007-02-17 06:30:44 +0100405 .def = "0",
406 },
407 {
Jens Axboe9c1f7432007-01-03 20:43:19 +0100408 .name = "thinktime_blocks",
409 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100410 .off1 = td_var_offset(thinktime_blocks),
Jens Axboefd28ca42007-01-09 21:20:13 +0100411 .help = "IO buffer period between 'thinktime'",
Jens Axboeee738492007-01-10 11:23:16 +0100412 .def = "1",
Jens Axboe9c1f7432007-01-03 20:43:19 +0100413 },
414 {
Jens Axboee1f36502006-10-27 10:54:08 +0200415 .name = "rate",
416 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100417 .off1 = td_var_offset(rate),
Jens Axboefd28ca42007-01-09 21:20:13 +0100418 .help = "Set bandwidth rate",
Jens Axboee1f36502006-10-27 10:54:08 +0200419 },
420 {
421 .name = "ratemin",
422 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100423 .off1 = td_var_offset(ratemin),
Jens Axboefd28ca42007-01-09 21:20:13 +0100424 .help = "The bottom limit accepted",
Jens Axboee1f36502006-10-27 10:54:08 +0200425 },
426 {
427 .name = "ratecycle",
428 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100429 .off1 = td_var_offset(ratecycle),
Jens Axboe6da1fa72007-01-10 11:27:48 +0100430 .help = "Window average for rate limits (msec)",
Jens Axboeee738492007-01-10 11:23:16 +0100431 .def = "1000",
Jens Axboee1f36502006-10-27 10:54:08 +0200432 },
433 {
Jens Axboee1f36502006-10-27 10:54:08 +0200434 .name = "invalidate",
Jens Axboe13335dd2007-01-10 13:14:02 +0100435 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100436 .off1 = td_var_offset(invalidate_cache),
Jens Axboefd28ca42007-01-09 21:20:13 +0100437 .help = "Invalidate buffer/page cache prior to running job",
Jens Axboeee738492007-01-10 11:23:16 +0100438 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200439 },
440 {
441 .name = "sync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100442 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100443 .off1 = td_var_offset(sync_io),
Jens Axboefd28ca42007-01-09 21:20:13 +0100444 .help = "Use O_SYNC for buffered writes",
Jens Axboeee738492007-01-10 11:23:16 +0100445 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200446 },
447 {
448 .name = "bwavgtime",
449 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100450 .off1 = td_var_offset(bw_avg_time),
Jens Axboeee738492007-01-10 11:23:16 +0100451 .help = "Time window over which to calculate bandwidth (msec)",
452 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200453 },
454 {
455 .name = "create_serialize",
Jens Axboe13335dd2007-01-10 13:14:02 +0100456 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100457 .off1 = td_var_offset(create_serialize),
Jens Axboefd28ca42007-01-09 21:20:13 +0100458 .help = "Serialize creating of job files",
Jens Axboeee738492007-01-10 11:23:16 +0100459 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200460 },
461 {
462 .name = "create_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100463 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100464 .off1 = td_var_offset(create_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100465 .help = "Fsync file after creation",
Jens Axboeee738492007-01-10 11:23:16 +0100466 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200467 },
468 {
Jens Axboee1f36502006-10-27 10:54:08 +0200469 .name = "cpuload",
470 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100471 .off1 = td_var_offset(cpuload),
Jens Axboefd28ca42007-01-09 21:20:13 +0100472 .help = "Use this percentage of CPU",
Jens Axboee1f36502006-10-27 10:54:08 +0200473 },
474 {
475 .name = "cpuchunks",
476 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100477 .off1 = td_var_offset(cpucycle),
Jens Axboefd28ca42007-01-09 21:20:13 +0100478 .help = "Length of the CPU burn cycles",
Jens Axboee1f36502006-10-27 10:54:08 +0200479 },
Jens Axboee1f36502006-10-27 10:54:08 +0200480#ifdef FIO_HAVE_CPU_AFFINITY
481 {
482 .name = "cpumask",
483 .type = FIO_OPT_INT,
484 .cb = str_cpumask_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100485 .help = "CPU affinity mask",
Jens Axboee1f36502006-10-27 10:54:08 +0200486 },
487#endif
488 {
489 .name = "end_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100490 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100491 .off1 = td_var_offset(end_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100492 .help = "Include fsync at the end of job",
Jens Axboeee738492007-01-10 11:23:16 +0100493 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200494 },
495 {
496 .name = "unlink",
Jens Axboe13335dd2007-01-10 13:14:02 +0100497 .type = FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +0200498 .off1 = td_var_offset(unlink),
Jens Axboeee738492007-01-10 11:23:16 +0100499 .help = "Unlink created files after job has completed",
Jens Axboee545a6c2007-01-14 00:00:29 +0100500 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200501 },
502 {
503 .name = "exitall",
504 .type = FIO_OPT_STR_SET,
505 .cb = str_exitall_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100506 .help = "Terminate all jobs when one exits",
Jens Axboee1f36502006-10-27 10:54:08 +0200507 },
508 {
509 .name = "stonewall",
510 .type = FIO_OPT_STR_SET,
511 .off1 = td_var_offset(stonewall),
Jens Axboefd28ca42007-01-09 21:20:13 +0100512 .help = "Insert a hard barrier between this job and previous",
Jens Axboee1f36502006-10-27 10:54:08 +0200513 },
514 {
515 .name = "thread",
516 .type = FIO_OPT_STR_SET,
Jens Axboed9bb3b82007-01-10 20:30:53 +0100517 .off1 = td_var_offset(use_thread),
Jens Axboefd28ca42007-01-09 21:20:13 +0100518 .help = "Use threads instead of forks",
Jens Axboee1f36502006-10-27 10:54:08 +0200519 },
520 {
521 .name = "write_bw_log",
522 .type = FIO_OPT_STR_SET,
523 .off1 = td_var_offset(write_bw_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100524 .help = "Write log of bandwidth during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200525 },
526 {
527 .name = "write_lat_log",
528 .type = FIO_OPT_STR_SET,
529 .off1 = td_var_offset(write_lat_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100530 .help = "Write log of latency during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200531 },
532 {
Jens Axboe56bb17f2006-12-20 20:27:36 +0100533 .name = "hugepage-size",
534 .type = FIO_OPT_STR_VAL,
535 .off1 = td_var_offset(hugepage_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100536 .help = "When using hugepages, specify size of each page",
Jens Axboeee738492007-01-10 11:23:16 +0100537 .def = __stringify(FIO_HUGE_PAGE),
Jens Axboe56bb17f2006-12-20 20:27:36 +0100538 },
539 {
Jens Axboeb2560f32007-03-06 12:43:03 +0100540 .name = "group_reporting",
541 .type = FIO_OPT_STR_SET,
542 .off1 = td_var_offset(group_reporting),
543 .help = "Do reporting on a per-group basis",
544 },
545 {
Jens Axboee1f36502006-10-27 10:54:08 +0200546 .name = NULL,
547 },
548};
549
Jens Axboeb4692822006-10-27 13:43:22 +0200550#define FIO_JOB_OPTS (sizeof(options) / sizeof(struct fio_option))
551#define FIO_CMD_OPTS (16)
552#define FIO_GETOPT_JOB (0x89988998)
553
554/*
555 * Command line options. These will contain the above, plus a few
556 * extra that only pertain to fio itself and not jobs.
557 */
558static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
559 {
560 .name = "output",
561 .has_arg = required_argument,
562 .val = 'o',
563 },
564 {
565 .name = "timeout",
566 .has_arg = required_argument,
567 .val = 't',
568 },
569 {
570 .name = "latency-log",
571 .has_arg = required_argument,
572 .val = 'l',
573 },
574 {
575 .name = "bandwidth-log",
576 .has_arg = required_argument,
577 .val = 'b',
578 },
579 {
580 .name = "minimal",
581 .has_arg = optional_argument,
582 .val = 'm',
583 },
584 {
585 .name = "version",
586 .has_arg = no_argument,
587 .val = 'v',
588 },
589 {
Jens Axboefd28ca42007-01-09 21:20:13 +0100590 .name = "help",
591 .has_arg = no_argument,
592 .val = 'h',
593 },
594 {
595 .name = "cmdhelp",
Jens Axboe320beef2007-03-01 10:44:12 +0100596 .has_arg = optional_argument,
Jens Axboefd28ca42007-01-09 21:20:13 +0100597 .val = 'c',
598 },
599 {
Jens Axboeb4692822006-10-27 13:43:22 +0200600 .name = NULL,
601 },
602};
603
Jens Axboeee738492007-01-10 11:23:16 +0100604static int def_timeout = 0;
Jens Axboe972cfd22006-06-09 11:08:56 +0200605
Jens Axboefdf3de22007-03-03 12:21:34 +0100606static char fio_version_string[] = "fio 1.13";
Jens Axboeebac4652005-12-08 15:25:21 +0100607
Jens Axboe972cfd22006-06-09 11:08:56 +0200608static char **ini_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100609static int max_jobs = MAX_JOBS;
610
611struct thread_data def_thread;
612struct thread_data *threads = NULL;
613
Jens Axboeebac4652005-12-08 15:25:21 +0100614int exitall_on_terminate = 0;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200615int terse_output = 0;
Jens Axboec04f7ec2006-05-31 10:13:16 +0200616unsigned long long mlock_size = 0;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200617FILE *f_out = NULL;
618FILE *f_err = NULL;
Jens Axboeebac4652005-12-08 15:25:21 +0100619
Jens Axboeee738492007-01-10 11:23:16 +0100620static int write_lat_log = 0;
Jens Axboebb3884d2007-01-17 17:23:11 +1100621int write_bw_log = 0;
Jens Axboeec94ec52006-10-20 10:59:19 +0200622
Joel Becker9728ce32007-03-01 08:24:39 +0100623FILE *get_f_out()
624{
625 return f_out;
626}
627
628FILE *get_f_err()
629{
630 return f_err;
631}
632
Jens Axboe906c8d72006-06-13 09:37:56 +0200633/*
634 * Return a free job structure.
635 */
Jens Axboeebac4652005-12-08 15:25:21 +0100636static struct thread_data *get_new_job(int global, struct thread_data *parent)
637{
638 struct thread_data *td;
639
640 if (global)
641 return &def_thread;
642 if (thread_number >= max_jobs)
643 return NULL;
644
645 td = &threads[thread_number++];
Jens Axboeddaeaa52006-06-08 11:00:58 +0200646 *td = *parent;
Jens Axboeebac4652005-12-08 15:25:21 +0100647
Jens Axboeebac4652005-12-08 15:25:21 +0100648 td->thread_number = thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100649 return td;
650}
651
652static void put_job(struct thread_data *td)
653{
Jens Axboe549577a2006-10-30 12:23:41 +0100654 if (td == &def_thread)
655 return;
656
Jens Axboe16edf252007-02-10 14:59:22 +0100657 if (td->error)
658 fprintf(f_out, "fio: %s\n", td->verror);
659
Jens Axboeebac4652005-12-08 15:25:21 +0100660 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
661 thread_number--;
662}
663
Jens Axboedad915e2006-10-27 11:10:18 +0200664/*
665 * Lazy way of fixing up options that depend on each other. We could also
666 * define option callback handlers, but this is easier.
667 */
Jens Axboee1f36502006-10-27 10:54:08 +0200668static void fixup_options(struct thread_data *td)
669{
Jens Axboee1f36502006-10-27 10:54:08 +0200670 if (!td->rwmixread && td->rwmixwrite)
671 td->rwmixread = 100 - td->rwmixwrite;
Jens Axboedad915e2006-10-27 11:10:18 +0200672
Jens Axboe076efc72006-10-27 11:24:25 +0200673 if (td->write_iolog_file && td->read_iolog_file) {
674 log_err("fio: read iolog overrides write_iolog\n");
675 free(td->write_iolog_file);
676 td->write_iolog_file = NULL;
677 }
Jens Axboe16b462a2006-10-30 12:35:18 +0100678
679 if (td->io_ops->flags & FIO_SYNCIO)
680 td->iodepth = 1;
681 else {
682 if (!td->iodepth)
Jens Axboeb5af8292007-03-08 12:43:13 +0100683 td->iodepth = td->open_files;
Jens Axboe16b462a2006-10-30 12:35:18 +0100684 }
685
686 /*
687 * only really works for sequential io for now, and with 1 file
688 */
Jens Axboeb5af8292007-03-08 12:43:13 +0100689 if (td->zone_size && td_random(td) && td->open_files == 1)
Jens Axboe16b462a2006-10-30 12:35:18 +0100690 td->zone_size = 0;
691
692 /*
693 * Reads can do overwrites, we always need to pre-create the file
694 */
695 if (td_read(td) || td_rw(td))
696 td->overwrite = 1;
697
Jens Axboea00735e2006-11-03 08:58:08 +0100698 if (!td->min_bs[DDIR_READ])
699 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
700 if (!td->max_bs[DDIR_READ])
701 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
702 if (!td->min_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100703 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100704 if (!td->max_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100705 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100706
707 td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
708
Jens Axboe16b462a2006-10-30 12:35:18 +0100709 if (td_read(td) && !td_rw(td))
710 td->verify = 0;
Jens Axboebb8895e2006-10-30 15:14:48 +0100711
712 if (td->norandommap && td->verify != VERIFY_NONE) {
713 log_err("fio: norandommap given, verify disabled\n");
714 td->verify = VERIFY_NONE;
715 }
Jens Axboe690adba2006-10-30 15:25:09 +0100716 if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
717 log_err("fio: bs_unaligned may not work with raw io\n");
Jens Axboee0a22332006-12-20 12:54:25 +0100718
719 /*
720 * O_DIRECT and char doesn't mix, clear that flag if necessary.
721 */
722 if (td->filetype == FIO_TYPE_CHAR && td->odirect)
723 td->odirect = 0;
Jens Axboe48097d52007-02-17 06:30:44 +0100724
725 /*
726 * thinktime_spin must be less than thinktime
727 */
728 if (td->thinktime_spin > td->thinktime)
729 td->thinktime_spin = td->thinktime;
Jens Axboee916b392007-02-20 14:37:26 +0100730
731 /*
732 * The low water mark cannot be bigger than the iodepth
733 */
Jens Axboe9467b772007-02-27 19:56:43 +0100734 if (td->iodepth_low > td->iodepth || !td->iodepth_low) {
735 /*
736 * syslet work around - if the workload is sequential,
737 * we want to let the queue drain all the way down to
738 * avoid seeking between async threads
739 */
740 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
741 td->iodepth_low = 1;
742 else
743 td->iodepth_low = td->iodepth;
744 }
Jens Axboecb5ab512007-02-26 12:57:09 +0100745
746 /*
747 * If batch number isn't set, default to the same as iodepth
748 */
749 if (td->iodepth_batch > td->iodepth || !td->iodepth_batch)
750 td->iodepth_batch = td->iodepth;
Jens Axboeb5af8292007-03-08 12:43:13 +0100751
752 if (td->open_files > td->nr_files || !td->open_files)
753 td->open_files = td->nr_files;
Jens Axboee1f36502006-10-27 10:54:08 +0200754}
755
Jens Axboe906c8d72006-06-13 09:37:56 +0200756/*
Jens Axboef8977ee2006-11-06 14:03:03 +0100757 * This function leaks the buffer
758 */
759static char *to_kmg(unsigned int val)
760{
761 char *buf = malloc(32);
Jens Axboef3502ba2007-02-14 01:27:09 +0100762 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
Jens Axboef8977ee2006-11-06 14:03:03 +0100763 char *p = post;
764
Jens Axboe245142f2006-11-08 12:49:21 +0100765 do {
Jens Axboef8977ee2006-11-06 14:03:03 +0100766 if (val & 1023)
767 break;
768
769 val >>= 10;
770 p++;
Jens Axboe245142f2006-11-08 12:49:21 +0100771 } while (*p);
Jens Axboef8977ee2006-11-06 14:03:03 +0100772
773 snprintf(buf, 31, "%u%c", val, *p);
774 return buf;
775}
776
777/*
Jens Axboe906c8d72006-06-13 09:37:56 +0200778 * Adds a job to the list of things todo. Sanitizes the various options
779 * to make sure we don't have conflicts, and initializes various
780 * members of td.
781 */
Jens Axboe75154842006-06-01 13:56:09 +0200782static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
Jens Axboeebac4652005-12-08 15:25:21 +0100783{
Jens Axboe413dd452007-02-23 09:26:09 +0100784 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
785 "randread", "randwrite", "randrw" };
Jens Axboeebac4652005-12-08 15:25:21 +0100786 struct stat sb;
Jens Axboe413dd452007-02-23 09:26:09 +0100787 int numjobs, i;
Jens Axboe53cdc682006-10-18 11:50:58 +0200788 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100789
Jens Axboeebac4652005-12-08 15:25:21 +0100790 /*
791 * the def_thread is just for options, it's not a real job
792 */
793 if (td == &def_thread)
794 return 0;
795
Jens Axboeee738492007-01-10 11:23:16 +0100796 assert(td->io_ops);
Jens Axboedf641192006-10-12 07:55:41 +0200797
Jens Axboe690adba2006-10-30 15:25:09 +0100798 if (td->odirect)
799 td->io_ops->flags |= FIO_RAWIO;
800
Jens Axboeebac4652005-12-08 15:25:21 +0100801 td->filetype = FIO_TYPE_FILE;
Jens Axboe890df532007-02-17 01:51:13 +0100802 if (td->filename && !lstat(td->filename, &sb)) {
Jens Axboe0af7b542006-02-17 10:10:12 +0100803 if (S_ISBLK(sb.st_mode))
804 td->filetype = FIO_TYPE_BD;
805 else if (S_ISCHR(sb.st_mode))
806 td->filetype = FIO_TYPE_CHAR;
807 }
Jens Axboeebac4652005-12-08 15:25:21 +0100808
Jens Axboee0a22332006-12-20 12:54:25 +0100809 fixup_options(td);
810
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200811 if (td->filename)
812 td->nr_uniq_files = 1;
813 else
814 td->nr_uniq_files = td->nr_files;
815
816 if (td->filetype == FIO_TYPE_FILE || td->filename) {
Jens Axboee9c047a2006-06-07 21:13:04 +0200817 char tmp[PATH_MAX];
Jens Axboe53cdc682006-10-18 11:50:58 +0200818 int len = 0;
Jens Axboee9c047a2006-06-07 21:13:04 +0200819
Jens Axboe16edf252007-02-10 14:59:22 +0100820 if (td->directory && td->directory[0] != '\0') {
821 if (lstat(td->directory, &sb) < 0) {
822 log_err("fio: %s is not a directory\n", td->directory);
Jens Axboee1161c32007-02-22 19:36:48 +0100823 td_verror(td, errno, "lstat");
Jens Axboe16edf252007-02-10 14:59:22 +0100824 return 1;
825 }
826 if (!S_ISDIR(sb.st_mode)) {
827 log_err("fio: %s is not a directory\n", td->directory);
828 return 1;
829 }
Jens Axboe8aeebd52007-01-08 10:47:43 +0100830 len = sprintf(tmp, "%s/", td->directory);
Jens Axboe16edf252007-02-10 14:59:22 +0100831 }
Jens Axboeebac4652005-12-08 15:25:21 +0100832
Jens Axboeb5af8292007-03-08 12:43:13 +0100833 td->files = malloc(sizeof(struct fio_file) * td->open_files);
Jens Axboe53cdc682006-10-18 11:50:58 +0200834
835 for_each_file(td, f, i) {
836 memset(f, 0, sizeof(*f));
837 f->fd = -1;
838
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200839 if (td->filename)
840 sprintf(tmp + len, "%s", td->filename);
841 else
842 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
Jens Axboe53cdc682006-10-18 11:50:58 +0200843 f->file_name = strdup(tmp);
844 }
845 } else {
Jens Axboeb5af8292007-03-08 12:43:13 +0100846 td->open_files = td->nr_files = 1;
Jens Axboe53cdc682006-10-18 11:50:58 +0200847 td->files = malloc(sizeof(struct fio_file));
848 f = &td->files[0];
849
850 memset(f, 0, sizeof(*f));
851 f->fd = -1;
852 f->file_name = strdup(jobname);
853 }
854
855 for_each_file(td, f, i) {
856 f->file_size = td->total_file_size / td->nr_files;
857 f->file_offset = td->start_offset;
858 }
859
Jens Axboebbfd6b02006-06-07 19:42:54 +0200860 fio_sem_init(&td->mutex, 0);
Jens Axboeebac4652005-12-08 15:25:21 +0100861
Jens Axboe756867b2007-03-06 15:19:24 +0100862 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
863 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
864 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
Jens Axboeebac4652005-12-08 15:25:21 +0100865
Jens Axboeebac4652005-12-08 15:25:21 +0100866 if (td->stonewall && td->thread_number > 1)
867 groupid++;
868
869 td->groupid = groupid;
870
871 if (setup_rate(td))
872 goto err;
873
Jens Axboeec94ec52006-10-20 10:59:19 +0200874 if (td->write_lat_log) {
Jens Axboe756867b2007-03-06 15:19:24 +0100875 setup_log(&td->ts.slat_log);
876 setup_log(&td->ts.clat_log);
Jens Axboeebac4652005-12-08 15:25:21 +0100877 }
Jens Axboeec94ec52006-10-20 10:59:19 +0200878 if (td->write_bw_log)
Jens Axboe756867b2007-03-06 15:19:24 +0100879 setup_log(&td->ts.bw_log);
Jens Axboeebac4652005-12-08 15:25:21 +0100880
Jens Axboeb4692822006-10-27 13:43:22 +0200881 if (!td->name)
882 td->name = strdup(jobname);
Jens Axboe01452052006-06-07 10:29:47 +0200883
Jens Axboec6ae0a52006-06-12 11:04:44 +0200884 if (!terse_output) {
Jens Axboeb990b5c2006-09-14 09:48:22 +0200885 if (!job_add_num) {
Jens Axboe2866c822006-10-09 15:57:48 +0200886 if (td->io_ops->flags & FIO_CPUIO)
Jens Axboeb990b5c2006-09-14 09:48:22 +0200887 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
Jens Axboef8977ee2006-11-06 14:03:03 +0100888 else {
889 char *c1, *c2, *c3, *c4;
890
891 c1 = to_kmg(td->min_bs[DDIR_READ]);
892 c2 = to_kmg(td->max_bs[DDIR_READ]);
893 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
894 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
895
Jens Axboe413dd452007-02-23 09:26:09 +0100896 fprintf(f_out, "%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[td->td_ddir], c1, c2, c3, c4, td->io_ops->name, td->iodepth);
Jens Axboef8977ee2006-11-06 14:03:03 +0100897
898 free(c1);
899 free(c2);
900 free(c3);
901 free(c4);
902 }
Jens Axboeb990b5c2006-09-14 09:48:22 +0200903 } else if (job_add_num == 1)
Jens Axboec6ae0a52006-06-12 11:04:44 +0200904 fprintf(f_out, "...\n");
905 }
Jens Axboeebac4652005-12-08 15:25:21 +0100906
907 /*
908 * recurse add identical jobs, clear numjobs and stonewall options
909 * as they don't apply to sub-jobs
910 */
911 numjobs = td->numjobs;
912 while (--numjobs) {
913 struct thread_data *td_new = get_new_job(0, td);
914
915 if (!td_new)
916 goto err;
917
918 td_new->numjobs = 1;
919 td_new->stonewall = 0;
Jens Axboe75154842006-06-01 13:56:09 +0200920 job_add_num = numjobs - 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100921
Jens Axboe75154842006-06-01 13:56:09 +0200922 if (add_job(td_new, jobname, job_add_num))
Jens Axboeebac4652005-12-08 15:25:21 +0100923 goto err;
924 }
925 return 0;
926err:
927 put_job(td);
928 return -1;
929}
930
Jens Axboe906c8d72006-06-13 09:37:56 +0200931/*
932 * Initialize the various random states we need (random io, block size ranges,
933 * read/write mix, etc).
934 */
Jens Axboeebac4652005-12-08 15:25:21 +0100935int init_random_state(struct thread_data *td)
936{
Jens Axboe0aabe162007-02-23 08:45:55 +0100937 unsigned long seeds[5];
Jens Axboe53cdc682006-10-18 11:50:58 +0200938 int fd, num_maps, blocks, i;
Jens Axboe0ab8db82006-10-18 17:16:23 +0200939 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100940
Jens Axboef48b4672006-10-27 11:30:07 +0200941 if (td->io_ops->flags & FIO_CPUIO)
942 return 0;
943
Jens Axboe1ac267b2006-05-31 20:29:00 +0200944 fd = open("/dev/urandom", O_RDONLY);
Jens Axboeebac4652005-12-08 15:25:21 +0100945 if (fd == -1) {
Jens Axboee1161c32007-02-22 19:36:48 +0100946 td_verror(td, errno, "open");
Jens Axboeebac4652005-12-08 15:25:21 +0100947 return 1;
948 }
949
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200950 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
Jens Axboee1161c32007-02-22 19:36:48 +0100951 td_verror(td, EIO, "read");
Jens Axboeebac4652005-12-08 15:25:21 +0100952 close(fd);
953 return 1;
954 }
955
956 close(fd);
957
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200958 os_random_seed(seeds[0], &td->bsrange_state);
959 os_random_seed(seeds[1], &td->verify_state);
960 os_random_seed(seeds[2], &td->rwmix_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100961
Jens Axboe413dd452007-02-23 09:26:09 +0100962 if (td->file_service_type == FIO_FSERVICE_RANDOM)
963 os_random_seed(seeds[3], &td->next_file_state);
964
965 if (!td_random(td))
Jens Axboeebac4652005-12-08 15:25:21 +0100966 return 0;
967
Jens Axboe9ebc27e2006-06-12 10:21:50 +0200968 if (td->rand_repeatable)
Jens Axboe0aabe162007-02-23 08:45:55 +0100969 seeds[4] = FIO_RANDSEED * td->thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100970
Jens Axboebb8895e2006-10-30 15:14:48 +0100971 if (!td->norandommap) {
972 for_each_file(td, f, i) {
Jens Axboea4a81712007-02-13 20:07:26 +0100973 blocks = (f->real_file_size + td->rw_min_bs - 1) / td->rw_min_bs;
Jens Axboec7c280e2006-11-02 20:10:33 +0100974 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
Jens Axboebb8895e2006-10-30 15:14:48 +0100975 f->file_map = malloc(num_maps * sizeof(long));
976 f->num_maps = num_maps;
977 memset(f->file_map, 0, num_maps * sizeof(long));
978 }
Jens Axboe53cdc682006-10-18 11:50:58 +0200979 }
Jens Axboeebac4652005-12-08 15:25:21 +0100980
Jens Axboe0aabe162007-02-23 08:45:55 +0100981 os_random_seed(seeds[4], &td->random_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100982 return 0;
983}
984
985static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
986{
987#ifdef FIO_HAVE_CPU_AFFINITY
988 unsigned int i;
989
990 CPU_ZERO(&cpumask);
991
992 for (i = 0; i < sizeof(int) * 8; i++) {
993 if ((1 << i) & cpu)
994 CPU_SET(i, &cpumask);
995 }
996#endif
997}
998
Jens Axboeebac4652005-12-08 15:25:21 +0100999static int is_empty_or_comment(char *line)
1000{
1001 unsigned int i;
1002
1003 for (i = 0; i < strlen(line); i++) {
1004 if (line[i] == ';')
1005 return 1;
Ingo Molnar5cc2da32007-02-20 10:19:44 +01001006 if (line[i] == '#')
1007 return 1;
Jens Axboeebac4652005-12-08 15:25:21 +01001008 if (!isspace(line[i]) && !iscntrl(line[i]))
1009 return 0;
1010 }
1011
1012 return 1;
1013}
1014
Jens Axboe313cb202006-12-21 09:50:00 +01001015/*
1016 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
1017 */
1018static char *get_mmap_file(const char *str)
1019{
1020 char *p = strstr(str, ":");
1021
1022 if (!p)
1023 return NULL;
1024
1025 p++;
1026 strip_blank_front(&p);
1027 strip_blank_end(p);
1028 return strdup(p);
1029}
1030
Jens Axboeb4692822006-10-27 13:43:22 +02001031static int str_mem_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +01001032{
Jens Axboecb2c86f2006-10-26 13:48:34 +02001033 struct thread_data *td = data;
1034
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001035 if (td->mem_type == MEM_MMAPHUGE || td->mem_type == MEM_MMAP) {
Jens Axboe313cb202006-12-21 09:50:00 +01001036 td->mmapfile = get_mmap_file(mem);
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001037 if (td->mem_type == MEM_MMAPHUGE && !td->mmapfile) {
Jens Axboed0bdaf42006-12-20 14:40:44 +01001038 log_err("fio: mmaphuge:/path/to/file\n");
1039 return 1;
1040 }
Jens Axboeebac4652005-12-08 15:25:21 +01001041 }
1042
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001043 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001044}
1045
Joel Becker7b395ca2007-02-28 11:10:58 +01001046/* External engines are specified by "external:name.o") */
1047static const char *get_engine_name(const char *str)
1048{
1049 char *p = strstr(str, ":");
1050
1051 if (!p)
1052 return str;
1053
1054 p++;
1055 strip_blank_front(&p);
1056 strip_blank_end(p);
1057 return p;
1058}
1059
Jens Axboeb4692822006-10-27 13:43:22 +02001060static int str_ioengine_cb(void *data, const char *str)
Jens Axboeebac4652005-12-08 15:25:21 +01001061{
Jens Axboecb2c86f2006-10-26 13:48:34 +02001062 struct thread_data *td = data;
Joel Becker7b395ca2007-02-28 11:10:58 +01001063 const char *name = get_engine_name(str);
Jens Axboecb2c86f2006-10-26 13:48:34 +02001064
Joel Becker7b395ca2007-02-28 11:10:58 +01001065 td->io_ops = load_ioengine(td, name);
Jens Axboe2866c822006-10-09 15:57:48 +02001066 if (td->io_ops)
Jens Axboeebac4652005-12-08 15:25:21 +01001067 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001068
Jens Axboeebac4652005-12-08 15:25:21 +01001069 return 1;
1070}
1071
Jens Axboee1f36502006-10-27 10:54:08 +02001072static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
1073{
1074 mlock_size = *val;
1075 return 0;
1076}
1077
Jens Axboe34cfcda2006-11-03 14:00:45 +01001078#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +02001079static int str_prioclass_cb(void *data, unsigned int *val)
1080{
1081 struct thread_data *td = data;
1082
1083 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1084 return 0;
1085}
1086
1087static int str_prio_cb(void *data, unsigned int *val)
1088{
1089 struct thread_data *td = data;
1090
1091 td->ioprio |= *val;
1092 return 0;
1093}
Jens Axboe34cfcda2006-11-03 14:00:45 +01001094#endif
Jens Axboee1f36502006-10-27 10:54:08 +02001095
1096static int str_exitall_cb(void)
1097{
1098 exitall_on_terminate = 1;
1099 return 0;
1100}
1101
1102static int str_cpumask_cb(void *data, unsigned int *val)
1103{
1104 struct thread_data *td = data;
1105
1106 fill_cpu_mask(td->cpumask, *val);
1107 return 0;
1108}
1109
Jens Axboe07261982006-06-07 10:51:12 +02001110/*
1111 * This is our [ini] type file parser.
1112 */
Jens Axboe1e97cce2006-12-05 11:44:16 +01001113static int parse_jobs_ini(char *file, int stonewall_flag)
Jens Axboeebac4652005-12-08 15:25:21 +01001114{
Jens Axboee1f36502006-10-27 10:54:08 +02001115 unsigned int global;
Jens Axboeebac4652005-12-08 15:25:21 +01001116 struct thread_data *td;
Jens Axboefee3bb42006-10-30 13:32:08 +01001117 char *string, *name;
Jens Axboeebac4652005-12-08 15:25:21 +01001118 fpos_t off;
1119 FILE *f;
1120 char *p;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001121 int ret = 0, stonewall;
Jens Axboeebac4652005-12-08 15:25:21 +01001122
1123 f = fopen(file, "r");
1124 if (!f) {
Jens Axboeaea47d42006-05-26 19:27:29 +02001125 perror("fopen job file");
Jens Axboeebac4652005-12-08 15:25:21 +01001126 return 1;
1127 }
1128
1129 string = malloc(4096);
1130 name = malloc(256);
Jens Axboefee3bb42006-10-30 13:32:08 +01001131 memset(name, 0, 256);
Jens Axboeebac4652005-12-08 15:25:21 +01001132
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001133 stonewall = stonewall_flag;
Jens Axboe7c124ac2006-10-30 13:36:52 +01001134 do {
1135 p = fgets(string, 4095, f);
1136 if (!p)
Jens Axboe45410ac2006-06-07 11:10:39 +02001137 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001138 if (is_empty_or_comment(p))
1139 continue;
Jens Axboefee3bb42006-10-30 13:32:08 +01001140 if (sscanf(p, "[%255s]", name) != 1)
Jens Axboeebac4652005-12-08 15:25:21 +01001141 continue;
1142
1143 global = !strncmp(name, "global", 6);
1144
1145 name[strlen(name) - 1] = '\0';
1146
1147 td = get_new_job(global, &def_thread);
Jens Axboe45410ac2006-06-07 11:10:39 +02001148 if (!td) {
1149 ret = 1;
1150 break;
1151 }
Jens Axboeebac4652005-12-08 15:25:21 +01001152
Jens Axboe972cfd22006-06-09 11:08:56 +02001153 /*
1154 * Seperate multiple job files by a stonewall
1155 */
Jens Axboef9481912006-06-09 11:37:28 +02001156 if (!global && stonewall) {
Jens Axboe972cfd22006-06-09 11:08:56 +02001157 td->stonewall = stonewall;
1158 stonewall = 0;
1159 }
1160
Jens Axboeebac4652005-12-08 15:25:21 +01001161 fgetpos(f, &off);
1162 while ((p = fgets(string, 4096, f)) != NULL) {
1163 if (is_empty_or_comment(p))
1164 continue;
Jens Axboee1f36502006-10-27 10:54:08 +02001165
Jens Axboeb6754f92006-05-30 14:29:32 +02001166 strip_blank_front(&p);
Jens Axboe7c124ac2006-10-30 13:36:52 +01001167
1168 if (p[0] == '[')
1169 break;
1170
Jens Axboe4ae3f762006-05-30 13:35:14 +02001171 strip_blank_end(p);
Jens Axboeaea47d42006-05-26 19:27:29 +02001172
Jens Axboee1f36502006-10-27 10:54:08 +02001173 fgetpos(f, &off);
Jens Axboeebac4652005-12-08 15:25:21 +01001174
Jens Axboe45410ac2006-06-07 11:10:39 +02001175 /*
1176 * Don't break here, continue parsing options so we
1177 * dump all the bad ones. Makes trial/error fixups
1178 * easier on the user.
1179 */
Jens Axboe7c124ac2006-10-30 13:36:52 +01001180 ret |= parse_option(p, options, td);
Jens Axboeebac4652005-12-08 15:25:21 +01001181 }
Jens Axboeebac4652005-12-08 15:25:21 +01001182
Jens Axboe45410ac2006-06-07 11:10:39 +02001183 if (!ret) {
1184 fsetpos(f, &off);
1185 ret = add_job(td, name, 0);
Jens Axboeb1508cf2006-11-02 09:12:40 +01001186 } else {
1187 log_err("fio: job %s dropped\n", name);
1188 put_job(td);
Jens Axboe45410ac2006-06-07 11:10:39 +02001189 }
Jens Axboe7c124ac2006-10-30 13:36:52 +01001190 } while (!ret);
Jens Axboeebac4652005-12-08 15:25:21 +01001191
1192 free(string);
1193 free(name);
1194 fclose(f);
Jens Axboe45410ac2006-06-07 11:10:39 +02001195 return ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001196}
1197
1198static int fill_def_thread(void)
1199{
1200 memset(&def_thread, 0, sizeof(def_thread));
1201
1202 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1203 perror("sched_getaffinity");
1204 return 1;
1205 }
1206
1207 /*
Jens Axboeee738492007-01-10 11:23:16 +01001208 * fill default options
Jens Axboeebac4652005-12-08 15:25:21 +01001209 */
Jens Axboeee738492007-01-10 11:23:16 +01001210 fill_default_options(&def_thread, options);
1211
Jens Axboe972cfd22006-06-09 11:08:56 +02001212 def_thread.timeout = def_timeout;
Jens Axboeec94ec52006-10-20 10:59:19 +02001213 def_thread.write_bw_log = write_bw_log;
1214 def_thread.write_lat_log = write_lat_log;
Jens Axboeee738492007-01-10 11:23:16 +01001215
Jens Axboeebac4652005-12-08 15:25:21 +01001216#ifdef FIO_HAVE_DISK_UTIL
1217 def_thread.do_disk_util = 1;
1218#endif
1219
1220 return 0;
1221}
1222
Jens Axboe0ab8db82006-10-18 17:16:23 +02001223static void usage(void)
Jens Axboe4785f992006-05-26 03:59:10 +02001224{
1225 printf("%s\n", fio_version_string);
Jens Axboeb4692822006-10-27 13:43:22 +02001226 printf("\t--output\tWrite output to file\n");
1227 printf("\t--timeout\tRuntime in seconds\n");
1228 printf("\t--latency-log\tGenerate per-job latency logs\n");
1229 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1230 printf("\t--minimal\tMinimal (terse) output\n");
1231 printf("\t--version\tPrint version info and exit\n");
Jens Axboefd28ca42007-01-09 21:20:13 +01001232 printf("\t--help\t\tPrint this page\n");
1233 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
Jens Axboe4785f992006-05-26 03:59:10 +02001234}
1235
Jens Axboe972cfd22006-06-09 11:08:56 +02001236static int parse_cmd_line(int argc, char *argv[])
Jens Axboeebac4652005-12-08 15:25:21 +01001237{
Jens Axboeb4692822006-10-27 13:43:22 +02001238 struct thread_data *td = NULL;
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001239 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001240
Jens Axboe0be06ea2007-03-01 14:23:28 +01001241 while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
Jens Axboeebac4652005-12-08 15:25:21 +01001242 switch (c) {
Jens Axboeb4692822006-10-27 13:43:22 +02001243 case 't':
1244 def_timeout = atoi(optarg);
1245 break;
1246 case 'l':
1247 write_lat_log = 1;
1248 break;
1249 case 'w':
1250 write_bw_log = 1;
1251 break;
1252 case 'o':
1253 f_out = fopen(optarg, "w+");
1254 if (!f_out) {
1255 perror("fopen output");
1256 exit(1);
1257 }
1258 f_err = f_out;
1259 break;
1260 case 'm':
1261 terse_output = 1;
1262 break;
1263 case 'h':
1264 usage();
1265 exit(0);
Jens Axboefd28ca42007-01-09 21:20:13 +01001266 case 'c':
Jens Axboe29fc6af2007-01-09 21:22:02 +01001267 ret = show_cmd_help(options, optarg);
1268 exit(ret);
Jens Axboeb4692822006-10-27 13:43:22 +02001269 case 'v':
1270 printf("%s\n", fio_version_string);
1271 exit(0);
1272 case FIO_GETOPT_JOB: {
1273 const char *opt = long_options[lidx].name;
1274 char *val = optarg;
1275
Jens Axboec2b1e752006-10-30 09:03:13 +01001276 if (!strncmp(opt, "name", 4) && td) {
1277 ret = add_job(td, td->name ?: "fio", 0);
1278 if (ret) {
1279 put_job(td);
1280 return 0;
1281 }
1282 td = NULL;
1283 }
Jens Axboeb4692822006-10-27 13:43:22 +02001284 if (!td) {
Jens Axboe38d0adb2006-10-30 12:21:25 +01001285 int global = !strncmp(val, "global", 6);
Jens Axboec2b1e752006-10-30 09:03:13 +01001286
1287 td = get_new_job(global, &def_thread);
Jens Axboeb4692822006-10-27 13:43:22 +02001288 if (!td)
1289 return 0;
1290 }
Jens Axboe38d0adb2006-10-30 12:21:25 +01001291
Jens Axboeb1508cf2006-11-02 09:12:40 +01001292 ret = parse_cmd_option(opt, val, options, td);
Jens Axboe78217df2007-02-23 11:18:30 +01001293 if (ret)
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001294 dont_add_job = 1;
Jens Axboeb4692822006-10-27 13:43:22 +02001295 break;
1296 }
1297 default:
Jens Axboeb4692822006-10-27 13:43:22 +02001298 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001299 }
1300 }
Jens Axboec9fad892006-05-27 17:26:50 +02001301
Jens Axboeb4692822006-10-27 13:43:22 +02001302 if (td) {
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001303 if (dont_add_job)
Jens Axboeb4692822006-10-27 13:43:22 +02001304 put_job(td);
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001305 else {
1306 ret = add_job(td, td->name ?: "fio", 0);
1307 if (ret)
1308 put_job(td);
1309 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001310 }
Jens Axboe774a6172006-08-24 08:44:26 +02001311
Jens Axboeb4692822006-10-27 13:43:22 +02001312 while (optind < argc) {
1313 ini_idx++;
1314 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1315 ini_file[ini_idx - 1] = strdup(argv[optind]);
1316 optind++;
Jens Axboeeb8bbf42006-06-08 21:40:11 +02001317 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001318
1319 return ini_idx;
Jens Axboeebac4652005-12-08 15:25:21 +01001320}
1321
1322static void free_shm(void)
1323{
1324 struct shmid_ds sbuf;
1325
1326 if (threads) {
Jens Axboe2c0ecd22006-06-08 13:25:41 +02001327 shmdt((void *) threads);
Jens Axboeebac4652005-12-08 15:25:21 +01001328 threads = NULL;
1329 shmctl(shm_id, IPC_RMID, &sbuf);
1330 }
1331}
1332
Jens Axboe906c8d72006-06-13 09:37:56 +02001333/*
1334 * The thread area is shared between the main process and the job
1335 * threads/processes. So setup a shared memory segment that will hold
1336 * all the job info.
1337 */
Jens Axboeebac4652005-12-08 15:25:21 +01001338static int setup_thread_area(void)
1339{
1340 /*
1341 * 1024 is too much on some machines, scale max_jobs if
1342 * we get a failure that looks like too large a shm segment
1343 */
1344 do {
Jens Axboe906c8d72006-06-13 09:37:56 +02001345 size_t size = max_jobs * sizeof(struct thread_data);
Jens Axboeebac4652005-12-08 15:25:21 +01001346
Jens Axboe906c8d72006-06-13 09:37:56 +02001347 shm_id = shmget(0, size, IPC_CREAT | 0600);
Jens Axboeebac4652005-12-08 15:25:21 +01001348 if (shm_id != -1)
1349 break;
1350 if (errno != EINVAL) {
1351 perror("shmget");
1352 break;
1353 }
1354
1355 max_jobs >>= 1;
1356 } while (max_jobs);
1357
1358 if (shm_id == -1)
1359 return 1;
1360
1361 threads = shmat(shm_id, NULL, 0);
1362 if (threads == (void *) -1) {
1363 perror("shmat");
1364 return 1;
1365 }
1366
1367 atexit(free_shm);
1368 return 0;
1369}
1370
Jens Axboeb4692822006-10-27 13:43:22 +02001371/*
1372 * Copy the fio options into the long options map, so we mirror
1373 * job and cmd line options.
1374 */
1375static void dupe_job_options(void)
1376{
1377 struct fio_option *o;
1378 unsigned int i;
1379
1380 i = 0;
1381 while (long_options[i].name)
1382 i++;
1383
1384 o = &options[0];
1385 while (o->name) {
1386 long_options[i].name = o->name;
1387 long_options[i].val = FIO_GETOPT_JOB;
1388 if (o->type == FIO_OPT_STR_SET)
1389 long_options[i].has_arg = no_argument;
1390 else
1391 long_options[i].has_arg = required_argument;
1392
1393 i++;
1394 o++;
1395 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1396 }
1397}
1398
Jens Axboeebac4652005-12-08 15:25:21 +01001399int parse_options(int argc, char *argv[])
1400{
Jens Axboe972cfd22006-06-09 11:08:56 +02001401 int job_files, i;
1402
Jens Axboeb4692822006-10-27 13:43:22 +02001403 f_out = stdout;
1404 f_err = stderr;
1405
Jens Axboe13335dd2007-01-10 13:14:02 +01001406 options_init(options);
1407
Jens Axboeb4692822006-10-27 13:43:22 +02001408 dupe_job_options();
1409
Jens Axboeebac4652005-12-08 15:25:21 +01001410 if (setup_thread_area())
1411 return 1;
1412 if (fill_def_thread())
1413 return 1;
1414
Jens Axboe972cfd22006-06-09 11:08:56 +02001415 job_files = parse_cmd_line(argc, argv);
Jens Axboeebac4652005-12-08 15:25:21 +01001416
Jens Axboe972cfd22006-06-09 11:08:56 +02001417 for (i = 0; i < job_files; i++) {
1418 if (fill_def_thread())
1419 return 1;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001420 if (parse_jobs_ini(ini_file[i], i))
Jens Axboe972cfd22006-06-09 11:08:56 +02001421 return 1;
Jens Axboe88c6ed82006-06-09 11:28:10 +02001422 free(ini_file[i]);
Jens Axboe972cfd22006-06-09 11:08:56 +02001423 }
Jens Axboeebac4652005-12-08 15:25:21 +01001424
Jens Axboe88c6ed82006-06-09 11:28:10 +02001425 free(ini_file);
Jens Axboeb4692822006-10-27 13:43:22 +02001426
1427 if (!thread_number) {
1428 log_err("No jobs defined(s)\n");
Jens Axboeb4692822006-10-27 13:43:22 +02001429 return 1;
1430 }
1431
Jens Axboeebac4652005-12-08 15:25:21 +01001432 return 0;
1433}