blob: 9e41d55af957a66d6a0900462d5d4ca5a8c7f038 [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 {
94 .name = "size",
95 .type = FIO_OPT_STR_VAL,
96 .off1 = td_var_offset(total_file_size),
97 .help = "Size of device or file",
98 },
99 {
100 .name = "bs",
101 .type = FIO_OPT_STR_VAL_INT,
102 .off1 = td_var_offset(bs[DDIR_READ]),
103 .off2 = td_var_offset(bs[DDIR_WRITE]),
104 .help = "Block size unit",
105 .def = "4k",
106 },
107 {
108 .name = "bsrange",
109 .type = FIO_OPT_RANGE,
110 .off1 = td_var_offset(min_bs[DDIR_READ]),
111 .off2 = td_var_offset(max_bs[DDIR_READ]),
112 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
113 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
114 .help = "Set block size range (in more detail than bs)",
115 },
116 {
117 .name = "bs_unaligned",
118 .type = FIO_OPT_STR_SET,
119 .off1 = td_var_offset(bs_unaligned),
120 .help = "Don't sector align IO buffer sizes",
121 },
122 {
123 .name = "offset",
124 .type = FIO_OPT_STR_VAL,
125 .off1 = td_var_offset(start_offset),
126 .help = "Start IO from this offset",
127 .def = "0",
128 },
129 {
130 .name = "randrepeat",
131 .type = FIO_OPT_BOOL,
132 .off1 = td_var_offset(rand_repeatable),
133 .help = "Use repeatable random IO pattern",
134 .def = "1",
135 },
136 {
137 .name = "norandommap",
138 .type = FIO_OPT_STR_SET,
139 .off1 = td_var_offset(norandommap),
140 .help = "Accept potential duplicate random blocks",
141 },
142 {
143 .name = "nrfiles",
144 .type = FIO_OPT_INT,
145 .off1 = td_var_offset(nr_files),
146 .help = "Split job workload between this number of files",
147 .def = "1",
148 },
149 {
150 .name = "fsync",
151 .type = FIO_OPT_INT,
152 .off1 = td_var_offset(fsync_blocks),
153 .help = "Issue fsync for writes every given number of blocks",
154 .def = "0",
155 },
156 {
157 .name = "direct",
158 .type = FIO_OPT_BOOL,
159 .off1 = td_var_offset(odirect),
Jens Axboe76a43db2007-01-11 13:24:44 +0100160 .help = "Use O_DIRECT IO (negates buffered)",
161 .def = "0",
162 },
163 {
164 .name = "buffered",
165 .type = FIO_OPT_BOOL,
166 .off1 = td_var_offset(odirect),
167 .neg = 1,
168 .help = "Use buffered IO (negates direct)",
Jens Axboe03b74b32007-01-11 11:04:31 +0100169 .def = "1",
170 },
171 {
172 .name = "overwrite",
173 .type = FIO_OPT_BOOL,
174 .off1 = td_var_offset(overwrite),
175 .help = "When writing, set whether to overwrite current data",
176 .def = "0",
177 },
178 {
179 .name = "loops",
180 .type = FIO_OPT_INT,
181 .off1 = td_var_offset(loops),
182 .help = "Number of times to run the job",
183 .def = "1",
184 },
185 {
186 .name = "numjobs",
187 .type = FIO_OPT_INT,
188 .off1 = td_var_offset(numjobs),
189 .help = "Duplicate this job this many times",
190 .def = "1",
191 },
192 {
193 .name = "startdelay",
194 .type = FIO_OPT_INT,
195 .off1 = td_var_offset(start_delay),
196 .help = "Only start job when this period has passed",
197 .def = "0",
198 },
199 {
200 .name = "runtime",
201 .alias = "timeout",
202 .type = FIO_OPT_STR_VAL_TIME,
203 .off1 = td_var_offset(timeout),
204 .help = "Stop workload when this amount of time has passed",
205 .def = "0",
206 },
207 {
Jens Axboee1f36502006-10-27 10:54:08 +0200208 .name = "mem",
209 .type = FIO_OPT_STR,
210 .cb = str_mem_cb,
Jens Axboe15f79182007-01-10 12:26:18 +0100211 .help = "Backing type for IO buffers",
Jens Axboeee738492007-01-10 11:23:16 +0100212 .def = "malloc",
Jens Axboe15f79182007-01-10 12:26:18 +0100213 .posval = { "malloc", "shm", "shmhuge", "mmap", "mmaphuge", },
Jens Axboee1f36502006-10-27 10:54:08 +0200214 },
215 {
216 .name = "verify",
217 .type = FIO_OPT_STR,
218 .cb = str_verify_cb,
Jens Axboe15f79182007-01-10 12:26:18 +0100219 .help = "Verify sum function",
Jens Axboeee738492007-01-10 11:23:16 +0100220 .def = "0",
Jens Axboe15f79182007-01-10 12:26:18 +0100221 .posval = { "crc32", "md5", },
Jens Axboee1f36502006-10-27 10:54:08 +0200222 },
223 {
224 .name = "write_iolog",
Jens Axboe076efc72006-10-27 11:24:25 +0200225 .type = FIO_OPT_STR_STORE,
226 .off1 = td_var_offset(write_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100227 .help = "Store IO pattern to file",
Jens Axboee1f36502006-10-27 10:54:08 +0200228 },
229 {
Jens Axboe076efc72006-10-27 11:24:25 +0200230 .name = "read_iolog",
Jens Axboee1f36502006-10-27 10:54:08 +0200231 .type = FIO_OPT_STR_STORE,
Jens Axboe076efc72006-10-27 11:24:25 +0200232 .off1 = td_var_offset(read_iolog_file),
Jens Axboefd28ca42007-01-09 21:20:13 +0100233 .help = "Playback IO pattern from file",
Jens Axboee1f36502006-10-27 10:54:08 +0200234 },
235 {
236 .name = "exec_prerun",
237 .type = FIO_OPT_STR_STORE,
238 .off1 = td_var_offset(exec_prerun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100239 .help = "Execute this file prior to running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200240 },
241 {
242 .name = "exec_postrun",
243 .type = FIO_OPT_STR_STORE,
244 .off1 = td_var_offset(exec_postrun),
Jens Axboefd28ca42007-01-09 21:20:13 +0100245 .help = "Execute this file after running job",
Jens Axboee1f36502006-10-27 10:54:08 +0200246 },
247#ifdef FIO_HAVE_IOSCHED_SWITCH
248 {
249 .name = "ioscheduler",
250 .type = FIO_OPT_STR_STORE,
251 .off1 = td_var_offset(ioscheduler),
Jens Axboefd28ca42007-01-09 21:20:13 +0100252 .help = "Use this IO scheduler on the backing device",
Jens Axboee1f36502006-10-27 10:54:08 +0200253 },
254#endif
255 {
Jens Axboee1f36502006-10-27 10:54:08 +0200256 .name = "zonesize",
257 .type = FIO_OPT_STR_VAL,
258 .off1 = td_var_offset(zone_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100259 .help = "Give size of an IO zone",
Jens Axboeee738492007-01-10 11:23:16 +0100260 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200261 },
262 {
263 .name = "zoneskip",
264 .type = FIO_OPT_STR_VAL,
265 .off1 = td_var_offset(zone_skip),
Jens Axboefd28ca42007-01-09 21:20:13 +0100266 .help = "Space between IO zones",
Jens Axboeee738492007-01-10 11:23:16 +0100267 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200268 },
269 {
270 .name = "lockmem",
271 .type = FIO_OPT_STR_VAL,
272 .cb = str_lockmem_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100273 .help = "Lock down this amount of memory",
Jens Axboeee738492007-01-10 11:23:16 +0100274 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200275 },
276 {
Jens Axboee1f36502006-10-27 10:54:08 +0200277 .name = "rwmixcycle",
278 .type = FIO_OPT_INT,
279 .off1 = td_var_offset(rwmixcycle),
Jens Axboeee738492007-01-10 11:23:16 +0100280 .help = "Cycle period for mixed read/write workloads (msec)",
281 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200282 },
283 {
284 .name = "rwmixread",
285 .type = FIO_OPT_INT,
286 .off1 = td_var_offset(rwmixread),
Jens Axboeee738492007-01-10 11:23:16 +0100287 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100288 .help = "Percentage of mixed workload that is reads",
Jens Axboeee738492007-01-10 11:23:16 +0100289 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200290 },
291 {
292 .name = "rwmixwrite",
293 .type = FIO_OPT_INT,
294 .off1 = td_var_offset(rwmixwrite),
Jens Axboeee738492007-01-10 11:23:16 +0100295 .maxval = 100,
Jens Axboefd28ca42007-01-09 21:20:13 +0100296 .help = "Percentage of mixed workload that is writes",
Jens Axboeee738492007-01-10 11:23:16 +0100297 .def = "50",
Jens Axboee1f36502006-10-27 10:54:08 +0200298 },
299 {
300 .name = "nice",
301 .type = FIO_OPT_INT,
302 .off1 = td_var_offset(nice),
Jens Axboefd28ca42007-01-09 21:20:13 +0100303 .help = "Set job CPU nice value",
Jens Axboe15f79182007-01-10 12:26:18 +0100304 .minval = -19,
Jens Axboeee738492007-01-10 11:23:16 +0100305 .maxval = 20,
306 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200307 },
308#ifdef FIO_HAVE_IOPRIO
309 {
310 .name = "prio",
311 .type = FIO_OPT_INT,
312 .cb = str_prio_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100313 .help = "Set job IO priority value",
Jens Axboe15f79182007-01-10 12:26:18 +0100314 .minval = 0,
315 .maxval = 7,
Jens Axboee1f36502006-10-27 10:54:08 +0200316 },
317 {
318 .name = "prioclass",
319 .type = FIO_OPT_INT,
320 .cb = str_prioclass_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100321 .help = "Set job IO priority class",
Jens Axboe15f79182007-01-10 12:26:18 +0100322 .minval = 0,
323 .maxval = 3,
Jens Axboee1f36502006-10-27 10:54:08 +0200324 },
325#endif
326 {
327 .name = "thinktime",
328 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100329 .off1 = td_var_offset(thinktime),
Jens Axboe5fa0f812007-01-11 14:06:35 +0100330 .help = "Idle time between IO buffers (usec)",
Jens Axboeee738492007-01-10 11:23:16 +0100331 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200332 },
333 {
Jens Axboe9c1f7432007-01-03 20:43:19 +0100334 .name = "thinktime_blocks",
335 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100336 .off1 = td_var_offset(thinktime_blocks),
Jens Axboefd28ca42007-01-09 21:20:13 +0100337 .help = "IO buffer period between 'thinktime'",
Jens Axboeee738492007-01-10 11:23:16 +0100338 .def = "1",
Jens Axboe9c1f7432007-01-03 20:43:19 +0100339 },
340 {
Jens Axboee1f36502006-10-27 10:54:08 +0200341 .name = "rate",
342 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100343 .off1 = td_var_offset(rate),
Jens Axboefd28ca42007-01-09 21:20:13 +0100344 .help = "Set bandwidth rate",
Jens Axboee1f36502006-10-27 10:54:08 +0200345 },
346 {
347 .name = "ratemin",
348 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100349 .off1 = td_var_offset(ratemin),
Jens Axboefd28ca42007-01-09 21:20:13 +0100350 .help = "The bottom limit accepted",
Jens Axboee1f36502006-10-27 10:54:08 +0200351 },
352 {
353 .name = "ratecycle",
354 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100355 .off1 = td_var_offset(ratecycle),
Jens Axboe6da1fa72007-01-10 11:27:48 +0100356 .help = "Window average for rate limits (msec)",
Jens Axboeee738492007-01-10 11:23:16 +0100357 .def = "1000",
Jens Axboee1f36502006-10-27 10:54:08 +0200358 },
359 {
Jens Axboee1f36502006-10-27 10:54:08 +0200360 .name = "invalidate",
Jens Axboe13335dd2007-01-10 13:14:02 +0100361 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100362 .off1 = td_var_offset(invalidate_cache),
Jens Axboefd28ca42007-01-09 21:20:13 +0100363 .help = "Invalidate buffer/page cache prior to running job",
Jens Axboeee738492007-01-10 11:23:16 +0100364 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200365 },
366 {
367 .name = "sync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100368 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100369 .off1 = td_var_offset(sync_io),
Jens Axboefd28ca42007-01-09 21:20:13 +0100370 .help = "Use O_SYNC for buffered writes",
Jens Axboeee738492007-01-10 11:23:16 +0100371 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200372 },
373 {
374 .name = "bwavgtime",
375 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100376 .off1 = td_var_offset(bw_avg_time),
Jens Axboeee738492007-01-10 11:23:16 +0100377 .help = "Time window over which to calculate bandwidth (msec)",
378 .def = "500",
Jens Axboee1f36502006-10-27 10:54:08 +0200379 },
380 {
381 .name = "create_serialize",
Jens Axboe13335dd2007-01-10 13:14:02 +0100382 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100383 .off1 = td_var_offset(create_serialize),
Jens Axboefd28ca42007-01-09 21:20:13 +0100384 .help = "Serialize creating of job files",
Jens Axboeee738492007-01-10 11:23:16 +0100385 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200386 },
387 {
388 .name = "create_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100389 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100390 .off1 = td_var_offset(create_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100391 .help = "Fsync file after creation",
Jens Axboeee738492007-01-10 11:23:16 +0100392 .def = "1",
Jens Axboee1f36502006-10-27 10:54:08 +0200393 },
394 {
Jens Axboee1f36502006-10-27 10:54:08 +0200395 .name = "cpuload",
396 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100397 .off1 = td_var_offset(cpuload),
Jens Axboefd28ca42007-01-09 21:20:13 +0100398 .help = "Use this percentage of CPU",
Jens Axboee1f36502006-10-27 10:54:08 +0200399 },
400 {
401 .name = "cpuchunks",
402 .type = FIO_OPT_INT,
Jens Axboe13049232007-01-03 20:45:09 +0100403 .off1 = td_var_offset(cpucycle),
Jens Axboefd28ca42007-01-09 21:20:13 +0100404 .help = "Length of the CPU burn cycles",
Jens Axboee1f36502006-10-27 10:54:08 +0200405 },
Jens Axboee1f36502006-10-27 10:54:08 +0200406#ifdef FIO_HAVE_CPU_AFFINITY
407 {
408 .name = "cpumask",
409 .type = FIO_OPT_INT,
410 .cb = str_cpumask_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100411 .help = "CPU affinity mask",
Jens Axboee1f36502006-10-27 10:54:08 +0200412 },
413#endif
414 {
415 .name = "end_fsync",
Jens Axboe13335dd2007-01-10 13:14:02 +0100416 .type = FIO_OPT_BOOL,
Jens Axboe13049232007-01-03 20:45:09 +0100417 .off1 = td_var_offset(end_fsync),
Jens Axboefd28ca42007-01-09 21:20:13 +0100418 .help = "Include fsync at the end of job",
Jens Axboeee738492007-01-10 11:23:16 +0100419 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200420 },
421 {
422 .name = "unlink",
Jens Axboe13335dd2007-01-10 13:14:02 +0100423 .type = FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +0200424 .off1 = td_var_offset(unlink),
Jens Axboeee738492007-01-10 11:23:16 +0100425 .help = "Unlink created files after job has completed",
Jens Axboee545a6c2007-01-14 00:00:29 +0100426 .def = "0",
Jens Axboee1f36502006-10-27 10:54:08 +0200427 },
428 {
429 .name = "exitall",
430 .type = FIO_OPT_STR_SET,
431 .cb = str_exitall_cb,
Jens Axboefd28ca42007-01-09 21:20:13 +0100432 .help = "Terminate all jobs when one exits",
Jens Axboee1f36502006-10-27 10:54:08 +0200433 },
434 {
435 .name = "stonewall",
436 .type = FIO_OPT_STR_SET,
437 .off1 = td_var_offset(stonewall),
Jens Axboefd28ca42007-01-09 21:20:13 +0100438 .help = "Insert a hard barrier between this job and previous",
Jens Axboee1f36502006-10-27 10:54:08 +0200439 },
440 {
441 .name = "thread",
442 .type = FIO_OPT_STR_SET,
Jens Axboed9bb3b82007-01-10 20:30:53 +0100443 .off1 = td_var_offset(use_thread),
Jens Axboefd28ca42007-01-09 21:20:13 +0100444 .help = "Use threads instead of forks",
Jens Axboee1f36502006-10-27 10:54:08 +0200445 },
446 {
447 .name = "write_bw_log",
448 .type = FIO_OPT_STR_SET,
449 .off1 = td_var_offset(write_bw_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100450 .help = "Write log of bandwidth during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200451 },
452 {
453 .name = "write_lat_log",
454 .type = FIO_OPT_STR_SET,
455 .off1 = td_var_offset(write_lat_log),
Jens Axboefd28ca42007-01-09 21:20:13 +0100456 .help = "Write log of latency during run",
Jens Axboee1f36502006-10-27 10:54:08 +0200457 },
458 {
Jens Axboe56bb17f2006-12-20 20:27:36 +0100459 .name = "hugepage-size",
460 .type = FIO_OPT_STR_VAL,
461 .off1 = td_var_offset(hugepage_size),
Jens Axboefd28ca42007-01-09 21:20:13 +0100462 .help = "When using hugepages, specify size of each page",
Jens Axboeee738492007-01-10 11:23:16 +0100463 .def = __stringify(FIO_HUGE_PAGE),
Jens Axboe56bb17f2006-12-20 20:27:36 +0100464 },
465 {
Jens Axboee1f36502006-10-27 10:54:08 +0200466 .name = NULL,
467 },
468};
469
Jens Axboeb4692822006-10-27 13:43:22 +0200470#define FIO_JOB_OPTS (sizeof(options) / sizeof(struct fio_option))
471#define FIO_CMD_OPTS (16)
472#define FIO_GETOPT_JOB (0x89988998)
473
474/*
475 * Command line options. These will contain the above, plus a few
476 * extra that only pertain to fio itself and not jobs.
477 */
478static struct option long_options[FIO_JOB_OPTS + FIO_CMD_OPTS] = {
479 {
480 .name = "output",
481 .has_arg = required_argument,
482 .val = 'o',
483 },
484 {
485 .name = "timeout",
486 .has_arg = required_argument,
487 .val = 't',
488 },
489 {
490 .name = "latency-log",
491 .has_arg = required_argument,
492 .val = 'l',
493 },
494 {
495 .name = "bandwidth-log",
496 .has_arg = required_argument,
497 .val = 'b',
498 },
499 {
500 .name = "minimal",
501 .has_arg = optional_argument,
502 .val = 'm',
503 },
504 {
505 .name = "version",
506 .has_arg = no_argument,
507 .val = 'v',
508 },
509 {
Jens Axboefd28ca42007-01-09 21:20:13 +0100510 .name = "help",
511 .has_arg = no_argument,
512 .val = 'h',
513 },
514 {
515 .name = "cmdhelp",
516 .has_arg = required_argument,
517 .val = 'c',
518 },
519 {
Jens Axboeb4692822006-10-27 13:43:22 +0200520 .name = NULL,
521 },
522};
523
Jens Axboeee738492007-01-10 11:23:16 +0100524static int def_timeout = 0;
Jens Axboe972cfd22006-06-09 11:08:56 +0200525
Jens Axboe5cd033b2007-01-09 08:19:01 +0100526static char fio_version_string[] = "fio 1.11";
Jens Axboeebac4652005-12-08 15:25:21 +0100527
Jens Axboe972cfd22006-06-09 11:08:56 +0200528static char **ini_file;
Jens Axboeebac4652005-12-08 15:25:21 +0100529static int max_jobs = MAX_JOBS;
530
531struct thread_data def_thread;
532struct thread_data *threads = NULL;
533
Jens Axboeebac4652005-12-08 15:25:21 +0100534int exitall_on_terminate = 0;
Jens Axboec6ae0a52006-06-12 11:04:44 +0200535int terse_output = 0;
Jens Axboec04f7ec2006-05-31 10:13:16 +0200536unsigned long long mlock_size = 0;
Jens Axboeeb8bbf42006-06-08 21:40:11 +0200537FILE *f_out = NULL;
538FILE *f_err = NULL;
Jens Axboeebac4652005-12-08 15:25:21 +0100539
Jens Axboeee738492007-01-10 11:23:16 +0100540static int write_lat_log = 0;
Jens Axboebb3884d2007-01-17 17:23:11 +1100541int write_bw_log = 0;
Jens Axboeec94ec52006-10-20 10:59:19 +0200542
Jens Axboe906c8d72006-06-13 09:37:56 +0200543/*
544 * Return a free job structure.
545 */
Jens Axboeebac4652005-12-08 15:25:21 +0100546static struct thread_data *get_new_job(int global, struct thread_data *parent)
547{
548 struct thread_data *td;
549
550 if (global)
551 return &def_thread;
552 if (thread_number >= max_jobs)
553 return NULL;
554
555 td = &threads[thread_number++];
Jens Axboeddaeaa52006-06-08 11:00:58 +0200556 *td = *parent;
Jens Axboeebac4652005-12-08 15:25:21 +0100557
Jens Axboeebac4652005-12-08 15:25:21 +0100558 td->thread_number = thread_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100559 return td;
560}
561
562static void put_job(struct thread_data *td)
563{
Jens Axboe549577a2006-10-30 12:23:41 +0100564 if (td == &def_thread)
565 return;
566
Jens Axboe16edf252007-02-10 14:59:22 +0100567 if (td->error)
568 fprintf(f_out, "fio: %s\n", td->verror);
569
Jens Axboeebac4652005-12-08 15:25:21 +0100570 memset(&threads[td->thread_number - 1], 0, sizeof(*td));
571 thread_number--;
572}
573
Jens Axboedad915e2006-10-27 11:10:18 +0200574/*
575 * Lazy way of fixing up options that depend on each other. We could also
576 * define option callback handlers, but this is easier.
577 */
Jens Axboee1f36502006-10-27 10:54:08 +0200578static void fixup_options(struct thread_data *td)
579{
Jens Axboee1f36502006-10-27 10:54:08 +0200580 if (!td->rwmixread && td->rwmixwrite)
581 td->rwmixread = 100 - td->rwmixwrite;
Jens Axboedad915e2006-10-27 11:10:18 +0200582
Jens Axboe076efc72006-10-27 11:24:25 +0200583 if (td->write_iolog_file && td->read_iolog_file) {
584 log_err("fio: read iolog overrides write_iolog\n");
585 free(td->write_iolog_file);
586 td->write_iolog_file = NULL;
587 }
Jens Axboe16b462a2006-10-30 12:35:18 +0100588
589 if (td->io_ops->flags & FIO_SYNCIO)
590 td->iodepth = 1;
591 else {
592 if (!td->iodepth)
593 td->iodepth = td->nr_files;
594 }
595
596 /*
597 * only really works for sequential io for now, and with 1 file
598 */
599 if (td->zone_size && !td->sequential && td->nr_files == 1)
600 td->zone_size = 0;
601
602 /*
603 * Reads can do overwrites, we always need to pre-create the file
604 */
605 if (td_read(td) || td_rw(td))
606 td->overwrite = 1;
607
Jens Axboea00735e2006-11-03 08:58:08 +0100608 if (!td->min_bs[DDIR_READ])
609 td->min_bs[DDIR_READ]= td->bs[DDIR_READ];
610 if (!td->max_bs[DDIR_READ])
611 td->max_bs[DDIR_READ] = td->bs[DDIR_READ];
612 if (!td->min_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100613 td->min_bs[DDIR_WRITE]= td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100614 if (!td->max_bs[DDIR_WRITE])
Jens Axboe75e6f362006-11-03 08:17:09 +0100615 td->max_bs[DDIR_WRITE] = td->bs[DDIR_WRITE];
Jens Axboea00735e2006-11-03 08:58:08 +0100616
617 td->rw_min_bs = min(td->min_bs[DDIR_READ], td->min_bs[DDIR_WRITE]);
618
Jens Axboe16b462a2006-10-30 12:35:18 +0100619 if (td_read(td) && !td_rw(td))
620 td->verify = 0;
Jens Axboebb8895e2006-10-30 15:14:48 +0100621
622 if (td->norandommap && td->verify != VERIFY_NONE) {
623 log_err("fio: norandommap given, verify disabled\n");
624 td->verify = VERIFY_NONE;
625 }
Jens Axboe690adba2006-10-30 15:25:09 +0100626 if (td->bs_unaligned && (td->odirect || td->io_ops->flags & FIO_RAWIO))
627 log_err("fio: bs_unaligned may not work with raw io\n");
Jens Axboee0a22332006-12-20 12:54:25 +0100628
629 /*
630 * O_DIRECT and char doesn't mix, clear that flag if necessary.
631 */
632 if (td->filetype == FIO_TYPE_CHAR && td->odirect)
633 td->odirect = 0;
Jens Axboee1f36502006-10-27 10:54:08 +0200634}
635
Jens Axboe906c8d72006-06-13 09:37:56 +0200636/*
Jens Axboef8977ee2006-11-06 14:03:03 +0100637 * This function leaks the buffer
638 */
639static char *to_kmg(unsigned int val)
640{
641 char *buf = malloc(32);
Jens Axboef3502ba2007-02-14 01:27:09 +0100642 char post[] = { 0, 'K', 'M', 'G', 'P', 'E', 0 };
Jens Axboef8977ee2006-11-06 14:03:03 +0100643 char *p = post;
644
Jens Axboe245142f2006-11-08 12:49:21 +0100645 do {
Jens Axboef8977ee2006-11-06 14:03:03 +0100646 if (val & 1023)
647 break;
648
649 val >>= 10;
650 p++;
Jens Axboe245142f2006-11-08 12:49:21 +0100651 } while (*p);
Jens Axboef8977ee2006-11-06 14:03:03 +0100652
653 snprintf(buf, 31, "%u%c", val, *p);
654 return buf;
655}
656
657/*
Jens Axboe906c8d72006-06-13 09:37:56 +0200658 * Adds a job to the list of things todo. Sanitizes the various options
659 * to make sure we don't have conflicts, and initializes various
660 * members of td.
661 */
Jens Axboe75154842006-06-01 13:56:09 +0200662static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
Jens Axboeebac4652005-12-08 15:25:21 +0100663{
Jens Axboe3c9b60c2006-11-07 08:36:14 +0100664 const char *ddir_str[] = { "read", "write", "randread", "randwrite",
665 "rw", NULL, "randrw" };
Jens Axboeebac4652005-12-08 15:25:21 +0100666 struct stat sb;
Jens Axboe53cdc682006-10-18 11:50:58 +0200667 int numjobs, ddir, i;
668 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100669
Jens Axboeebac4652005-12-08 15:25:21 +0100670 /*
671 * the def_thread is just for options, it's not a real job
672 */
673 if (td == &def_thread)
674 return 0;
675
Jens Axboeee738492007-01-10 11:23:16 +0100676 assert(td->io_ops);
Jens Axboedf641192006-10-12 07:55:41 +0200677
Jens Axboe690adba2006-10-30 15:25:09 +0100678 if (td->odirect)
679 td->io_ops->flags |= FIO_RAWIO;
680
Jens Axboeebac4652005-12-08 15:25:21 +0100681 td->filetype = FIO_TYPE_FILE;
Jens Axboe890df532007-02-17 01:51:13 +0100682 if (td->filename && !lstat(td->filename, &sb)) {
Jens Axboe0af7b542006-02-17 10:10:12 +0100683 if (S_ISBLK(sb.st_mode))
684 td->filetype = FIO_TYPE_BD;
685 else if (S_ISCHR(sb.st_mode))
686 td->filetype = FIO_TYPE_CHAR;
687 }
Jens Axboeebac4652005-12-08 15:25:21 +0100688
Jens Axboee0a22332006-12-20 12:54:25 +0100689 fixup_options(td);
690
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200691 if (td->filename)
692 td->nr_uniq_files = 1;
693 else
694 td->nr_uniq_files = td->nr_files;
695
696 if (td->filetype == FIO_TYPE_FILE || td->filename) {
Jens Axboee9c047a2006-06-07 21:13:04 +0200697 char tmp[PATH_MAX];
Jens Axboe53cdc682006-10-18 11:50:58 +0200698 int len = 0;
Jens Axboee9c047a2006-06-07 21:13:04 +0200699
Jens Axboe16edf252007-02-10 14:59:22 +0100700 if (td->directory && td->directory[0] != '\0') {
701 if (lstat(td->directory, &sb) < 0) {
702 log_err("fio: %s is not a directory\n", td->directory);
703 td_verror(td, errno);
704 return 1;
705 }
706 if (!S_ISDIR(sb.st_mode)) {
707 log_err("fio: %s is not a directory\n", td->directory);
708 return 1;
709 }
Jens Axboe8aeebd52007-01-08 10:47:43 +0100710 len = sprintf(tmp, "%s/", td->directory);
Jens Axboe16edf252007-02-10 14:59:22 +0100711 }
Jens Axboeebac4652005-12-08 15:25:21 +0100712
Jens Axboe53cdc682006-10-18 11:50:58 +0200713 td->files = malloc(sizeof(struct fio_file) * td->nr_files);
714
715 for_each_file(td, f, i) {
716 memset(f, 0, sizeof(*f));
717 f->fd = -1;
718
Jens Axboe13f8e2d2006-10-24 09:29:45 +0200719 if (td->filename)
720 sprintf(tmp + len, "%s", td->filename);
721 else
722 sprintf(tmp + len, "%s.%d.%d", jobname, td->thread_number, i);
Jens Axboe53cdc682006-10-18 11:50:58 +0200723 f->file_name = strdup(tmp);
724 }
725 } else {
726 td->nr_files = 1;
727 td->files = malloc(sizeof(struct fio_file));
728 f = &td->files[0];
729
730 memset(f, 0, sizeof(*f));
731 f->fd = -1;
732 f->file_name = strdup(jobname);
733 }
734
735 for_each_file(td, f, i) {
736 f->file_size = td->total_file_size / td->nr_files;
737 f->file_offset = td->start_offset;
738 }
739
Jens Axboebbfd6b02006-06-07 19:42:54 +0200740 fio_sem_init(&td->mutex, 0);
Jens Axboeebac4652005-12-08 15:25:21 +0100741
742 td->clat_stat[0].min_val = td->clat_stat[1].min_val = ULONG_MAX;
743 td->slat_stat[0].min_val = td->slat_stat[1].min_val = ULONG_MAX;
744 td->bw_stat[0].min_val = td->bw_stat[1].min_val = ULONG_MAX;
745
Jens Axboeebac4652005-12-08 15:25:21 +0100746 if (td->stonewall && td->thread_number > 1)
747 groupid++;
748
749 td->groupid = groupid;
750
751 if (setup_rate(td))
752 goto err;
753
Jens Axboeec94ec52006-10-20 10:59:19 +0200754 if (td->write_lat_log) {
Jens Axboeebac4652005-12-08 15:25:21 +0100755 setup_log(&td->slat_log);
756 setup_log(&td->clat_log);
757 }
Jens Axboeec94ec52006-10-20 10:59:19 +0200758 if (td->write_bw_log)
Jens Axboeebac4652005-12-08 15:25:21 +0100759 setup_log(&td->bw_log);
760
Jens Axboeb4692822006-10-27 13:43:22 +0200761 if (!td->name)
762 td->name = strdup(jobname);
Jens Axboe01452052006-06-07 10:29:47 +0200763
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200764 ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
Jens Axboe75154842006-06-01 13:56:09 +0200765
Jens Axboec6ae0a52006-06-12 11:04:44 +0200766 if (!terse_output) {
Jens Axboeb990b5c2006-09-14 09:48:22 +0200767 if (!job_add_num) {
Jens Axboe2866c822006-10-09 15:57:48 +0200768 if (td->io_ops->flags & FIO_CPUIO)
Jens Axboeb990b5c2006-09-14 09:48:22 +0200769 fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
Jens Axboef8977ee2006-11-06 14:03:03 +0100770 else {
771 char *c1, *c2, *c3, *c4;
772
773 c1 = to_kmg(td->min_bs[DDIR_READ]);
774 c2 = to_kmg(td->max_bs[DDIR_READ]);
775 c3 = to_kmg(td->min_bs[DDIR_WRITE]);
776 c4 = to_kmg(td->max_bs[DDIR_WRITE]);
777
Jens Axboed56cbab2007-01-11 19:24:55 +0100778 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 +0100779
780 free(c1);
781 free(c2);
782 free(c3);
783 free(c4);
784 }
Jens Axboeb990b5c2006-09-14 09:48:22 +0200785 } else if (job_add_num == 1)
Jens Axboec6ae0a52006-06-12 11:04:44 +0200786 fprintf(f_out, "...\n");
787 }
Jens Axboeebac4652005-12-08 15:25:21 +0100788
789 /*
790 * recurse add identical jobs, clear numjobs and stonewall options
791 * as they don't apply to sub-jobs
792 */
793 numjobs = td->numjobs;
794 while (--numjobs) {
795 struct thread_data *td_new = get_new_job(0, td);
796
797 if (!td_new)
798 goto err;
799
800 td_new->numjobs = 1;
801 td_new->stonewall = 0;
Jens Axboe75154842006-06-01 13:56:09 +0200802 job_add_num = numjobs - 1;
Jens Axboeebac4652005-12-08 15:25:21 +0100803
Jens Axboe75154842006-06-01 13:56:09 +0200804 if (add_job(td_new, jobname, job_add_num))
Jens Axboeebac4652005-12-08 15:25:21 +0100805 goto err;
806 }
807 return 0;
808err:
809 put_job(td);
810 return -1;
811}
812
Jens Axboe906c8d72006-06-13 09:37:56 +0200813/*
814 * Initialize the various random states we need (random io, block size ranges,
815 * read/write mix, etc).
816 */
Jens Axboeebac4652005-12-08 15:25:21 +0100817int init_random_state(struct thread_data *td)
818{
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200819 unsigned long seeds[4];
Jens Axboe53cdc682006-10-18 11:50:58 +0200820 int fd, num_maps, blocks, i;
Jens Axboe0ab8db82006-10-18 17:16:23 +0200821 struct fio_file *f;
Jens Axboeebac4652005-12-08 15:25:21 +0100822
Jens Axboef48b4672006-10-27 11:30:07 +0200823 if (td->io_ops->flags & FIO_CPUIO)
824 return 0;
825
Jens Axboe1ac267b2006-05-31 20:29:00 +0200826 fd = open("/dev/urandom", O_RDONLY);
Jens Axboeebac4652005-12-08 15:25:21 +0100827 if (fd == -1) {
828 td_verror(td, errno);
829 return 1;
830 }
831
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200832 if (read(fd, seeds, sizeof(seeds)) < (int) sizeof(seeds)) {
Jens Axboeebac4652005-12-08 15:25:21 +0100833 td_verror(td, EIO);
834 close(fd);
835 return 1;
836 }
837
838 close(fd);
839
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200840 os_random_seed(seeds[0], &td->bsrange_state);
841 os_random_seed(seeds[1], &td->verify_state);
842 os_random_seed(seeds[2], &td->rwmix_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100843
844 if (td->sequential)
845 return 0;
846
Jens Axboe9ebc27e2006-06-12 10:21:50 +0200847 if (td->rand_repeatable)
Jens Axboeee738492007-01-10 11:23:16 +0100848 seeds[3] = FIO_RANDSEED;
Jens Axboeebac4652005-12-08 15:25:21 +0100849
Jens Axboebb8895e2006-10-30 15:14:48 +0100850 if (!td->norandommap) {
851 for_each_file(td, f, i) {
Jens Axboea4a81712007-02-13 20:07:26 +0100852 blocks = (f->real_file_size + td->rw_min_bs - 1) / td->rw_min_bs;
Jens Axboec7c280e2006-11-02 20:10:33 +0100853 num_maps = (blocks + BLOCKS_PER_MAP-1)/ BLOCKS_PER_MAP;
Jens Axboebb8895e2006-10-30 15:14:48 +0100854 f->file_map = malloc(num_maps * sizeof(long));
855 f->num_maps = num_maps;
856 memset(f->file_map, 0, num_maps * sizeof(long));
857 }
Jens Axboe53cdc682006-10-18 11:50:58 +0200858 }
Jens Axboeebac4652005-12-08 15:25:21 +0100859
Jens Axboe6dfd46b2006-06-07 13:57:06 +0200860 os_random_seed(seeds[3], &td->random_state);
Jens Axboeebac4652005-12-08 15:25:21 +0100861 return 0;
862}
863
864static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
865{
866#ifdef FIO_HAVE_CPU_AFFINITY
867 unsigned int i;
868
869 CPU_ZERO(&cpumask);
870
871 for (i = 0; i < sizeof(int) * 8; i++) {
872 if ((1 << i) & cpu)
873 CPU_SET(i, &cpumask);
874 }
875#endif
876}
877
Jens Axboeebac4652005-12-08 15:25:21 +0100878static int is_empty_or_comment(char *line)
879{
880 unsigned int i;
881
882 for (i = 0; i < strlen(line); i++) {
883 if (line[i] == ';')
884 return 1;
885 if (!isspace(line[i]) && !iscntrl(line[i]))
886 return 0;
887 }
888
889 return 1;
890}
891
Jens Axboeb4692822006-10-27 13:43:22 +0200892static int str_rw_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100893{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200894 struct thread_data *td = data;
895
Jens Axboeebac4652005-12-08 15:25:21 +0100896 if (!strncmp(mem, "read", 4) || !strncmp(mem, "0", 1)) {
897 td->ddir = DDIR_READ;
898 td->sequential = 1;
899 return 0;
900 } else if (!strncmp(mem, "randread", 8)) {
901 td->ddir = DDIR_READ;
902 td->sequential = 0;
903 return 0;
904 } else if (!strncmp(mem, "write", 5) || !strncmp(mem, "1", 1)) {
905 td->ddir = DDIR_WRITE;
906 td->sequential = 1;
907 return 0;
908 } else if (!strncmp(mem, "randwrite", 9)) {
909 td->ddir = DDIR_WRITE;
910 td->sequential = 0;
911 return 0;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200912 } else if (!strncmp(mem, "rw", 2)) {
Jens Axboe1e97cce2006-12-05 11:44:16 +0100913 td->ddir = DDIR_READ;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200914 td->iomix = 1;
915 td->sequential = 1;
916 return 0;
917 } else if (!strncmp(mem, "randrw", 6)) {
Jens Axboe1e97cce2006-12-05 11:44:16 +0100918 td->ddir = DDIR_READ;
Jens Axboe3d60d1e2006-05-25 06:31:06 +0200919 td->iomix = 1;
920 td->sequential = 0;
921 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +0100922 }
923
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200924 log_err("fio: data direction: read, write, randread, randwrite, rw, randrw\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100925 return 1;
926}
927
Jens Axboeb4692822006-10-27 13:43:22 +0200928static int str_verify_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100929{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200930 struct thread_data *td = data;
931
Jens Axboeebac4652005-12-08 15:25:21 +0100932 if (!strncmp(mem, "0", 1)) {
933 td->verify = VERIFY_NONE;
934 return 0;
935 } else if (!strncmp(mem, "md5", 3) || !strncmp(mem, "1", 1)) {
936 td->verify = VERIFY_MD5;
937 return 0;
938 } else if (!strncmp(mem, "crc32", 5)) {
939 td->verify = VERIFY_CRC32;
940 return 0;
941 }
942
Jens Axboe3b70d7e2006-06-08 21:48:46 +0200943 log_err("fio: verify types: md5, crc32\n");
Jens Axboeebac4652005-12-08 15:25:21 +0100944 return 1;
945}
946
Jens Axboe313cb202006-12-21 09:50:00 +0100947/*
948 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
949 */
950static char *get_mmap_file(const char *str)
951{
952 char *p = strstr(str, ":");
953
954 if (!p)
955 return NULL;
956
957 p++;
958 strip_blank_front(&p);
959 strip_blank_end(p);
960 return strdup(p);
961}
962
Jens Axboeb4692822006-10-27 13:43:22 +0200963static int str_mem_cb(void *data, const char *mem)
Jens Axboeebac4652005-12-08 15:25:21 +0100964{
Jens Axboecb2c86f2006-10-26 13:48:34 +0200965 struct thread_data *td = data;
966
Jens Axboeebac4652005-12-08 15:25:21 +0100967 if (!strncmp(mem, "malloc", 6)) {
968 td->mem_type = MEM_MALLOC;
969 return 0;
Jens Axboed0bdaf42006-12-20 14:40:44 +0100970 } else if (!strncmp(mem, "mmaphuge", 8)) {
971#ifdef FIO_HAVE_HUGETLB
Jens Axboed0bdaf42006-12-20 14:40:44 +0100972 /*
973 * mmaphuge must be appended with the actual file
974 */
Jens Axboe313cb202006-12-21 09:50:00 +0100975 td->mmapfile = get_mmap_file(mem);
976 if (!td->mmapfile) {
Jens Axboed0bdaf42006-12-20 14:40:44 +0100977 log_err("fio: mmaphuge:/path/to/file\n");
978 return 1;
979 }
980
Jens Axboed0bdaf42006-12-20 14:40:44 +0100981 td->mem_type = MEM_MMAPHUGE;
982 return 0;
983#else
984 log_err("fio: mmaphuge not available\n");
985 return 1;
986#endif
Jens Axboeebac4652005-12-08 15:25:21 +0100987 } else if (!strncmp(mem, "mmap", 4)) {
Jens Axboe313cb202006-12-21 09:50:00 +0100988 /*
989 * Check if the user wants file backed memory. It's ok
990 * if there's no file given, we'll just use anon mamp then.
991 */
992 td->mmapfile = get_mmap_file(mem);
Jens Axboeebac4652005-12-08 15:25:21 +0100993 td->mem_type = MEM_MMAP;
994 return 0;
Jens Axboe74b025b2006-12-19 15:18:14 +0100995 } else if (!strncmp(mem, "shmhuge", 7)) {
996#ifdef FIO_HAVE_HUGETLB
997 td->mem_type = MEM_SHMHUGE;
998 return 0;
999#else
1000 log_err("fio: shmhuge not available\n");
1001 return 1;
1002#endif
Jens Axboe0268b8b2006-12-20 12:48:23 +01001003 } else if (!strncmp(mem, "shm", 3)) {
1004 td->mem_type = MEM_SHM;
1005 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001006 }
1007
Jens Axboed0bdaf42006-12-20 14:40:44 +01001008 log_err("fio: mem type: malloc, shm, shmhuge, mmap, mmaphuge\n");
Jens Axboeebac4652005-12-08 15:25:21 +01001009 return 1;
1010}
1011
Jens Axboeb4692822006-10-27 13:43:22 +02001012static int str_ioengine_cb(void *data, const char *str)
Jens Axboeebac4652005-12-08 15:25:21 +01001013{
Jens Axboecb2c86f2006-10-26 13:48:34 +02001014 struct thread_data *td = data;
1015
Jens Axboe2866c822006-10-09 15:57:48 +02001016 td->io_ops = load_ioengine(td, str);
1017 if (td->io_ops)
Jens Axboeebac4652005-12-08 15:25:21 +01001018 return 0;
Jens Axboeebac4652005-12-08 15:25:21 +01001019
Jens Axboe08aae9a2006-11-24 12:43:49 +01001020 log_err("fio: ioengine= libaio, posixaio, sync, mmap, sgio, splice, cpu, null\n");
Jens Axboe5f350952006-11-07 15:20:59 +01001021 log_err("fio: or specify path to dynamic ioengine module\n");
Jens Axboeebac4652005-12-08 15:25:21 +01001022 return 1;
1023}
1024
Jens Axboee1f36502006-10-27 10:54:08 +02001025static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
1026{
1027 mlock_size = *val;
1028 return 0;
1029}
1030
Jens Axboe34cfcda2006-11-03 14:00:45 +01001031#ifdef FIO_HAVE_IOPRIO
Jens Axboee1f36502006-10-27 10:54:08 +02001032static int str_prioclass_cb(void *data, unsigned int *val)
1033{
1034 struct thread_data *td = data;
1035
1036 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
1037 return 0;
1038}
1039
1040static int str_prio_cb(void *data, unsigned int *val)
1041{
1042 struct thread_data *td = data;
1043
1044 td->ioprio |= *val;
1045 return 0;
1046}
Jens Axboe34cfcda2006-11-03 14:00:45 +01001047#endif
Jens Axboee1f36502006-10-27 10:54:08 +02001048
1049static int str_exitall_cb(void)
1050{
1051 exitall_on_terminate = 1;
1052 return 0;
1053}
1054
1055static int str_cpumask_cb(void *data, unsigned int *val)
1056{
1057 struct thread_data *td = data;
1058
1059 fill_cpu_mask(td->cpumask, *val);
1060 return 0;
1061}
1062
Jens Axboe07261982006-06-07 10:51:12 +02001063/*
1064 * This is our [ini] type file parser.
1065 */
Jens Axboe1e97cce2006-12-05 11:44:16 +01001066static int parse_jobs_ini(char *file, int stonewall_flag)
Jens Axboeebac4652005-12-08 15:25:21 +01001067{
Jens Axboee1f36502006-10-27 10:54:08 +02001068 unsigned int global;
Jens Axboeebac4652005-12-08 15:25:21 +01001069 struct thread_data *td;
Jens Axboefee3bb42006-10-30 13:32:08 +01001070 char *string, *name;
Jens Axboeebac4652005-12-08 15:25:21 +01001071 fpos_t off;
1072 FILE *f;
1073 char *p;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001074 int ret = 0, stonewall;
Jens Axboeebac4652005-12-08 15:25:21 +01001075
1076 f = fopen(file, "r");
1077 if (!f) {
Jens Axboeaea47d42006-05-26 19:27:29 +02001078 perror("fopen job file");
Jens Axboeebac4652005-12-08 15:25:21 +01001079 return 1;
1080 }
1081
1082 string = malloc(4096);
1083 name = malloc(256);
Jens Axboefee3bb42006-10-30 13:32:08 +01001084 memset(name, 0, 256);
Jens Axboeebac4652005-12-08 15:25:21 +01001085
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001086 stonewall = stonewall_flag;
Jens Axboe7c124ac2006-10-30 13:36:52 +01001087 do {
1088 p = fgets(string, 4095, f);
1089 if (!p)
Jens Axboe45410ac2006-06-07 11:10:39 +02001090 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001091 if (is_empty_or_comment(p))
1092 continue;
Jens Axboefee3bb42006-10-30 13:32:08 +01001093 if (sscanf(p, "[%255s]", name) != 1)
Jens Axboeebac4652005-12-08 15:25:21 +01001094 continue;
1095
1096 global = !strncmp(name, "global", 6);
1097
1098 name[strlen(name) - 1] = '\0';
1099
1100 td = get_new_job(global, &def_thread);
Jens Axboe45410ac2006-06-07 11:10:39 +02001101 if (!td) {
1102 ret = 1;
1103 break;
1104 }
Jens Axboeebac4652005-12-08 15:25:21 +01001105
Jens Axboe972cfd22006-06-09 11:08:56 +02001106 /*
1107 * Seperate multiple job files by a stonewall
1108 */
Jens Axboef9481912006-06-09 11:37:28 +02001109 if (!global && stonewall) {
Jens Axboe972cfd22006-06-09 11:08:56 +02001110 td->stonewall = stonewall;
1111 stonewall = 0;
1112 }
1113
Jens Axboeebac4652005-12-08 15:25:21 +01001114 fgetpos(f, &off);
1115 while ((p = fgets(string, 4096, f)) != NULL) {
1116 if (is_empty_or_comment(p))
1117 continue;
Jens Axboee1f36502006-10-27 10:54:08 +02001118
Jens Axboeb6754f92006-05-30 14:29:32 +02001119 strip_blank_front(&p);
Jens Axboe7c124ac2006-10-30 13:36:52 +01001120
1121 if (p[0] == '[')
1122 break;
1123
Jens Axboe4ae3f762006-05-30 13:35:14 +02001124 strip_blank_end(p);
Jens Axboeaea47d42006-05-26 19:27:29 +02001125
Jens Axboee1f36502006-10-27 10:54:08 +02001126 fgetpos(f, &off);
Jens Axboeebac4652005-12-08 15:25:21 +01001127
Jens Axboe45410ac2006-06-07 11:10:39 +02001128 /*
1129 * Don't break here, continue parsing options so we
1130 * dump all the bad ones. Makes trial/error fixups
1131 * easier on the user.
1132 */
Jens Axboe7c124ac2006-10-30 13:36:52 +01001133 ret |= parse_option(p, options, td);
Jens Axboeebac4652005-12-08 15:25:21 +01001134 }
Jens Axboeebac4652005-12-08 15:25:21 +01001135
Jens Axboe45410ac2006-06-07 11:10:39 +02001136 if (!ret) {
1137 fsetpos(f, &off);
1138 ret = add_job(td, name, 0);
Jens Axboeb1508cf2006-11-02 09:12:40 +01001139 } else {
1140 log_err("fio: job %s dropped\n", name);
1141 put_job(td);
Jens Axboe45410ac2006-06-07 11:10:39 +02001142 }
Jens Axboe7c124ac2006-10-30 13:36:52 +01001143 } while (!ret);
Jens Axboeebac4652005-12-08 15:25:21 +01001144
1145 free(string);
1146 free(name);
1147 fclose(f);
Jens Axboe45410ac2006-06-07 11:10:39 +02001148 return ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001149}
1150
1151static int fill_def_thread(void)
1152{
1153 memset(&def_thread, 0, sizeof(def_thread));
1154
1155 if (fio_getaffinity(getpid(), &def_thread.cpumask) == -1) {
1156 perror("sched_getaffinity");
1157 return 1;
1158 }
1159
1160 /*
Jens Axboeee738492007-01-10 11:23:16 +01001161 * fill default options
Jens Axboeebac4652005-12-08 15:25:21 +01001162 */
Jens Axboeee738492007-01-10 11:23:16 +01001163 fill_default_options(&def_thread, options);
1164
Jens Axboe972cfd22006-06-09 11:08:56 +02001165 def_thread.timeout = def_timeout;
Jens Axboeec94ec52006-10-20 10:59:19 +02001166 def_thread.write_bw_log = write_bw_log;
1167 def_thread.write_lat_log = write_lat_log;
Jens Axboeee738492007-01-10 11:23:16 +01001168
Jens Axboeebac4652005-12-08 15:25:21 +01001169#ifdef FIO_HAVE_DISK_UTIL
1170 def_thread.do_disk_util = 1;
1171#endif
1172
1173 return 0;
1174}
1175
Jens Axboe0ab8db82006-10-18 17:16:23 +02001176static void usage(void)
Jens Axboe4785f992006-05-26 03:59:10 +02001177{
1178 printf("%s\n", fio_version_string);
Jens Axboeb4692822006-10-27 13:43:22 +02001179 printf("\t--output\tWrite output to file\n");
1180 printf("\t--timeout\tRuntime in seconds\n");
1181 printf("\t--latency-log\tGenerate per-job latency logs\n");
1182 printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
1183 printf("\t--minimal\tMinimal (terse) output\n");
1184 printf("\t--version\tPrint version info and exit\n");
Jens Axboefd28ca42007-01-09 21:20:13 +01001185 printf("\t--help\t\tPrint this page\n");
1186 printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
Jens Axboe4785f992006-05-26 03:59:10 +02001187}
1188
Jens Axboe972cfd22006-06-09 11:08:56 +02001189static int parse_cmd_line(int argc, char *argv[])
Jens Axboeebac4652005-12-08 15:25:21 +01001190{
Jens Axboeb4692822006-10-27 13:43:22 +02001191 struct thread_data *td = NULL;
Jens Axboec2b1e752006-10-30 09:03:13 +01001192 int c, ini_idx = 0, lidx, ret;
Jens Axboeebac4652005-12-08 15:25:21 +01001193
Jens Axboeb4692822006-10-27 13:43:22 +02001194 while ((c = getopt_long(argc, argv, "", long_options, &lidx)) != -1) {
Jens Axboeebac4652005-12-08 15:25:21 +01001195 switch (c) {
Jens Axboeb4692822006-10-27 13:43:22 +02001196 case 't':
1197 def_timeout = atoi(optarg);
1198 break;
1199 case 'l':
1200 write_lat_log = 1;
1201 break;
1202 case 'w':
1203 write_bw_log = 1;
1204 break;
1205 case 'o':
1206 f_out = fopen(optarg, "w+");
1207 if (!f_out) {
1208 perror("fopen output");
1209 exit(1);
1210 }
1211 f_err = f_out;
1212 break;
1213 case 'm':
1214 terse_output = 1;
1215 break;
1216 case 'h':
1217 usage();
1218 exit(0);
Jens Axboefd28ca42007-01-09 21:20:13 +01001219 case 'c':
Jens Axboe29fc6af2007-01-09 21:22:02 +01001220 ret = show_cmd_help(options, optarg);
1221 exit(ret);
Jens Axboeb4692822006-10-27 13:43:22 +02001222 case 'v':
1223 printf("%s\n", fio_version_string);
1224 exit(0);
1225 case FIO_GETOPT_JOB: {
1226 const char *opt = long_options[lidx].name;
1227 char *val = optarg;
1228
Jens Axboec2b1e752006-10-30 09:03:13 +01001229 if (!strncmp(opt, "name", 4) && td) {
1230 ret = add_job(td, td->name ?: "fio", 0);
1231 if (ret) {
1232 put_job(td);
1233 return 0;
1234 }
1235 td = NULL;
1236 }
Jens Axboeb4692822006-10-27 13:43:22 +02001237 if (!td) {
Jens Axboe38d0adb2006-10-30 12:21:25 +01001238 int global = !strncmp(val, "global", 6);
Jens Axboec2b1e752006-10-30 09:03:13 +01001239
1240 td = get_new_job(global, &def_thread);
Jens Axboeb4692822006-10-27 13:43:22 +02001241 if (!td)
1242 return 0;
1243 }
Jens Axboe38d0adb2006-10-30 12:21:25 +01001244
Jens Axboeb1508cf2006-11-02 09:12:40 +01001245 ret = parse_cmd_option(opt, val, options, td);
1246 if (ret) {
1247 log_err("fio: job dropped\n");
1248 put_job(td);
1249 td = NULL;
1250 }
Jens Axboeb4692822006-10-27 13:43:22 +02001251 break;
1252 }
1253 default:
Jens Axboeb4692822006-10-27 13:43:22 +02001254 break;
Jens Axboeebac4652005-12-08 15:25:21 +01001255 }
1256 }
Jens Axboec9fad892006-05-27 17:26:50 +02001257
Jens Axboeb4692822006-10-27 13:43:22 +02001258 if (td) {
Jens Axboec2b1e752006-10-30 09:03:13 +01001259 ret = add_job(td, td->name ?: "fio", 0);
Jens Axboeb4692822006-10-27 13:43:22 +02001260 if (ret)
1261 put_job(td);
Jens Axboe972cfd22006-06-09 11:08:56 +02001262 }
Jens Axboe774a6172006-08-24 08:44:26 +02001263
Jens Axboeb4692822006-10-27 13:43:22 +02001264 while (optind < argc) {
1265 ini_idx++;
1266 ini_file = realloc(ini_file, ini_idx * sizeof(char *));
1267 ini_file[ini_idx - 1] = strdup(argv[optind]);
1268 optind++;
Jens Axboeeb8bbf42006-06-08 21:40:11 +02001269 }
Jens Axboe972cfd22006-06-09 11:08:56 +02001270
1271 return ini_idx;
Jens Axboeebac4652005-12-08 15:25:21 +01001272}
1273
1274static void free_shm(void)
1275{
1276 struct shmid_ds sbuf;
1277
1278 if (threads) {
Jens Axboe2c0ecd22006-06-08 13:25:41 +02001279 shmdt((void *) threads);
Jens Axboeebac4652005-12-08 15:25:21 +01001280 threads = NULL;
1281 shmctl(shm_id, IPC_RMID, &sbuf);
1282 }
1283}
1284
Jens Axboe906c8d72006-06-13 09:37:56 +02001285/*
1286 * The thread area is shared between the main process and the job
1287 * threads/processes. So setup a shared memory segment that will hold
1288 * all the job info.
1289 */
Jens Axboeebac4652005-12-08 15:25:21 +01001290static int setup_thread_area(void)
1291{
1292 /*
1293 * 1024 is too much on some machines, scale max_jobs if
1294 * we get a failure that looks like too large a shm segment
1295 */
1296 do {
Jens Axboe906c8d72006-06-13 09:37:56 +02001297 size_t size = max_jobs * sizeof(struct thread_data);
Jens Axboeebac4652005-12-08 15:25:21 +01001298
Jens Axboe906c8d72006-06-13 09:37:56 +02001299 shm_id = shmget(0, size, IPC_CREAT | 0600);
Jens Axboeebac4652005-12-08 15:25:21 +01001300 if (shm_id != -1)
1301 break;
1302 if (errno != EINVAL) {
1303 perror("shmget");
1304 break;
1305 }
1306
1307 max_jobs >>= 1;
1308 } while (max_jobs);
1309
1310 if (shm_id == -1)
1311 return 1;
1312
1313 threads = shmat(shm_id, NULL, 0);
1314 if (threads == (void *) -1) {
1315 perror("shmat");
1316 return 1;
1317 }
1318
1319 atexit(free_shm);
1320 return 0;
1321}
1322
Jens Axboeb4692822006-10-27 13:43:22 +02001323/*
1324 * Copy the fio options into the long options map, so we mirror
1325 * job and cmd line options.
1326 */
1327static void dupe_job_options(void)
1328{
1329 struct fio_option *o;
1330 unsigned int i;
1331
1332 i = 0;
1333 while (long_options[i].name)
1334 i++;
1335
1336 o = &options[0];
1337 while (o->name) {
1338 long_options[i].name = o->name;
1339 long_options[i].val = FIO_GETOPT_JOB;
1340 if (o->type == FIO_OPT_STR_SET)
1341 long_options[i].has_arg = no_argument;
1342 else
1343 long_options[i].has_arg = required_argument;
1344
1345 i++;
1346 o++;
1347 assert(i < FIO_JOB_OPTS + FIO_CMD_OPTS);
1348 }
1349}
1350
Jens Axboeebac4652005-12-08 15:25:21 +01001351int parse_options(int argc, char *argv[])
1352{
Jens Axboe972cfd22006-06-09 11:08:56 +02001353 int job_files, i;
1354
Jens Axboeb4692822006-10-27 13:43:22 +02001355 f_out = stdout;
1356 f_err = stderr;
1357
Jens Axboe13335dd2007-01-10 13:14:02 +01001358 options_init(options);
1359
Jens Axboeb4692822006-10-27 13:43:22 +02001360 dupe_job_options();
1361
Jens Axboeebac4652005-12-08 15:25:21 +01001362 if (setup_thread_area())
1363 return 1;
1364 if (fill_def_thread())
1365 return 1;
1366
Jens Axboe972cfd22006-06-09 11:08:56 +02001367 job_files = parse_cmd_line(argc, argv);
Jens Axboeebac4652005-12-08 15:25:21 +01001368
Jens Axboe972cfd22006-06-09 11:08:56 +02001369 for (i = 0; i < job_files; i++) {
1370 if (fill_def_thread())
1371 return 1;
Jens Axboe0c7e37a2006-06-13 14:53:38 +02001372 if (parse_jobs_ini(ini_file[i], i))
Jens Axboe972cfd22006-06-09 11:08:56 +02001373 return 1;
Jens Axboe88c6ed82006-06-09 11:28:10 +02001374 free(ini_file[i]);
Jens Axboe972cfd22006-06-09 11:08:56 +02001375 }
Jens Axboeebac4652005-12-08 15:25:21 +01001376
Jens Axboe88c6ed82006-06-09 11:28:10 +02001377 free(ini_file);
Jens Axboeb4692822006-10-27 13:43:22 +02001378
1379 if (!thread_number) {
1380 log_err("No jobs defined(s)\n");
Jens Axboeb4692822006-10-27 13:43:22 +02001381 return 1;
1382 }
1383
Jens Axboeebac4652005-12-08 15:25:21 +01001384 return 0;
1385}