blob: 5630c9fb3e821708b6bb8552cd5a3111834c82fb [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 {
Jens Axboe61697c32007-02-05 15:04:46 +010045 .name = "description",
46 .type = FIO_OPT_STR_STORE,
47 .off1 = td_var_offset(description),
48 .help = "Text job description",
49 },
50 {
Jens Axboee1f36502006-10-27 10:54:08 +020051 .name = "name",
52 .type = FIO_OPT_STR_STORE,
53 .off1 = td_var_offset(name),
Jens Axboefd28ca42007-01-09 21:20:13 +010054 .help = "Name of this job",
Jens Axboee1f36502006-10-27 10:54:08 +020055 },
56 {
57 .name = "directory",
58 .type = FIO_OPT_STR_STORE,
59 .off1 = td_var_offset(directory),
Jens Axboefd28ca42007-01-09 21:20:13 +010060 .help = "Directory to store files in",
Jens Axboee1f36502006-10-27 10:54:08 +020061 },
62 {
63 .name = "filename",
64 .type = FIO_OPT_STR_STORE,
65 .off1 = td_var_offset(filename),
Jens Axboefd28ca42007-01-09 21:20:13 +010066 .help = "Force the use of a specific file",
Jens Axboee1f36502006-10-27 10:54:08 +020067 },
68 {
69 .name = "rw",
70 .type = FIO_OPT_STR,
71 .cb = str_rw_cb,
Jens Axboe15f79182007-01-10 12:26:18 +010072 .help = "IO direction",
Jens Axboeee738492007-01-10 11:23:16 +010073 .def = "read",
Jens Axboe15f79182007-01-10 12:26:18 +010074 .posval = { "read", "write", "randwrite", "randread", "rw",
75 "randrw", },
Jens Axboee1f36502006-10-27 10:54:08 +020076 },
77 {
78 .name = "ioengine",
79 .type = FIO_OPT_STR,
80 .cb = str_ioengine_cb,
Jens Axboe15f79182007-01-10 12:26:18 +010081 .help = "IO engine to use",
Jens Axboeee738492007-01-10 11:23:16 +010082 .def = "sync",
Jens Axboe15f79182007-01-10 12:26:18 +010083 .posval = { "sync", "libaio", "posixaio", "mmap", "splice",
Jens Axboea4f4fdd2007-02-14 01:16:39 +010084 "sg", "null", "net", "syslet-rw" },
Jens Axboee1f36502006-10-27 10:54:08 +020085 },
86 {
Jens Axboe03b74b32007-01-11 11:04:31 +010087 .name = "iodepth",
88 .type = FIO_OPT_INT,
89 .off1 = td_var_offset(iodepth),
90 .help = "Amount of IO buffers to keep in flight",
91 .def = "1",
92 },
93 {
Jens Axboee916b392007-02-20 14:37:26 +010094 .name = "iodepth_low",
95 .type = FIO_OPT_INT,
96 .off1 = td_var_offset(iodepth_low),
97 .help = "Low water mark for queuing depth",
98 },
99 {
Jens Axboe03b74b32007-01-11 11:04:31 +0100100 .name = "size",
101 .type = FIO_OPT_STR_VAL,
102 .off1 = td_var_offset(total_file_size),
103 .help = "Size of device or file",
104 },
105 {
106 .name = "bs",
107 .type = FIO_OPT_STR_VAL_INT,
108 .off1 = td_var_offset(bs[DDIR_READ]),
109 .off2 = td_var_offset(bs[DDIR_WRITE]),
110 .help = "Block size unit",
111 .def = "4k",
112 },
113 {
114 .name = "bsrange",
115 .type = FIO_OPT_RANGE,
116 .off1 = td_var_offset(min_bs[DDIR_READ]),
117 .off2 = td_var_offset(max_bs[DDIR_READ]),
118 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
119 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
120 .help = "Set block size range (in more detail than bs)",
121 },
122 {
123 .name = "bs_unaligned",
124 .type = FIO_OPT_STR_SET,
125 .off1 = td_var_offset(bs_unaligned),
126 .help = "Don't sector align IO buffer sizes",
127 },
128 {
129 .name = "offset",
130 .type = FIO_OPT_STR_VAL,
131 .off1 = td_var_offset(start_offset),
132 .help = "Start IO from this offset",
133 .def = "0",
134 },
135 {
136 .name = "randrepeat",
137 .type = FIO_OPT_BOOL,
138 .off1 = td_var_offset(rand_repeatable),
139 .help = "Use repeatable random IO pattern",
140 .def = "1",
141 },
142 {
143 .name = "norandommap",
144 .type = FIO_OPT_STR_SET,
145 .off1 = td_var_offset(norandommap),
146 .help = "Accept potential duplicate random blocks",
147 },
148 {
149 .name = "nrfiles",
150 .type = FIO_OPT_INT,
151 .off1 = td_var_offset(nr_files),
152 .help = "Split job workload between this number of files",
153 .def = "1",
154 },
155 {
156 .name = "fsync",
157 .type = FIO_OPT_INT,
158 .off1 = td_var_offset(fsync_blocks),
159 .help = "Issue fsync for writes every given number of blocks",
160 .def = "0",
161 },
162 {
163 .name = "direct",
164 .type = FIO_OPT_BOOL,
165 .off1 = td_var_offset(odirect),
Jens Axboe76a43db2007-01-11 13:24:44 +0100166 .help = "Use O_DIRECT IO (negates buffered)",
167 .def = "0",
168 },
169 {
170 .name = "buffered",
171 .type = FIO_OPT_BOOL,
172 .off1 = td_var_offset(odirect),
173 .neg = 1,
174 .help = "Use buffered IO (negates direct)",
Jens Axboe03b74b32007-01-11 11:04:31 +0100175 .def = "1",
176 },
177 {
178 .name = "overwrite",
179 .type = FIO_OPT_BOOL,
180 .off1 = td_var_offset(overwrite),
181 .help = "When writing, set whether to overwrite current data",
182 .def = "0",
183 },
184 {
185 .name = "loops",
186 .type = FIO_OPT_INT,
187 .off1 = td_var_offset(loops),
188 .help = "Number of times to run the job",
189 .def = "1",
190 },
191 {
192 .name = "numjobs",
193 .type = FIO_OPT_INT,
194 .off1 = td_var_offset(numjobs),
195 .help = "Duplicate this job this many times",
196 .def = "1",
197 },
198 {
199 .name = "startdelay",
200 .type = FIO_OPT_INT,
201 .off1 = td_var_offset(start_delay),
202 .help = "Only start job when this period has passed",
203 .def = "0",
204 },
205 {
206 .name = "runtime",
207 .alias = "timeout",
208 .type = FIO_OPT_STR_VAL_TIME,
209 .off1 = td_var_offset(timeout),
210 .help = "Stop workload when this amount of time has passed",
211 .def = "0",
212 },
213 {
Jens Axboee1f36502006-10-27 10:54:08 +0200214 .name = "mem",
215 .type = FIO_OPT_STR,
216 .cb = str_mem_cb,
Jens Axboe15f79182007-01-10 12:26:18 +0100217 .help = "Backing type for IO buffers",
Jens Axboeee738492007-01-10 11:23:16 +0100218 .def = "malloc",
Jens Axboe15f79182007-01-10 12:26:18 +0100219 .posval = { "malloc", "shm", "shmhuge", "mmap", "mmaphuge", },
Jens Axboee1f36502006-10-27 10:54:08 +0200220 },
221 {
222 .name = "verify",
223 .type = FIO_OPT_STR,
224 .cb = str_verify_cb,
Jens Axboe15f79182007-01-10 12:26:18 +0100225 .help = "Verify sum function",
Jens Axboeee738492007-01-10 11:23:16 +0100226 .def = "0",
Jens Axboe15f79182007-01-10 12:26:18 +0100227 .posval = { "crc32", "md5", },
Jens Axboee1f36502006-10-27 10:54:08 +0200228 },
229 {
230 .name = "write_iolog",
Jens Axboe076efc72006-10-27 11:24:25 +0200231 .type = FIO_OPT_STR_STORE,
232 .off1 = td_var_offset(write_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100233 .help = "Store IO pattern to file",
Jens Axboee1f36502006-10-27 10:54:08 +0200234 },
235 {
Jens Axboe076efc72006-10-27 11:24:25 +0200236 .name = "read_iolog",
Jens Axboee1f36502006-10-27 10:54:08 +0200237 .type = FIO_OPT_STR_STORE,
Jens Axboe076efc72006-10-27 11:24:25 +0200238 .off1 = td_var_offset(read_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100239 .help = "Playback IO pattern from file",
Jens Axboee1f36502006-10-27 10:54:08 +0200240 },
241 {
242 .name = "exec_prerun",
243 .type = FIO_OPT_STR_STORE,
244 .off1 = td_var_offset(exec_prerun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100245 .help = "Execute this file prior to running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200246 },
247 {
248 .name = "exec_postrun",
249 .type = FIO_OPT_STR_STORE,
250 .off1 = td_var_offset(exec_postrun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100251 .help = "Execute this file after running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200252 },
253#ifdef FIO_HAVE_IOSCHED_SWITCH
254 {
255 .name = "ioscheduler",
256 .type = FIO_OPT_STR_STORE,
257 .off1 = td_var_offset(ioscheduler),
Jens Axboefd28ca42007-01-09 21:20:13 +0100258 .help = "Use this IO scheduler on the backing device",
Jens Axboee1f36502006-10-27 10:54:08 +0200259 },
260#endif
261 {
Jens Axboee1f36502006-10-27 10:54:08 +0200262 .name = "zonesize",
263 .type = FIO_OPT_STR_VAL,
264 .off1 = td_var_offset(zone_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100265 .help = "Give size of an IO zone",
Jens Axboeee738492007-01-10 11:23:16 +0100266 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200267 },
268 {
269 .name = "zoneskip",
270 .type = FIO_OPT_STR_VAL,
271 .off1 = td_var_offset(zone_skip),
Jens Axboefd28ca42007-01-09 21:20:13 +0100272 .help = "Space between IO zones",
Jens Axboeee738492007-01-10 11:23:16 +0100273 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200274 },
275 {
276 .name = "lockmem",
277 .type = FIO_OPT_STR_VAL,
278 .cb = str_lockmem_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100279 .help = "Lock down this amount of memory",
Jens Axboeee738492007-01-10 11:23:16 +0100280 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200281 },
282 {
Jens Axboee1f36502006-10-27 10:54:08 +0200283 .name = "rwmixcycle",
284 .type = FIO_OPT_INT,
285 .off1 = td_var_offset(rwmixcycle),
Jens Axboeee738492007-01-10 11:23:16 +0100286 .help = "Cycle period for mixed read/write workloads (msec)",
287 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200288 },
289 {
290 .name = "rwmixread",
291 .type = FIO_OPT_INT,
292 .off1 = td_var_offset(rwmixread),
Jens Axboeee738492007-01-10 11:23:16 +0100293 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100294 .help = "Percentage of mixed workload that is reads",
Jens Axboeee738492007-01-10 11:23:16 +0100295 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200296 },
297 {
298 .name = "rwmixwrite",
299 .type = FIO_OPT_INT,
300 .off1 = td_var_offset(rwmixwrite),
Jens Axboeee738492007-01-10 11:23:16 +0100301 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100302 .help = "Percentage of mixed workload that is writes",
Jens Axboeee738492007-01-10 11:23:16 +0100303 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200304 },
305 {
306 .name = "nice",
307 .type = FIO_OPT_INT,
308 .off1 = td_var_offset(nice),
Jens Axboefd28ca42007-01-09 21:20:13 +0100309 .help = "Set job CPU nice value",
Jens Axboe15f79182007-01-10 12:26:18 +0100310 .minval = -19,
Jens Axboeee738492007-01-10 11:23:16 +0100311 .maxval = 20,
312 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200313 },
314#ifdef FIO_HAVE_IOPRIO
315 {
316 .name = "prio",
317 .type = FIO_OPT_INT,
318 .cb = str_prio_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100319 .help = "Set job IO priority value",
Jens Axboe15f79182007-01-10 12:26:18 +0100320 .minval = 0,
321 .maxval = 7,
Jens Axboee1f36502006-10-27 10:54:08 +0200322 },
323 {
324 .name = "prioclass",
325 .type = FIO_OPT_INT,
326 .cb = str_prioclass_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100327 .help = "Set job IO priority class",
Jens Axboe15f79182007-01-10 12:26:18 +0100328 .minval = 0,
329 .maxval = 3,
Jens Axboee1f36502006-10-27 10:54:08 +0200330 },
331#endif
332 {
333 .name = "thinktime",
334 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100335 .off1 = td_var_offset(thinktime),
Jens Axboe5fa0f812007-01-11 14:06:35 +0100336 .help = "Idle time between IO buffers (usec)",
Jens Axboeee738492007-01-10 11:23:16 +0100337 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200338 },
339 {
Jens Axboe48097d52007-02-17 06:30:44 +0100340 .name = "thinktime_spin",
341 .type = FIO_OPT_INT,
342 .off1 = td_var_offset(thinktime_spin),
343 .help = "Start thinktime by spinning this amount (usec)",
344 .def = "0",
345 },
346 {
Jens Axboe9c1f7432007-01-03 20:43:19 +0100347 .name = "thinktime_blocks",
348 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100349 .off1 = td_var_offset(thinktime_blocks),
Jens Axboefd28ca42007-01-09 21:20:13 +0100350 .help = "IO buffer period between 'thinktime'",
Jens Axboeee738492007-01-10 11:23:16 +0100351 .def = "1",
Jens Axboe9c1f7432007-01-03 20:43:19 +0100352 },
353 {
Jens Axboee1f36502006-10-27 10:54:08 +0200354 .name = "rate",
355 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100356 .off1 = td_var_offset(rate),
Jens Axboefd28ca42007-01-09 21:20:13 +0100357 .help = "Set bandwidth rate",
Jens Axboee1f36502006-10-27 10:54:08 +0200358 },
359 {
360 .name = "ratemin",
361 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100362 .off1 = td_var_offset(ratemin),
Jens Axboefd28ca42007-01-09 21:20:13 +0100363 .help = "The bottom limit accepted",
Jens Axboee1f36502006-10-27 10:54:08 +0200364 },
365 {
366 .name = "ratecycle",
367 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100368 .off1 = td_var_offset(ratecycle),
Jens Axboe6da1fa72007-01-10 11:27:48 +0100369 .help = "Window average for rate limits (msec)",
Jens Axboeee738492007-01-10 11:23:16 +0100370 .def = "1000",
Jens Axboee1f36502006-10-27 10:54:08 +0200371 },
372 {
Jens Axboee1f36502006-10-27 10:54:08 +0200373 .name = "invalidate",
Jens Axboe13335dd2007-01-10 13:14:02 +0100374 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100375 .off1 = td_var_offset(invalidate_cache),
Jens Axboefd28ca42007-01-09 21:20:13 +0100376 .help = "Invalidate buffer/page cache prior to running job",
Jens Axboeee738492007-01-10 11:23:16 +0100377 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200378 },
379 {
380 .name = "sync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100381 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100382 .off1 = td_var_offset(sync_io),
Jens Axboefd28ca42007-01-09 21:20:13 +0100383 .help = "Use O_SYNC for buffered writes",
Jens Axboeee738492007-01-10 11:23:16 +0100384 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200385 },
386 {
387 .name = "bwavgtime",
388 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100389 .off1 = td_var_offset(bw_avg_time),
Jens Axboeee738492007-01-10 11:23:16 +0100390 .help = "Time window over which to calculate bandwidth (msec)",
391 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200392 },
393 {
394 .name = "create_serialize",
Jens Axboe13335dd2007-01-10 13:14:02 +0100395 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100396 .off1 = td_var_offset(create_serialize),
Jens Axboefd28ca42007-01-09 21:20:13 +0100397 .help = "Serialize creating of job files",
Jens Axboeee738492007-01-10 11:23:16 +0100398 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200399 },
400 {
401 .name = "create_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(create_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100404 .help = "Fsync file after creation",
Jens Axboeee738492007-01-10 11:23:16 +0100405 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200406 },
407 {
Jens Axboee1f36502006-10-27 10:54:08 +0200408 .name = "cpuload",
409 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100410 .off1 = td_var_offset(cpuload),
Jens Axboefd28ca42007-01-09 21:20:13 +0100411 .help = "Use this percentage of CPU",
Jens Axboee1f36502006-10-27 10:54:08 +0200412 },
413 {
414 .name = "cpuchunks",
415 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100416 .off1 = td_var_offset(cpucycle),
Jens Axboefd28ca42007-01-09 21:20:13 +0100417 .help = "Length of the CPU burn cycles",
Jens Axboee1f36502006-10-27 10:54:08 +0200418 },
Jens Axboee1f36502006-10-27 10:54:08 +0200419#ifdef FIO_HAVE_CPU_AFFINITY
420 {
421 .name = "cpumask",
422 .type = FIO_OPT_INT,
423 .cb = str_cpumask_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100424 .help = "CPU affinity mask",
Jens Axboee1f36502006-10-27 10:54:08 +0200425 },
426#endif
427 {
428 .name = "end_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100429 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100430 .off1 = td_var_offset(end_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100431 .help = "Include fsync at the end of job",
Jens Axboeee738492007-01-10 11:23:16 +0100432 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200433 },
434 {
435 .name = "unlink",
Jens Axboe13335dd2007-01-10 13:14:02 +0100436 .type = FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +0200437 .off1 = td_var_offset(unlink),
Jens Axboeee738492007-01-10 11:23:16 +0100438 .help = "Unlink created files after job has completed",
Jens Axboee545a6c2007-01-14 00:00:29 +0100439 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200440 },
441 {
442 .name = "exitall",
443 .type = FIO_OPT_STR_SET,
444 .cb = str_exitall_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100445 .help = "Terminate all jobs when one exits",
Jens Axboee1f36502006-10-27 10:54:08 +0200446 },
447 {
448 .name = "stonewall",
449 .type = FIO_OPT_STR_SET,
450 .off1 = td_var_offset(stonewall),
Jens Axboefd28ca42007-01-09 21:20:13 +0100451 .help = "Insert a hard barrier between this job and previous",
Jens Axboee1f36502006-10-27 10:54:08 +0200452 },
453 {
454 .name = "thread",
455 .type = FIO_OPT_STR_SET,
Jens Axboed9bb3b82007-01-10 20:30:53 +0100456 .off1 = td_var_offset(use_thread),
Jens Axboefd28ca42007-01-09 21:20:13 +0100457 .help = "Use threads instead of forks",
Jens Axboee1f36502006-10-27 10:54:08 +0200458 },
459 {
460 .name = "write_bw_log",
461 .type = FIO_OPT_STR_SET,
462 .off1 = td_var_offset(write_bw_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100463 .help = "Write log of bandwidth during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200464 },
465 {
466 .name = "write_lat_log",
467 .type = FIO_OPT_STR_SET,
468 .off1 = td_var_offset(write_lat_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100469 .help = "Write log of latency during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200470 },
471 {
Jens Axboe56bb17f2006-12-20 20:27:36 +0100472 .name = "hugepage-size",
473 .type = FIO_OPT_STR_VAL,
474 .off1 = td_var_offset(hugepage_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100475 .help = "When using hugepages, specify size of each page",
Jens Axboeee738492007-01-10 11:23:16 +0100476 .def = __stringify(FIO_HUGE_PAGE),
Jens Axboe56bb17f2006-12-20 20:27:36 +0100477 },
478 {
Jens Axboee1f36502006-10-27 10:54:08 +0200479 .name = NULL,
480 },
481};
482
Jens Axboeb4692822006-10-27 13:43:22 +0200483#define FIO_JOB_OPTS (sizeof(options) / sizeof(struct fio_option))
484#define FIO_CMD_OPTS (16)
485#define FIO_GETOPT_JOB (0x89988998)
486
487/*
488 * Command line options. These will contain the above, plus a few
489 * extra that only pertain to fio itself and not jobs.
490 */
491static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
492 {
493 .name = "output",
494 .has_arg = required_argument,
495 .val = 'o',
496 },
497 {
498 .name = "timeout",
499 .has_arg = required_argument,
500 .val = 't',
501 },
502 {
503 .name = "latency-log",
504 .has_arg = required_argument,
505 .val = 'l',
506 },
507 {
508 .name = "bandwidth-log",
509 .has_arg = required_argument,
510 .val = 'b',
511 },
512 {
513 .name = "minimal",
514 .has_arg = optional_argument,
515 .val = 'm',
516 },
517 {
518 .name = "version",
519 .has_arg = no_argument,
520 .val = 'v',
521 },
522 {
Jens Axboefd28ca42007-01-09 21:20:13 +0100523 .name = "help",
524 .has_arg = no_argument,
525 .val = 'h',
526 },
527 {
528 .name = "cmdhelp",
529 .has_arg = required_argument,
530 .val = 'c',
531 },
532 {
Jens Axboeb4692822006-10-27 13:43:22 +0200533 .name = NULL,
534 },
535};
536
Jens Axboeee738492007-01-10 11:23:16 +0100537static int def_timeout = 0;
Jens Axboe972cfd22006-06-09 11:08:56 +0200538
Jens Axboe5cd033b2007-01-09 08:19:01 +0100539static char fio_version_string[] = "fio 1.11";
Jens Axboeebac4652005-12-08 15:25:21 +0100540
Jens Axboe972cfd22006-06-09 11:08:56 +0200541static char **ini_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100542static int max_jobs = MAX_JOBS;
543
544struct thread_data def_thread;
545struct thread_data *threads = NULL;
546
Jens Axboeebac4652005-12-08 15:25:21 +0100547int exitall_on_terminate = 0;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200548int terse_output = 0;
Jens Axboec04f7ec2006-05-31 10:13:16 +0200549unsigned long long mlock_size = 0;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200550FILE *f_out = NULL;
551FILE *f_err = NULL;
Jens Axboeebac4652005-12-08 15:25:21 +0100552
Jens Axboeee738492007-01-10 11:23:16 +0100553static int write_lat_log = 0;
Jens Axboebb3884d2007-01-17 17:23:11 +1100554int write_bw_log = 0;
Jens Axboeec94ec52006-10-20 10:59:19 +0200555
Jens Axboe906c8d72006-06-13 09:37:56 +0200556/*
557 * Return a free job structure.
558 */
Jens Axboeebac4652005-12-08 15:25:21 +0100559static struct thread_data *get_new_job(int global, struct thread_data *parent)
560{
561 struct thread_data *td;
562
563 if (global)
564 return &def_thread;
565 if (thread_number >= max_jobs)
566 return NULL;
567
568 td = &threads[thread_number++];
Jens Axboeddaeaa52006-06-08 11:00:58 +0200569 *td = *parent;
Jens Axboeebac4652005-12-08 15:25:21 +0100570
Jens Axboeebac4652005-12-08 15:25:21 +0100571 td->thread_number = thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100572 return td;
573}
574
575static void put_job(struct thread_data *td)
576{
Jens Axboe549577a2006-10-30 12:23:41 +0100577 if (td == &def_thread)
578 return;
579
Jens Axboe16edf252007-02-10 14:59:22 +0100580 if (td->error)
581 fprintf(f_out, "fio: %s\n", td->verror);
582
Jens Axboeebac4652005-12-08 15:25:21 +0100583 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
584 thread_number--;
585}
586
Jens Axboedad915e2006-10-27 11:10:18 +0200587/*
588 * Lazy way of fixing up options that depend on each other. We could also
589 * define option callback handlers, but this is easier.
590 */
Jens Axboee1f36502006-10-27 10:54:08 +0200591static void fixup_options(struct thread_data *td)
592{
Jens Axboee1f36502006-10-27 10:54:08 +0200593 if (!td->rwmixread && td->rwmixwrite)
594 td->rwmixread = 100 - td->rwmixwrite;
Jens Axboedad915e2006-10-27 11:10:18 +0200595
Jens Axboe076efc72006-10-27 11:24:25 +0200596 if (td->write_iolog_file && td->read_iolog_file) {
597 log_err("fio: read iolog overrides write_iolog\n");
598 free(td->write_iolog_file);
599 td->write_iolog_file = NULL;
600 }
Jens Axboe16b462a2006-10-30 12:35:18 +0100601
602 if (td->io_ops->flags & FIO_SYNCIO)
603 td->iodepth = 1;
604 else {
605 if (!td->iodepth)
606 td->iodepth = td->nr_files;
607 }
608
609 /*
610 * only really works for sequential io for now, and with 1 file
611 */
612 if (td->zone_size && !td->sequential && td->nr_files == 1)
613 td->zone_size = 0;
614
615 /*
616 * Reads can do overwrites, we always need to pre-create the file
617 */
618 if (td_read(td) || td_rw(td))
619 td->overwrite = 1;
620
Jens Axboea00735e2006-11-03 08:58:08 +0100621 if (!td->min_bs[DDIR_READ])
622 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
623 if (!td->max_bs[DDIR_READ])
624 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
625 if (!td->min_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100626 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100627 if (!td->max_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100628 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100629
630 td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
631
Jens Axboe16b462a2006-10-30 12:35:18 +0100632 if (td_read(td) && !td_rw(td))
633 td->verify = 0;
Jens Axboebb8895e2006-10-30 15:14:48 +0100634
635 if (td->norandommap && td->verify != VERIFY_NONE) {
636 log_err("fio: norandommap given, verify disabled\n");
637 td->verify = VERIFY_NONE;
638 }
Jens Axboe690adba2006-10-30 15:25:09 +0100639 if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
640 log_err("fio: bs_unaligned may not work with raw io\n");
Jens Axboee0a22332006-12-20 12:54:25 +0100641
642 /*
643 * O_DIRECT and char doesn't mix, clear that flag if necessary.
644 */
645 if (td->filetype == FIO_TYPE_CHAR && td->odirect)
646 td->odirect = 0;
Jens Axboe48097d52007-02-17 06:30:44 +0100647
648 /*
649 * thinktime_spin must be less than thinktime
650 */
651 if (td->thinktime_spin > td->thinktime)
652 td->thinktime_spin = td->thinktime;
Jens Axboee916b392007-02-20 14:37:26 +0100653
654 /*
655 * The low water mark cannot be bigger than the iodepth
656 */
657 if (td->iodepth_low > td->iodepth || !td->iodepth_low)
658 td->iodepth_low = td->iodepth;
659
660 printf("io depth %d/%d\n", td->iodepth_low, td->iodepth);
Jens Axboee1f36502006-10-27 10:54:08 +0200661}
662
Jens Axboe906c8d72006-06-13 09:37:56 +0200663/*
Jens Axboef8977ee2006-11-06 14:03:03 +0100664 * This function leaks the buffer
665 */
666static char *to_kmg(unsigned int val)
667{
668 char *buf = malloc(32);
Jens Axboef3502ba2007-02-14 01:27:09 +0100669 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
Jens Axboef8977ee2006-11-06 14:03:03 +0100670 char *p = post;
671
Jens Axboe245142f2006-11-08 12:49:21 +0100672 do {
Jens Axboef8977ee2006-11-06 14:03:03 +0100673 if (val & 1023)
674 break;
675
676 val >>= 10;
677 p++;
Jens Axboe245142f2006-11-08 12:49:21 +0100678 } while (*p);
Jens Axboef8977ee2006-11-06 14:03:03 +0100679
680 snprintf(buf, 31, "%u%c", val, *p);
681 return buf;
682}
683
684/*
Jens Axboe906c8d72006-06-13 09:37:56 +0200685 * Adds a job to the list of things todo. Sanitizes the various options
686 * to make sure we don't have conflicts, and initializes various
687 * members of td.
688 */
Jens Axboe75154842006-06-01 13:56:09 +0200689static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
Jens Axboeebac4652005-12-08 15:25:21 +0100690{
Jens Axboe3c9b60c2006-11-07 08:36:14 +0100691 const char *ddir_str[] = { "read", "write", "randread", "randwrite",
692 "rw", NULL, "randrw" };
Jens Axboeebac4652005-12-08 15:25:21 +0100693 struct stat sb;
Jens Axboe53cdc682006-10-18 11:50:58 +0200694 int numjobs, ddir, i;
695 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100696
Jens Axboeebac4652005-12-08 15:25:21 +0100697 /*
698 * the def_thread is just for options, it's not a real job
699 */
700 if (td == &def_thread)
701 return 0;
702
Jens Axboeee738492007-01-10 11:23:16 +0100703 assert(td->io_ops);
Jens Axboedf641192006-10-12 07:55:41 +0200704
Jens Axboe690adba2006-10-30 15:25:09 +0100705 if (td->odirect)
706 td->io_ops->flags |= FIO_RAWIO;
707
Jens Axboeebac4652005-12-08 15:25:21 +0100708 td->filetype = FIO_TYPE_FILE;
Jens Axboe890df532007-02-17 01:51:13 +0100709 if (td->filename && !lstat(td->filename, &sb)) {
Jens Axboe0af7b542006-02-17 10:10:12 +0100710 if (S_ISBLK(sb.st_mode))
711 td->filetype = FIO_TYPE_BD;
712 else if (S_ISCHR(sb.st_mode))
713 td->filetype = FIO_TYPE_CHAR;
714 }
Jens Axboeebac4652005-12-08 15:25:21 +0100715
Jens Axboee0a22332006-12-20 12:54:25 +0100716 fixup_options(td);
717
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200718 if (td->filename)
719 td->nr_uniq_files = 1;
720 else
721 td->nr_uniq_files = td->nr_files;
722
723 if (td->filetype == FIO_TYPE_FILE || td->filename) {
Jens Axboee9c047a2006-06-07 21:13:04 +0200724 char tmp[PATH_MAX];
Jens Axboe53cdc682006-10-18 11:50:58 +0200725 int len = 0;
Jens Axboee9c047a2006-06-07 21:13:04 +0200726
Jens Axboe16edf252007-02-10 14:59:22 +0100727 if (td->directory && td->directory[0] != '\0') {
728 if (lstat(td->directory, &sb) < 0) {
729 log_err("fio: %s is not a directory\n", td->directory);
730 td_verror(td, errno);
731 return 1;
732 }
733 if (!S_ISDIR(sb.st_mode)) {
734 log_err("fio: %s is not a directory\n", td->directory);
735 return 1;
736 }
Jens Axboe8aeebd52007-01-08 10:47:43 +0100737 len = sprintf(tmp, "%s/", td->directory);
Jens Axboe16edf252007-02-10 14:59:22 +0100738 }
Jens Axboeebac4652005-12-08 15:25:21 +0100739
Jens Axboe53cdc682006-10-18 11:50:58 +0200740 td->files = malloc(sizeof(struct fio_file) * td->nr_files);
741
742 for_each_file(td, f, i) {
743 memset(f, 0, sizeof(*f));
744 f->fd = -1;
745
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200746 if (td->filename)
747 sprintf(tmp + len, "%s", td->filename);
748 else
749 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
Jens Axboe53cdc682006-10-18 11:50:58 +0200750 f->file_name = strdup(tmp);
751 }
752 } else {
753 td->nr_files = 1;
754 td->files = malloc(sizeof(struct fio_file));
755 f = &td->files[0];
756
757 memset(f, 0, sizeof(*f));
758 f->fd = -1;
759 f->file_name = strdup(jobname);
760 }
761
762 for_each_file(td, f, i) {
763 f->file_size = td->total_file_size / td->nr_files;
764 f->file_offset = td->start_offset;
765 }
766
Jens Axboebbfd6b02006-06-07 19:42:54 +0200767 fio_sem_init(&td->mutex, 0);
Jens Axboeebac4652005-12-08 15:25:21 +0100768
Jens Axboe079ad092007-02-20 13:58:20 +0100769 td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
770 td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
771 td->ts.bw_stat[0].min_val = td->ts.bw_stat[1].min_val = ULONG_MAX;
Jens Axboeebac4652005-12-08 15:25:21 +0100772
Jens Axboeebac4652005-12-08 15:25:21 +0100773 if (td->stonewall && td->thread_number > 1)
774 groupid++;
775
776 td->groupid = groupid;
777
778 if (setup_rate(td))
779 goto err;
780
Jens Axboeec94ec52006-10-20 10:59:19 +0200781 if (td->write_lat_log) {
Jens Axboe079ad092007-02-20 13:58:20 +0100782 setup_log(&td->ts.slat_log);
783 setup_log(&td->ts.clat_log);
Jens Axboeebac4652005-12-08 15:25:21 +0100784 }
Jens Axboeec94ec52006-10-20 10:59:19 +0200785 if (td->write_bw_log)
Jens Axboe079ad092007-02-20 13:58:20 +0100786 setup_log(&td->ts.bw_log);
Jens Axboeebac4652005-12-08 15:25:21 +0100787
Jens Axboeb4692822006-10-27 13:43:22 +0200788 if (!td->name)
789 td->name = strdup(jobname);
Jens Axboe01452052006-06-07 10:29:47 +0200790
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200791 ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
Jens Axboe75154842006-06-01 13:56:09 +0200792
Jens Axboec6ae0a52006-06-12 11:04:44 +0200793 if (!terse_output) {
Jens Axboeb990b5c2006-09-14 09:48:22 +0200794 if (!job_add_num) {
Jens Axboe2866c822006-10-09 15:57:48 +0200795 if (td->io_ops->flags & FIO_CPUIO)
Jens Axboeb990b5c2006-09-14 09:48:22 +0200796 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
Jens Axboef8977ee2006-11-06 14:03:03 +0100797 else {
798 char *c1, *c2, *c3, *c4;
799
800 c1 = to_kmg(td->min_bs[DDIR_READ]);
801 c2 = to_kmg(td->max_bs[DDIR_READ]);
802 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
803 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
804
Jens Axboed56cbab2007-01-11 19:24:55 +0100805 fprintf(f_out, "%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[ddir], c1, c2, c3, c4, td->io_ops->name, td->iodepth);
Jens Axboef8977ee2006-11-06 14:03:03 +0100806
807 free(c1);
808 free(c2);
809 free(c3);
810 free(c4);
811 }
Jens Axboeb990b5c2006-09-14 09:48:22 +0200812 } else if (job_add_num == 1)
Jens Axboec6ae0a52006-06-12 11:04:44 +0200813 fprintf(f_out, "...\n");
814 }
Jens Axboeebac4652005-12-08 15:25:21 +0100815
816 /*
817 * recurse add identical jobs, clear numjobs and stonewall options
818 * as they don't apply to sub-jobs
819 */
820 numjobs = td->numjobs;
821 while (--numjobs) {
822 struct thread_data *td_new = get_new_job(0, td);
823
824 if (!td_new)
825 goto err;
826
827 td_new->numjobs = 1;
828 td_new->stonewall = 0;
Jens Axboe75154842006-06-01 13:56:09 +0200829 job_add_num = numjobs - 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100830
Jens Axboe75154842006-06-01 13:56:09 +0200831 if (add_job(td_new, jobname, job_add_num))
Jens Axboeebac4652005-12-08 15:25:21 +0100832 goto err;
833 }
834 return 0;
835err:
836 put_job(td);
837 return -1;
838}
839
Jens Axboe906c8d72006-06-13 09:37:56 +0200840/*
841 * Initialize the various random states we need (random io, block size ranges,
842 * read/write mix, etc).
843 */
Jens Axboeebac4652005-12-08 15:25:21 +0100844int init_random_state(struct thread_data *td)
845{
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200846 unsigned long seeds[4];
Jens Axboe53cdc682006-10-18 11:50:58 +0200847 int fd, num_maps, blocks, i;
Jens Axboe0ab8db82006-10-18 17:16:23 +0200848 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100849
Jens Axboef48b4672006-10-27 11:30:07 +0200850 if (td->io_ops->flags & FIO_CPUIO)
851 return 0;
852
Jens Axboe1ac267b2006-05-31 20:29:00 +0200853 fd = open("/dev/urandom", O_RDONLY);
Jens Axboeebac4652005-12-08 15:25:21 +0100854 if (fd == -1) {
855 td_verror(td, errno);
856 return 1;
857 }
858
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200859 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
Jens Axboeebac4652005-12-08 15:25:21 +0100860 td_verror(td, EIO);
861 close(fd);
862 return 1;
863 }
864
865 close(fd);
866
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200867 os_random_seed(seeds[0], &td->bsrange_state);
868 os_random_seed(seeds[1], &td->verify_state);
869 os_random_seed(seeds[2], &td->rwmix_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100870
871 if (td->sequential)
872 return 0;
873
Jens Axboe9ebc27e2006-06-12 10:21:50 +0200874 if (td->rand_repeatable)
Jens Axboe2f073b02007-02-17 02:09:01 +0100875 seeds[3] = FIO_RANDSEED * td->thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100876
Jens Axboebb8895e2006-10-30 15:14:48 +0100877 if (!td->norandommap) {
878 for_each_file(td, f, i) {
Jens Axboea4a81712007-02-13 20:07:26 +0100879 blocks = (f->real_file_size + td->rw_min_bs - 1) / td->rw_min_bs;
Jens Axboec7c280e2006-11-02 20:10:33 +0100880 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
Jens Axboebb8895e2006-10-30 15:14:48 +0100881 f->file_map = malloc(num_maps * sizeof(long));
882 f->num_maps = num_maps;
883 memset(f->file_map, 0, num_maps * sizeof(long));
884 }
Jens Axboe53cdc682006-10-18 11:50:58 +0200885 }
Jens Axboeebac4652005-12-08 15:25:21 +0100886
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200887 os_random_seed(seeds[3], &td->random_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100888 return 0;
889}
890
891static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
892{
893#ifdef FIO_HAVE_CPU_AFFINITY
894 unsigned int i;
895
896 CPU_ZERO(&cpumask);
897
898 for (i = 0; i < sizeof(int) * 8; i++) {
899 if ((1 << i) & cpu)
900 CPU_SET(i, &cpumask);
901 }
902#endif
903}
904
Jens Axboeebac4652005-12-08 15:25:21 +0100905static int is_empty_or_comment(char *line)
906{
907 unsigned int i;
908
909 for (i = 0; i < strlen(line); i++) {
910 if (line[i] == ';')
911 return 1;
Ingo Molnar5cc2da32007-02-20 10:19:44 +0100912 if (line[i] == '#')
913 return 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100914 if (!isspace(line[i]) && !iscntrl(line[i]))
915 return 0;
916 }
917
918 return 1;
919}
920
Jens Axboeb4692822006-10-27 13:43:22 +0200921static int str_rw_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100922{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200923 struct thread_data *td = data;
924
Jens Axboeebac4652005-12-08 15:25:21 +0100925 if (!strncmp(mem, "read", 4) || !strncmp(mem, "0", 1)) {
926 td->ddir = DDIR_READ;
927 td->sequential = 1;
928 return 0;
929 } else if (!strncmp(mem, "randread", 8)) {
930 td->ddir = DDIR_READ;
931 td->sequential = 0;
932 return 0;
933 } else if (!strncmp(mem, "write", 5) || !strncmp(mem, "1", 1)) {
934 td->ddir = DDIR_WRITE;
935 td->sequential = 1;
936 return 0;
937 } else if (!strncmp(mem, "randwrite", 9)) {
938 td->ddir = DDIR_WRITE;
939 td->sequential = 0;
940 return 0;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200941 } else if (!strncmp(mem, "rw", 2)) {
Jens Axboe1e97cce2006-12-05 11:44:16 +0100942 td->ddir = DDIR_READ;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200943 td->iomix = 1;
944 td->sequential = 1;
945 return 0;
946 } else if (!strncmp(mem, "randrw", 6)) {
Jens Axboe1e97cce2006-12-05 11:44:16 +0100947 td->ddir = DDIR_READ;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200948 td->iomix = 1;
949 td->sequential = 0;
950 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +0100951 }
952
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200953 log_err("fio: data direction: read, write, randread, randwrite, rw, randrw\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100954 return 1;
955}
956
Jens Axboeb4692822006-10-27 13:43:22 +0200957static int str_verify_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100958{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200959 struct thread_data *td = data;
960
Jens Axboeebac4652005-12-08 15:25:21 +0100961 if (!strncmp(mem, "0", 1)) {
962 td->verify = VERIFY_NONE;
963 return 0;
964 } else if (!strncmp(mem, "md5", 3) || !strncmp(mem, "1", 1)) {
965 td->verify = VERIFY_MD5;
966 return 0;
967 } else if (!strncmp(mem, "crc32", 5)) {
968 td->verify = VERIFY_CRC32;
969 return 0;
970 }
971
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200972 log_err("fio: verify types: md5, crc32\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100973 return 1;
974}
975
Jens Axboe313cb202006-12-21 09:50:00 +0100976/*
977 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
978 */
979static char *get_mmap_file(const char *str)
980{
981 char *p = strstr(str, ":");
982
983 if (!p)
984 return NULL;
985
986 p++;
987 strip_blank_front(&p);
988 strip_blank_end(p);
989 return strdup(p);
990}
991
Jens Axboeb4692822006-10-27 13:43:22 +0200992static int str_mem_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100993{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200994 struct thread_data *td = data;
995
Jens Axboeebac4652005-12-08 15:25:21 +0100996 if (!strncmp(mem, "malloc", 6)) {
997 td->mem_type = MEM_MALLOC;
998 return 0;
Jens Axboed0bdaf42006-12-20 14:40:44 +0100999 } else if (!strncmp(mem, "mmaphuge", 8)) {
1000#ifdef FIO_HAVE_HUGETLB
Jens Axboed0bdaf42006-12-20 14:40:44 +01001001 /*
1002 * mmaphuge must be appended with the actual file
1003 */
Jens Axboe313cb202006-12-21 09:50:00 +01001004 td->mmapfile = get_mmap_file(mem);
1005 if (!td->mmapfile) {
Jens Axboed0bdaf42006-12-20 14:40:44 +01001006 log_err("fio: mmaphuge:/path/to/file\n");
1007 return 1;
1008 }
1009
Jens Axboed0bdaf42006-12-20 14:40:44 +01001010 td->mem_type = MEM_MMAPHUGE;
1011 return 0;
1012#else
1013 log_err("fio: mmaphuge not available\n");
1014 return 1;
1015#endif
Jens Axboeebac4652005-12-08 15:25:21 +01001016 } else if (!strncmp(mem, "mmap", 4)) {
Jens Axboe313cb202006-12-21 09:50:00 +01001017 /*
1018 * Check if the user wants file backed memory. It's ok
1019 * if there's no file given, we'll just use anon mamp then.
1020 */
1021 td->mmapfile = get_mmap_file(mem);
Jens Axboeebac4652005-12-08 15:25:21 +01001022 td->mem_type = MEM_MMAP;
1023 return 0;
Jens Axboe74b025b2006-12-19 15:18:14 +01001024 } else if (!strncmp(mem, "shmhuge", 7)) {
1025#ifdef FIO_HAVE_HUGETLB
1026 td->mem_type = MEM_SHMHUGE;
1027 return 0;
1028#else
1029 log_err("fio: shmhuge not available\n");
1030 return 1;
1031#endif
Jens Axboe0268b8b2006-12-20 12:48:23 +01001032 } else if (!strncmp(mem, "shm", 3)) {
1033 td->mem_type = MEM_SHM;
1034 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001035 }
1036
Jens Axboed0bdaf42006-12-20 14:40:44 +01001037 log_err("fio: mem type: malloc, shm, shmhuge, mmap, mmaphuge\n");
Jens Axboeebac4652005-12-08 15:25:21 +01001038 return 1;
1039}
1040
Jens Axboeb4692822006-10-27 13:43:22 +02001041static int str_ioengine_cb(void *data, const char *str)
Jens Axboeebac4652005-12-08 15:25:21 +01001042{
Jens Axboecb2c86f2006-10-26 13:48:34 +02001043 struct thread_data *td = data;
1044
Jens Axboe2866c822006-10-09 15:57:48 +02001045 td->io_ops = load_ioengine(td, str);
1046 if (td->io_ops)
Jens Axboeebac4652005-12-08 15:25:21 +01001047 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001048
Jens Axboe08aae9a2006-11-24 12:43:49 +01001049 log_err("fio: ioengine= libaio, posixaio, sync, mmap, sgio, splice, cpu, null\n");
Jens Axboe5f350952006-11-07 15:20:59 +01001050 log_err("fio: or specify path to dynamic ioengine module\n");
Jens Axboeebac4652005-12-08 15:25:21 +01001051 return 1;
1052}
1053
Jens Axboee1f36502006-10-27 10:54:08 +02001054static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
1055{
1056 mlock_size = *val;
1057 return 0;
1058}
1059
Jens Axboe34cfcda2006-11-03 14:00:45 +01001060#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +02001061static int str_prioclass_cb(void *data, unsigned int *val)
1062{
1063 struct thread_data *td = data;
1064
1065 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1066 return 0;
1067}
1068
1069static int str_prio_cb(void *data, unsigned int *val)
1070{
1071 struct thread_data *td = data;
1072
1073 td->ioprio |= *val;
1074 return 0;
1075}
Jens Axboe34cfcda2006-11-03 14:00:45 +01001076#endif
Jens Axboee1f36502006-10-27 10:54:08 +02001077
1078static int str_exitall_cb(void)
1079{
1080 exitall_on_terminate = 1;
1081 return 0;
1082}
1083
1084static int str_cpumask_cb(void *data, unsigned int *val)
1085{
1086 struct thread_data *td = data;
1087
1088 fill_cpu_mask(td->cpumask, *val);
1089 return 0;
1090}
1091
Jens Axboe07261982006-06-07 10:51:12 +02001092/*
1093 * This is our [ini] type file parser.
1094 */
Jens Axboe1e97cce2006-12-05 11:44:16 +01001095static int parse_jobs_ini(char *file, int stonewall_flag)
Jens Axboeebac4652005-12-08 15:25:21 +01001096{
Jens Axboee1f36502006-10-27 10:54:08 +02001097 unsigned int global;
Jens Axboeebac4652005-12-08 15:25:21 +01001098 struct thread_data *td;
Jens Axboefee3bb42006-10-30 13:32:08 +01001099 char *string, *name;
Jens Axboeebac4652005-12-08 15:25:21 +01001100 fpos_t off;
1101 FILE *f;
1102 char *p;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001103 int ret = 0, stonewall;
Jens Axboeebac4652005-12-08 15:25:21 +01001104
1105 f = fopen(file, "r");
1106 if (!f) {
Jens Axboeaea47d42006-05-26 19:27:29 +02001107 perror("fopen job file");
Jens Axboeebac4652005-12-08 15:25:21 +01001108 return 1;
1109 }
1110
1111 string = malloc(4096);
1112 name = malloc(256);
Jens Axboefee3bb42006-10-30 13:32:08 +01001113 memset(name, 0, 256);
Jens Axboeebac4652005-12-08 15:25:21 +01001114
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001115 stonewall = stonewall_flag;
Jens Axboe7c124ac2006-10-30 13:36:52 +01001116 do {
1117 p = fgets(string, 4095, f);
1118 if (!p)
Jens Axboe45410ac2006-06-07 11:10:39 +02001119 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001120 if (is_empty_or_comment(p))
1121 continue;
Jens Axboefee3bb42006-10-30 13:32:08 +01001122 if (sscanf(p, "[%255s]", name) != 1)
Jens Axboeebac4652005-12-08 15:25:21 +01001123 continue;
1124
1125 global = !strncmp(name, "global", 6);
1126
1127 name[strlen(name) - 1] = '\0';
1128
1129 td = get_new_job(global, &def_thread);
Jens Axboe45410ac2006-06-07 11:10:39 +02001130 if (!td) {
1131 ret = 1;
1132 break;
1133 }
Jens Axboeebac4652005-12-08 15:25:21 +01001134
Jens Axboe972cfd22006-06-09 11:08:56 +02001135 /*
1136 * Seperate multiple job files by a stonewall
1137 */
Jens Axboef9481912006-06-09 11:37:28 +02001138 if (!global && stonewall) {
Jens Axboe972cfd22006-06-09 11:08:56 +02001139 td->stonewall = stonewall;
1140 stonewall = 0;
1141 }
1142
Jens Axboeebac4652005-12-08 15:25:21 +01001143 fgetpos(f, &off);
1144 while ((p = fgets(string, 4096, f)) != NULL) {
1145 if (is_empty_or_comment(p))
1146 continue;
Jens Axboee1f36502006-10-27 10:54:08 +02001147
Jens Axboeb6754f92006-05-30 14:29:32 +02001148 strip_blank_front(&p);
Jens Axboe7c124ac2006-10-30 13:36:52 +01001149
1150 if (p[0] == '[')
1151 break;
1152
Jens Axboe4ae3f762006-05-30 13:35:14 +02001153 strip_blank_end(p);
Jens Axboeaea47d42006-05-26 19:27:29 +02001154
Jens Axboee1f36502006-10-27 10:54:08 +02001155 fgetpos(f, &off);
Jens Axboeebac4652005-12-08 15:25:21 +01001156
Jens Axboe45410ac2006-06-07 11:10:39 +02001157 /*
1158 * Don't break here, continue parsing options so we
1159 * dump all the bad ones. Makes trial/error fixups
1160 * easier on the user.
1161 */
Jens Axboe7c124ac2006-10-30 13:36:52 +01001162 ret |= parse_option(p, options, td);
Jens Axboeebac4652005-12-08 15:25:21 +01001163 }
Jens Axboeebac4652005-12-08 15:25:21 +01001164
Jens Axboe45410ac2006-06-07 11:10:39 +02001165 if (!ret) {
1166 fsetpos(f, &off);
1167 ret = add_job(td, name, 0);
Jens Axboeb1508cf2006-11-02 09:12:40 +01001168 } else {
1169 log_err("fio: job %s dropped\n", name);
1170 put_job(td);
Jens Axboe45410ac2006-06-07 11:10:39 +02001171 }
Jens Axboe7c124ac2006-10-30 13:36:52 +01001172 } while (!ret);
Jens Axboeebac4652005-12-08 15:25:21 +01001173
1174 free(string);
1175 free(name);
1176 fclose(f);
Jens Axboe45410ac2006-06-07 11:10:39 +02001177 return ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001178}
1179
1180static int fill_def_thread(void)
1181{
1182 memset(&def_thread, 0, sizeof(def_thread));
1183
1184 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1185 perror("sched_getaffinity");
1186 return 1;
1187 }
1188
1189 /*
Jens Axboeee738492007-01-10 11:23:16 +01001190 * fill default options
Jens Axboeebac4652005-12-08 15:25:21 +01001191 */
Jens Axboeee738492007-01-10 11:23:16 +01001192 fill_default_options(&def_thread, options);
1193
Jens Axboe972cfd22006-06-09 11:08:56 +02001194 def_thread.timeout = def_timeout;
Jens Axboeec94ec52006-10-20 10:59:19 +02001195 def_thread.write_bw_log = write_bw_log;
1196 def_thread.write_lat_log = write_lat_log;
Jens Axboeee738492007-01-10 11:23:16 +01001197
Jens Axboeebac4652005-12-08 15:25:21 +01001198#ifdef FIO_HAVE_DISK_UTIL
1199 def_thread.do_disk_util = 1;
1200#endif
1201
1202 return 0;
1203}
1204
Jens Axboe0ab8db82006-10-18 17:16:23 +02001205static void usage(void)
Jens Axboe4785f992006-05-26 03:59:10 +02001206{
1207 printf("%s\n", fio_version_string);
Jens Axboeb4692822006-10-27 13:43:22 +02001208 printf("\t--output\tWrite output to file\n");
1209 printf("\t--timeout\tRuntime in seconds\n");
1210 printf("\t--latency-log\tGenerate per-job latency logs\n");
1211 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1212 printf("\t--minimal\tMinimal (terse) output\n");
1213 printf("\t--version\tPrint version info and exit\n");
Jens Axboefd28ca42007-01-09 21:20:13 +01001214 printf("\t--help\t\tPrint this page\n");
1215 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
Jens Axboe4785f992006-05-26 03:59:10 +02001216}
1217
Jens Axboe972cfd22006-06-09 11:08:56 +02001218static int parse_cmd_line(int argc, char *argv[])
Jens Axboeebac4652005-12-08 15:25:21 +01001219{
Jens Axboeb4692822006-10-27 13:43:22 +02001220 struct thread_data *td = NULL;
Jens Axboec2b1e752006-10-30 09:03:13 +01001221 int c, ini_idx = 0, lidx, ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001222
Jens Axboeb4692822006-10-27 13:43:22 +02001223 while ((c = getopt_long(argc, argv, "", long_options, &lidx)) != -1) {
Jens Axboeebac4652005-12-08 15:25:21 +01001224 switch (c) {
Jens Axboeb4692822006-10-27 13:43:22 +02001225 case 't':
1226 def_timeout = atoi(optarg);
1227 break;
1228 case 'l':
1229 write_lat_log = 1;
1230 break;
1231 case 'w':
1232 write_bw_log = 1;
1233 break;
1234 case 'o':
1235 f_out = fopen(optarg, "w+");
1236 if (!f_out) {
1237 perror("fopen output");
1238 exit(1);
1239 }
1240 f_err = f_out;
1241 break;
1242 case 'm':
1243 terse_output = 1;
1244 break;
1245 case 'h':
1246 usage();
1247 exit(0);
Jens Axboefd28ca42007-01-09 21:20:13 +01001248 case 'c':
Jens Axboe29fc6af2007-01-09 21:22:02 +01001249 ret = show_cmd_help(options, optarg);
1250 exit(ret);
Jens Axboeb4692822006-10-27 13:43:22 +02001251 case 'v':
1252 printf("%s\n", fio_version_string);
1253 exit(0);
1254 case FIO_GETOPT_JOB: {
1255 const char *opt = long_options[lidx].name;
1256 char *val = optarg;
1257
Jens Axboec2b1e752006-10-30 09:03:13 +01001258 if (!strncmp(opt, "name", 4) && td) {
1259 ret = add_job(td, td->name ?: "fio", 0);
1260 if (ret) {
1261 put_job(td);
1262 return 0;
1263 }
1264 td = NULL;
1265 }
Jens Axboeb4692822006-10-27 13:43:22 +02001266 if (!td) {
Jens Axboe38d0adb2006-10-30 12:21:25 +01001267 int global = !strncmp(val, "global", 6);
Jens Axboec2b1e752006-10-30 09:03:13 +01001268
1269 td = get_new_job(global, &def_thread);
Jens Axboeb4692822006-10-27 13:43:22 +02001270 if (!td)
1271 return 0;
1272 }
Jens Axboe38d0adb2006-10-30 12:21:25 +01001273
Jens Axboeb1508cf2006-11-02 09:12:40 +01001274 ret = parse_cmd_option(opt, val, options, td);
1275 if (ret) {
1276 log_err("fio: job dropped\n");
1277 put_job(td);
1278 td = NULL;
1279 }
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 Axboec2b1e752006-10-30 09:03:13 +01001288 ret = add_job(td, td->name ?: "fio", 0);
Jens Axboeb4692822006-10-27 13:43:22 +02001289 if (ret)
1290 put_job(td);
Jens Axboe972cfd22006-06-09 11:08:56 +02001291 }
Jens Axboe774a6172006-08-24 08:44:26 +02001292
Jens Axboeb4692822006-10-27 13:43:22 +02001293 while (optind < argc) {
1294 ini_idx++;
1295 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1296 ini_file[ini_idx - 1] = strdup(argv[optind]);
1297 optind++;
Jens Axboeeb8bbf42006-06-08 21:40:11 +02001298 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001299
1300 return ini_idx;
Jens Axboeebac4652005-12-08 15:25:21 +01001301}
1302
1303static void free_shm(void)
1304{
1305 struct shmid_ds sbuf;
1306
1307 if (threads) {
Jens Axboe2c0ecd22006-06-08 13:25:41 +02001308 shmdt((void *) threads);
Jens Axboeebac4652005-12-08 15:25:21 +01001309 threads = NULL;
1310 shmctl(shm_id, IPC_RMID, &sbuf);
1311 }
1312}
1313
Jens Axboe906c8d72006-06-13 09:37:56 +02001314/*
1315 * The thread area is shared between the main process and the job
1316 * threads/processes. So setup a shared memory segment that will hold
1317 * all the job info.
1318 */
Jens Axboeebac4652005-12-08 15:25:21 +01001319static int setup_thread_area(void)
1320{
1321 /*
1322 * 1024 is too much on some machines, scale max_jobs if
1323 * we get a failure that looks like too large a shm segment
1324 */
1325 do {
Jens Axboe906c8d72006-06-13 09:37:56 +02001326 size_t size = max_jobs * sizeof(struct thread_data);
Jens Axboeebac4652005-12-08 15:25:21 +01001327
Jens Axboe906c8d72006-06-13 09:37:56 +02001328 shm_id = shmget(0, size, IPC_CREAT | 0600);
Jens Axboeebac4652005-12-08 15:25:21 +01001329 if (shm_id != -1)
1330 break;
1331 if (errno != EINVAL) {
1332 perror("shmget");
1333 break;
1334 }
1335
1336 max_jobs >>= 1;
1337 } while (max_jobs);
1338
1339 if (shm_id == -1)
1340 return 1;
1341
1342 threads = shmat(shm_id, NULL, 0);
1343 if (threads == (void *) -1) {
1344 perror("shmat");
1345 return 1;
1346 }
1347
1348 atexit(free_shm);
1349 return 0;
1350}
1351
Jens Axboeb4692822006-10-27 13:43:22 +02001352/*
1353 * Copy the fio options into the long options map, so we mirror
1354 * job and cmd line options.
1355 */
1356static void dupe_job_options(void)
1357{
1358 struct fio_option *o;
1359 unsigned int i;
1360
1361 i = 0;
1362 while (long_options[i].name)
1363 i++;
1364
1365 o = &options[0];
1366 while (o->name) {
1367 long_options[i].name = o->name;
1368 long_options[i].val = FIO_GETOPT_JOB;
1369 if (o->type == FIO_OPT_STR_SET)
1370 long_options[i].has_arg = no_argument;
1371 else
1372 long_options[i].has_arg = required_argument;
1373
1374 i++;
1375 o++;
1376 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1377 }
1378}
1379
Jens Axboeebac4652005-12-08 15:25:21 +01001380int parse_options(int argc, char *argv[])
1381{
Jens Axboe972cfd22006-06-09 11:08:56 +02001382 int job_files, i;
1383
Jens Axboeb4692822006-10-27 13:43:22 +02001384 f_out = stdout;
1385 f_err = stderr;
1386
Jens Axboe13335dd2007-01-10 13:14:02 +01001387 options_init(options);
1388
Jens Axboeb4692822006-10-27 13:43:22 +02001389 dupe_job_options();
1390
Jens Axboeebac4652005-12-08 15:25:21 +01001391 if (setup_thread_area())
1392 return 1;
1393 if (fill_def_thread())
1394 return 1;
1395
Jens Axboe972cfd22006-06-09 11:08:56 +02001396 job_files = parse_cmd_line(argc, argv);
Jens Axboeebac4652005-12-08 15:25:21 +01001397
Jens Axboe972cfd22006-06-09 11:08:56 +02001398 for (i = 0; i < job_files; i++) {
1399 if (fill_def_thread())
1400 return 1;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001401 if (parse_jobs_ini(ini_file[i], i))
Jens Axboe972cfd22006-06-09 11:08:56 +02001402 return 1;
Jens Axboe88c6ed82006-06-09 11:28:10 +02001403 free(ini_file[i]);
Jens Axboe972cfd22006-06-09 11:08:56 +02001404 }
Jens Axboeebac4652005-12-08 15:25:21 +01001405
Jens Axboe88c6ed82006-06-09 11:28:10 +02001406 free(ini_file);
Jens Axboeb4692822006-10-27 13:43:22 +02001407
1408 if (!thread_number) {
1409 log_err("No jobs defined(s)\n");
Jens Axboeb4692822006-10-27 13:43:22 +02001410 return 1;
1411 }
1412
Jens Axboeebac4652005-12-08 15:25:21 +01001413 return 0;
1414}