blob: c2725261ad8481ee923de2fb5b6e3ac524868e03 [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_rw_cb(void *, const char *);
26static int str_ioengine_cb(void *, const char *);
27static int str_mem_cb(void *, const char *);
28static int str_verify_cb(void *, const char *);
Jens Axboee1f36502006-10-27 10:54:08 +020029static int str_lockmem_cb(void *, unsigned long *);
Jens Axboe34cfcda2006-11-03 14:00:45 +010030#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +020031static int str_prio_cb(void *, unsigned int *);
32static int str_prioclass_cb(void *, unsigned int *);
Jens Axboe34cfcda2006-11-03 14:00:45 +010033#endif
Jens Axboee1f36502006-10-27 10:54:08 +020034static int str_exitall_cb(void);
35static int str_cpumask_cb(void *, unsigned int *);
36
Jens Axboeee738492007-01-10 11:23:16 +010037#define __stringify_1(x) #x
38#define __stringify(x) __stringify_1(x)
39
Jens Axboee1f36502006-10-27 10:54:08 +020040/*
41 * Map of job/command line options
42 */
43static struct fio_option options[] = {
44 {
45 .name = "name",
46 .type = FIO_OPT_STR_STORE,
47 .off1 = td_var_offset(name),
Jens Axboefd28ca42007-01-09 21:20:13 +010048 .help = "Name of this job",
Jens Axboee1f36502006-10-27 10:54:08 +020049 },
50 {
51 .name = "directory",
52 .type = FIO_OPT_STR_STORE,
53 .off1 = td_var_offset(directory),
Jens Axboefd28ca42007-01-09 21:20:13 +010054 .help = "Directory to store files in",
Jens Axboee1f36502006-10-27 10:54:08 +020055 },
56 {
57 .name = "filename",
58 .type = FIO_OPT_STR_STORE,
59 .off1 = td_var_offset(filename),
Jens Axboefd28ca42007-01-09 21:20:13 +010060 .help = "Force the use of a specific file",
Jens Axboee1f36502006-10-27 10:54:08 +020061 },
62 {
63 .name = "rw",
64 .type = FIO_OPT_STR,
65 .cb = str_rw_cb,
Jens Axboe15f79182007-01-10 12:26:18 +010066 .help = "IO direction",
Jens Axboeee738492007-01-10 11:23:16 +010067 .def = "read",
Jens Axboe15f79182007-01-10 12:26:18 +010068 .posval = { "read", "write", "randwrite", "randread", "rw",
69 "randrw", },
Jens Axboee1f36502006-10-27 10:54:08 +020070 },
71 {
72 .name = "ioengine",
73 .type = FIO_OPT_STR,
74 .cb = str_ioengine_cb,
Jens Axboe15f79182007-01-10 12:26:18 +010075 .help = "IO engine to use",
Jens Axboeee738492007-01-10 11:23:16 +010076 .def = "sync",
Jens Axboe15f79182007-01-10 12:26:18 +010077 .posval = { "sync", "libaio", "posixaio", "mmap", "splice",
78 "sg", "null", },
Jens Axboee1f36502006-10-27 10:54:08 +020079 },
80 {
Jens Axboe03b74b32007-01-11 11:04:31 +010081 .name = "iodepth",
82 .type = FIO_OPT_INT,
83 .off1 = td_var_offset(iodepth),
84 .help = "Amount of IO buffers to keep in flight",
85 .def = "1",
86 },
87 {
88 .name = "size",
89 .type = FIO_OPT_STR_VAL,
90 .off1 = td_var_offset(total_file_size),
91 .help = "Size of device or file",
92 },
93 {
94 .name = "bs",
95 .type = FIO_OPT_STR_VAL_INT,
96 .off1 = td_var_offset(bs[DDIR_READ]),
97 .off2 = td_var_offset(bs[DDIR_WRITE]),
98 .help = "Block size unit",
99 .def = "4k",
100 },
101 {
102 .name = "bsrange",
103 .type = FIO_OPT_RANGE,
104 .off1 = td_var_offset(min_bs[DDIR_READ]),
105 .off2 = td_var_offset(max_bs[DDIR_READ]),
106 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
107 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
108 .help = "Set block size range (in more detail than bs)",
109 },
110 {
111 .name = "bs_unaligned",
112 .type = FIO_OPT_STR_SET,
113 .off1 = td_var_offset(bs_unaligned),
114 .help = "Don't sector align IO buffer sizes",
115 },
116 {
117 .name = "offset",
118 .type = FIO_OPT_STR_VAL,
119 .off1 = td_var_offset(start_offset),
120 .help = "Start IO from this offset",
121 .def = "0",
122 },
123 {
124 .name = "randrepeat",
125 .type = FIO_OPT_BOOL,
126 .off1 = td_var_offset(rand_repeatable),
127 .help = "Use repeatable random IO pattern",
128 .def = "1",
129 },
130 {
131 .name = "norandommap",
132 .type = FIO_OPT_STR_SET,
133 .off1 = td_var_offset(norandommap),
134 .help = "Accept potential duplicate random blocks",
135 },
136 {
137 .name = "nrfiles",
138 .type = FIO_OPT_INT,
139 .off1 = td_var_offset(nr_files),
140 .help = "Split job workload between this number of files",
141 .def = "1",
142 },
143 {
144 .name = "fsync",
145 .type = FIO_OPT_INT,
146 .off1 = td_var_offset(fsync_blocks),
147 .help = "Issue fsync for writes every given number of blocks",
148 .def = "0",
149 },
150 {
151 .name = "direct",
152 .type = FIO_OPT_BOOL,
153 .off1 = td_var_offset(odirect),
154 .help = "Use O_DIRECT IO",
155 .def = "1",
156 },
157 {
158 .name = "overwrite",
159 .type = FIO_OPT_BOOL,
160 .off1 = td_var_offset(overwrite),
161 .help = "When writing, set whether to overwrite current data",
162 .def = "0",
163 },
164 {
165 .name = "loops",
166 .type = FIO_OPT_INT,
167 .off1 = td_var_offset(loops),
168 .help = "Number of times to run the job",
169 .def = "1",
170 },
171 {
172 .name = "numjobs",
173 .type = FIO_OPT_INT,
174 .off1 = td_var_offset(numjobs),
175 .help = "Duplicate this job this many times",
176 .def = "1",
177 },
178 {
179 .name = "startdelay",
180 .type = FIO_OPT_INT,
181 .off1 = td_var_offset(start_delay),
182 .help = "Only start job when this period has passed",
183 .def = "0",
184 },
185 {
186 .name = "runtime",
187 .alias = "timeout",
188 .type = FIO_OPT_STR_VAL_TIME,
189 .off1 = td_var_offset(timeout),
190 .help = "Stop workload when this amount of time has passed",
191 .def = "0",
192 },
193 {
Jens Axboee1f36502006-10-27 10:54:08 +0200194 .name = "mem",
195 .type = FIO_OPT_STR,
196 .cb = str_mem_cb,
Jens Axboe15f79182007-01-10 12:26:18 +0100197 .help = "Backing type for IO buffers",
Jens Axboeee738492007-01-10 11:23:16 +0100198 .def = "malloc",
Jens Axboe15f79182007-01-10 12:26:18 +0100199 .posval = { "malloc", "shm", "shmhuge", "mmap", "mmaphuge", },
Jens Axboee1f36502006-10-27 10:54:08 +0200200 },
201 {
202 .name = "verify",
203 .type = FIO_OPT_STR,
204 .cb = str_verify_cb,
Jens Axboe15f79182007-01-10 12:26:18 +0100205 .help = "Verify sum function",
Jens Axboeee738492007-01-10 11:23:16 +0100206 .def = "0",
Jens Axboe15f79182007-01-10 12:26:18 +0100207 .posval = { "crc32", "md5", },
Jens Axboee1f36502006-10-27 10:54:08 +0200208 },
209 {
210 .name = "write_iolog",
Jens Axboe076efc72006-10-27 11:24:25 +0200211 .type = FIO_OPT_STR_STORE,
212 .off1 = td_var_offset(write_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100213 .help = "Store IO pattern to file",
Jens Axboee1f36502006-10-27 10:54:08 +0200214 },
215 {
Jens Axboe076efc72006-10-27 11:24:25 +0200216 .name = "read_iolog",
Jens Axboee1f36502006-10-27 10:54:08 +0200217 .type = FIO_OPT_STR_STORE,
Jens Axboe076efc72006-10-27 11:24:25 +0200218 .off1 = td_var_offset(read_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100219 .help = "Playback IO pattern from file",
Jens Axboee1f36502006-10-27 10:54:08 +0200220 },
221 {
222 .name = "exec_prerun",
223 .type = FIO_OPT_STR_STORE,
224 .off1 = td_var_offset(exec_prerun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100225 .help = "Execute this file prior to running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200226 },
227 {
228 .name = "exec_postrun",
229 .type = FIO_OPT_STR_STORE,
230 .off1 = td_var_offset(exec_postrun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100231 .help = "Execute this file after running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200232 },
233#ifdef FIO_HAVE_IOSCHED_SWITCH
234 {
235 .name = "ioscheduler",
236 .type = FIO_OPT_STR_STORE,
237 .off1 = td_var_offset(ioscheduler),
Jens Axboefd28ca42007-01-09 21:20:13 +0100238 .help = "Use this IO scheduler on the backing device",
Jens Axboee1f36502006-10-27 10:54:08 +0200239 },
240#endif
241 {
Jens Axboee1f36502006-10-27 10:54:08 +0200242 .name = "zonesize",
243 .type = FIO_OPT_STR_VAL,
244 .off1 = td_var_offset(zone_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100245 .help = "Give size of an IO zone",
Jens Axboeee738492007-01-10 11:23:16 +0100246 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200247 },
248 {
249 .name = "zoneskip",
250 .type = FIO_OPT_STR_VAL,
251 .off1 = td_var_offset(zone_skip),
Jens Axboefd28ca42007-01-09 21:20:13 +0100252 .help = "Space between IO zones",
Jens Axboeee738492007-01-10 11:23:16 +0100253 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200254 },
255 {
256 .name = "lockmem",
257 .type = FIO_OPT_STR_VAL,
258 .cb = str_lockmem_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100259 .help = "Lock down this amount of memory",
Jens Axboeee738492007-01-10 11:23:16 +0100260 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200261 },
262 {
Jens Axboee1f36502006-10-27 10:54:08 +0200263 .name = "rwmixcycle",
264 .type = FIO_OPT_INT,
265 .off1 = td_var_offset(rwmixcycle),
Jens Axboeee738492007-01-10 11:23:16 +0100266 .help = "Cycle period for mixed read/write workloads (msec)",
267 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200268 },
269 {
270 .name = "rwmixread",
271 .type = FIO_OPT_INT,
272 .off1 = td_var_offset(rwmixread),
Jens Axboeee738492007-01-10 11:23:16 +0100273 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100274 .help = "Percentage of mixed workload that is reads",
Jens Axboeee738492007-01-10 11:23:16 +0100275 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200276 },
277 {
278 .name = "rwmixwrite",
279 .type = FIO_OPT_INT,
280 .off1 = td_var_offset(rwmixwrite),
Jens Axboeee738492007-01-10 11:23:16 +0100281 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100282 .help = "Percentage of mixed workload that is writes",
Jens Axboeee738492007-01-10 11:23:16 +0100283 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200284 },
285 {
286 .name = "nice",
287 .type = FIO_OPT_INT,
288 .off1 = td_var_offset(nice),
Jens Axboefd28ca42007-01-09 21:20:13 +0100289 .help = "Set job CPU nice value",
Jens Axboe15f79182007-01-10 12:26:18 +0100290 .minval = -19,
Jens Axboeee738492007-01-10 11:23:16 +0100291 .maxval = 20,
292 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200293 },
294#ifdef FIO_HAVE_IOPRIO
295 {
296 .name = "prio",
297 .type = FIO_OPT_INT,
298 .cb = str_prio_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100299 .help = "Set job IO priority value",
Jens Axboe15f79182007-01-10 12:26:18 +0100300 .minval = 0,
301 .maxval = 7,
Jens Axboee1f36502006-10-27 10:54:08 +0200302 },
303 {
304 .name = "prioclass",
305 .type = FIO_OPT_INT,
306 .cb = str_prioclass_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100307 .help = "Set job IO priority class",
Jens Axboe15f79182007-01-10 12:26:18 +0100308 .minval = 0,
309 .maxval = 3,
Jens Axboee1f36502006-10-27 10:54:08 +0200310 },
311#endif
312 {
313 .name = "thinktime",
314 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100315 .off1 = td_var_offset(thinktime),
Jens Axboefd28ca42007-01-09 21:20:13 +0100316 .help = "Idle time between IO buffers",
Jens Axboeee738492007-01-10 11:23:16 +0100317 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200318 },
319 {
Jens Axboe9c1f7432007-01-03 20:43:19 +0100320 .name = "thinktime_blocks",
321 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100322 .off1 = td_var_offset(thinktime_blocks),
Jens Axboefd28ca42007-01-09 21:20:13 +0100323 .help = "IO buffer period between 'thinktime'",
Jens Axboeee738492007-01-10 11:23:16 +0100324 .def = "1",
Jens Axboe9c1f7432007-01-03 20:43:19 +0100325 },
326 {
Jens Axboee1f36502006-10-27 10:54:08 +0200327 .name = "rate",
328 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100329 .off1 = td_var_offset(rate),
Jens Axboefd28ca42007-01-09 21:20:13 +0100330 .help = "Set bandwidth rate",
Jens Axboee1f36502006-10-27 10:54:08 +0200331 },
332 {
333 .name = "ratemin",
334 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100335 .off1 = td_var_offset(ratemin),
Jens Axboefd28ca42007-01-09 21:20:13 +0100336 .help = "The bottom limit accepted",
Jens Axboee1f36502006-10-27 10:54:08 +0200337 },
338 {
339 .name = "ratecycle",
340 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100341 .off1 = td_var_offset(ratecycle),
Jens Axboe6da1fa72007-01-10 11:27:48 +0100342 .help = "Window average for rate limits (msec)",
Jens Axboeee738492007-01-10 11:23:16 +0100343 .def = "1000",
Jens Axboee1f36502006-10-27 10:54:08 +0200344 },
345 {
Jens Axboee1f36502006-10-27 10:54:08 +0200346 .name = "invalidate",
Jens Axboe13335dd2007-01-10 13:14:02 +0100347 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100348 .off1 = td_var_offset(invalidate_cache),
Jens Axboefd28ca42007-01-09 21:20:13 +0100349 .help = "Invalidate buffer/page cache prior to running job",
Jens Axboeee738492007-01-10 11:23:16 +0100350 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200351 },
352 {
353 .name = "sync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100354 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100355 .off1 = td_var_offset(sync_io),
Jens Axboefd28ca42007-01-09 21:20:13 +0100356 .help = "Use O_SYNC for buffered writes",
Jens Axboeee738492007-01-10 11:23:16 +0100357 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200358 },
359 {
360 .name = "bwavgtime",
361 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100362 .off1 = td_var_offset(bw_avg_time),
Jens Axboeee738492007-01-10 11:23:16 +0100363 .help = "Time window over which to calculate bandwidth (msec)",
364 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200365 },
366 {
367 .name = "create_serialize",
Jens Axboe13335dd2007-01-10 13:14:02 +0100368 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100369 .off1 = td_var_offset(create_serialize),
Jens Axboefd28ca42007-01-09 21:20:13 +0100370 .help = "Serialize creating of job files",
Jens Axboeee738492007-01-10 11:23:16 +0100371 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200372 },
373 {
374 .name = "create_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100375 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100376 .off1 = td_var_offset(create_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100377 .help = "Fsync file after creation",
Jens Axboeee738492007-01-10 11:23:16 +0100378 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200379 },
380 {
Jens Axboee1f36502006-10-27 10:54:08 +0200381 .name = "cpuload",
382 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100383 .off1 = td_var_offset(cpuload),
Jens Axboefd28ca42007-01-09 21:20:13 +0100384 .help = "Use this percentage of CPU",
Jens Axboee1f36502006-10-27 10:54:08 +0200385 },
386 {
387 .name = "cpuchunks",
388 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100389 .off1 = td_var_offset(cpucycle),
Jens Axboefd28ca42007-01-09 21:20:13 +0100390 .help = "Length of the CPU burn cycles",
Jens Axboee1f36502006-10-27 10:54:08 +0200391 },
Jens Axboee1f36502006-10-27 10:54:08 +0200392#ifdef FIO_HAVE_CPU_AFFINITY
393 {
394 .name = "cpumask",
395 .type = FIO_OPT_INT,
396 .cb = str_cpumask_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100397 .help = "CPU affinity mask",
Jens Axboee1f36502006-10-27 10:54:08 +0200398 },
399#endif
400 {
401 .name = "end_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100402 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100403 .off1 = td_var_offset(end_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100404 .help = "Include fsync at the end of job",
Jens Axboeee738492007-01-10 11:23:16 +0100405 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200406 },
407 {
408 .name = "unlink",
Jens Axboe13335dd2007-01-10 13:14:02 +0100409 .type = FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +0200410 .off1 = td_var_offset(unlink),
Jens Axboeee738492007-01-10 11:23:16 +0100411 .help = "Unlink created files after job has completed",
412 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200413 },
414 {
415 .name = "exitall",
416 .type = FIO_OPT_STR_SET,
417 .cb = str_exitall_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100418 .help = "Terminate all jobs when one exits",
Jens Axboee1f36502006-10-27 10:54:08 +0200419 },
420 {
421 .name = "stonewall",
422 .type = FIO_OPT_STR_SET,
423 .off1 = td_var_offset(stonewall),
Jens Axboefd28ca42007-01-09 21:20:13 +0100424 .help = "Insert a hard barrier between this job and previous",
Jens Axboee1f36502006-10-27 10:54:08 +0200425 },
426 {
427 .name = "thread",
428 .type = FIO_OPT_STR_SET,
Jens Axboed9bb3b82007-01-10 20:30:53 +0100429 .off1 = td_var_offset(use_thread),
Jens Axboefd28ca42007-01-09 21:20:13 +0100430 .help = "Use threads instead of forks",
Jens Axboee1f36502006-10-27 10:54:08 +0200431 },
432 {
433 .name = "write_bw_log",
434 .type = FIO_OPT_STR_SET,
435 .off1 = td_var_offset(write_bw_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100436 .help = "Write log of bandwidth during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200437 },
438 {
439 .name = "write_lat_log",
440 .type = FIO_OPT_STR_SET,
441 .off1 = td_var_offset(write_lat_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100442 .help = "Write log of latency during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200443 },
444 {
Jens Axboe56bb17f2006-12-20 20:27:36 +0100445 .name = "hugepage-size",
446 .type = FIO_OPT_STR_VAL,
447 .off1 = td_var_offset(hugepage_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100448 .help = "When using hugepages, specify size of each page",
Jens Axboeee738492007-01-10 11:23:16 +0100449 .def = __stringify(FIO_HUGE_PAGE),
Jens Axboe56bb17f2006-12-20 20:27:36 +0100450 },
451 {
Jens Axboee1f36502006-10-27 10:54:08 +0200452 .name = NULL,
453 },
454};
455
Jens Axboeb4692822006-10-27 13:43:22 +0200456#define FIO_JOB_OPTS (sizeof(options) / sizeof(struct fio_option))
457#define FIO_CMD_OPTS (16)
458#define FIO_GETOPT_JOB (0x89988998)
459
460/*
461 * Command line options. These will contain the above, plus a few
462 * extra that only pertain to fio itself and not jobs.
463 */
464static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
465 {
466 .name = "output",
467 .has_arg = required_argument,
468 .val = 'o',
469 },
470 {
471 .name = "timeout",
472 .has_arg = required_argument,
473 .val = 't',
474 },
475 {
476 .name = "latency-log",
477 .has_arg = required_argument,
478 .val = 'l',
479 },
480 {
481 .name = "bandwidth-log",
482 .has_arg = required_argument,
483 .val = 'b',
484 },
485 {
486 .name = "minimal",
487 .has_arg = optional_argument,
488 .val = 'm',
489 },
490 {
491 .name = "version",
492 .has_arg = no_argument,
493 .val = 'v',
494 },
495 {
Jens Axboefd28ca42007-01-09 21:20:13 +0100496 .name = "help",
497 .has_arg = no_argument,
498 .val = 'h',
499 },
500 {
501 .name = "cmdhelp",
502 .has_arg = required_argument,
503 .val = 'c',
504 },
505 {
Jens Axboeb4692822006-10-27 13:43:22 +0200506 .name = NULL,
507 },
508};
509
Jens Axboeee738492007-01-10 11:23:16 +0100510static int def_timeout = 0;
Jens Axboe972cfd22006-06-09 11:08:56 +0200511
Jens Axboe5cd033b2007-01-09 08:19:01 +0100512static char fio_version_string[] = "fio 1.11";
Jens Axboeebac4652005-12-08 15:25:21 +0100513
Jens Axboe972cfd22006-06-09 11:08:56 +0200514static char **ini_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100515static int max_jobs = MAX_JOBS;
516
517struct thread_data def_thread;
518struct thread_data *threads = NULL;
519
Jens Axboeebac4652005-12-08 15:25:21 +0100520int exitall_on_terminate = 0;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200521int terse_output = 0;
Jens Axboec04f7ec2006-05-31 10:13:16 +0200522unsigned long long mlock_size = 0;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200523FILE *f_out = NULL;
524FILE *f_err = NULL;
Jens Axboeebac4652005-12-08 15:25:21 +0100525
Jens Axboeee738492007-01-10 11:23:16 +0100526static int write_lat_log = 0;
527static int write_bw_log = 0;
Jens Axboeec94ec52006-10-20 10:59:19 +0200528
Jens Axboe906c8d72006-06-13 09:37:56 +0200529/*
530 * Return a free job structure.
531 */
Jens Axboeebac4652005-12-08 15:25:21 +0100532static struct thread_data *get_new_job(int global, struct thread_data *parent)
533{
534 struct thread_data *td;
535
536 if (global)
537 return &def_thread;
538 if (thread_number >= max_jobs)
539 return NULL;
540
541 td = &threads[thread_number++];
Jens Axboeddaeaa52006-06-08 11:00:58 +0200542 *td = *parent;
Jens Axboeebac4652005-12-08 15:25:21 +0100543
Jens Axboeebac4652005-12-08 15:25:21 +0100544 td->thread_number = thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100545 return td;
546}
547
548static void put_job(struct thread_data *td)
549{
Jens Axboe549577a2006-10-30 12:23:41 +0100550 if (td == &def_thread)
551 return;
552
Jens Axboeebac4652005-12-08 15:25:21 +0100553 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
554 thread_number--;
555}
556
Jens Axboedad915e2006-10-27 11:10:18 +0200557/*
558 * Lazy way of fixing up options that depend on each other. We could also
559 * define option callback handlers, but this is easier.
560 */
Jens Axboee1f36502006-10-27 10:54:08 +0200561static void fixup_options(struct thread_data *td)
562{
Jens Axboee1f36502006-10-27 10:54:08 +0200563 if (!td->rwmixread && td->rwmixwrite)
564 td->rwmixread = 100 - td->rwmixwrite;
Jens Axboedad915e2006-10-27 11:10:18 +0200565
Jens Axboe076efc72006-10-27 11:24:25 +0200566 if (td->write_iolog_file && td->read_iolog_file) {
567 log_err("fio: read iolog overrides write_iolog\n");
568 free(td->write_iolog_file);
569 td->write_iolog_file = NULL;
570 }
Jens Axboe16b462a2006-10-30 12:35:18 +0100571
572 if (td->io_ops->flags & FIO_SYNCIO)
573 td->iodepth = 1;
574 else {
575 if (!td->iodepth)
576 td->iodepth = td->nr_files;
577 }
578
579 /*
580 * only really works for sequential io for now, and with 1 file
581 */
582 if (td->zone_size && !td->sequential && td->nr_files == 1)
583 td->zone_size = 0;
584
585 /*
586 * Reads can do overwrites, we always need to pre-create the file
587 */
588 if (td_read(td) || td_rw(td))
589 td->overwrite = 1;
590
Jens Axboea00735e2006-11-03 08:58:08 +0100591 if (!td->min_bs[DDIR_READ])
592 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
593 if (!td->max_bs[DDIR_READ])
594 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
595 if (!td->min_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100596 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100597 if (!td->max_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100598 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100599
600 td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
601
Jens Axboe16b462a2006-10-30 12:35:18 +0100602 if (td_read(td) && !td_rw(td))
603 td->verify = 0;
Jens Axboebb8895e2006-10-30 15:14:48 +0100604
605 if (td->norandommap && td->verify != VERIFY_NONE) {
606 log_err("fio: norandommap given, verify disabled\n");
607 td->verify = VERIFY_NONE;
608 }
Jens Axboe690adba2006-10-30 15:25:09 +0100609 if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
610 log_err("fio: bs_unaligned may not work with raw io\n");
Jens Axboee0a22332006-12-20 12:54:25 +0100611
612 /*
613 * O_DIRECT and char doesn't mix, clear that flag if necessary.
614 */
615 if (td->filetype == FIO_TYPE_CHAR && td->odirect)
616 td->odirect = 0;
Jens Axboee1f36502006-10-27 10:54:08 +0200617}
618
Jens Axboe906c8d72006-06-13 09:37:56 +0200619/*
Jens Axboef8977ee2006-11-06 14:03:03 +0100620 * This function leaks the buffer
621 */
622static char *to_kmg(unsigned int val)
623{
624 char *buf = malloc(32);
Jens Axboe245142f2006-11-08 12:49:21 +0100625 char post[] = { 0, 'K', 'M', 'G', 'P', 0 };
Jens Axboef8977ee2006-11-06 14:03:03 +0100626 char *p = post;
627
Jens Axboe245142f2006-11-08 12:49:21 +0100628 do {
Jens Axboef8977ee2006-11-06 14:03:03 +0100629 if (val & 1023)
630 break;
631
632 val >>= 10;
633 p++;
Jens Axboe245142f2006-11-08 12:49:21 +0100634 } while (*p);
Jens Axboef8977ee2006-11-06 14:03:03 +0100635
636 snprintf(buf, 31, "%u%c", val, *p);
637 return buf;
638}
639
640/*
Jens Axboe906c8d72006-06-13 09:37:56 +0200641 * Adds a job to the list of things todo. Sanitizes the various options
642 * to make sure we don't have conflicts, and initializes various
643 * members of td.
644 */
Jens Axboe75154842006-06-01 13:56:09 +0200645static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
Jens Axboeebac4652005-12-08 15:25:21 +0100646{
Jens Axboe3c9b60c2006-11-07 08:36:14 +0100647 const char *ddir_str[] = { "read", "write", "randread", "randwrite",
648 "rw", NULL, "randrw" };
Jens Axboeebac4652005-12-08 15:25:21 +0100649 struct stat sb;
Jens Axboe53cdc682006-10-18 11:50:58 +0200650 int numjobs, ddir, i;
651 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100652
Jens Axboeebac4652005-12-08 15:25:21 +0100653 /*
654 * the def_thread is just for options, it's not a real job
655 */
656 if (td == &def_thread)
657 return 0;
658
Jens Axboeee738492007-01-10 11:23:16 +0100659 assert(td->io_ops);
Jens Axboedf641192006-10-12 07:55:41 +0200660
Jens Axboe690adba2006-10-30 15:25:09 +0100661 if (td->odirect)
662 td->io_ops->flags |= FIO_RAWIO;
663
Jens Axboeebac4652005-12-08 15:25:21 +0100664 td->filetype = FIO_TYPE_FILE;
Jens Axboe0af7b542006-02-17 10:10:12 +0100665 if (!stat(jobname, &sb)) {
666 if (S_ISBLK(sb.st_mode))
667 td->filetype = FIO_TYPE_BD;
668 else if (S_ISCHR(sb.st_mode))
669 td->filetype = FIO_TYPE_CHAR;
670 }
Jens Axboeebac4652005-12-08 15:25:21 +0100671
Jens Axboee0a22332006-12-20 12:54:25 +0100672 fixup_options(td);
673
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200674 if (td->filename)
675 td->nr_uniq_files = 1;
676 else
677 td->nr_uniq_files = td->nr_files;
678
679 if (td->filetype == FIO_TYPE_FILE || td->filename) {
Jens Axboee9c047a2006-06-07 21:13:04 +0200680 char tmp[PATH_MAX];
Jens Axboe53cdc682006-10-18 11:50:58 +0200681 int len = 0;
Jens Axboee9c047a2006-06-07 21:13:04 +0200682
Jens Axboeef899b62006-06-06 09:31:00 +0200683 if (td->directory && td->directory[0] != '\0')
Jens Axboe8aeebd52007-01-08 10:47:43 +0100684 len = sprintf(tmp, "%s/", td->directory);
Jens Axboeebac4652005-12-08 15:25:21 +0100685
Jens Axboe53cdc682006-10-18 11:50:58 +0200686 td->files = malloc(sizeof(struct fio_file) * td->nr_files);
687
688 for_each_file(td, f, i) {
689 memset(f, 0, sizeof(*f));
690 f->fd = -1;
691
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200692 if (td->filename)
693 sprintf(tmp + len, "%s", td->filename);
694 else
695 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
Jens Axboe53cdc682006-10-18 11:50:58 +0200696 f->file_name = strdup(tmp);
697 }
698 } else {
699 td->nr_files = 1;
700 td->files = malloc(sizeof(struct fio_file));
701 f = &td->files[0];
702
703 memset(f, 0, sizeof(*f));
704 f->fd = -1;
705 f->file_name = strdup(jobname);
706 }
707
708 for_each_file(td, f, i) {
709 f->file_size = td->total_file_size / td->nr_files;
710 f->file_offset = td->start_offset;
711 }
712
Jens Axboebbfd6b02006-06-07 19:42:54 +0200713 fio_sem_init(&td->mutex, 0);
Jens Axboeebac4652005-12-08 15:25:21 +0100714
715 td->clat_stat[0].min_val = td->clat_stat[1].min_val = ULONG_MAX;
716 td->slat_stat[0].min_val = td->slat_stat[1].min_val = ULONG_MAX;
717 td->bw_stat[0].min_val = td->bw_stat[1].min_val = ULONG_MAX;
718
Jens Axboeebac4652005-12-08 15:25:21 +0100719 if (td->stonewall && td->thread_number > 1)
720 groupid++;
721
722 td->groupid = groupid;
723
724 if (setup_rate(td))
725 goto err;
726
Jens Axboeec94ec52006-10-20 10:59:19 +0200727 if (td->write_lat_log) {
Jens Axboeebac4652005-12-08 15:25:21 +0100728 setup_log(&td->slat_log);
729 setup_log(&td->clat_log);
730 }
Jens Axboeec94ec52006-10-20 10:59:19 +0200731 if (td->write_bw_log)
Jens Axboeebac4652005-12-08 15:25:21 +0100732 setup_log(&td->bw_log);
733
Jens Axboeb4692822006-10-27 13:43:22 +0200734 if (!td->name)
735 td->name = strdup(jobname);
Jens Axboe01452052006-06-07 10:29:47 +0200736
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200737 ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
Jens Axboe75154842006-06-01 13:56:09 +0200738
Jens Axboec6ae0a52006-06-12 11:04:44 +0200739 if (!terse_output) {
Jens Axboeb990b5c2006-09-14 09:48:22 +0200740 if (!job_add_num) {
Jens Axboe2866c822006-10-09 15:57:48 +0200741 if (td->io_ops->flags & FIO_CPUIO)
Jens Axboeb990b5c2006-09-14 09:48:22 +0200742 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
Jens Axboef8977ee2006-11-06 14:03:03 +0100743 else {
744 char *c1, *c2, *c3, *c4;
745
746 c1 = to_kmg(td->min_bs[DDIR_READ]);
747 c2 = to_kmg(td->max_bs[DDIR_READ]);
748 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
749 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
750
Jens Axboe1e97cce2006-12-05 11:44:16 +0100751 fprintf(f_out, "%s: (g=%d): rw=%s, odir=%u, bs=%s-%s/%s-%s, rate=%u, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[ddir], td->odirect, c1, c2, c3, c4, td->rate, td->io_ops->name, td->iodepth);
Jens Axboef8977ee2006-11-06 14:03:03 +0100752
753 free(c1);
754 free(c2);
755 free(c3);
756 free(c4);
757 }
Jens Axboeb990b5c2006-09-14 09:48:22 +0200758 } else if (job_add_num == 1)
Jens Axboec6ae0a52006-06-12 11:04:44 +0200759 fprintf(f_out, "...\n");
760 }
Jens Axboeebac4652005-12-08 15:25:21 +0100761
762 /*
763 * recurse add identical jobs, clear numjobs and stonewall options
764 * as they don't apply to sub-jobs
765 */
766 numjobs = td->numjobs;
767 while (--numjobs) {
768 struct thread_data *td_new = get_new_job(0, td);
769
770 if (!td_new)
771 goto err;
772
773 td_new->numjobs = 1;
774 td_new->stonewall = 0;
Jens Axboe75154842006-06-01 13:56:09 +0200775 job_add_num = numjobs - 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100776
Jens Axboe75154842006-06-01 13:56:09 +0200777 if (add_job(td_new, jobname, job_add_num))
Jens Axboeebac4652005-12-08 15:25:21 +0100778 goto err;
779 }
780 return 0;
781err:
782 put_job(td);
783 return -1;
784}
785
Jens Axboe906c8d72006-06-13 09:37:56 +0200786/*
787 * Initialize the various random states we need (random io, block size ranges,
788 * read/write mix, etc).
789 */
Jens Axboeebac4652005-12-08 15:25:21 +0100790int init_random_state(struct thread_data *td)
791{
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200792 unsigned long seeds[4];
Jens Axboe53cdc682006-10-18 11:50:58 +0200793 int fd, num_maps, blocks, i;
Jens Axboe0ab8db82006-10-18 17:16:23 +0200794 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100795
Jens Axboef48b4672006-10-27 11:30:07 +0200796 if (td->io_ops->flags & FIO_CPUIO)
797 return 0;
798
Jens Axboe1ac267b2006-05-31 20:29:00 +0200799 fd = open("/dev/urandom", O_RDONLY);
Jens Axboeebac4652005-12-08 15:25:21 +0100800 if (fd == -1) {
801 td_verror(td, errno);
802 return 1;
803 }
804
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200805 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
Jens Axboeebac4652005-12-08 15:25:21 +0100806 td_verror(td, EIO);
807 close(fd);
808 return 1;
809 }
810
811 close(fd);
812
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200813 os_random_seed(seeds[0], &td->bsrange_state);
814 os_random_seed(seeds[1], &td->verify_state);
815 os_random_seed(seeds[2], &td->rwmix_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100816
817 if (td->sequential)
818 return 0;
819
Jens Axboe9ebc27e2006-06-12 10:21:50 +0200820 if (td->rand_repeatable)
Jens Axboeee738492007-01-10 11:23:16 +0100821 seeds[3] = FIO_RANDSEED;
Jens Axboeebac4652005-12-08 15:25:21 +0100822
Jens Axboebb8895e2006-10-30 15:14:48 +0100823 if (!td->norandommap) {
824 for_each_file(td, f, i) {
Jens Axboea00735e2006-11-03 08:58:08 +0100825 blocks = (f->file_size + td->rw_min_bs - 1) / td->rw_min_bs;
Jens Axboec7c280e2006-11-02 20:10:33 +0100826 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
Jens Axboebb8895e2006-10-30 15:14:48 +0100827 f->file_map = malloc(num_maps * sizeof(long));
828 f->num_maps = num_maps;
829 memset(f->file_map, 0, num_maps * sizeof(long));
830 }
Jens Axboe53cdc682006-10-18 11:50:58 +0200831 }
Jens Axboeebac4652005-12-08 15:25:21 +0100832
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200833 os_random_seed(seeds[3], &td->random_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100834 return 0;
835}
836
837static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
838{
839#ifdef FIO_HAVE_CPU_AFFINITY
840 unsigned int i;
841
842 CPU_ZERO(&cpumask);
843
844 for (i = 0; i < sizeof(int) * 8; i++) {
845 if ((1 << i) & cpu)
846 CPU_SET(i, &cpumask);
847 }
848#endif
849}
850
Jens Axboeebac4652005-12-08 15:25:21 +0100851static int is_empty_or_comment(char *line)
852{
853 unsigned int i;
854
855 for (i = 0; i < strlen(line); i++) {
856 if (line[i] == ';')
857 return 1;
858 if (!isspace(line[i]) && !iscntrl(line[i]))
859 return 0;
860 }
861
862 return 1;
863}
864
Jens Axboeb4692822006-10-27 13:43:22 +0200865static int str_rw_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100866{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200867 struct thread_data *td = data;
868
Jens Axboeebac4652005-12-08 15:25:21 +0100869 if (!strncmp(mem, "read", 4) || !strncmp(mem, "0", 1)) {
870 td->ddir = DDIR_READ;
871 td->sequential = 1;
872 return 0;
873 } else if (!strncmp(mem, "randread", 8)) {
874 td->ddir = DDIR_READ;
875 td->sequential = 0;
876 return 0;
877 } else if (!strncmp(mem, "write", 5) || !strncmp(mem, "1", 1)) {
878 td->ddir = DDIR_WRITE;
879 td->sequential = 1;
880 return 0;
881 } else if (!strncmp(mem, "randwrite", 9)) {
882 td->ddir = DDIR_WRITE;
883 td->sequential = 0;
884 return 0;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200885 } else if (!strncmp(mem, "rw", 2)) {
Jens Axboe1e97cce2006-12-05 11:44:16 +0100886 td->ddir = DDIR_READ;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200887 td->iomix = 1;
888 td->sequential = 1;
889 return 0;
890 } else if (!strncmp(mem, "randrw", 6)) {
Jens Axboe1e97cce2006-12-05 11:44:16 +0100891 td->ddir = DDIR_READ;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200892 td->iomix = 1;
893 td->sequential = 0;
894 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +0100895 }
896
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200897 log_err("fio: data direction: read, write, randread, randwrite, rw, randrw\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100898 return 1;
899}
900
Jens Axboeb4692822006-10-27 13:43:22 +0200901static int str_verify_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100902{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200903 struct thread_data *td = data;
904
Jens Axboeebac4652005-12-08 15:25:21 +0100905 if (!strncmp(mem, "0", 1)) {
906 td->verify = VERIFY_NONE;
907 return 0;
908 } else if (!strncmp(mem, "md5", 3) || !strncmp(mem, "1", 1)) {
909 td->verify = VERIFY_MD5;
910 return 0;
911 } else if (!strncmp(mem, "crc32", 5)) {
912 td->verify = VERIFY_CRC32;
913 return 0;
914 }
915
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200916 log_err("fio: verify types: md5, crc32\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100917 return 1;
918}
919
Jens Axboe313cb202006-12-21 09:50:00 +0100920/*
921 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
922 */
923static char *get_mmap_file(const char *str)
924{
925 char *p = strstr(str, ":");
926
927 if (!p)
928 return NULL;
929
930 p++;
931 strip_blank_front(&p);
932 strip_blank_end(p);
933 return strdup(p);
934}
935
Jens Axboeb4692822006-10-27 13:43:22 +0200936static int str_mem_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100937{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200938 struct thread_data *td = data;
939
Jens Axboeebac4652005-12-08 15:25:21 +0100940 if (!strncmp(mem, "malloc", 6)) {
941 td->mem_type = MEM_MALLOC;
942 return 0;
Jens Axboed0bdaf42006-12-20 14:40:44 +0100943 } else if (!strncmp(mem, "mmaphuge", 8)) {
944#ifdef FIO_HAVE_HUGETLB
Jens Axboed0bdaf42006-12-20 14:40:44 +0100945 /*
946 * mmaphuge must be appended with the actual file
947 */
Jens Axboe313cb202006-12-21 09:50:00 +0100948 td->mmapfile = get_mmap_file(mem);
949 if (!td->mmapfile) {
Jens Axboed0bdaf42006-12-20 14:40:44 +0100950 log_err("fio: mmaphuge:/path/to/file\n");
951 return 1;
952 }
953
Jens Axboed0bdaf42006-12-20 14:40:44 +0100954 td->mem_type = MEM_MMAPHUGE;
955 return 0;
956#else
957 log_err("fio: mmaphuge not available\n");
958 return 1;
959#endif
Jens Axboeebac4652005-12-08 15:25:21 +0100960 } else if (!strncmp(mem, "mmap", 4)) {
Jens Axboe313cb202006-12-21 09:50:00 +0100961 /*
962 * Check if the user wants file backed memory. It's ok
963 * if there's no file given, we'll just use anon mamp then.
964 */
965 td->mmapfile = get_mmap_file(mem);
Jens Axboeebac4652005-12-08 15:25:21 +0100966 td->mem_type = MEM_MMAP;
967 return 0;
Jens Axboe74b025b2006-12-19 15:18:14 +0100968 } else if (!strncmp(mem, "shmhuge", 7)) {
969#ifdef FIO_HAVE_HUGETLB
970 td->mem_type = MEM_SHMHUGE;
971 return 0;
972#else
973 log_err("fio: shmhuge not available\n");
974 return 1;
975#endif
Jens Axboe0268b8b2006-12-20 12:48:23 +0100976 } else if (!strncmp(mem, "shm", 3)) {
977 td->mem_type = MEM_SHM;
978 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +0100979 }
980
Jens Axboed0bdaf42006-12-20 14:40:44 +0100981 log_err("fio: mem type: malloc, shm, shmhuge, mmap, mmaphuge\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100982 return 1;
983}
984
Jens Axboeb4692822006-10-27 13:43:22 +0200985static int str_ioengine_cb(void *data, const char *str)
Jens Axboeebac4652005-12-08 15:25:21 +0100986{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200987 struct thread_data *td = data;
988
Jens Axboe2866c822006-10-09 15:57:48 +0200989 td->io_ops = load_ioengine(td, str);
990 if (td->io_ops)
Jens Axboeebac4652005-12-08 15:25:21 +0100991 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +0100992
Jens Axboe08aae9a2006-11-24 12:43:49 +0100993 log_err("fio: ioengine= libaio, posixaio, sync, mmap, sgio, splice, cpu, null\n");
Jens Axboe5f350952006-11-07 15:20:59 +0100994 log_err("fio: or specify path to dynamic ioengine module\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100995 return 1;
996}
997
Jens Axboee1f36502006-10-27 10:54:08 +0200998static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
999{
1000 mlock_size = *val;
1001 return 0;
1002}
1003
Jens Axboe34cfcda2006-11-03 14:00:45 +01001004#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +02001005static int str_prioclass_cb(void *data, unsigned int *val)
1006{
1007 struct thread_data *td = data;
1008
1009 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1010 return 0;
1011}
1012
1013static int str_prio_cb(void *data, unsigned int *val)
1014{
1015 struct thread_data *td = data;
1016
1017 td->ioprio |= *val;
1018 return 0;
1019}
Jens Axboe34cfcda2006-11-03 14:00:45 +01001020#endif
Jens Axboee1f36502006-10-27 10:54:08 +02001021
1022static int str_exitall_cb(void)
1023{
1024 exitall_on_terminate = 1;
1025 return 0;
1026}
1027
1028static int str_cpumask_cb(void *data, unsigned int *val)
1029{
1030 struct thread_data *td = data;
1031
1032 fill_cpu_mask(td->cpumask, *val);
1033 return 0;
1034}
1035
Jens Axboe07261982006-06-07 10:51:12 +02001036/*
1037 * This is our [ini] type file parser.
1038 */
Jens Axboe1e97cce2006-12-05 11:44:16 +01001039static int parse_jobs_ini(char *file, int stonewall_flag)
Jens Axboeebac4652005-12-08 15:25:21 +01001040{
Jens Axboee1f36502006-10-27 10:54:08 +02001041 unsigned int global;
Jens Axboeebac4652005-12-08 15:25:21 +01001042 struct thread_data *td;
Jens Axboefee3bb42006-10-30 13:32:08 +01001043 char *string, *name;
Jens Axboeebac4652005-12-08 15:25:21 +01001044 fpos_t off;
1045 FILE *f;
1046 char *p;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001047 int ret = 0, stonewall;
Jens Axboeebac4652005-12-08 15:25:21 +01001048
1049 f = fopen(file, "r");
1050 if (!f) {
Jens Axboeaea47d42006-05-26 19:27:29 +02001051 perror("fopen job file");
Jens Axboeebac4652005-12-08 15:25:21 +01001052 return 1;
1053 }
1054
1055 string = malloc(4096);
1056 name = malloc(256);
Jens Axboefee3bb42006-10-30 13:32:08 +01001057 memset(name, 0, 256);
Jens Axboeebac4652005-12-08 15:25:21 +01001058
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001059 stonewall = stonewall_flag;
Jens Axboe7c124ac2006-10-30 13:36:52 +01001060 do {
1061 p = fgets(string, 4095, f);
1062 if (!p)
Jens Axboe45410ac2006-06-07 11:10:39 +02001063 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001064 if (is_empty_or_comment(p))
1065 continue;
Jens Axboefee3bb42006-10-30 13:32:08 +01001066 if (sscanf(p, "[%255s]", name) != 1)
Jens Axboeebac4652005-12-08 15:25:21 +01001067 continue;
1068
1069 global = !strncmp(name, "global", 6);
1070
1071 name[strlen(name) - 1] = '\0';
1072
1073 td = get_new_job(global, &def_thread);
Jens Axboe45410ac2006-06-07 11:10:39 +02001074 if (!td) {
1075 ret = 1;
1076 break;
1077 }
Jens Axboeebac4652005-12-08 15:25:21 +01001078
Jens Axboe972cfd22006-06-09 11:08:56 +02001079 /*
1080 * Seperate multiple job files by a stonewall
1081 */
Jens Axboef9481912006-06-09 11:37:28 +02001082 if (!global && stonewall) {
Jens Axboe972cfd22006-06-09 11:08:56 +02001083 td->stonewall = stonewall;
1084 stonewall = 0;
1085 }
1086
Jens Axboeebac4652005-12-08 15:25:21 +01001087 fgetpos(f, &off);
1088 while ((p = fgets(string, 4096, f)) != NULL) {
1089 if (is_empty_or_comment(p))
1090 continue;
Jens Axboee1f36502006-10-27 10:54:08 +02001091
Jens Axboeb6754f92006-05-30 14:29:32 +02001092 strip_blank_front(&p);
Jens Axboe7c124ac2006-10-30 13:36:52 +01001093
1094 if (p[0] == '[')
1095 break;
1096
Jens Axboe4ae3f762006-05-30 13:35:14 +02001097 strip_blank_end(p);
Jens Axboeaea47d42006-05-26 19:27:29 +02001098
Jens Axboee1f36502006-10-27 10:54:08 +02001099 fgetpos(f, &off);
Jens Axboeebac4652005-12-08 15:25:21 +01001100
Jens Axboe45410ac2006-06-07 11:10:39 +02001101 /*
1102 * Don't break here, continue parsing options so we
1103 * dump all the bad ones. Makes trial/error fixups
1104 * easier on the user.
1105 */
Jens Axboe7c124ac2006-10-30 13:36:52 +01001106 ret |= parse_option(p, options, td);
Jens Axboeebac4652005-12-08 15:25:21 +01001107 }
Jens Axboeebac4652005-12-08 15:25:21 +01001108
Jens Axboe45410ac2006-06-07 11:10:39 +02001109 if (!ret) {
1110 fsetpos(f, &off);
1111 ret = add_job(td, name, 0);
Jens Axboeb1508cf2006-11-02 09:12:40 +01001112 } else {
1113 log_err("fio: job %s dropped\n", name);
1114 put_job(td);
Jens Axboe45410ac2006-06-07 11:10:39 +02001115 }
Jens Axboe7c124ac2006-10-30 13:36:52 +01001116 } while (!ret);
Jens Axboeebac4652005-12-08 15:25:21 +01001117
1118 free(string);
1119 free(name);
1120 fclose(f);
Jens Axboe45410ac2006-06-07 11:10:39 +02001121 return ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001122}
1123
1124static int fill_def_thread(void)
1125{
1126 memset(&def_thread, 0, sizeof(def_thread));
1127
1128 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1129 perror("sched_getaffinity");
1130 return 1;
1131 }
1132
1133 /*
Jens Axboeee738492007-01-10 11:23:16 +01001134 * fill default options
Jens Axboeebac4652005-12-08 15:25:21 +01001135 */
Jens Axboeee738492007-01-10 11:23:16 +01001136 fill_default_options(&def_thread, options);
1137
Jens Axboe972cfd22006-06-09 11:08:56 +02001138 def_thread.timeout = def_timeout;
Jens Axboeec94ec52006-10-20 10:59:19 +02001139 def_thread.write_bw_log = write_bw_log;
1140 def_thread.write_lat_log = write_lat_log;
Jens Axboeee738492007-01-10 11:23:16 +01001141
Jens Axboeebac4652005-12-08 15:25:21 +01001142#ifdef FIO_HAVE_DISK_UTIL
1143 def_thread.do_disk_util = 1;
1144#endif
1145
1146 return 0;
1147}
1148
Jens Axboe0ab8db82006-10-18 17:16:23 +02001149static void usage(void)
Jens Axboe4785f992006-05-26 03:59:10 +02001150{
1151 printf("%s\n", fio_version_string);
Jens Axboeb4692822006-10-27 13:43:22 +02001152 printf("\t--output\tWrite output to file\n");
1153 printf("\t--timeout\tRuntime in seconds\n");
1154 printf("\t--latency-log\tGenerate per-job latency logs\n");
1155 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1156 printf("\t--minimal\tMinimal (terse) output\n");
1157 printf("\t--version\tPrint version info and exit\n");
Jens Axboefd28ca42007-01-09 21:20:13 +01001158 printf("\t--help\t\tPrint this page\n");
1159 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
Jens Axboe4785f992006-05-26 03:59:10 +02001160}
1161
Jens Axboe972cfd22006-06-09 11:08:56 +02001162static int parse_cmd_line(int argc, char *argv[])
Jens Axboeebac4652005-12-08 15:25:21 +01001163{
Jens Axboeb4692822006-10-27 13:43:22 +02001164 struct thread_data *td = NULL;
Jens Axboec2b1e752006-10-30 09:03:13 +01001165 int c, ini_idx = 0, lidx, ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001166
Jens Axboeb4692822006-10-27 13:43:22 +02001167 while ((c = getopt_long(argc, argv, "", long_options, &lidx)) != -1) {
Jens Axboeebac4652005-12-08 15:25:21 +01001168 switch (c) {
Jens Axboeb4692822006-10-27 13:43:22 +02001169 case 't':
1170 def_timeout = atoi(optarg);
1171 break;
1172 case 'l':
1173 write_lat_log = 1;
1174 break;
1175 case 'w':
1176 write_bw_log = 1;
1177 break;
1178 case 'o':
1179 f_out = fopen(optarg, "w+");
1180 if (!f_out) {
1181 perror("fopen output");
1182 exit(1);
1183 }
1184 f_err = f_out;
1185 break;
1186 case 'm':
1187 terse_output = 1;
1188 break;
1189 case 'h':
1190 usage();
1191 exit(0);
Jens Axboefd28ca42007-01-09 21:20:13 +01001192 case 'c':
Jens Axboe29fc6af2007-01-09 21:22:02 +01001193 ret = show_cmd_help(options, optarg);
1194 exit(ret);
Jens Axboeb4692822006-10-27 13:43:22 +02001195 case 'v':
1196 printf("%s\n", fio_version_string);
1197 exit(0);
1198 case FIO_GETOPT_JOB: {
1199 const char *opt = long_options[lidx].name;
1200 char *val = optarg;
1201
Jens Axboec2b1e752006-10-30 09:03:13 +01001202 if (!strncmp(opt, "name", 4) && td) {
1203 ret = add_job(td, td->name ?: "fio", 0);
1204 if (ret) {
1205 put_job(td);
1206 return 0;
1207 }
1208 td = NULL;
1209 }
Jens Axboeb4692822006-10-27 13:43:22 +02001210 if (!td) {
Jens Axboe38d0adb2006-10-30 12:21:25 +01001211 int global = !strncmp(val, "global", 6);
Jens Axboec2b1e752006-10-30 09:03:13 +01001212
1213 td = get_new_job(global, &def_thread);
Jens Axboeb4692822006-10-27 13:43:22 +02001214 if (!td)
1215 return 0;
1216 }
Jens Axboe38d0adb2006-10-30 12:21:25 +01001217
Jens Axboeb1508cf2006-11-02 09:12:40 +01001218 ret = parse_cmd_option(opt, val, options, td);
1219 if (ret) {
1220 log_err("fio: job dropped\n");
1221 put_job(td);
1222 td = NULL;
1223 }
Jens Axboeb4692822006-10-27 13:43:22 +02001224 break;
1225 }
1226 default:
Jens Axboeb4692822006-10-27 13:43:22 +02001227 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001228 }
1229 }
Jens Axboec9fad892006-05-27 17:26:50 +02001230
Jens Axboeb4692822006-10-27 13:43:22 +02001231 if (td) {
Jens Axboec2b1e752006-10-30 09:03:13 +01001232 ret = add_job(td, td->name ?: "fio", 0);
Jens Axboeb4692822006-10-27 13:43:22 +02001233 if (ret)
1234 put_job(td);
Jens Axboe972cfd22006-06-09 11:08:56 +02001235 }
Jens Axboe774a6172006-08-24 08:44:26 +02001236
Jens Axboeb4692822006-10-27 13:43:22 +02001237 while (optind < argc) {
1238 ini_idx++;
1239 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1240 ini_file[ini_idx - 1] = strdup(argv[optind]);
1241 optind++;
Jens Axboeeb8bbf42006-06-08 21:40:11 +02001242 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001243
1244 return ini_idx;
Jens Axboeebac4652005-12-08 15:25:21 +01001245}
1246
1247static void free_shm(void)
1248{
1249 struct shmid_ds sbuf;
1250
1251 if (threads) {
Jens Axboe2c0ecd22006-06-08 13:25:41 +02001252 shmdt((void *) threads);
Jens Axboeebac4652005-12-08 15:25:21 +01001253 threads = NULL;
1254 shmctl(shm_id, IPC_RMID, &sbuf);
1255 }
1256}
1257
Jens Axboe906c8d72006-06-13 09:37:56 +02001258/*
1259 * The thread area is shared between the main process and the job
1260 * threads/processes. So setup a shared memory segment that will hold
1261 * all the job info.
1262 */
Jens Axboeebac4652005-12-08 15:25:21 +01001263static int setup_thread_area(void)
1264{
1265 /*
1266 * 1024 is too much on some machines, scale max_jobs if
1267 * we get a failure that looks like too large a shm segment
1268 */
1269 do {
Jens Axboe906c8d72006-06-13 09:37:56 +02001270 size_t size = max_jobs * sizeof(struct thread_data);
Jens Axboeebac4652005-12-08 15:25:21 +01001271
Jens Axboe906c8d72006-06-13 09:37:56 +02001272 shm_id = shmget(0, size, IPC_CREAT | 0600);
Jens Axboeebac4652005-12-08 15:25:21 +01001273 if (shm_id != -1)
1274 break;
1275 if (errno != EINVAL) {
1276 perror("shmget");
1277 break;
1278 }
1279
1280 max_jobs >>= 1;
1281 } while (max_jobs);
1282
1283 if (shm_id == -1)
1284 return 1;
1285
1286 threads = shmat(shm_id, NULL, 0);
1287 if (threads == (void *) -1) {
1288 perror("shmat");
1289 return 1;
1290 }
1291
1292 atexit(free_shm);
1293 return 0;
1294}
1295
Jens Axboeb4692822006-10-27 13:43:22 +02001296/*
1297 * Copy the fio options into the long options map, so we mirror
1298 * job and cmd line options.
1299 */
1300static void dupe_job_options(void)
1301{
1302 struct fio_option *o;
1303 unsigned int i;
1304
1305 i = 0;
1306 while (long_options[i].name)
1307 i++;
1308
1309 o = &options[0];
1310 while (o->name) {
1311 long_options[i].name = o->name;
1312 long_options[i].val = FIO_GETOPT_JOB;
1313 if (o->type == FIO_OPT_STR_SET)
1314 long_options[i].has_arg = no_argument;
1315 else
1316 long_options[i].has_arg = required_argument;
1317
1318 i++;
1319 o++;
1320 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1321 }
1322}
1323
Jens Axboeebac4652005-12-08 15:25:21 +01001324int parse_options(int argc, char *argv[])
1325{
Jens Axboe972cfd22006-06-09 11:08:56 +02001326 int job_files, i;
1327
Jens Axboeb4692822006-10-27 13:43:22 +02001328 f_out = stdout;
1329 f_err = stderr;
1330
Jens Axboe13335dd2007-01-10 13:14:02 +01001331 options_init(options);
1332
Jens Axboeb4692822006-10-27 13:43:22 +02001333 dupe_job_options();
1334
Jens Axboeebac4652005-12-08 15:25:21 +01001335 if (setup_thread_area())
1336 return 1;
1337 if (fill_def_thread())
1338 return 1;
1339
Jens Axboe972cfd22006-06-09 11:08:56 +02001340 job_files = parse_cmd_line(argc, argv);
Jens Axboeebac4652005-12-08 15:25:21 +01001341
Jens Axboe972cfd22006-06-09 11:08:56 +02001342 for (i = 0; i < job_files; i++) {
1343 if (fill_def_thread())
1344 return 1;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001345 if (parse_jobs_ini(ini_file[i], i))
Jens Axboe972cfd22006-06-09 11:08:56 +02001346 return 1;
Jens Axboe88c6ed82006-06-09 11:28:10 +02001347 free(ini_file[i]);
Jens Axboe972cfd22006-06-09 11:08:56 +02001348 }
Jens Axboeebac4652005-12-08 15:25:21 +01001349
Jens Axboe88c6ed82006-06-09 11:28:10 +02001350 free(ini_file);
Jens Axboeb4692822006-10-27 13:43:22 +02001351
1352 if (!thread_number) {
1353 log_err("No jobs defined(s)\n");
Jens Axboeb4692822006-10-27 13:43:22 +02001354 return 1;
1355 }
1356
Jens Axboeebac4652005-12-08 15:25:21 +01001357 return 0;
1358}