blob: c6837c9f91d3bea0db10d7a8a4a106bcf9268deb [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 Axboe0aabe162007-02-23 08:45:55 +0100185 .name = "file_service_type",
186 .type = FIO_OPT_STR,
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100187 .off1 = td_var_offset(file_service_type),
Jens Axboe0aabe162007-02-23 08:45:55 +0100188 .help = "How to select which file to service next",
189 .def = "roundrobin",
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100190 .posval = {
191 { .ival = "random", .oval = FIO_FSERVICE_RANDOM },
192 { .ival = "roundrobin", .oval = FIO_FSERVICE_RR },
193 },
Jens Axboe0aabe162007-02-23 08:45:55 +0100194 },
195 {
Jens Axboe03b74b32007-01-11 11:04:31 +0100196 .name = "fsync",
197 .type = FIO_OPT_INT,
198 .off1 = td_var_offset(fsync_blocks),
199 .help = "Issue fsync for writes every given number of blocks",
200 .def = "0",
201 },
202 {
203 .name = "direct",
204 .type = FIO_OPT_BOOL,
205 .off1 = td_var_offset(odirect),
Jens Axboe76a43db2007-01-11 13:24:44 +0100206 .help = "Use O_DIRECT IO (negates buffered)",
207 .def = "0",
208 },
209 {
210 .name = "buffered",
211 .type = FIO_OPT_BOOL,
212 .off1 = td_var_offset(odirect),
213 .neg = 1,
214 .help = "Use buffered IO (negates direct)",
Jens Axboe03b74b32007-01-11 11:04:31 +0100215 .def = "1",
216 },
217 {
218 .name = "overwrite",
219 .type = FIO_OPT_BOOL,
220 .off1 = td_var_offset(overwrite),
221 .help = "When writing, set whether to overwrite current data",
222 .def = "0",
223 },
224 {
225 .name = "loops",
226 .type = FIO_OPT_INT,
227 .off1 = td_var_offset(loops),
228 .help = "Number of times to run the job",
229 .def = "1",
230 },
231 {
232 .name = "numjobs",
233 .type = FIO_OPT_INT,
234 .off1 = td_var_offset(numjobs),
235 .help = "Duplicate this job this many times",
236 .def = "1",
237 },
238 {
239 .name = "startdelay",
240 .type = FIO_OPT_INT,
241 .off1 = td_var_offset(start_delay),
242 .help = "Only start job when this period has passed",
243 .def = "0",
244 },
245 {
246 .name = "runtime",
247 .alias = "timeout",
248 .type = FIO_OPT_STR_VAL_TIME,
249 .off1 = td_var_offset(timeout),
250 .help = "Stop workload when this amount of time has passed",
251 .def = "0",
252 },
253 {
Jens Axboee1f36502006-10-27 10:54:08 +0200254 .name = "mem",
255 .type = FIO_OPT_STR,
256 .cb = str_mem_cb,
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100257 .off1 = td_var_offset(mem_type),
Jens Axboe15f79182007-01-10 12:26:18 +0100258 .help = "Backing type for IO buffers",
Jens Axboeee738492007-01-10 11:23:16 +0100259 .def = "malloc",
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100260 .posval = {
261 { .ival = "malloc", .oval = MEM_MALLOC },
262 { .ival = "shm", .oval = MEM_SHM },
263#ifdef FIO_HAVE_HUGETLB
264 { .ival = "shmhuge", .oval = MEM_SHMHUGE },
265#endif
266 { .ival = "mmap", .oval = MEM_MMAP },
267#ifdef FIO_HAVE_HUGETLB
268 { .ival = "mmaphuge", .oval = MEM_MMAPHUGE },
269#endif
270 },
Jens Axboee1f36502006-10-27 10:54:08 +0200271 },
272 {
273 .name = "verify",
274 .type = FIO_OPT_STR,
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100275 .off1 = td_var_offset(verify),
Jens Axboe15f79182007-01-10 12:26:18 +0100276 .help = "Verify sum function",
Jens Axboeee738492007-01-10 11:23:16 +0100277 .def = "0",
Jens Axboeb1ec1da2007-02-23 10:29:16 +0100278 .posval = {
279 { .ival = "0", .oval = VERIFY_NONE },
280 { .ival = "crc32", .oval = VERIFY_CRC32 },
281 { .ival = "md5", .oval = VERIFY_MD5 },
282 },
Jens Axboee1f36502006-10-27 10:54:08 +0200283 },
284 {
285 .name = "write_iolog",
Jens Axboe076efc72006-10-27 11:24:25 +0200286 .type = FIO_OPT_STR_STORE,
287 .off1 = td_var_offset(write_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100288 .help = "Store IO pattern to file",
Jens Axboee1f36502006-10-27 10:54:08 +0200289 },
290 {
Jens Axboe076efc72006-10-27 11:24:25 +0200291 .name = "read_iolog",
Jens Axboee1f36502006-10-27 10:54:08 +0200292 .type = FIO_OPT_STR_STORE,
Jens Axboe076efc72006-10-27 11:24:25 +0200293 .off1 = td_var_offset(read_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100294 .help = "Playback IO pattern from file",
Jens Axboee1f36502006-10-27 10:54:08 +0200295 },
296 {
297 .name = "exec_prerun",
298 .type = FIO_OPT_STR_STORE,
299 .off1 = td_var_offset(exec_prerun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100300 .help = "Execute this file prior to running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200301 },
302 {
303 .name = "exec_postrun",
304 .type = FIO_OPT_STR_STORE,
305 .off1 = td_var_offset(exec_postrun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100306 .help = "Execute this file after running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200307 },
308#ifdef FIO_HAVE_IOSCHED_SWITCH
309 {
310 .name = "ioscheduler",
311 .type = FIO_OPT_STR_STORE,
312 .off1 = td_var_offset(ioscheduler),
Jens Axboefd28ca42007-01-09 21:20:13 +0100313 .help = "Use this IO scheduler on the backing device",
Jens Axboee1f36502006-10-27 10:54:08 +0200314 },
315#endif
316 {
Jens Axboee1f36502006-10-27 10:54:08 +0200317 .name = "zonesize",
318 .type = FIO_OPT_STR_VAL,
319 .off1 = td_var_offset(zone_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100320 .help = "Give size of an IO zone",
Jens Axboeee738492007-01-10 11:23:16 +0100321 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200322 },
323 {
324 .name = "zoneskip",
325 .type = FIO_OPT_STR_VAL,
326 .off1 = td_var_offset(zone_skip),
Jens Axboefd28ca42007-01-09 21:20:13 +0100327 .help = "Space between IO zones",
Jens Axboeee738492007-01-10 11:23:16 +0100328 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200329 },
330 {
331 .name = "lockmem",
332 .type = FIO_OPT_STR_VAL,
333 .cb = str_lockmem_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100334 .help = "Lock down this amount of memory",
Jens Axboeee738492007-01-10 11:23:16 +0100335 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200336 },
337 {
Jens Axboee1f36502006-10-27 10:54:08 +0200338 .name = "rwmixcycle",
339 .type = FIO_OPT_INT,
340 .off1 = td_var_offset(rwmixcycle),
Jens Axboeee738492007-01-10 11:23:16 +0100341 .help = "Cycle period for mixed read/write workloads (msec)",
342 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200343 },
344 {
345 .name = "rwmixread",
346 .type = FIO_OPT_INT,
347 .off1 = td_var_offset(rwmixread),
Jens Axboeee738492007-01-10 11:23:16 +0100348 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100349 .help = "Percentage of mixed workload that is reads",
Jens Axboeee738492007-01-10 11:23:16 +0100350 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200351 },
352 {
353 .name = "rwmixwrite",
354 .type = FIO_OPT_INT,
355 .off1 = td_var_offset(rwmixwrite),
Jens Axboeee738492007-01-10 11:23:16 +0100356 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100357 .help = "Percentage of mixed workload that is writes",
Jens Axboeee738492007-01-10 11:23:16 +0100358 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200359 },
360 {
361 .name = "nice",
362 .type = FIO_OPT_INT,
363 .off1 = td_var_offset(nice),
Jens Axboefd28ca42007-01-09 21:20:13 +0100364 .help = "Set job CPU nice value",
Jens Axboe15f79182007-01-10 12:26:18 +0100365 .minval = -19,
Jens Axboeee738492007-01-10 11:23:16 +0100366 .maxval = 20,
367 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200368 },
369#ifdef FIO_HAVE_IOPRIO
370 {
371 .name = "prio",
372 .type = FIO_OPT_INT,
373 .cb = str_prio_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100374 .help = "Set job IO priority value",
Jens Axboe15f79182007-01-10 12:26:18 +0100375 .minval = 0,
376 .maxval = 7,
Jens Axboee1f36502006-10-27 10:54:08 +0200377 },
378 {
379 .name = "prioclass",
380 .type = FIO_OPT_INT,
381 .cb = str_prioclass_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100382 .help = "Set job IO priority class",
Jens Axboe15f79182007-01-10 12:26:18 +0100383 .minval = 0,
384 .maxval = 3,
Jens Axboee1f36502006-10-27 10:54:08 +0200385 },
386#endif
387 {
388 .name = "thinktime",
389 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100390 .off1 = td_var_offset(thinktime),
Jens Axboe5fa0f812007-01-11 14:06:35 +0100391 .help = "Idle time between IO buffers (usec)",
Jens Axboeee738492007-01-10 11:23:16 +0100392 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200393 },
394 {
Jens Axboe48097d52007-02-17 06:30:44 +0100395 .name = "thinktime_spin",
396 .type = FIO_OPT_INT,
397 .off1 = td_var_offset(thinktime_spin),
398 .help = "Start thinktime by spinning this amount (usec)",
399 .def = "0",
400 },
401 {
Jens Axboe9c1f7432007-01-03 20:43:19 +0100402 .name = "thinktime_blocks",
403 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100404 .off1 = td_var_offset(thinktime_blocks),
Jens Axboefd28ca42007-01-09 21:20:13 +0100405 .help = "IO buffer period between 'thinktime'",
Jens Axboeee738492007-01-10 11:23:16 +0100406 .def = "1",
Jens Axboe9c1f7432007-01-03 20:43:19 +0100407 },
408 {
Jens Axboee1f36502006-10-27 10:54:08 +0200409 .name = "rate",
410 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100411 .off1 = td_var_offset(rate),
Jens Axboefd28ca42007-01-09 21:20:13 +0100412 .help = "Set bandwidth rate",
Jens Axboee1f36502006-10-27 10:54:08 +0200413 },
414 {
415 .name = "ratemin",
416 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100417 .off1 = td_var_offset(ratemin),
Jens Axboefd28ca42007-01-09 21:20:13 +0100418 .help = "The bottom limit accepted",
Jens Axboee1f36502006-10-27 10:54:08 +0200419 },
420 {
421 .name = "ratecycle",
422 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100423 .off1 = td_var_offset(ratecycle),
Jens Axboe6da1fa72007-01-10 11:27:48 +0100424 .help = "Window average for rate limits (msec)",
Jens Axboeee738492007-01-10 11:23:16 +0100425 .def = "1000",
Jens Axboee1f36502006-10-27 10:54:08 +0200426 },
427 {
Jens Axboee1f36502006-10-27 10:54:08 +0200428 .name = "invalidate",
Jens Axboe13335dd2007-01-10 13:14:02 +0100429 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100430 .off1 = td_var_offset(invalidate_cache),
Jens Axboefd28ca42007-01-09 21:20:13 +0100431 .help = "Invalidate buffer/page cache prior to running job",
Jens Axboeee738492007-01-10 11:23:16 +0100432 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200433 },
434 {
435 .name = "sync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100436 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100437 .off1 = td_var_offset(sync_io),
Jens Axboefd28ca42007-01-09 21:20:13 +0100438 .help = "Use O_SYNC for buffered writes",
Jens Axboeee738492007-01-10 11:23:16 +0100439 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200440 },
441 {
442 .name = "bwavgtime",
443 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100444 .off1 = td_var_offset(bw_avg_time),
Jens Axboeee738492007-01-10 11:23:16 +0100445 .help = "Time window over which to calculate bandwidth (msec)",
446 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200447 },
448 {
449 .name = "create_serialize",
Jens Axboe13335dd2007-01-10 13:14:02 +0100450 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100451 .off1 = td_var_offset(create_serialize),
Jens Axboefd28ca42007-01-09 21:20:13 +0100452 .help = "Serialize creating of job files",
Jens Axboeee738492007-01-10 11:23:16 +0100453 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200454 },
455 {
456 .name = "create_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100457 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100458 .off1 = td_var_offset(create_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100459 .help = "Fsync file after creation",
Jens Axboeee738492007-01-10 11:23:16 +0100460 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200461 },
462 {
Jens Axboee1f36502006-10-27 10:54:08 +0200463 .name = "cpuload",
464 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100465 .off1 = td_var_offset(cpuload),
Jens Axboefd28ca42007-01-09 21:20:13 +0100466 .help = "Use this percentage of CPU",
Jens Axboee1f36502006-10-27 10:54:08 +0200467 },
468 {
469 .name = "cpuchunks",
470 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100471 .off1 = td_var_offset(cpucycle),
Jens Axboefd28ca42007-01-09 21:20:13 +0100472 .help = "Length of the CPU burn cycles",
Jens Axboee1f36502006-10-27 10:54:08 +0200473 },
Jens Axboee1f36502006-10-27 10:54:08 +0200474#ifdef FIO_HAVE_CPU_AFFINITY
475 {
476 .name = "cpumask",
477 .type = FIO_OPT_INT,
478 .cb = str_cpumask_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100479 .help = "CPU affinity mask",
Jens Axboee1f36502006-10-27 10:54:08 +0200480 },
481#endif
482 {
483 .name = "end_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100484 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100485 .off1 = td_var_offset(end_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100486 .help = "Include fsync at the end of job",
Jens Axboeee738492007-01-10 11:23:16 +0100487 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200488 },
489 {
490 .name = "unlink",
Jens Axboe13335dd2007-01-10 13:14:02 +0100491 .type = FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +0200492 .off1 = td_var_offset(unlink),
Jens Axboeee738492007-01-10 11:23:16 +0100493 .help = "Unlink created files after job has completed",
Jens Axboee545a6c2007-01-14 00:00:29 +0100494 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200495 },
496 {
497 .name = "exitall",
498 .type = FIO_OPT_STR_SET,
499 .cb = str_exitall_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100500 .help = "Terminate all jobs when one exits",
Jens Axboee1f36502006-10-27 10:54:08 +0200501 },
502 {
503 .name = "stonewall",
504 .type = FIO_OPT_STR_SET,
505 .off1 = td_var_offset(stonewall),
Jens Axboefd28ca42007-01-09 21:20:13 +0100506 .help = "Insert a hard barrier between this job and previous",
Jens Axboee1f36502006-10-27 10:54:08 +0200507 },
508 {
509 .name = "thread",
510 .type = FIO_OPT_STR_SET,
Jens Axboed9bb3b82007-01-10 20:30:53 +0100511 .off1 = td_var_offset(use_thread),
Jens Axboefd28ca42007-01-09 21:20:13 +0100512 .help = "Use threads instead of forks",
Jens Axboee1f36502006-10-27 10:54:08 +0200513 },
514 {
515 .name = "write_bw_log",
516 .type = FIO_OPT_STR_SET,
517 .off1 = td_var_offset(write_bw_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100518 .help = "Write log of bandwidth during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200519 },
520 {
521 .name = "write_lat_log",
522 .type = FIO_OPT_STR_SET,
523 .off1 = td_var_offset(write_lat_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100524 .help = "Write log of latency during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200525 },
526 {
Jens Axboe56bb17f2006-12-20 20:27:36 +0100527 .name = "hugepage-size",
528 .type = FIO_OPT_STR_VAL,
529 .off1 = td_var_offset(hugepage_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100530 .help = "When using hugepages, specify size of each page",
Jens Axboeee738492007-01-10 11:23:16 +0100531 .def = __stringify(FIO_HUGE_PAGE),
Jens Axboe56bb17f2006-12-20 20:27:36 +0100532 },
533 {
Jens Axboee1f36502006-10-27 10:54:08 +0200534 .name = NULL,
535 },
536};
537
Jens Axboeb4692822006-10-27 13:43:22 +0200538#define FIO_JOB_OPTS (sizeof(options) / sizeof(struct fio_option))
539#define FIO_CMD_OPTS (16)
540#define FIO_GETOPT_JOB (0x89988998)
541
542/*
543 * Command line options. These will contain the above, plus a few
544 * extra that only pertain to fio itself and not jobs.
545 */
546static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
547 {
548 .name = "output",
549 .has_arg = required_argument,
550 .val = 'o',
551 },
552 {
553 .name = "timeout",
554 .has_arg = required_argument,
555 .val = 't',
556 },
557 {
558 .name = "latency-log",
559 .has_arg = required_argument,
560 .val = 'l',
561 },
562 {
563 .name = "bandwidth-log",
564 .has_arg = required_argument,
565 .val = 'b',
566 },
567 {
568 .name = "minimal",
569 .has_arg = optional_argument,
570 .val = 'm',
571 },
572 {
573 .name = "version",
574 .has_arg = no_argument,
575 .val = 'v',
576 },
577 {
Jens Axboefd28ca42007-01-09 21:20:13 +0100578 .name = "help",
579 .has_arg = no_argument,
580 .val = 'h',
581 },
582 {
583 .name = "cmdhelp",
584 .has_arg = required_argument,
585 .val = 'c',
586 },
587 {
Jens Axboeb4692822006-10-27 13:43:22 +0200588 .name = NULL,
589 },
590};
591
Jens Axboeee738492007-01-10 11:23:16 +0100592static int def_timeout = 0;
Jens Axboe972cfd22006-06-09 11:08:56 +0200593
Jens Axboee77fe332007-02-27 20:38:51 +0100594static char fio_version_string[] = "fio 1.12";
Jens Axboeebac4652005-12-08 15:25:21 +0100595
Jens Axboe972cfd22006-06-09 11:08:56 +0200596static char **ini_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100597static int max_jobs = MAX_JOBS;
598
599struct thread_data def_thread;
600struct thread_data *threads = NULL;
601
Jens Axboeebac4652005-12-08 15:25:21 +0100602int exitall_on_terminate = 0;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200603int terse_output = 0;
Jens Axboec04f7ec2006-05-31 10:13:16 +0200604unsigned long long mlock_size = 0;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200605FILE *f_out = NULL;
606FILE *f_err = NULL;
Jens Axboeebac4652005-12-08 15:25:21 +0100607
Jens Axboeee738492007-01-10 11:23:16 +0100608static int write_lat_log = 0;
Jens Axboebb3884d2007-01-17 17:23:11 +1100609int write_bw_log = 0;
Jens Axboeec94ec52006-10-20 10:59:19 +0200610
Joel Becker9728ce32007-03-01 08:24:39 +0100611FILE *get_f_out()
612{
613 return f_out;
614}
615
616FILE *get_f_err()
617{
618 return f_err;
619}
620
Jens Axboe906c8d72006-06-13 09:37:56 +0200621/*
622 * Return a free job structure.
623 */
Jens Axboeebac4652005-12-08 15:25:21 +0100624static struct thread_data *get_new_job(int global, struct thread_data *parent)
625{
626 struct thread_data *td;
627
628 if (global)
629 return &def_thread;
630 if (thread_number >= max_jobs)
631 return NULL;
632
633 td = &threads[thread_number++];
Jens Axboeddaeaa52006-06-08 11:00:58 +0200634 *td = *parent;
Jens Axboeebac4652005-12-08 15:25:21 +0100635
Jens Axboeebac4652005-12-08 15:25:21 +0100636 td->thread_number = thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100637 return td;
638}
639
640static void put_job(struct thread_data *td)
641{
Jens Axboe549577a2006-10-30 12:23:41 +0100642 if (td == &def_thread)
643 return;
644
Jens Axboe16edf252007-02-10 14:59:22 +0100645 if (td->error)
646 fprintf(f_out, "fio: %s\n", td->verror);
647
Jens Axboeebac4652005-12-08 15:25:21 +0100648 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
649 thread_number--;
650}
651
Jens Axboedad915e2006-10-27 11:10:18 +0200652/*
653 * Lazy way of fixing up options that depend on each other. We could also
654 * define option callback handlers, but this is easier.
655 */
Jens Axboee1f36502006-10-27 10:54:08 +0200656static void fixup_options(struct thread_data *td)
657{
Jens Axboee1f36502006-10-27 10:54:08 +0200658 if (!td->rwmixread && td->rwmixwrite)
659 td->rwmixread = 100 - td->rwmixwrite;
Jens Axboedad915e2006-10-27 11:10:18 +0200660
Jens Axboe076efc72006-10-27 11:24:25 +0200661 if (td->write_iolog_file && td->read_iolog_file) {
662 log_err("fio: read iolog overrides write_iolog\n");
663 free(td->write_iolog_file);
664 td->write_iolog_file = NULL;
665 }
Jens Axboe16b462a2006-10-30 12:35:18 +0100666
667 if (td->io_ops->flags & FIO_SYNCIO)
668 td->iodepth = 1;
669 else {
670 if (!td->iodepth)
671 td->iodepth = td->nr_files;
672 }
673
674 /*
675 * only really works for sequential io for now, and with 1 file
676 */
Jens Axboe413dd452007-02-23 09:26:09 +0100677 if (td->zone_size && td_random(td) && td->nr_files == 1)
Jens Axboe16b462a2006-10-30 12:35:18 +0100678 td->zone_size = 0;
679
680 /*
681 * Reads can do overwrites, we always need to pre-create the file
682 */
683 if (td_read(td) || td_rw(td))
684 td->overwrite = 1;
685
Jens Axboea00735e2006-11-03 08:58:08 +0100686 if (!td->min_bs[DDIR_READ])
687 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
688 if (!td->max_bs[DDIR_READ])
689 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
690 if (!td->min_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100691 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100692 if (!td->max_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100693 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100694
695 td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
696
Jens Axboe16b462a2006-10-30 12:35:18 +0100697 if (td_read(td) && !td_rw(td))
698 td->verify = 0;
Jens Axboebb8895e2006-10-30 15:14:48 +0100699
700 if (td->norandommap && td->verify != VERIFY_NONE) {
701 log_err("fio: norandommap given, verify disabled\n");
702 td->verify = VERIFY_NONE;
703 }
Jens Axboe690adba2006-10-30 15:25:09 +0100704 if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
705 log_err("fio: bs_unaligned may not work with raw io\n");
Jens Axboee0a22332006-12-20 12:54:25 +0100706
707 /*
708 * O_DIRECT and char doesn't mix, clear that flag if necessary.
709 */
710 if (td->filetype == FIO_TYPE_CHAR && td->odirect)
711 td->odirect = 0;
Jens Axboe48097d52007-02-17 06:30:44 +0100712
713 /*
714 * thinktime_spin must be less than thinktime
715 */
716 if (td->thinktime_spin > td->thinktime)
717 td->thinktime_spin = td->thinktime;
Jens Axboee916b392007-02-20 14:37:26 +0100718
719 /*
720 * The low water mark cannot be bigger than the iodepth
721 */
Jens Axboe9467b772007-02-27 19:56:43 +0100722 if (td->iodepth_low > td->iodepth || !td->iodepth_low) {
723 /*
724 * syslet work around - if the workload is sequential,
725 * we want to let the queue drain all the way down to
726 * avoid seeking between async threads
727 */
728 if (!strcmp(td->io_ops->name, "syslet-rw") && !td_random(td))
729 td->iodepth_low = 1;
730 else
731 td->iodepth_low = td->iodepth;
732 }
Jens Axboecb5ab512007-02-26 12:57:09 +0100733
734 /*
735 * If batch number isn't set, default to the same as iodepth
736 */
737 if (td->iodepth_batch > td->iodepth || !td->iodepth_batch)
738 td->iodepth_batch = td->iodepth;
Jens Axboee1f36502006-10-27 10:54:08 +0200739}
740
Jens Axboe906c8d72006-06-13 09:37:56 +0200741/*
Jens Axboef8977ee2006-11-06 14:03:03 +0100742 * This function leaks the buffer
743 */
744static char *to_kmg(unsigned int val)
745{
746 char *buf = malloc(32);
Jens Axboef3502ba2007-02-14 01:27:09 +0100747 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
Jens Axboef8977ee2006-11-06 14:03:03 +0100748 char *p = post;
749
Jens Axboe245142f2006-11-08 12:49:21 +0100750 do {
Jens Axboef8977ee2006-11-06 14:03:03 +0100751 if (val & 1023)
752 break;
753
754 val >>= 10;
755 p++;
Jens Axboe245142f2006-11-08 12:49:21 +0100756 } while (*p);
Jens Axboef8977ee2006-11-06 14:03:03 +0100757
758 snprintf(buf, 31, "%u%c", val, *p);
759 return buf;
760}
761
762/*
Jens Axboe906c8d72006-06-13 09:37:56 +0200763 * Adds a job to the list of things todo. Sanitizes the various options
764 * to make sure we don't have conflicts, and initializes various
765 * members of td.
766 */
Jens Axboe75154842006-06-01 13:56:09 +0200767static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
Jens Axboeebac4652005-12-08 15:25:21 +0100768{
Jens Axboe413dd452007-02-23 09:26:09 +0100769 const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
770 "randread", "randwrite", "randrw" };
Jens Axboeebac4652005-12-08 15:25:21 +0100771 struct stat sb;
Jens Axboe413dd452007-02-23 09:26:09 +0100772 int numjobs, i;
Jens Axboe53cdc682006-10-18 11:50:58 +0200773 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100774
Jens Axboeebac4652005-12-08 15:25:21 +0100775 /*
776 * the def_thread is just for options, it's not a real job
777 */
778 if (td == &def_thread)
779 return 0;
780
Jens Axboeee738492007-01-10 11:23:16 +0100781 assert(td->io_ops);
Jens Axboedf641192006-10-12 07:55:41 +0200782
Jens Axboe690adba2006-10-30 15:25:09 +0100783 if (td->odirect)
784 td->io_ops->flags |= FIO_RAWIO;
785
Jens Axboeebac4652005-12-08 15:25:21 +0100786 td->filetype = FIO_TYPE_FILE;
Jens Axboe890df532007-02-17 01:51:13 +0100787 if (td->filename && !lstat(td->filename, &sb)) {
Jens Axboe0af7b542006-02-17 10:10:12 +0100788 if (S_ISBLK(sb.st_mode))
789 td->filetype = FIO_TYPE_BD;
790 else if (S_ISCHR(sb.st_mode))
791 td->filetype = FIO_TYPE_CHAR;
792 }
Jens Axboeebac4652005-12-08 15:25:21 +0100793
Jens Axboee0a22332006-12-20 12:54:25 +0100794 fixup_options(td);
795
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200796 if (td->filename)
797 td->nr_uniq_files = 1;
798 else
799 td->nr_uniq_files = td->nr_files;
800
801 if (td->filetype == FIO_TYPE_FILE || td->filename) {
Jens Axboee9c047a2006-06-07 21:13:04 +0200802 char tmp[PATH_MAX];
Jens Axboe53cdc682006-10-18 11:50:58 +0200803 int len = 0;
Jens Axboee9c047a2006-06-07 21:13:04 +0200804
Jens Axboe16edf252007-02-10 14:59:22 +0100805 if (td->directory && td->directory[0] != '\0') {
806 if (lstat(td->directory, &sb) < 0) {
807 log_err("fio: %s is not a directory\n", td->directory);
Jens Axboee1161c32007-02-22 19:36:48 +0100808 td_verror(td, errno, "lstat");
Jens Axboe16edf252007-02-10 14:59:22 +0100809 return 1;
810 }
811 if (!S_ISDIR(sb.st_mode)) {
812 log_err("fio: %s is not a directory\n", td->directory);
813 return 1;
814 }
Jens Axboe8aeebd52007-01-08 10:47:43 +0100815 len = sprintf(tmp, "%s/", td->directory);
Jens Axboe16edf252007-02-10 14:59:22 +0100816 }
Jens Axboeebac4652005-12-08 15:25:21 +0100817
Jens Axboe53cdc682006-10-18 11:50:58 +0200818 td->files = malloc(sizeof(struct fio_file) * td->nr_files);
819
820 for_each_file(td, f, i) {
821 memset(f, 0, sizeof(*f));
822 f->fd = -1;
823
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200824 if (td->filename)
825 sprintf(tmp + len, "%s", td->filename);
826 else
827 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
Jens Axboe53cdc682006-10-18 11:50:58 +0200828 f->file_name = strdup(tmp);
829 }
830 } else {
831 td->nr_files = 1;
832 td->files = malloc(sizeof(struct fio_file));
833 f = &td->files[0];
834
835 memset(f, 0, sizeof(*f));
836 f->fd = -1;
837 f->file_name = strdup(jobname);
838 }
839
840 for_each_file(td, f, i) {
841 f->file_size = td->total_file_size / td->nr_files;
842 f->file_offset = td->start_offset;
843 }
844
Jens Axboebbfd6b02006-06-07 19:42:54 +0200845 fio_sem_init(&td->mutex, 0);
Jens Axboeebac4652005-12-08 15:25:21 +0100846
Jens Axboe079ad092007-02-20 13:58:20 +0100847 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
848 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
849 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
Jens Axboeebac4652005-12-08 15:25:21 +0100850
Jens Axboeebac4652005-12-08 15:25:21 +0100851 if (td->stonewall && td->thread_number > 1)
852 groupid++;
853
854 td->groupid = groupid;
855
856 if (setup_rate(td))
857 goto err;
858
Jens Axboeec94ec52006-10-20 10:59:19 +0200859 if (td->write_lat_log) {
Jens Axboe079ad092007-02-20 13:58:20 +0100860 setup_log(&td->ts.slat_log);
861 setup_log(&td->ts.clat_log);
Jens Axboeebac4652005-12-08 15:25:21 +0100862 }
Jens Axboeec94ec52006-10-20 10:59:19 +0200863 if (td->write_bw_log)
Jens Axboe079ad092007-02-20 13:58:20 +0100864 setup_log(&td->ts.bw_log);
Jens Axboeebac4652005-12-08 15:25:21 +0100865
Jens Axboeb4692822006-10-27 13:43:22 +0200866 if (!td->name)
867 td->name = strdup(jobname);
Jens Axboe01452052006-06-07 10:29:47 +0200868
Jens Axboec6ae0a52006-06-12 11:04:44 +0200869 if (!terse_output) {
Jens Axboeb990b5c2006-09-14 09:48:22 +0200870 if (!job_add_num) {
Jens Axboe2866c822006-10-09 15:57:48 +0200871 if (td->io_ops->flags & FIO_CPUIO)
Jens Axboeb990b5c2006-09-14 09:48:22 +0200872 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
Jens Axboef8977ee2006-11-06 14:03:03 +0100873 else {
874 char *c1, *c2, *c3, *c4;
875
876 c1 = to_kmg(td->min_bs[DDIR_READ]);
877 c2 = to_kmg(td->max_bs[DDIR_READ]);
878 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
879 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
880
Jens Axboe413dd452007-02-23 09:26:09 +0100881 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 +0100882
883 free(c1);
884 free(c2);
885 free(c3);
886 free(c4);
887 }
Jens Axboeb990b5c2006-09-14 09:48:22 +0200888 } else if (job_add_num == 1)
Jens Axboec6ae0a52006-06-12 11:04:44 +0200889 fprintf(f_out, "...\n");
890 }
Jens Axboeebac4652005-12-08 15:25:21 +0100891
892 /*
893 * recurse add identical jobs, clear numjobs and stonewall options
894 * as they don't apply to sub-jobs
895 */
896 numjobs = td->numjobs;
897 while (--numjobs) {
898 struct thread_data *td_new = get_new_job(0, td);
899
900 if (!td_new)
901 goto err;
902
903 td_new->numjobs = 1;
904 td_new->stonewall = 0;
Jens Axboe75154842006-06-01 13:56:09 +0200905 job_add_num = numjobs - 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100906
Jens Axboe75154842006-06-01 13:56:09 +0200907 if (add_job(td_new, jobname, job_add_num))
Jens Axboeebac4652005-12-08 15:25:21 +0100908 goto err;
909 }
910 return 0;
911err:
912 put_job(td);
913 return -1;
914}
915
Jens Axboe906c8d72006-06-13 09:37:56 +0200916/*
917 * Initialize the various random states we need (random io, block size ranges,
918 * read/write mix, etc).
919 */
Jens Axboeebac4652005-12-08 15:25:21 +0100920int init_random_state(struct thread_data *td)
921{
Jens Axboe0aabe162007-02-23 08:45:55 +0100922 unsigned long seeds[5];
Jens Axboe53cdc682006-10-18 11:50:58 +0200923 int fd, num_maps, blocks, i;
Jens Axboe0ab8db82006-10-18 17:16:23 +0200924 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100925
Jens Axboef48b4672006-10-27 11:30:07 +0200926 if (td->io_ops->flags & FIO_CPUIO)
927 return 0;
928
Jens Axboe1ac267b2006-05-31 20:29:00 +0200929 fd = open("/dev/urandom", O_RDONLY);
Jens Axboeebac4652005-12-08 15:25:21 +0100930 if (fd == -1) {
Jens Axboee1161c32007-02-22 19:36:48 +0100931 td_verror(td, errno, "open");
Jens Axboeebac4652005-12-08 15:25:21 +0100932 return 1;
933 }
934
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200935 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
Jens Axboee1161c32007-02-22 19:36:48 +0100936 td_verror(td, EIO, "read");
Jens Axboeebac4652005-12-08 15:25:21 +0100937 close(fd);
938 return 1;
939 }
940
941 close(fd);
942
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200943 os_random_seed(seeds[0], &td->bsrange_state);
944 os_random_seed(seeds[1], &td->verify_state);
945 os_random_seed(seeds[2], &td->rwmix_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100946
Jens Axboe413dd452007-02-23 09:26:09 +0100947 if (td->file_service_type == FIO_FSERVICE_RANDOM)
948 os_random_seed(seeds[3], &td->next_file_state);
949
950 if (!td_random(td))
Jens Axboeebac4652005-12-08 15:25:21 +0100951 return 0;
952
Jens Axboe9ebc27e2006-06-12 10:21:50 +0200953 if (td->rand_repeatable)
Jens Axboe0aabe162007-02-23 08:45:55 +0100954 seeds[4] = FIO_RANDSEED * td->thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100955
Jens Axboebb8895e2006-10-30 15:14:48 +0100956 if (!td->norandommap) {
957 for_each_file(td, f, i) {
Jens Axboea4a81712007-02-13 20:07:26 +0100958 blocks = (f->real_file_size + td->rw_min_bs - 1) / td->rw_min_bs;
Jens Axboec7c280e2006-11-02 20:10:33 +0100959 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
Jens Axboebb8895e2006-10-30 15:14:48 +0100960 f->file_map = malloc(num_maps * sizeof(long));
961 f->num_maps = num_maps;
962 memset(f->file_map, 0, num_maps * sizeof(long));
963 }
Jens Axboe53cdc682006-10-18 11:50:58 +0200964 }
Jens Axboeebac4652005-12-08 15:25:21 +0100965
Jens Axboe0aabe162007-02-23 08:45:55 +0100966 os_random_seed(seeds[4], &td->random_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100967 return 0;
968}
969
970static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
971{
972#ifdef FIO_HAVE_CPU_AFFINITY
973 unsigned int i;
974
975 CPU_ZERO(&cpumask);
976
977 for (i = 0; i < sizeof(int) * 8; i++) {
978 if ((1 << i) & cpu)
979 CPU_SET(i, &cpumask);
980 }
981#endif
982}
983
Jens Axboeebac4652005-12-08 15:25:21 +0100984static int is_empty_or_comment(char *line)
985{
986 unsigned int i;
987
988 for (i = 0; i < strlen(line); i++) {
989 if (line[i] == ';')
990 return 1;
Ingo Molnar5cc2da32007-02-20 10:19:44 +0100991 if (line[i] == '#')
992 return 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100993 if (!isspace(line[i]) && !iscntrl(line[i]))
994 return 0;
995 }
996
997 return 1;
998}
999
Jens Axboe313cb202006-12-21 09:50:00 +01001000/*
1001 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
1002 */
1003static char *get_mmap_file(const char *str)
1004{
1005 char *p = strstr(str, ":");
1006
1007 if (!p)
1008 return NULL;
1009
1010 p++;
1011 strip_blank_front(&p);
1012 strip_blank_end(p);
1013 return strdup(p);
1014}
1015
Jens Axboeb4692822006-10-27 13:43:22 +02001016static int str_mem_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +01001017{
Jens Axboecb2c86f2006-10-26 13:48:34 +02001018 struct thread_data *td = data;
1019
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001020 if (td->mem_type == MEM_MMAPHUGE || td->mem_type == MEM_MMAP) {
Jens Axboe313cb202006-12-21 09:50:00 +01001021 td->mmapfile = get_mmap_file(mem);
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001022 if (td->mem_type == MEM_MMAPHUGE && !td->mmapfile) {
Jens Axboed0bdaf42006-12-20 14:40:44 +01001023 log_err("fio: mmaphuge:/path/to/file\n");
1024 return 1;
1025 }
Jens Axboeebac4652005-12-08 15:25:21 +01001026 }
1027
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001028 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001029}
1030
Joel Becker7b395ca2007-02-28 11:10:58 +01001031/* External engines are specified by "external:name.o") */
1032static const char *get_engine_name(const char *str)
1033{
1034 char *p = strstr(str, ":");
1035
1036 if (!p)
1037 return str;
1038
1039 p++;
1040 strip_blank_front(&p);
1041 strip_blank_end(p);
1042 return p;
1043}
1044
Jens Axboeb4692822006-10-27 13:43:22 +02001045static int str_ioengine_cb(void *data, const char *str)
Jens Axboeebac4652005-12-08 15:25:21 +01001046{
Jens Axboecb2c86f2006-10-26 13:48:34 +02001047 struct thread_data *td = data;
Joel Becker7b395ca2007-02-28 11:10:58 +01001048 const char *name = get_engine_name(str);
Jens Axboecb2c86f2006-10-26 13:48:34 +02001049
Joel Becker7b395ca2007-02-28 11:10:58 +01001050 td->io_ops = load_ioengine(td, name);
Jens Axboe2866c822006-10-09 15:57:48 +02001051 if (td->io_ops)
Jens Axboeebac4652005-12-08 15:25:21 +01001052 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001053
Jens Axboeebac4652005-12-08 15:25:21 +01001054 return 1;
1055}
1056
Jens Axboee1f36502006-10-27 10:54:08 +02001057static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
1058{
1059 mlock_size = *val;
1060 return 0;
1061}
1062
Jens Axboe34cfcda2006-11-03 14:00:45 +01001063#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +02001064static int str_prioclass_cb(void *data, unsigned int *val)
1065{
1066 struct thread_data *td = data;
1067
1068 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1069 return 0;
1070}
1071
1072static int str_prio_cb(void *data, unsigned int *val)
1073{
1074 struct thread_data *td = data;
1075
1076 td->ioprio |= *val;
1077 return 0;
1078}
Jens Axboe34cfcda2006-11-03 14:00:45 +01001079#endif
Jens Axboee1f36502006-10-27 10:54:08 +02001080
1081static int str_exitall_cb(void)
1082{
1083 exitall_on_terminate = 1;
1084 return 0;
1085}
1086
1087static int str_cpumask_cb(void *data, unsigned int *val)
1088{
1089 struct thread_data *td = data;
1090
1091 fill_cpu_mask(td->cpumask, *val);
1092 return 0;
1093}
1094
Jens Axboe07261982006-06-07 10:51:12 +02001095/*
1096 * This is our [ini] type file parser.
1097 */
Jens Axboe1e97cce2006-12-05 11:44:16 +01001098static int parse_jobs_ini(char *file, int stonewall_flag)
Jens Axboeebac4652005-12-08 15:25:21 +01001099{
Jens Axboee1f36502006-10-27 10:54:08 +02001100 unsigned int global;
Jens Axboeebac4652005-12-08 15:25:21 +01001101 struct thread_data *td;
Jens Axboefee3bb42006-10-30 13:32:08 +01001102 char *string, *name;
Jens Axboeebac4652005-12-08 15:25:21 +01001103 fpos_t off;
1104 FILE *f;
1105 char *p;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001106 int ret = 0, stonewall;
Jens Axboeebac4652005-12-08 15:25:21 +01001107
1108 f = fopen(file, "r");
1109 if (!f) {
Jens Axboeaea47d42006-05-26 19:27:29 +02001110 perror("fopen job file");
Jens Axboeebac4652005-12-08 15:25:21 +01001111 return 1;
1112 }
1113
1114 string = malloc(4096);
1115 name = malloc(256);
Jens Axboefee3bb42006-10-30 13:32:08 +01001116 memset(name, 0, 256);
Jens Axboeebac4652005-12-08 15:25:21 +01001117
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001118 stonewall = stonewall_flag;
Jens Axboe7c124ac2006-10-30 13:36:52 +01001119 do {
1120 p = fgets(string, 4095, f);
1121 if (!p)
Jens Axboe45410ac2006-06-07 11:10:39 +02001122 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001123 if (is_empty_or_comment(p))
1124 continue;
Jens Axboefee3bb42006-10-30 13:32:08 +01001125 if (sscanf(p, "[%255s]", name) != 1)
Jens Axboeebac4652005-12-08 15:25:21 +01001126 continue;
1127
1128 global = !strncmp(name, "global", 6);
1129
1130 name[strlen(name) - 1] = '\0';
1131
1132 td = get_new_job(global, &def_thread);
Jens Axboe45410ac2006-06-07 11:10:39 +02001133 if (!td) {
1134 ret = 1;
1135 break;
1136 }
Jens Axboeebac4652005-12-08 15:25:21 +01001137
Jens Axboe972cfd22006-06-09 11:08:56 +02001138 /*
1139 * Seperate multiple job files by a stonewall
1140 */
Jens Axboef9481912006-06-09 11:37:28 +02001141 if (!global && stonewall) {
Jens Axboe972cfd22006-06-09 11:08:56 +02001142 td->stonewall = stonewall;
1143 stonewall = 0;
1144 }
1145
Jens Axboeebac4652005-12-08 15:25:21 +01001146 fgetpos(f, &off);
1147 while ((p = fgets(string, 4096, f)) != NULL) {
1148 if (is_empty_or_comment(p))
1149 continue;
Jens Axboee1f36502006-10-27 10:54:08 +02001150
Jens Axboeb6754f92006-05-30 14:29:32 +02001151 strip_blank_front(&p);
Jens Axboe7c124ac2006-10-30 13:36:52 +01001152
1153 if (p[0] == '[')
1154 break;
1155
Jens Axboe4ae3f762006-05-30 13:35:14 +02001156 strip_blank_end(p);
Jens Axboeaea47d42006-05-26 19:27:29 +02001157
Jens Axboee1f36502006-10-27 10:54:08 +02001158 fgetpos(f, &off);
Jens Axboeebac4652005-12-08 15:25:21 +01001159
Jens Axboe45410ac2006-06-07 11:10:39 +02001160 /*
1161 * Don't break here, continue parsing options so we
1162 * dump all the bad ones. Makes trial/error fixups
1163 * easier on the user.
1164 */
Jens Axboe7c124ac2006-10-30 13:36:52 +01001165 ret |= parse_option(p, options, td);
Jens Axboeebac4652005-12-08 15:25:21 +01001166 }
Jens Axboeebac4652005-12-08 15:25:21 +01001167
Jens Axboe45410ac2006-06-07 11:10:39 +02001168 if (!ret) {
1169 fsetpos(f, &off);
1170 ret = add_job(td, name, 0);
Jens Axboeb1508cf2006-11-02 09:12:40 +01001171 } else {
1172 log_err("fio: job %s dropped\n", name);
1173 put_job(td);
Jens Axboe45410ac2006-06-07 11:10:39 +02001174 }
Jens Axboe7c124ac2006-10-30 13:36:52 +01001175 } while (!ret);
Jens Axboeebac4652005-12-08 15:25:21 +01001176
1177 free(string);
1178 free(name);
1179 fclose(f);
Jens Axboe45410ac2006-06-07 11:10:39 +02001180 return ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001181}
1182
1183static int fill_def_thread(void)
1184{
1185 memset(&def_thread, 0, sizeof(def_thread));
1186
1187 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1188 perror("sched_getaffinity");
1189 return 1;
1190 }
1191
1192 /*
Jens Axboeee738492007-01-10 11:23:16 +01001193 * fill default options
Jens Axboeebac4652005-12-08 15:25:21 +01001194 */
Jens Axboeee738492007-01-10 11:23:16 +01001195 fill_default_options(&def_thread, options);
1196
Jens Axboe972cfd22006-06-09 11:08:56 +02001197 def_thread.timeout = def_timeout;
Jens Axboeec94ec52006-10-20 10:59:19 +02001198 def_thread.write_bw_log = write_bw_log;
1199 def_thread.write_lat_log = write_lat_log;
Jens Axboeee738492007-01-10 11:23:16 +01001200
Jens Axboeebac4652005-12-08 15:25:21 +01001201#ifdef FIO_HAVE_DISK_UTIL
1202 def_thread.do_disk_util = 1;
1203#endif
1204
1205 return 0;
1206}
1207
Jens Axboe0ab8db82006-10-18 17:16:23 +02001208static void usage(void)
Jens Axboe4785f992006-05-26 03:59:10 +02001209{
1210 printf("%s\n", fio_version_string);
Jens Axboeb4692822006-10-27 13:43:22 +02001211 printf("\t--output\tWrite output to file\n");
1212 printf("\t--timeout\tRuntime in seconds\n");
1213 printf("\t--latency-log\tGenerate per-job latency logs\n");
1214 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1215 printf("\t--minimal\tMinimal (terse) output\n");
1216 printf("\t--version\tPrint version info and exit\n");
Jens Axboefd28ca42007-01-09 21:20:13 +01001217 printf("\t--help\t\tPrint this page\n");
1218 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
Jens Axboe4785f992006-05-26 03:59:10 +02001219}
1220
Jens Axboe972cfd22006-06-09 11:08:56 +02001221static int parse_cmd_line(int argc, char *argv[])
Jens Axboeebac4652005-12-08 15:25:21 +01001222{
Jens Axboeb4692822006-10-27 13:43:22 +02001223 struct thread_data *td = NULL;
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001224 int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001225
Jens Axboeb4692822006-10-27 13:43:22 +02001226 while ((c = getopt_long(argc, argv, "", long_options, &lidx)) != -1) {
Jens Axboeebac4652005-12-08 15:25:21 +01001227 switch (c) {
Jens Axboeb4692822006-10-27 13:43:22 +02001228 case 't':
1229 def_timeout = atoi(optarg);
1230 break;
1231 case 'l':
1232 write_lat_log = 1;
1233 break;
1234 case 'w':
1235 write_bw_log = 1;
1236 break;
1237 case 'o':
1238 f_out = fopen(optarg, "w+");
1239 if (!f_out) {
1240 perror("fopen output");
1241 exit(1);
1242 }
1243 f_err = f_out;
1244 break;
1245 case 'm':
1246 terse_output = 1;
1247 break;
1248 case 'h':
1249 usage();
1250 exit(0);
Jens Axboefd28ca42007-01-09 21:20:13 +01001251 case 'c':
Jens Axboe29fc6af2007-01-09 21:22:02 +01001252 ret = show_cmd_help(options, optarg);
1253 exit(ret);
Jens Axboeb4692822006-10-27 13:43:22 +02001254 case 'v':
1255 printf("%s\n", fio_version_string);
1256 exit(0);
1257 case FIO_GETOPT_JOB: {
1258 const char *opt = long_options[lidx].name;
1259 char *val = optarg;
1260
Jens Axboec2b1e752006-10-30 09:03:13 +01001261 if (!strncmp(opt, "name", 4) && td) {
1262 ret = add_job(td, td->name ?: "fio", 0);
1263 if (ret) {
1264 put_job(td);
1265 return 0;
1266 }
1267 td = NULL;
1268 }
Jens Axboeb4692822006-10-27 13:43:22 +02001269 if (!td) {
Jens Axboe38d0adb2006-10-30 12:21:25 +01001270 int global = !strncmp(val, "global", 6);
Jens Axboec2b1e752006-10-30 09:03:13 +01001271
1272 td = get_new_job(global, &def_thread);
Jens Axboeb4692822006-10-27 13:43:22 +02001273 if (!td)
1274 return 0;
1275 }
Jens Axboe38d0adb2006-10-30 12:21:25 +01001276
Jens Axboeb1508cf2006-11-02 09:12:40 +01001277 ret = parse_cmd_option(opt, val, options, td);
Jens Axboe78217df2007-02-23 11:18:30 +01001278 if (ret)
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001279 dont_add_job = 1;
Jens Axboeb4692822006-10-27 13:43:22 +02001280 break;
1281 }
1282 default:
Jens Axboeb4692822006-10-27 13:43:22 +02001283 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001284 }
1285 }
Jens Axboec9fad892006-05-27 17:26:50 +02001286
Jens Axboeb4692822006-10-27 13:43:22 +02001287 if (td) {
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001288 if (dont_add_job)
Jens Axboeb4692822006-10-27 13:43:22 +02001289 put_job(td);
Jens Axboeb1ec1da2007-02-23 10:29:16 +01001290 else {
1291 ret = add_job(td, td->name ?: "fio", 0);
1292 if (ret)
1293 put_job(td);
1294 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001295 }
Jens Axboe774a6172006-08-24 08:44:26 +02001296
Jens Axboeb4692822006-10-27 13:43:22 +02001297 while (optind < argc) {
1298 ini_idx++;
1299 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1300 ini_file[ini_idx - 1] = strdup(argv[optind]);
1301 optind++;
Jens Axboeeb8bbf42006-06-08 21:40:11 +02001302 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001303
1304 return ini_idx;
Jens Axboeebac4652005-12-08 15:25:21 +01001305}
1306
1307static void free_shm(void)
1308{
1309 struct shmid_ds sbuf;
1310
1311 if (threads) {
Jens Axboe2c0ecd22006-06-08 13:25:41 +02001312 shmdt((void *) threads);
Jens Axboeebac4652005-12-08 15:25:21 +01001313 threads = NULL;
1314 shmctl(shm_id, IPC_RMID, &sbuf);
1315 }
1316}
1317
Jens Axboe906c8d72006-06-13 09:37:56 +02001318/*
1319 * The thread area is shared between the main process and the job
1320 * threads/processes. So setup a shared memory segment that will hold
1321 * all the job info.
1322 */
Jens Axboeebac4652005-12-08 15:25:21 +01001323static int setup_thread_area(void)
1324{
1325 /*
1326 * 1024 is too much on some machines, scale max_jobs if
1327 * we get a failure that looks like too large a shm segment
1328 */
1329 do {
Jens Axboe906c8d72006-06-13 09:37:56 +02001330 size_t size = max_jobs * sizeof(struct thread_data);
Jens Axboeebac4652005-12-08 15:25:21 +01001331
Jens Axboe906c8d72006-06-13 09:37:56 +02001332 shm_id = shmget(0, size, IPC_CREAT | 0600);
Jens Axboeebac4652005-12-08 15:25:21 +01001333 if (shm_id != -1)
1334 break;
1335 if (errno != EINVAL) {
1336 perror("shmget");
1337 break;
1338 }
1339
1340 max_jobs >>= 1;
1341 } while (max_jobs);
1342
1343 if (shm_id == -1)
1344 return 1;
1345
1346 threads = shmat(shm_id, NULL, 0);
1347 if (threads == (void *) -1) {
1348 perror("shmat");
1349 return 1;
1350 }
1351
1352 atexit(free_shm);
1353 return 0;
1354}
1355
Jens Axboeb4692822006-10-27 13:43:22 +02001356/*
1357 * Copy the fio options into the long options map, so we mirror
1358 * job and cmd line options.
1359 */
1360static void dupe_job_options(void)
1361{
1362 struct fio_option *o;
1363 unsigned int i;
1364
1365 i = 0;
1366 while (long_options[i].name)
1367 i++;
1368
1369 o = &options[0];
1370 while (o->name) {
1371 long_options[i].name = o->name;
1372 long_options[i].val = FIO_GETOPT_JOB;
1373 if (o->type == FIO_OPT_STR_SET)
1374 long_options[i].has_arg = no_argument;
1375 else
1376 long_options[i].has_arg = required_argument;
1377
1378 i++;
1379 o++;
1380 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1381 }
1382}
1383
Jens Axboeebac4652005-12-08 15:25:21 +01001384int parse_options(int argc, char *argv[])
1385{
Jens Axboe972cfd22006-06-09 11:08:56 +02001386 int job_files, i;
1387
Jens Axboeb4692822006-10-27 13:43:22 +02001388 f_out = stdout;
1389 f_err = stderr;
1390
Jens Axboe13335dd2007-01-10 13:14:02 +01001391 options_init(options);
1392
Jens Axboeb4692822006-10-27 13:43:22 +02001393 dupe_job_options();
1394
Jens Axboeebac4652005-12-08 15:25:21 +01001395 if (setup_thread_area())
1396 return 1;
1397 if (fill_def_thread())
1398 return 1;
1399
Jens Axboe972cfd22006-06-09 11:08:56 +02001400 job_files = parse_cmd_line(argc, argv);
Jens Axboeebac4652005-12-08 15:25:21 +01001401
Jens Axboe972cfd22006-06-09 11:08:56 +02001402 for (i = 0; i < job_files; i++) {
1403 if (fill_def_thread())
1404 return 1;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001405 if (parse_jobs_ini(ini_file[i], i))
Jens Axboe972cfd22006-06-09 11:08:56 +02001406 return 1;
Jens Axboe88c6ed82006-06-09 11:28:10 +02001407 free(ini_file[i]);
Jens Axboe972cfd22006-06-09 11:08:56 +02001408 }
Jens Axboeebac4652005-12-08 15:25:21 +01001409
Jens Axboe88c6ed82006-06-09 11:28:10 +02001410 free(ini_file);
Jens Axboeb4692822006-10-27 13:43:22 +02001411
1412 if (!thread_number) {
1413 log_err("No jobs defined(s)\n");
Jens Axboeb4692822006-10-27 13:43:22 +02001414 return 1;
1415 }
1416
Jens Axboeebac4652005-12-08 15:25:21 +01001417 return 0;
1418}