Commit | Line | Data |
---|---|---|
ebac4655 JA |
1 | #ifndef FIO_H |
2 | #define FIO_H | |
3 | ||
4 | #include <sched.h> | |
5 | #include <limits.h> | |
6 | #include <pthread.h> | |
7 | #include <sys/time.h> | |
8 | #include <sys/resource.h> | |
3c39a379 JA |
9 | #include <errno.h> |
10 | #include <stdlib.h> | |
11 | #include <stdio.h> | |
6d6f031f | 12 | #include <unistd.h> |
34cfcdaf | 13 | #include <string.h> |
214e1eca | 14 | #include <getopt.h> |
ebac4655 JA |
15 | |
16 | #include "list.h" | |
4b87898e | 17 | #include "rbtree.h" |
ebac4655 JA |
18 | #include "md5.h" |
19 | #include "crc32.h" | |
20 | #include "arch.h" | |
21 | #include "os.h" | |
07739b57 | 22 | #include "mutex.h" |
ebac4655 | 23 | |
b6959b55 | 24 | #ifdef FIO_HAVE_SYSLET |
a4f4fdd7 | 25 | #include "syslet.h" |
b6959b55 | 26 | #endif |
a4f4fdd7 | 27 | |
609342ff DL |
28 | #ifdef FIO_HAVE_GUASI |
29 | #include <guasi.h> | |
30 | #endif | |
31 | ||
1e97cce9 JA |
32 | enum fio_ddir { |
33 | DDIR_READ = 0, | |
34 | DDIR_WRITE, | |
35 | DDIR_SYNC, | |
36 | }; | |
37 | ||
413dd459 | 38 | enum td_ddir { |
b1ec1da6 JA |
39 | TD_DDIR_READ = 1 << 0, |
40 | TD_DDIR_WRITE = 1 << 1, | |
41 | TD_DDIR_RAND = 1 << 2, | |
42 | TD_DDIR_RW = TD_DDIR_READ | TD_DDIR_WRITE, | |
43 | TD_DDIR_RANDREAD = TD_DDIR_READ | TD_DDIR_RAND, | |
7ff1c14b | 44 | TD_DDIR_RANDWRITE = TD_DDIR_WRITE | TD_DDIR_RAND, |
b1ec1da6 | 45 | TD_DDIR_RANDRW = TD_DDIR_RW | TD_DDIR_RAND, |
413dd459 JA |
46 | }; |
47 | ||
1c9e06ee JA |
48 | /* |
49 | * Use for maintaining statistics | |
50 | */ | |
ebac4655 | 51 | struct io_stat { |
ebac4655 JA |
52 | unsigned long max_val; |
53 | unsigned long min_val; | |
54 | unsigned long samples; | |
68704084 JA |
55 | |
56 | double mean; | |
57 | double S; | |
ebac4655 JA |
58 | }; |
59 | ||
1c9e06ee JA |
60 | /* |
61 | * A single data sample | |
62 | */ | |
ebac4655 JA |
63 | struct io_sample { |
64 | unsigned long time; | |
65 | unsigned long val; | |
1e97cce9 | 66 | enum fio_ddir ddir; |
ebac4655 JA |
67 | }; |
68 | ||
1c9e06ee JA |
69 | /* |
70 | * Dynamically growing data sample log | |
71 | */ | |
ebac4655 JA |
72 | struct io_log { |
73 | unsigned long nr_samples; | |
74 | unsigned long max_samples; | |
75 | struct io_sample *log; | |
76 | }; | |
77 | ||
1c9e06ee JA |
78 | /* |
79 | * When logging io actions, this matches a single sent io_u | |
80 | */ | |
ebac4655 | 81 | struct io_piece { |
4b87898e JA |
82 | union { |
83 | struct rb_node rb_node; | |
84 | struct list_head list; | |
85 | }; | |
53cdc686 | 86 | struct fio_file *file; |
ebac4655 | 87 | unsigned long long offset; |
a4f4fdd7 | 88 | unsigned long len; |
1e97cce9 | 89 | enum fio_ddir ddir; |
ebac4655 JA |
90 | }; |
91 | ||
a4f4fdd7 JA |
92 | #ifdef FIO_HAVE_SYSLET |
93 | struct syslet_req { | |
5b38ee84 JA |
94 | struct syslet_uatom atom; /* the atom to submit */ |
95 | struct syslet_uatom *head; /* head of the sequence */ | |
96 | long ret; /* syscall return value */ | |
a4f4fdd7 JA |
97 | }; |
98 | #endif | |
99 | ||
0c6e7517 JA |
100 | enum { |
101 | IO_U_F_FREE = 1 << 0, | |
102 | IO_U_F_FLIGHT = 1 << 1, | |
103 | }; | |
104 | ||
36690c9b JA |
105 | struct thread_data; |
106 | ||
ebac4655 JA |
107 | /* |
108 | * The io unit | |
109 | */ | |
110 | struct io_u { | |
111 | union { | |
112 | #ifdef FIO_HAVE_LIBAIO | |
113 | struct iocb iocb; | |
114 | #endif | |
115 | #ifdef FIO_HAVE_POSIXAIO | |
116 | struct aiocb aiocb; | |
117 | #endif | |
118 | #ifdef FIO_HAVE_SGIO | |
119 | struct sg_io_hdr hdr; | |
a4f4fdd7 JA |
120 | #endif |
121 | #ifdef FIO_HAVE_SYSLET | |
a2e1b08a | 122 | struct syslet_req req; |
609342ff DL |
123 | #endif |
124 | #ifdef FIO_HAVE_GUASI | |
125 | guasi_req_t greq; | |
ebac4655 JA |
126 | #endif |
127 | }; | |
128 | struct timeval start_time; | |
129 | struct timeval issue_time; | |
130 | ||
1c9e06ee JA |
131 | /* |
132 | * Allocated/set buffer and length | |
133 | */ | |
6b9cea23 | 134 | void *buf; |
a4f4fdd7 | 135 | unsigned long buflen; |
ebac4655 JA |
136 | unsigned long long offset; |
137 | ||
1c9e06ee JA |
138 | /* |
139 | * IO engine state, may be different from above when we get | |
140 | * partial transfers / residual data counts | |
141 | */ | |
cec6b55d | 142 | void *xfer_buf; |
a4f4fdd7 | 143 | unsigned long xfer_buflen; |
cec6b55d | 144 | |
ebac4655 JA |
145 | unsigned int resid; |
146 | unsigned int error; | |
147 | ||
1e97cce9 | 148 | enum fio_ddir ddir; |
ebac4655 | 149 | |
dfd7bc2c JA |
150 | /* |
151 | * io engine private data | |
152 | */ | |
153 | union { | |
154 | unsigned int index; | |
155 | unsigned int seen; | |
156 | }; | |
157 | ||
0c6e7517 JA |
158 | unsigned int flags; |
159 | ||
53cdc686 JA |
160 | struct fio_file *file; |
161 | ||
ebac4655 | 162 | struct list_head list; |
d7762cf8 JA |
163 | |
164 | /* | |
165 | * Callback for io completion | |
166 | */ | |
36690c9b | 167 | int (*end_io)(struct thread_data *, struct io_u *); |
ebac4655 JA |
168 | }; |
169 | ||
36167d82 JA |
170 | /* |
171 | * io_ops->queue() return values | |
172 | */ | |
173 | enum { | |
174 | FIO_Q_COMPLETED = 0, /* completed sync */ | |
175 | FIO_Q_QUEUED = 1, /* queued, will complete async */ | |
755200a3 | 176 | FIO_Q_BUSY = 2, /* no more room, call ->commit() */ |
36167d82 JA |
177 | }; |
178 | ||
ebac4655 JA |
179 | #define FIO_HDR_MAGIC 0xf00baaef |
180 | ||
181 | enum { | |
1c9e06ee JA |
182 | VERIFY_NONE = 0, /* no verification */ |
183 | VERIFY_MD5, /* md5 sum data blocks */ | |
184 | VERIFY_CRC32, /* crc32 sum data blocks */ | |
36690c9b | 185 | VERIFY_NULL, /* pretend to verify */ |
ebac4655 JA |
186 | }; |
187 | ||
1c9e06ee JA |
188 | /* |
189 | * A header structure associated with each checksummed data block | |
190 | */ | |
ebac4655 JA |
191 | struct verify_header { |
192 | unsigned int fio_magic; | |
193 | unsigned int len; | |
194 | unsigned int verify_type; | |
195 | union { | |
196 | char md5_digest[MD5_HASH_WORDS * 4]; | |
197 | unsigned long crc32; | |
198 | }; | |
199 | }; | |
200 | ||
201 | struct group_run_stats { | |
9104f874 JA |
202 | unsigned long long max_run[2], min_run[2]; |
203 | unsigned long long max_bw[2], min_bw[2]; | |
e9b2a3fa | 204 | unsigned long long io_kb[2]; |
9104f874 | 205 | unsigned long long agg[2]; |
ebac4655 JA |
206 | }; |
207 | ||
e9c047a0 JA |
208 | /* |
209 | * What type of allocation to use for io buffers | |
210 | */ | |
211 | enum fio_memtype { | |
212 | MEM_MALLOC = 0, /* ordinary malloc */ | |
213 | MEM_SHM, /* use shared memory segments */ | |
74b025b0 | 214 | MEM_SHMHUGE, /* use shared memory segments with huge pages */ |
e9c047a0 | 215 | MEM_MMAP, /* use anonynomous mmap */ |
d0bdaf49 | 216 | MEM_MMAPHUGE, /* memory mapped huge file */ |
e9c047a0 JA |
217 | }; |
218 | ||
219 | /* | |
220 | * The type of object we are working on | |
221 | */ | |
222 | enum fio_filetype { | |
1c9e06ee JA |
223 | FIO_TYPE_FILE = 1, /* plain file */ |
224 | FIO_TYPE_BD, /* block device */ | |
225 | FIO_TYPE_CHAR, /* character device */ | |
e9c047a0 JA |
226 | }; |
227 | ||
2866c82d | 228 | enum fio_ioengine_flags { |
1c9e06ee | 229 | FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */ |
ba0fbe10 JA |
230 | FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */ |
231 | FIO_DISKLESSIO = 1 << 2, /* no disk involved */ | |
0263882a | 232 | FIO_NOEXTEND = 1 << 3, /* engine can't extend file */ |
62d984e2 | 233 | FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */ |
e9c047a0 JA |
234 | }; |
235 | ||
f11bd94d | 236 | enum fio_file_flags { |
0ad920e7 JA |
237 | FIO_FILE_OPEN = 1 << 0, /* file is open */ |
238 | FIO_FILE_UNLINK = 1 << 1, /* unlink on close */ | |
239 | FIO_FILE_CLOSING = 1 << 2, /* file being closed */ | |
7bb48f84 JA |
240 | FIO_FILE_EXISTS = 1 << 3, /* file there */ |
241 | FIO_FILE_EXTEND = 1 << 4, /* needs extend */ | |
242 | FIO_FILE_NOSORT = 1 << 5, /* don't sort verify blocks */ | |
f11bd94d JA |
243 | }; |
244 | ||
1c9e06ee JA |
245 | /* |
246 | * Each thread_data structure has a number of files associated with it, | |
247 | * this structure holds state information for a single file. | |
248 | */ | |
53cdc686 | 249 | struct fio_file { |
af52b345 JA |
250 | enum fio_filetype filetype; |
251 | ||
53cdc686 JA |
252 | /* |
253 | * A file may not be a file descriptor, let the io engine decide | |
254 | */ | |
255 | union { | |
256 | unsigned long file_data; | |
e26f8f7a | 257 | int fd; |
53cdc686 | 258 | }; |
7bb48f84 JA |
259 | |
260 | /* | |
261 | * filename and possible memory mapping | |
262 | */ | |
1315a68a | 263 | char *file_name; |
53cdc686 | 264 | void *mmap; |
7bb48f84 JA |
265 | |
266 | /* | |
267 | * size of the file, offset into file, and io size from that offset | |
268 | */ | |
53cdc686 JA |
269 | unsigned long long real_file_size; |
270 | unsigned long long file_offset; | |
7bb48f84 JA |
271 | unsigned long long io_size; |
272 | ||
53cdc686 | 273 | unsigned long long last_pos; |
02bcaa8c | 274 | unsigned long long last_completed_pos; |
53cdc686 | 275 | |
1c9e06ee JA |
276 | /* |
277 | * block map for random io | |
278 | */ | |
53cdc686 JA |
279 | unsigned long *file_map; |
280 | unsigned int num_maps; | |
1c9e06ee | 281 | unsigned int last_free_lookup; |
9b031dc8 | 282 | |
0ad920e7 | 283 | int references; |
f11bd94d | 284 | enum fio_file_flags flags; |
53cdc686 JA |
285 | }; |
286 | ||
b2560f3c JA |
287 | /* |
288 | * How many depth levels to log | |
289 | */ | |
290 | #define FIO_IO_U_MAP_NR 8 | |
291 | #define FIO_IO_U_LAT_NR 12 | |
292 | ||
079ad09b | 293 | struct thread_stat { |
756867bd JA |
294 | char *name; |
295 | char *verror; | |
296 | int error; | |
297 | int groupid; | |
298 | pid_t pid; | |
299 | char *description; | |
6586ee89 | 300 | int members; |
756867bd | 301 | |
079ad09b JA |
302 | struct io_log *slat_log; |
303 | struct io_log *clat_log; | |
304 | struct io_log *bw_log; | |
305 | ||
306 | /* | |
307 | * bandwidth and latency stats | |
308 | */ | |
309 | struct io_stat clat_stat[2]; /* completion latency */ | |
310 | struct io_stat slat_stat[2]; /* submission latency */ | |
311 | struct io_stat bw_stat[2]; /* bandwidth stats */ | |
312 | ||
313 | unsigned long long stat_io_bytes[2]; | |
314 | struct timeval stat_sample_time[2]; | |
315 | ||
316 | /* | |
317 | * fio system usage accounting | |
318 | */ | |
319 | struct rusage ru_start; | |
320 | struct rusage ru_end; | |
321 | unsigned long usr_time; | |
322 | unsigned long sys_time; | |
323 | unsigned long ctx; | |
079ad09b | 324 | |
b2560f3c JA |
325 | /* |
326 | * IO depth and latency stats | |
327 | */ | |
328 | unsigned int io_u_map[FIO_IO_U_MAP_NR]; | |
329 | unsigned int io_u_lat[FIO_IO_U_LAT_NR]; | |
b3605062 | 330 | unsigned long total_io_u[2]; |
756867bd JA |
331 | |
332 | unsigned long long io_bytes[2]; | |
333 | unsigned long runtime[2]; | |
334 | unsigned long total_run_time; | |
b2560f3c | 335 | }; |
71619dc2 | 336 | |
2dc1bbeb | 337 | struct thread_options { |
b1ec1da6 | 338 | int pad; |
61697c37 | 339 | char *description; |
b4692828 | 340 | char *name; |
ef899b63 | 341 | char *directory; |
13f8e2d2 | 342 | char *filename; |
2dc1bbeb | 343 | char *opendir; |
09629a90 | 344 | char *ioengine; |
413dd459 | 345 | enum td_ddir td_ddir; |
211097b2 | 346 | unsigned int ddir_nr; |
2dc1bbeb JA |
347 | unsigned int iodepth; |
348 | unsigned int iodepth_low; | |
349 | unsigned int iodepth_batch; | |
350 | ||
351 | unsigned long long size; | |
352 | unsigned long long file_size_low; | |
353 | unsigned long long file_size_high; | |
354 | unsigned long long start_offset; | |
355 | ||
356 | unsigned int bs[2]; | |
357 | unsigned int min_bs[2]; | |
358 | unsigned int max_bs[2]; | |
359 | ||
360 | unsigned int nr_files; | |
361 | unsigned int open_files; | |
e9c047a0 | 362 | |
9158d2f7 JA |
363 | unsigned int odirect; |
364 | unsigned int invalidate_cache; | |
365 | unsigned int create_serialize; | |
366 | unsigned int create_fsync; | |
367 | unsigned int end_fsync; | |
368 | unsigned int sync_io; | |
369 | unsigned int verify; | |
160b966d | 370 | unsigned int verifysort; |
9158d2f7 JA |
371 | unsigned int use_thread; |
372 | unsigned int unlink; | |
373 | unsigned int do_disk_util; | |
374 | unsigned int override_sync; | |
375 | unsigned int rand_repeatable; | |
376 | unsigned int write_lat_log; | |
377 | unsigned int write_bw_log; | |
bb8895e0 | 378 | unsigned int norandommap; |
690adba3 | 379 | unsigned int bs_unaligned; |
ebb1415f | 380 | unsigned int fsync_on_close; |
e9c047a0 | 381 | |
56bb17f2 | 382 | unsigned int hugepage_size; |
a00735e6 | 383 | unsigned int rw_min_bs; |
ebac4655 | 384 | unsigned int thinktime; |
48097d5c | 385 | unsigned int thinktime_spin; |
9c1f7434 | 386 | unsigned int thinktime_blocks; |
ebac4655 JA |
387 | unsigned int fsync_blocks; |
388 | unsigned int start_delay; | |
906c8d75 | 389 | unsigned long timeout; |
ebac4655 | 390 | unsigned int overwrite; |
ebac4655 | 391 | unsigned int bw_avg_time; |
ebac4655 | 392 | unsigned int loops; |
20dc95c4 JA |
393 | unsigned long long zone_size; |
394 | unsigned long long zone_skip; | |
e9c047a0 | 395 | enum fio_memtype mem_type; |
2dc1bbeb | 396 | |
ebac4655 | 397 | unsigned int stonewall; |
b3d62a75 | 398 | unsigned int new_group; |
ebac4655 | 399 | unsigned int numjobs; |
ebac4655 | 400 | os_cpu_mask_t cpumask; |
aea47d44 | 401 | unsigned int iolog; |
843a7413 | 402 | unsigned int read_iolog; |
a6ccc7be | 403 | unsigned int rwmixcycle; |
e47f799f | 404 | unsigned int rwmix[2]; |
b6f4d880 | 405 | unsigned int nice; |
0aabe160 | 406 | unsigned int file_service_type; |
b2560f3c | 407 | unsigned int group_reporting; |
d2f3ac35 | 408 | unsigned int fadvise_hint; |
aea47d44 | 409 | |
076efc7c JA |
410 | char *read_iolog_file; |
411 | char *write_iolog_file; | |
2dc1bbeb JA |
412 | |
413 | /* | |
414 | * Pre-run and post-run shell | |
415 | */ | |
416 | char *exec_prerun; | |
417 | char *exec_postrun; | |
418 | ||
419 | unsigned int rate; | |
420 | unsigned int ratemin; | |
421 | unsigned int ratecycle; | |
422 | unsigned int rate_iops; | |
423 | unsigned int rate_iops_min; | |
424 | ||
425 | char *ioscheduler; | |
426 | ||
427 | /* | |
428 | * CPU "io" cycle burner | |
429 | */ | |
430 | unsigned int cpuload; | |
431 | unsigned int cpucycle; | |
432 | }; | |
433 | ||
e4e33258 JA |
434 | #define FIO_VERROR_SIZE 128 |
435 | ||
2dc1bbeb JA |
436 | /* |
437 | * This describes a single thread/process executing a fio job. | |
438 | */ | |
439 | struct thread_data { | |
440 | struct thread_options o; | |
e4e33258 | 441 | char verror[FIO_VERROR_SIZE]; |
2dc1bbeb JA |
442 | pthread_t thread; |
443 | int thread_number; | |
444 | int groupid; | |
445 | struct thread_stat ts; | |
446 | struct fio_file *files; | |
447 | unsigned int files_index; | |
448 | unsigned int nr_open_files; | |
449 | unsigned int nr_normal_files; | |
450 | union { | |
451 | unsigned int next_file; | |
452 | os_random_state_t next_file_state; | |
453 | }; | |
454 | int error; | |
455 | pid_t pid; | |
456 | char *orig_buffer; | |
457 | size_t orig_buffer_size; | |
458 | volatile int terminate; | |
459 | volatile int runstate; | |
460 | unsigned int ioprio; | |
461 | unsigned int last_was_sync; | |
462 | ||
463 | char *mmapfile; | |
464 | int mmapfd; | |
465 | ||
843a7413 JA |
466 | void *iolog_buf; |
467 | FILE *iolog_f; | |
ebac4655 | 468 | |
da86774e | 469 | char *sysfs_root; |
da86774e | 470 | |
6dfd46b9 JA |
471 | os_random_state_t bsrange_state; |
472 | os_random_state_t verify_state; | |
ebac4655 JA |
473 | |
474 | int shm_id; | |
475 | ||
e9c047a0 JA |
476 | /* |
477 | * IO engine hooks, contains everything needed to submit an io_u | |
478 | * to any of the available IO engines. | |
479 | */ | |
2866c82d | 480 | struct ioengine_ops *io_ops; |
ebac4655 | 481 | |
e9c047a0 JA |
482 | /* |
483 | * Current IO depth and list of free and busy io_u's. | |
484 | */ | |
ebac4655 JA |
485 | unsigned int cur_depth; |
486 | struct list_head io_u_freelist; | |
487 | struct list_head io_u_busylist; | |
755200a3 | 488 | struct list_head io_u_requeues; |
cb5ab512 | 489 | unsigned int io_u_queued; |
ebac4655 | 490 | |
e9c047a0 JA |
491 | /* |
492 | * Rate state | |
493 | */ | |
ebac4655 JA |
494 | unsigned long rate_usec_cycle; |
495 | long rate_pending_usleep; | |
496 | unsigned long rate_bytes; | |
4e991c23 | 497 | unsigned long rate_blocks; |
ebac4655 JA |
498 | struct timeval lastrate; |
499 | ||
ebac4655 JA |
500 | unsigned long long total_io_size; |
501 | ||
755200a3 | 502 | unsigned long io_issues[2]; |
9104f874 JA |
503 | unsigned long long io_blocks[2]; |
504 | unsigned long long io_bytes[2]; | |
9104f874 | 505 | unsigned long long this_io_bytes[2]; |
079ad09b | 506 | unsigned long long zone_bytes; |
07739b57 | 507 | struct fio_sem *mutex; |
ebac4655 | 508 | |
e9c047a0 JA |
509 | /* |
510 | * State for random io, a bitmap of blocks done vs not done | |
511 | */ | |
6dfd46b9 | 512 | os_random_state_t random_state; |
ebac4655 | 513 | |
ebac4655 JA |
514 | struct timeval start; /* start of this loop */ |
515 | struct timeval epoch; /* time job was started */ | |
38d77cae JA |
516 | struct timeval rw_end[2]; |
517 | unsigned int rw_end_set[2]; | |
ebac4655 | 518 | |
e9c047a0 JA |
519 | /* |
520 | * read/write mixed workload state | |
521 | */ | |
6dfd46b9 | 522 | os_random_state_t rwmix_state; |
afe24a5a | 523 | unsigned long long rwmix_bytes; |
a6ccc7be | 524 | struct timeval rwmix_switch; |
e9c047a0 | 525 | enum fio_ddir rwmix_ddir; |
211097b2 | 526 | unsigned int ddir_nr; |
a6ccc7be | 527 | |
e9c047a0 | 528 | /* |
8de8f047 JA |
529 | * IO history logs for verification. We use a tree for sorting, |
530 | * if we are overwriting. Otherwise just use a fifo. | |
e9c047a0 | 531 | */ |
4b87898e | 532 | struct rb_root io_hist_tree; |
8de8f047 JA |
533 | struct list_head io_hist_list; |
534 | ||
535 | /* | |
536 | * For IO replaying | |
537 | */ | |
aea47d44 | 538 | struct list_head io_log_list; |
433afcb4 JA |
539 | |
540 | /* | |
541 | * timeout handling | |
542 | */ | |
543 | struct timeval timeout_end; | |
544 | struct itimerval timer; | |
1907dbc6 JA |
545 | |
546 | /* | |
547 | * for fileservice, how often to switch to a new file | |
548 | */ | |
549 | unsigned int file_service_nr; | |
550 | unsigned int file_service_left; | |
551 | struct fio_file *file_service_file; | |
9c60ce64 JA |
552 | |
553 | /* | |
554 | * For generating file sizes | |
555 | */ | |
556 | os_random_state_t file_size_state; | |
ebac4655 JA |
557 | }; |
558 | ||
0aabe160 JA |
559 | /* |
560 | * roundrobin available files, or choose one at random. | |
561 | */ | |
562 | enum { | |
563 | FIO_FSERVICE_RANDOM = 1, | |
564 | FIO_FSERVICE_RR = 2, | |
565 | }; | |
566 | ||
433afcb4 JA |
567 | /* |
568 | * 30 second per-io_u timeout, with 5 second intervals to avoid resetting | |
569 | * the timer on each queue operation. | |
570 | */ | |
571 | #define IO_U_TIMEOUT_INC 5 | |
572 | #define IO_U_TIMEOUT 30 | |
573 | ||
e1161c32 | 574 | #define __td_verror(td, err, msg, func) \ |
ebac4655 | 575 | do { \ |
19abcd3d JA |
576 | if ((td)->error) \ |
577 | break; \ | |
ebac4655 JA |
578 | int e = (err); \ |
579 | (td)->error = e; \ | |
e1161c32 | 580 | snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \ |
ebac4655 JA |
581 | } while (0) |
582 | ||
b990b5c0 | 583 | |
e1161c32 JA |
584 | #define td_verror(td, err, func) \ |
585 | __td_verror((td), (err), strerror((err)), (func)) | |
586 | #define td_vmsg(td, err, msg, func) \ | |
587 | __td_verror((td), (err), (msg), (func)) | |
b990b5c0 | 588 | |
ebac4655 JA |
589 | extern int exitall_on_terminate; |
590 | extern int thread_number; | |
9cedf167 | 591 | extern int nr_process, nr_thread; |
ebac4655 JA |
592 | extern int shm_id; |
593 | extern int groupid; | |
c6ae0a5b | 594 | extern int terse_output; |
eb8bbf48 JA |
595 | extern FILE *f_out; |
596 | extern FILE *f_err; | |
53cdc686 | 597 | extern int temp_stall_ts; |
1e97cce9 | 598 | extern unsigned long long mlock_size; |
cfc99db7 | 599 | extern unsigned long page_mask, page_size; |
ebac4655 JA |
600 | |
601 | extern struct thread_data *threads; | |
602 | ||
2dc1bbeb JA |
603 | #define td_read(td) ((td)->o.td_ddir & TD_DDIR_READ) |
604 | #define td_write(td) ((td)->o.td_ddir & TD_DDIR_WRITE) | |
605 | #define td_rw(td) (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW) | |
606 | #define td_random(td) ((td)->o.td_ddir & TD_DDIR_RAND) | |
ebac4655 JA |
607 | |
608 | #define BLOCKS_PER_MAP (8 * sizeof(long)) | |
2dc1bbeb | 609 | #define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs)) |
53cdc686 JA |
610 | #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP) |
611 | #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1)) | |
ebac4655 JA |
612 | |
613 | #define MAX_JOBS (1024) | |
614 | ||
87dc1ab1 JA |
615 | static inline int should_fsync(struct thread_data *td) |
616 | { | |
617 | if (td->last_was_sync) | |
618 | return 0; | |
2dc1bbeb | 619 | if (td->o.odirect) |
87dc1ab1 | 620 | return 0; |
2dc1bbeb | 621 | if (td_write(td) || td_rw(td) || td->o.override_sync) |
87dc1ab1 JA |
622 | return 1; |
623 | ||
624 | return 0; | |
625 | } | |
626 | ||
1c9e06ee JA |
627 | /* |
628 | * Disk utils as read in /sys/block/<dev>/stat | |
629 | */ | |
ebac4655 JA |
630 | struct disk_util_stat { |
631 | unsigned ios[2]; | |
632 | unsigned merges[2]; | |
633 | unsigned long long sectors[2]; | |
634 | unsigned ticks[2]; | |
635 | unsigned io_ticks; | |
636 | unsigned time_in_queue; | |
637 | }; | |
638 | ||
1c9e06ee JA |
639 | /* |
640 | * Per-device disk util management | |
641 | */ | |
ebac4655 JA |
642 | struct disk_util { |
643 | struct list_head list; | |
644 | ||
645 | char *name; | |
646 | char path[256]; | |
647 | dev_t dev; | |
648 | ||
649 | struct disk_util_stat dus; | |
650 | struct disk_util_stat last_dus; | |
651 | ||
652 | unsigned long msec; | |
653 | struct timeval time; | |
654 | }; | |
655 | ||
ebac4655 JA |
656 | #define DISK_UTIL_MSEC (250) |
657 | ||
6a0106a0 JA |
658 | #ifndef min |
659 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
660 | #endif | |
a00735e6 JA |
661 | #ifndef max |
662 | #define max(a, b) ((a) > (b) ? (a) : (b)) | |
663 | #endif | |
6a0106a0 | 664 | |
6796209a JA |
665 | /* |
666 | * Log exports | |
667 | */ | |
72cb971b | 668 | extern int __must_check read_iolog_get(struct thread_data *, struct io_u *); |
6796209a | 669 | extern void write_iolog_put(struct thread_data *, struct io_u *); |
72cb971b | 670 | extern int __must_check init_iolog(struct thread_data *td); |
6796209a JA |
671 | extern void log_io_piece(struct thread_data *, struct io_u *); |
672 | extern void prune_io_piece_log(struct thread_data *); | |
673 | extern void write_iolog_close(struct thread_data *); | |
674 | ||
675 | /* | |
676 | * Logging | |
677 | */ | |
1e97cce9 JA |
678 | extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long); |
679 | extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long); | |
680 | extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *); | |
6796209a JA |
681 | extern void show_run_stats(void); |
682 | extern void init_disk_util(struct thread_data *); | |
683 | extern void update_rusage_stat(struct thread_data *); | |
684 | extern void update_io_ticks(void); | |
685 | extern void disk_util_timer_arm(void); | |
8914a9d8 JA |
686 | extern void setup_log(struct io_log **); |
687 | extern void finish_log(struct thread_data *, struct io_log *, const char *); | |
bb3884d8 | 688 | extern void __finish_log(struct io_log *, const char *); |
bb3884d8 JA |
689 | extern struct io_log *agg_io_log[2]; |
690 | extern int write_bw_log; | |
691 | extern void add_agg_sample(unsigned long, enum fio_ddir); | |
6796209a JA |
692 | |
693 | /* | |
694 | * Time functions | |
695 | */ | |
696 | extern unsigned long utime_since(struct timeval *, struct timeval *); | |
69008999 | 697 | extern unsigned long utime_since_now(struct timeval *); |
6796209a JA |
698 | extern unsigned long mtime_since(struct timeval *, struct timeval *); |
699 | extern unsigned long mtime_since_now(struct timeval *); | |
700 | extern unsigned long time_since_now(struct timeval *); | |
263e529f | 701 | extern unsigned long mtime_since_genesis(void); |
b990b5c0 | 702 | extern void __usec_sleep(unsigned int); |
6796209a | 703 | extern void usec_sleep(struct thread_data *, unsigned long); |
413dd459 | 704 | extern void rate_throttle(struct thread_data *, unsigned long, unsigned int); |
6043c579 | 705 | extern void fill_start_time(struct timeval *); |
02bcaa8c | 706 | extern void fio_gettime(struct timeval *, void *); |
a2f77c9f | 707 | extern void set_genesis_time(void); |
6796209a | 708 | |
8914a9d8 | 709 | /* |
214e1eca | 710 | * Init/option functions |
8914a9d8 | 711 | */ |
72cb971b | 712 | extern int __must_check parse_options(int, char **); |
214e1eca JA |
713 | extern int fio_option_parse(struct thread_data *, const char *); |
714 | extern int fio_cmd_option_parse(struct thread_data *, const char *, char *); | |
715 | extern void fio_fill_default_options(struct thread_data *); | |
716 | extern int fio_show_option_help(const char *); | |
717 | extern void fio_options_dup_and_init(struct option *); | |
d23bb327 JA |
718 | extern void options_mem_dupe(struct thread_data *); |
719 | extern void options_mem_free(struct thread_data *); | |
214e1eca JA |
720 | #define FIO_GETOPT_JOB 0x89988998 |
721 | #define FIO_NR_OPTIONS 128 | |
8914a9d8 | 722 | |
53cdc686 JA |
723 | /* |
724 | * File setup/shutdown | |
725 | */ | |
726 | extern void close_files(struct thread_data *); | |
b2fdda43 JA |
727 | extern int __must_check setup_files(struct thread_data *); |
728 | extern int __must_check open_files(struct thread_data *); | |
729 | extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *); | |
b5af8293 JA |
730 | extern int __must_check generic_open_file(struct thread_data *, struct fio_file *); |
731 | extern void generic_close_file(struct thread_data *, struct fio_file *); | |
af52b345 | 732 | extern void add_file(struct thread_data *, const char *); |
0ad920e7 JA |
733 | extern void get_file(struct fio_file *); |
734 | extern void put_file(struct thread_data *, struct fio_file *); | |
bbf6b540 | 735 | extern int add_dir_files(struct thread_data *, const char *); |
68727076 | 736 | extern int init_random_map(struct thread_data *); |
cade3ef4 | 737 | extern void dup_files(struct thread_data *, struct thread_data *); |
53cdc686 | 738 | |
263e529f JA |
739 | /* |
740 | * ETA/status stuff | |
741 | */ | |
742 | extern void print_thread_status(void); | |
743 | extern void print_status_init(int); | |
744 | ||
745 | /* | |
746 | * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it | |
747 | * will never back again. It may cycle between running/verififying/fsyncing. | |
748 | * Once the thread reaches TD_EXITED, it is just waiting for the core to | |
749 | * reap it. | |
750 | */ | |
751 | enum { | |
752 | TD_NOT_CREATED = 0, | |
753 | TD_CREATED, | |
754 | TD_INITIALIZED, | |
755 | TD_RUNNING, | |
756 | TD_VERIFYING, | |
757 | TD_FSYNCING, | |
758 | TD_EXITED, | |
759 | TD_REAPED, | |
760 | }; | |
761 | ||
e29d1b70 JA |
762 | /* |
763 | * Verify helpers | |
764 | */ | |
765 | extern void populate_verify_io_u(struct thread_data *, struct io_u *); | |
b2fdda43 | 766 | extern int __must_check get_next_verify(struct thread_data *td, struct io_u *); |
36690c9b | 767 | extern int __must_check verify_io_u(struct thread_data *, struct io_u *); |
e29d1b70 | 768 | |
2f9ade3c JA |
769 | /* |
770 | * Memory helpers | |
771 | */ | |
b2fdda43 | 772 | extern int __must_check fio_pin_memory(void); |
2f9ade3c | 773 | extern void fio_unpin_memory(void); |
b2fdda43 | 774 | extern int __must_check allocate_io_mem(struct thread_data *); |
2f9ade3c JA |
775 | extern void free_io_mem(struct thread_data *); |
776 | ||
10ba535a JA |
777 | /* |
778 | * io unit handling | |
779 | */ | |
780 | #define queue_full(td) list_empty(&(td)->io_u_freelist) | |
781 | extern struct io_u *__get_io_u(struct thread_data *); | |
3d7c391d | 782 | extern struct io_u *get_io_u(struct thread_data *); |
10ba535a | 783 | extern void put_io_u(struct thread_data *, struct io_u *); |
755200a3 | 784 | extern void requeue_io_u(struct thread_data *, struct io_u **); |
d7762cf8 JA |
785 | extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *); |
786 | extern long __must_check io_u_queued_complete(struct thread_data *, int); | |
7e77dd02 | 787 | extern void io_u_queued(struct thread_data *, struct io_u *); |
5451792e | 788 | extern void io_u_log_error(struct thread_data *, struct io_u *); |
433afcb4 JA |
789 | extern void io_u_init_timeout(void); |
790 | extern void io_u_set_timeout(struct thread_data *); | |
b3605062 | 791 | extern void io_u_mark_depth(struct thread_data *, struct io_u *); |
10ba535a JA |
792 | |
793 | /* | |
794 | * io engine entry points | |
795 | */ | |
b2fdda43 JA |
796 | extern int __must_check td_io_init(struct thread_data *); |
797 | extern int __must_check td_io_prep(struct thread_data *, struct io_u *); | |
798 | extern int __must_check td_io_queue(struct thread_data *, struct io_u *); | |
799 | extern int __must_check td_io_sync(struct thread_data *, struct fio_file *); | |
800 | extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *); | |
801 | extern int __must_check td_io_commit(struct thread_data *); | |
b5af8293 JA |
802 | extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *); |
803 | extern void td_io_close_file(struct thread_data *, struct fio_file *); | |
10ba535a | 804 | |
3b70d7e5 JA |
805 | /* |
806 | * If logging output to a file, stderr should go to both stderr and f_err | |
807 | */ | |
808 | #define log_err(args...) do { \ | |
809 | fprintf(f_err, ##args); \ | |
810 | if (f_err != stderr) \ | |
811 | fprintf(stderr, ##args); \ | |
812 | } while (0) | |
813 | ||
9c60ce64 JA |
814 | #define log_info(args...) fprintf(f_out, ##args) |
815 | ||
9728ce37 JB |
816 | FILE *get_f_out(void); |
817 | FILE *get_f_err(void); | |
818 | ||
2866c82d | 819 | struct ioengine_ops { |
5f350952 | 820 | struct list_head list; |
2866c82d JA |
821 | char name[16]; |
822 | int version; | |
823 | int flags; | |
ea2877a4 | 824 | int (*setup)(struct thread_data *); |
2866c82d JA |
825 | int (*init)(struct thread_data *); |
826 | int (*prep)(struct thread_data *, struct io_u *); | |
827 | int (*queue)(struct thread_data *, struct io_u *); | |
755200a3 | 828 | int (*commit)(struct thread_data *); |
2866c82d JA |
829 | int (*getevents)(struct thread_data *, int, int, struct timespec *); |
830 | struct io_u *(*event)(struct thread_data *, int); | |
831 | int (*cancel)(struct thread_data *, struct io_u *); | |
832 | void (*cleanup)(struct thread_data *); | |
b5af8293 JA |
833 | int (*open_file)(struct thread_data *, struct fio_file *); |
834 | void (*close_file)(struct thread_data *, struct fio_file *); | |
2866c82d JA |
835 | void *data; |
836 | void *dlhandle; | |
837 | }; | |
838 | ||
b5af8293 | 839 | #define FIO_IOOPS_VERSION 6 |
2866c82d | 840 | |
b4692828 | 841 | extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *); |
b2fdda43 | 842 | extern void register_ioengine(struct ioengine_ops *); |
5f350952 | 843 | extern void unregister_ioengine(struct ioengine_ops *); |
2866c82d JA |
844 | extern void close_ioengine(struct thread_data *); |
845 | ||
846 | /* | |
847 | * Mark unused variables passed to ops functions as unused, to silence gcc | |
848 | */ | |
849 | #define fio_unused __attribute((__unused__)) | |
5f350952 JA |
850 | #define fio_init __attribute__((constructor)) |
851 | #define fio_exit __attribute__((destructor)) | |
2866c82d | 852 | |
34572e28 JA |
853 | #define for_each_td(td, i) \ |
854 | for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++) | |
53cdc686 | 855 | #define for_each_file(td, f, i) \ |
2dc1bbeb | 856 | for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++) |
53cdc686 | 857 | |
0032bf9f JA |
858 | #define fio_assert(td, cond) do { \ |
859 | if (!(cond)) { \ | |
340fd243 | 860 | int *__foo = NULL; \ |
0032bf9f JA |
861 | fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \ |
862 | (td)->runstate = TD_EXITED; \ | |
437c9b71 | 863 | (td)->error = EFAULT; \ |
340fd243 | 864 | *__foo = 0; \ |
0032bf9f JA |
865 | } \ |
866 | } while (0) | |
867 | ||
ebac4655 | 868 | #endif |