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> |
ebac4655 JA |
13 | |
14 | #include "list.h" | |
15 | #include "md5.h" | |
16 | #include "crc32.h" | |
17 | #include "arch.h" | |
18 | #include "os.h" | |
19 | ||
20 | struct io_stat { | |
21 | unsigned long val; | |
22 | unsigned long val_sq; | |
23 | unsigned long max_val; | |
24 | unsigned long min_val; | |
25 | unsigned long samples; | |
26 | }; | |
27 | ||
28 | struct io_sample { | |
29 | unsigned long time; | |
30 | unsigned long val; | |
31 | unsigned int ddir; | |
32 | }; | |
33 | ||
34 | struct io_log { | |
35 | unsigned long nr_samples; | |
36 | unsigned long max_samples; | |
37 | struct io_sample *log; | |
38 | }; | |
39 | ||
40 | struct io_piece { | |
41 | struct list_head list; | |
42 | unsigned long long offset; | |
43 | unsigned int len; | |
aea47d44 | 44 | int ddir; |
ebac4655 JA |
45 | }; |
46 | ||
47 | /* | |
48 | * The io unit | |
49 | */ | |
50 | struct io_u { | |
51 | union { | |
52 | #ifdef FIO_HAVE_LIBAIO | |
53 | struct iocb iocb; | |
54 | #endif | |
55 | #ifdef FIO_HAVE_POSIXAIO | |
56 | struct aiocb aiocb; | |
57 | #endif | |
58 | #ifdef FIO_HAVE_SGIO | |
59 | struct sg_io_hdr hdr; | |
60 | #endif | |
61 | }; | |
62 | struct timeval start_time; | |
63 | struct timeval issue_time; | |
64 | ||
65 | char *buf; | |
66 | unsigned int buflen; | |
67 | unsigned long long offset; | |
b1ff3403 | 68 | unsigned int index; |
ebac4655 JA |
69 | |
70 | unsigned int resid; | |
71 | unsigned int error; | |
72 | ||
73 | unsigned char seen; | |
74 | unsigned char ddir; | |
75 | ||
76 | struct list_head list; | |
77 | }; | |
78 | ||
79 | #define FIO_HDR_MAGIC 0xf00baaef | |
80 | ||
81 | enum { | |
82 | VERIFY_NONE = 0, | |
83 | VERIFY_MD5, | |
84 | VERIFY_CRC32, | |
85 | }; | |
86 | ||
87 | struct verify_header { | |
88 | unsigned int fio_magic; | |
89 | unsigned int len; | |
90 | unsigned int verify_type; | |
91 | union { | |
92 | char md5_digest[MD5_HASH_WORDS * 4]; | |
93 | unsigned long crc32; | |
94 | }; | |
95 | }; | |
96 | ||
97 | struct group_run_stats { | |
9104f874 JA |
98 | unsigned long long max_run[2], min_run[2]; |
99 | unsigned long long max_bw[2], min_bw[2]; | |
e9b2a3fa | 100 | unsigned long long io_kb[2]; |
9104f874 | 101 | unsigned long long agg[2]; |
ebac4655 JA |
102 | }; |
103 | ||
e9c047a0 JA |
104 | enum fio_ddir { |
105 | DDIR_READ = 0, | |
106 | DDIR_WRITE, | |
107 | }; | |
108 | ||
109 | /* | |
110 | * What type of allocation to use for io buffers | |
111 | */ | |
112 | enum fio_memtype { | |
113 | MEM_MALLOC = 0, /* ordinary malloc */ | |
114 | MEM_SHM, /* use shared memory segments */ | |
115 | MEM_MMAP, /* use anonynomous mmap */ | |
116 | }; | |
117 | ||
118 | /* | |
119 | * The type of object we are working on | |
120 | */ | |
121 | enum fio_filetype { | |
122 | FIO_TYPE_FILE = 1, | |
123 | FIO_TYPE_BD, | |
124 | FIO_TYPE_CHAR, | |
125 | }; | |
126 | ||
2866c82d | 127 | enum fio_ioengine_flags { |
e9c047a0 | 128 | FIO_SYNCIO = 1 << 0, |
2866c82d JA |
129 | FIO_CPUIO = 1 << 1, |
130 | FIO_MMAPIO = 1 << 2, | |
e9c047a0 JA |
131 | }; |
132 | ||
133 | /* | |
134 | * This describes a single thread/process executing a fio job. | |
135 | */ | |
ebac4655 | 136 | struct thread_data { |
e9c047a0 JA |
137 | char name[32]; |
138 | char *file_name; | |
ef899b63 | 139 | char *directory; |
ebac4655 JA |
140 | char verror[80]; |
141 | pthread_t thread; | |
142 | int thread_number; | |
143 | int groupid; | |
e9c047a0 | 144 | enum fio_filetype filetype; |
ebac4655 JA |
145 | int error; |
146 | int fd; | |
147 | void *mmap; | |
148 | pid_t pid; | |
149 | char *orig_buffer; | |
150 | size_t orig_buffer_size; | |
151 | volatile int terminate; | |
152 | volatile int runstate; | |
e9c047a0 | 153 | enum fio_ddir ddir; |
3d60d1ed | 154 | unsigned int iomix; |
ebac4655 | 155 | unsigned int ioprio; |
e9c047a0 JA |
156 | |
157 | unsigned char sequential; | |
158 | unsigned char odirect; | |
159 | unsigned char create_file; | |
160 | unsigned char invalidate_cache; | |
161 | unsigned char create_serialize; | |
162 | unsigned char create_fsync; | |
163 | unsigned char end_fsync; | |
164 | unsigned char sync_io; | |
165 | unsigned char verify; | |
166 | unsigned char use_thread; | |
167 | unsigned char do_disk_util; | |
168 | unsigned char override_sync; | |
9ebc27e1 | 169 | unsigned char rand_repeatable; |
e9c047a0 | 170 | |
ebac4655 JA |
171 | unsigned int bs; |
172 | unsigned int min_bs; | |
173 | unsigned int max_bs; | |
ebac4655 JA |
174 | unsigned int thinktime; |
175 | unsigned int fsync_blocks; | |
176 | unsigned int start_delay; | |
906c8d75 | 177 | unsigned long timeout; |
ebac4655 | 178 | unsigned int overwrite; |
ebac4655 | 179 | unsigned int bw_avg_time; |
ebac4655 JA |
180 | unsigned int loops; |
181 | unsigned long long file_size; | |
838a3cd3 | 182 | unsigned long long real_file_size; |
ebac4655 | 183 | unsigned long long file_offset; |
20dc95c4 JA |
184 | unsigned long long zone_size; |
185 | unsigned long long zone_skip; | |
e9c047a0 | 186 | enum fio_memtype mem_type; |
ebac4655 JA |
187 | unsigned int stonewall; |
188 | unsigned int numjobs; | |
ebac4655 JA |
189 | unsigned int iodepth; |
190 | os_cpu_mask_t cpumask; | |
aea47d44 | 191 | unsigned int iolog; |
843a7413 JA |
192 | unsigned int read_iolog; |
193 | unsigned int write_iolog; | |
a6ccc7be JA |
194 | unsigned int rwmixcycle; |
195 | unsigned int rwmixread; | |
b6f4d880 | 196 | unsigned int nice; |
aea47d44 | 197 | |
ef899b63 | 198 | char *iolog_file; |
843a7413 JA |
199 | void *iolog_buf; |
200 | FILE *iolog_f; | |
ebac4655 | 201 | |
da86774e | 202 | char *sysfs_root; |
da86774e JA |
203 | char *ioscheduler; |
204 | ||
6dfd46b9 JA |
205 | os_random_state_t bsrange_state; |
206 | os_random_state_t verify_state; | |
ebac4655 JA |
207 | |
208 | int shm_id; | |
209 | ||
e9c047a0 JA |
210 | /* |
211 | * IO engine hooks, contains everything needed to submit an io_u | |
212 | * to any of the available IO engines. | |
213 | */ | |
2866c82d | 214 | struct ioengine_ops *io_ops; |
ebac4655 | 215 | |
e9c047a0 JA |
216 | /* |
217 | * Current IO depth and list of free and busy io_u's. | |
218 | */ | |
ebac4655 JA |
219 | unsigned int cur_depth; |
220 | struct list_head io_u_freelist; | |
221 | struct list_head io_u_busylist; | |
222 | ||
e9c047a0 JA |
223 | /* |
224 | * Rate state | |
225 | */ | |
ebac4655 JA |
226 | unsigned int rate; |
227 | unsigned int ratemin; | |
228 | unsigned int ratecycle; | |
229 | unsigned long rate_usec_cycle; | |
230 | long rate_pending_usleep; | |
231 | unsigned long rate_bytes; | |
232 | struct timeval lastrate; | |
233 | ||
234 | unsigned long runtime[2]; /* msec */ | |
235 | unsigned long long io_size; | |
236 | unsigned long long total_io_size; | |
237 | ||
9104f874 JA |
238 | unsigned long long io_blocks[2]; |
239 | unsigned long long io_bytes[2]; | |
240 | unsigned long long zone_bytes; | |
241 | unsigned long long this_io_bytes[2]; | |
20dc95c4 | 242 | unsigned long long last_pos; |
bbfd6b00 | 243 | volatile int mutex; |
ebac4655 | 244 | |
e9c047a0 JA |
245 | /* |
246 | * State for random io, a bitmap of blocks done vs not done | |
247 | */ | |
6dfd46b9 | 248 | os_random_state_t random_state; |
ebac4655 JA |
249 | unsigned long *file_map; |
250 | unsigned int num_maps; | |
251 | ||
b990b5c0 JA |
252 | /* |
253 | * CPU "io" cycle burner | |
254 | */ | |
255 | unsigned int cpuload; | |
256 | unsigned int cpucycle; | |
257 | ||
ebac4655 JA |
258 | /* |
259 | * bandwidth and latency stats | |
260 | */ | |
261 | struct io_stat clat_stat[2]; /* completion latency */ | |
262 | struct io_stat slat_stat[2]; /* submission latency */ | |
263 | struct io_stat bw_stat[2]; /* bandwidth stats */ | |
264 | ||
9104f874 | 265 | unsigned long long stat_io_bytes[2]; |
ebac4655 JA |
266 | struct timeval stat_sample_time[2]; |
267 | ||
268 | struct io_log *slat_log; | |
269 | struct io_log *clat_log; | |
270 | struct io_log *bw_log; | |
271 | ||
272 | struct timeval start; /* start of this loop */ | |
273 | struct timeval epoch; /* time job was started */ | |
274 | ||
e9c047a0 JA |
275 | /* |
276 | * fio system usage accounting | |
277 | */ | |
ebac4655 JA |
278 | struct rusage ru_start; |
279 | struct rusage ru_end; | |
280 | unsigned long usr_time; | |
281 | unsigned long sys_time; | |
282 | unsigned long ctx; | |
283 | ||
e9c047a0 JA |
284 | /* |
285 | * read/write mixed workload state | |
286 | */ | |
6dfd46b9 | 287 | os_random_state_t rwmix_state; |
a6ccc7be | 288 | struct timeval rwmix_switch; |
e9c047a0 | 289 | enum fio_ddir rwmix_ddir; |
a6ccc7be | 290 | |
4e0ba8af JA |
291 | /* |
292 | * Pre-run and post-run shell | |
293 | */ | |
294 | char *exec_prerun; | |
295 | char *exec_postrun; | |
296 | ||
e9c047a0 JA |
297 | /* |
298 | * IO historic logs | |
299 | */ | |
ebac4655 | 300 | struct list_head io_hist_list; |
aea47d44 | 301 | struct list_head io_log_list; |
ebac4655 JA |
302 | }; |
303 | ||
b990b5c0 | 304 | #define __td_verror(td, err, msg) \ |
ebac4655 JA |
305 | do { \ |
306 | int e = (err); \ | |
307 | (td)->error = e; \ | |
b990b5c0 | 308 | snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \ |
ebac4655 JA |
309 | } while (0) |
310 | ||
b990b5c0 JA |
311 | |
312 | #define td_verror(td, err) __td_verror((td), (err), strerror((err))) | |
313 | #define td_vmsg(td, err, msg) __td_verror((td), (err), (msg)) | |
314 | ||
b1ff3403 JA |
315 | extern struct io_u *__get_io_u(struct thread_data *); |
316 | extern void put_io_u(struct thread_data *, struct io_u *); | |
ebac4655 JA |
317 | |
318 | extern int rate_quit; | |
319 | extern int write_lat_log; | |
320 | extern int write_bw_log; | |
321 | extern int exitall_on_terminate; | |
322 | extern int thread_number; | |
323 | extern int shm_id; | |
324 | extern int groupid; | |
c6ae0a5b | 325 | extern int terse_output; |
eb8bbf48 JA |
326 | extern FILE *f_out; |
327 | extern FILE *f_err; | |
c1d5725e | 328 | extern char *fio_inst_prefix; |
ebac4655 JA |
329 | |
330 | extern struct thread_data *threads; | |
331 | ||
ebac4655 JA |
332 | #define td_read(td) ((td)->ddir == DDIR_READ) |
333 | #define td_write(td) ((td)->ddir == DDIR_WRITE) | |
3d60d1ed | 334 | #define td_rw(td) ((td)->iomix != 0) |
ebac4655 JA |
335 | |
336 | #define BLOCKS_PER_MAP (8 * sizeof(long)) | |
337 | #define TO_MAP_BLOCK(td, b) ((b) - ((td)->file_offset / (td)->min_bs)) | |
338 | #define RAND_MAP_IDX(td, b) (TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP) | |
339 | #define RAND_MAP_BIT(td, b) (TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1)) | |
340 | ||
341 | #define MAX_JOBS (1024) | |
342 | ||
343 | struct disk_util_stat { | |
344 | unsigned ios[2]; | |
345 | unsigned merges[2]; | |
346 | unsigned long long sectors[2]; | |
347 | unsigned ticks[2]; | |
348 | unsigned io_ticks; | |
349 | unsigned time_in_queue; | |
350 | }; | |
351 | ||
352 | struct disk_util { | |
353 | struct list_head list; | |
354 | ||
355 | char *name; | |
356 | char path[256]; | |
357 | dev_t dev; | |
358 | ||
359 | struct disk_util_stat dus; | |
360 | struct disk_util_stat last_dus; | |
361 | ||
362 | unsigned long msec; | |
363 | struct timeval time; | |
364 | }; | |
365 | ||
366 | struct io_completion_data { | |
367 | int nr; /* input */ | |
368 | ||
369 | int error; /* output */ | |
370 | unsigned long bytes_done[2]; /* output */ | |
371 | }; | |
372 | ||
373 | #define DISK_UTIL_MSEC (250) | |
374 | ||
6a0106a0 JA |
375 | #ifndef min |
376 | #define min(a, b) ((a) < (b) ? (a) : (b)) | |
377 | #endif | |
378 | ||
6796209a JA |
379 | /* |
380 | * Log exports | |
381 | */ | |
382 | extern int read_iolog_get(struct thread_data *, struct io_u *); | |
383 | extern void write_iolog_put(struct thread_data *, struct io_u *); | |
384 | extern int init_iolog(struct thread_data *td); | |
385 | extern void log_io_piece(struct thread_data *, struct io_u *); | |
386 | extern void prune_io_piece_log(struct thread_data *); | |
387 | extern void write_iolog_close(struct thread_data *); | |
388 | ||
389 | /* | |
390 | * Logging | |
391 | */ | |
392 | extern void add_clat_sample(struct thread_data *, int, unsigned long); | |
393 | extern void add_slat_sample(struct thread_data *, int, unsigned long); | |
394 | extern void add_bw_sample(struct thread_data *, int); | |
395 | extern void show_run_stats(void); | |
396 | extern void init_disk_util(struct thread_data *); | |
397 | extern void update_rusage_stat(struct thread_data *); | |
398 | extern void update_io_ticks(void); | |
399 | extern void disk_util_timer_arm(void); | |
8914a9d8 JA |
400 | extern void setup_log(struct io_log **); |
401 | extern void finish_log(struct thread_data *, struct io_log *, const char *); | |
402 | extern int setup_rate(struct thread_data *); | |
6796209a JA |
403 | |
404 | /* | |
405 | * Time functions | |
406 | */ | |
407 | extern unsigned long utime_since(struct timeval *, struct timeval *); | |
408 | extern unsigned long mtime_since(struct timeval *, struct timeval *); | |
409 | extern unsigned long mtime_since_now(struct timeval *); | |
410 | extern unsigned long time_since_now(struct timeval *); | |
b990b5c0 | 411 | extern void __usec_sleep(unsigned int); |
6796209a JA |
412 | extern void usec_sleep(struct thread_data *, unsigned long); |
413 | extern void rate_throttle(struct thread_data *, unsigned long, unsigned int); | |
414 | ||
8914a9d8 JA |
415 | /* |
416 | * Init functions | |
417 | */ | |
418 | extern int parse_options(int, char **); | |
419 | extern int init_random_state(struct thread_data *); | |
420 | ||
bbfd6b00 JA |
421 | /* |
422 | * This is a pretty crappy semaphore implementation, but with the use that fio | |
423 | * has (just signalling start/go conditions), it doesn't have to be better. | |
424 | * Naturally this would not work for any type of contended semaphore or | |
425 | * for real locking. | |
426 | */ | |
1056eaad | 427 | static inline void fio_sem_init(volatile int *sem, int val) |
bbfd6b00 JA |
428 | { |
429 | *sem = val; | |
430 | } | |
431 | ||
1056eaad | 432 | static inline void fio_sem_down(volatile int *sem) |
bbfd6b00 JA |
433 | { |
434 | while (*sem == 0) | |
435 | usleep(10000); | |
436 | ||
437 | (*sem)--; | |
438 | } | |
439 | ||
1056eaad | 440 | static inline void fio_sem_up(volatile int *sem) |
bbfd6b00 JA |
441 | { |
442 | (*sem)++; | |
443 | } | |
444 | ||
3b70d7e5 JA |
445 | /* |
446 | * If logging output to a file, stderr should go to both stderr and f_err | |
447 | */ | |
448 | #define log_err(args...) do { \ | |
449 | fprintf(f_err, ##args); \ | |
450 | if (f_err != stderr) \ | |
451 | fprintf(stderr, ##args); \ | |
452 | } while (0) | |
453 | ||
2866c82d JA |
454 | struct ioengine_ops { |
455 | char name[16]; | |
456 | int version; | |
457 | int flags; | |
458 | int (*init)(struct thread_data *); | |
459 | int (*prep)(struct thread_data *, struct io_u *); | |
460 | int (*queue)(struct thread_data *, struct io_u *); | |
461 | int (*getevents)(struct thread_data *, int, int, struct timespec *); | |
462 | struct io_u *(*event)(struct thread_data *, int); | |
463 | int (*cancel)(struct thread_data *, struct io_u *); | |
464 | void (*cleanup)(struct thread_data *); | |
465 | int (*sync)(struct thread_data *); | |
466 | void *data; | |
467 | void *dlhandle; | |
468 | }; | |
469 | ||
470 | #define FIO_IOOPS_VERSION 1 | |
471 | ||
472 | extern struct ioengine_ops *load_ioengine(struct thread_data *, char *); | |
473 | extern void close_ioengine(struct thread_data *); | |
474 | ||
475 | /* | |
476 | * Mark unused variables passed to ops functions as unused, to silence gcc | |
477 | */ | |
478 | #define fio_unused __attribute((__unused__)) | |
479 | ||
ebac4655 | 480 | #endif |