[PATCH] Fix stack overflow
[fio.git] / fio.h
CommitLineData
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>
ebac4655
JA
14
15#include "list.h"
16#include "md5.h"
17#include "crc32.h"
18#include "arch.h"
19#include "os.h"
20
1e97cce9
JA
21enum fio_ddir {
22 DDIR_READ = 0,
23 DDIR_WRITE,
24 DDIR_SYNC,
25};
26
ebac4655 27struct io_stat {
ebac4655
JA
28 unsigned long max_val;
29 unsigned long min_val;
30 unsigned long samples;
68704084
JA
31
32 double mean;
33 double S;
ebac4655
JA
34};
35
36struct io_sample {
37 unsigned long time;
38 unsigned long val;
1e97cce9 39 enum fio_ddir ddir;
ebac4655
JA
40};
41
42struct io_log {
43 unsigned long nr_samples;
44 unsigned long max_samples;
45 struct io_sample *log;
46};
47
48struct io_piece {
49 struct list_head list;
53cdc686 50 struct fio_file *file;
ebac4655
JA
51 unsigned long long offset;
52 unsigned int len;
1e97cce9 53 enum fio_ddir ddir;
ebac4655
JA
54};
55
56/*
57 * The io unit
58 */
59struct io_u {
60 union {
61#ifdef FIO_HAVE_LIBAIO
62 struct iocb iocb;
63#endif
64#ifdef FIO_HAVE_POSIXAIO
65 struct aiocb aiocb;
66#endif
67#ifdef FIO_HAVE_SGIO
68 struct sg_io_hdr hdr;
69#endif
70 };
71 struct timeval start_time;
72 struct timeval issue_time;
73
6b9cea23 74 void *buf;
ebac4655
JA
75 unsigned int buflen;
76 unsigned long long offset;
77
cec6b55d
JA
78 void *xfer_buf;
79 unsigned int xfer_buflen;
80
ebac4655
JA
81 unsigned int resid;
82 unsigned int error;
83
1e97cce9 84 enum fio_ddir ddir;
ebac4655 85
dfd7bc2c
JA
86 /*
87 * io engine private data
88 */
89 union {
90 unsigned int index;
91 unsigned int seen;
92 };
93
53cdc686
JA
94 struct fio_file *file;
95
ebac4655
JA
96 struct list_head list;
97};
98
99#define FIO_HDR_MAGIC 0xf00baaef
100
101enum {
102 VERIFY_NONE = 0,
103 VERIFY_MD5,
104 VERIFY_CRC32,
105};
106
107struct verify_header {
108 unsigned int fio_magic;
109 unsigned int len;
110 unsigned int verify_type;
111 union {
112 char md5_digest[MD5_HASH_WORDS * 4];
113 unsigned long crc32;
114 };
115};
116
117struct group_run_stats {
9104f874
JA
118 unsigned long long max_run[2], min_run[2];
119 unsigned long long max_bw[2], min_bw[2];
e9b2a3fa 120 unsigned long long io_kb[2];
9104f874 121 unsigned long long agg[2];
ebac4655
JA
122};
123
e9c047a0
JA
124/*
125 * What type of allocation to use for io buffers
126 */
127enum fio_memtype {
128 MEM_MALLOC = 0, /* ordinary malloc */
129 MEM_SHM, /* use shared memory segments */
74b025b0 130 MEM_SHMHUGE, /* use shared memory segments with huge pages */
e9c047a0 131 MEM_MMAP, /* use anonynomous mmap */
d0bdaf49 132 MEM_MMAPHUGE, /* memory mapped huge file */
e9c047a0
JA
133};
134
135/*
136 * The type of object we are working on
137 */
138enum fio_filetype {
139 FIO_TYPE_FILE = 1,
140 FIO_TYPE_BD,
141 FIO_TYPE_CHAR,
142};
143
2866c82d 144enum fio_ioengine_flags {
e9c047a0 145 FIO_SYNCIO = 1 << 0,
2866c82d
JA
146 FIO_CPUIO = 1 << 1,
147 FIO_MMAPIO = 1 << 2,
b2a15192 148 FIO_RAWIO = 1 << 3,
ed92ac0c 149 FIO_NETIO = 1 << 4,
4d9345ae 150 FIO_NULLIO = 1 << 5,
e9c047a0
JA
151};
152
53cdc686
JA
153struct fio_file {
154 /*
155 * A file may not be a file descriptor, let the io engine decide
156 */
157 union {
158 unsigned long file_data;
159 int fd;
160 };
161 char *file_name;
162 void *mmap;
163 unsigned long long file_size;
164 unsigned long long real_file_size;
165 unsigned long long file_offset;
166 unsigned long long last_pos;
02bcaa8c 167 unsigned long long last_completed_pos;
53cdc686
JA
168
169 unsigned long *file_map;
170 unsigned int num_maps;
9b031dc8
JA
171
172 unsigned int unlink;
c685b5b2
JA
173
174 unsigned int last_free_lookup;
53cdc686
JA
175};
176
71619dc2
JA
177/*
178 * How many depth levels to log
179 */
180#define FIO_IO_U_MAP_NR 8
181
e9c047a0
JA
182/*
183 * This describes a single thread/process executing a fio job.
184 */
ebac4655 185struct thread_data {
61697c37 186 char *description;
b4692828 187 char *name;
ef899b63 188 char *directory;
13f8e2d2 189 char *filename;
ebac4655
JA
190 char verror[80];
191 pthread_t thread;
192 int thread_number;
193 int groupid;
e9c047a0 194 enum fio_filetype filetype;
53cdc686
JA
195 struct fio_file *files;
196 unsigned int nr_files;
13f8e2d2 197 unsigned int nr_uniq_files;
53cdc686 198 unsigned int next_file;
ebac4655 199 int error;
ebac4655
JA
200 pid_t pid;
201 char *orig_buffer;
202 size_t orig_buffer_size;
203 volatile int terminate;
204 volatile int runstate;
e9c047a0 205 enum fio_ddir ddir;
3d60d1ed 206 unsigned int iomix;
ebac4655 207 unsigned int ioprio;
87dc1ab1 208 unsigned int last_was_sync;
e9c047a0 209
9158d2f7
JA
210 unsigned int sequential;
211 unsigned int odirect;
212 unsigned int invalidate_cache;
213 unsigned int create_serialize;
214 unsigned int create_fsync;
215 unsigned int end_fsync;
216 unsigned int sync_io;
217 unsigned int verify;
218 unsigned int use_thread;
219 unsigned int unlink;
220 unsigned int do_disk_util;
221 unsigned int override_sync;
222 unsigned int rand_repeatable;
223 unsigned int write_lat_log;
224 unsigned int write_bw_log;
bb8895e0 225 unsigned int norandommap;
690adba3 226 unsigned int bs_unaligned;
e9c047a0 227
a00735e6
JA
228 unsigned int bs[2];
229 unsigned int min_bs[2];
230 unsigned int max_bs[2];
56bb17f2 231 unsigned int hugepage_size;
a00735e6 232 unsigned int rw_min_bs;
ebac4655 233 unsigned int thinktime;
9c1f7434 234 unsigned int thinktime_blocks;
ebac4655
JA
235 unsigned int fsync_blocks;
236 unsigned int start_delay;
906c8d75 237 unsigned long timeout;
ebac4655 238 unsigned int overwrite;
ebac4655 239 unsigned int bw_avg_time;
ebac4655 240 unsigned int loops;
20dc95c4
JA
241 unsigned long long zone_size;
242 unsigned long long zone_skip;
e9c047a0 243 enum fio_memtype mem_type;
313cb206
JA
244 char *mmapfile;
245 int mmapfd;
ebac4655
JA
246 unsigned int stonewall;
247 unsigned int numjobs;
ebac4655
JA
248 unsigned int iodepth;
249 os_cpu_mask_t cpumask;
aea47d44 250 unsigned int iolog;
843a7413 251 unsigned int read_iolog;
a6ccc7be
JA
252 unsigned int rwmixcycle;
253 unsigned int rwmixread;
e1f36503 254 unsigned int rwmixwrite;
b6f4d880 255 unsigned int nice;
aea47d44 256
076efc7c
JA
257 char *read_iolog_file;
258 char *write_iolog_file;
843a7413
JA
259 void *iolog_buf;
260 FILE *iolog_f;
ebac4655 261
da86774e 262 char *sysfs_root;
da86774e
JA
263 char *ioscheduler;
264
6dfd46b9
JA
265 os_random_state_t bsrange_state;
266 os_random_state_t verify_state;
ebac4655
JA
267
268 int shm_id;
269
e9c047a0
JA
270 /*
271 * IO engine hooks, contains everything needed to submit an io_u
272 * to any of the available IO engines.
273 */
2866c82d 274 struct ioengine_ops *io_ops;
ebac4655 275
e9c047a0
JA
276 /*
277 * Current IO depth and list of free and busy io_u's.
278 */
ebac4655 279 unsigned int cur_depth;
71619dc2
JA
280 unsigned int io_u_map[FIO_IO_U_MAP_NR];
281 unsigned long total_io_u;
ebac4655
JA
282 struct list_head io_u_freelist;
283 struct list_head io_u_busylist;
284
e9c047a0
JA
285 /*
286 * Rate state
287 */
ebac4655
JA
288 unsigned int rate;
289 unsigned int ratemin;
290 unsigned int ratecycle;
291 unsigned long rate_usec_cycle;
292 long rate_pending_usleep;
293 unsigned long rate_bytes;
294 struct timeval lastrate;
295
296 unsigned long runtime[2]; /* msec */
297 unsigned long long io_size;
53cdc686
JA
298 unsigned long long total_file_size;
299 unsigned long long start_offset;
ebac4655
JA
300 unsigned long long total_io_size;
301
9104f874
JA
302 unsigned long long io_blocks[2];
303 unsigned long long io_bytes[2];
304 unsigned long long zone_bytes;
305 unsigned long long this_io_bytes[2];
bbfd6b00 306 volatile int mutex;
ebac4655 307
e9c047a0
JA
308 /*
309 * State for random io, a bitmap of blocks done vs not done
310 */
6dfd46b9 311 os_random_state_t random_state;
ebac4655 312
b990b5c0
JA
313 /*
314 * CPU "io" cycle burner
315 */
316 unsigned int cpuload;
317 unsigned int cpucycle;
318
ebac4655
JA
319 /*
320 * bandwidth and latency stats
321 */
322 struct io_stat clat_stat[2]; /* completion latency */
323 struct io_stat slat_stat[2]; /* submission latency */
324 struct io_stat bw_stat[2]; /* bandwidth stats */
325
9104f874 326 unsigned long long stat_io_bytes[2];
ebac4655
JA
327 struct timeval stat_sample_time[2];
328
329 struct io_log *slat_log;
330 struct io_log *clat_log;
331 struct io_log *bw_log;
332
333 struct timeval start; /* start of this loop */
334 struct timeval epoch; /* time job was started */
69008999 335 struct timeval end_time;/* time job ended */
ebac4655 336
e9c047a0
JA
337 /*
338 * fio system usage accounting
339 */
ebac4655
JA
340 struct rusage ru_start;
341 struct rusage ru_end;
342 unsigned long usr_time;
343 unsigned long sys_time;
344 unsigned long ctx;
345
e9c047a0
JA
346 /*
347 * read/write mixed workload state
348 */
6dfd46b9 349 os_random_state_t rwmix_state;
a6ccc7be 350 struct timeval rwmix_switch;
e9c047a0 351 enum fio_ddir rwmix_ddir;
a6ccc7be 352
4e0ba8af
JA
353 /*
354 * Pre-run and post-run shell
355 */
356 char *exec_prerun;
357 char *exec_postrun;
358
e9c047a0
JA
359 /*
360 * IO historic logs
361 */
ebac4655 362 struct list_head io_hist_list;
aea47d44 363 struct list_head io_log_list;
ebac4655
JA
364};
365
b990b5c0 366#define __td_verror(td, err, msg) \
ebac4655
JA
367 do { \
368 int e = (err); \
369 (td)->error = e; \
b990b5c0 370 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \
ebac4655
JA
371 } while (0)
372
b990b5c0
JA
373
374#define td_verror(td, err) __td_verror((td), (err), strerror((err)))
375#define td_vmsg(td, err, msg) __td_verror((td), (err), (msg))
376
ebac4655
JA
377extern int exitall_on_terminate;
378extern int thread_number;
379extern int shm_id;
380extern int groupid;
c6ae0a5b 381extern int terse_output;
eb8bbf48
JA
382extern FILE *f_out;
383extern FILE *f_err;
53cdc686 384extern int temp_stall_ts;
1e97cce9 385extern unsigned long long mlock_size;
ebac4655
JA
386
387extern struct thread_data *threads;
388
ebac4655
JA
389#define td_read(td) ((td)->ddir == DDIR_READ)
390#define td_write(td) ((td)->ddir == DDIR_WRITE)
3d60d1ed 391#define td_rw(td) ((td)->iomix != 0)
ebac4655
JA
392
393#define BLOCKS_PER_MAP (8 * sizeof(long))
a00735e6 394#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
53cdc686
JA
395#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
396#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655
JA
397
398#define MAX_JOBS (1024)
399
87dc1ab1
JA
400static inline int should_fsync(struct thread_data *td)
401{
402 if (td->last_was_sync)
403 return 0;
404 if (td->odirect)
405 return 0;
406 if (td_write(td) || td_rw(td) || td->override_sync)
407 return 1;
408
409 return 0;
410}
411
ebac4655
JA
412struct disk_util_stat {
413 unsigned ios[2];
414 unsigned merges[2];
415 unsigned long long sectors[2];
416 unsigned ticks[2];
417 unsigned io_ticks;
418 unsigned time_in_queue;
419};
420
421struct disk_util {
422 struct list_head list;
423
424 char *name;
425 char path[256];
426 dev_t dev;
427
428 struct disk_util_stat dus;
429 struct disk_util_stat last_dus;
430
431 unsigned long msec;
432 struct timeval time;
433};
434
435struct io_completion_data {
436 int nr; /* input */
437
438 int error; /* output */
439 unsigned long bytes_done[2]; /* output */
02bcaa8c 440 struct timeval time; /* output */
ebac4655
JA
441};
442
443#define DISK_UTIL_MSEC (250)
444
6a0106a0
JA
445#ifndef min
446#define min(a, b) ((a) < (b) ? (a) : (b))
447#endif
a00735e6
JA
448#ifndef max
449#define max(a, b) ((a) > (b) ? (a) : (b))
450#endif
6a0106a0 451
6796209a
JA
452/*
453 * Log exports
454 */
455extern int read_iolog_get(struct thread_data *, struct io_u *);
456extern void write_iolog_put(struct thread_data *, struct io_u *);
457extern int init_iolog(struct thread_data *td);
458extern void log_io_piece(struct thread_data *, struct io_u *);
459extern void prune_io_piece_log(struct thread_data *);
460extern void write_iolog_close(struct thread_data *);
461
462/*
463 * Logging
464 */
1e97cce9
JA
465extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
466extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
467extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
6796209a
JA
468extern void show_run_stats(void);
469extern void init_disk_util(struct thread_data *);
470extern void update_rusage_stat(struct thread_data *);
471extern void update_io_ticks(void);
472extern void disk_util_timer_arm(void);
8914a9d8
JA
473extern void setup_log(struct io_log **);
474extern void finish_log(struct thread_data *, struct io_log *, const char *);
bb3884d8 475extern void __finish_log(struct io_log *, const char *);
8914a9d8 476extern int setup_rate(struct thread_data *);
bb3884d8
JA
477extern struct io_log *agg_io_log[2];
478extern int write_bw_log;
479extern void add_agg_sample(unsigned long, enum fio_ddir);
6796209a
JA
480
481/*
482 * Time functions
483 */
484extern unsigned long utime_since(struct timeval *, struct timeval *);
69008999 485extern unsigned long utime_since_now(struct timeval *);
6796209a
JA
486extern unsigned long mtime_since(struct timeval *, struct timeval *);
487extern unsigned long mtime_since_now(struct timeval *);
488extern unsigned long time_since_now(struct timeval *);
263e529f 489extern unsigned long mtime_since_genesis(void);
b990b5c0 490extern void __usec_sleep(unsigned int);
6796209a 491extern void usec_sleep(struct thread_data *, unsigned long);
a00735e6 492extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
6043c579 493extern void fill_start_time(struct timeval *);
02bcaa8c 494extern void fio_gettime(struct timeval *, void *);
6796209a 495
8914a9d8
JA
496/*
497 * Init functions
498 */
499extern int parse_options(int, char **);
500extern int init_random_state(struct thread_data *);
501
53cdc686
JA
502/*
503 * File setup/shutdown
504 */
505extern void close_files(struct thread_data *);
506extern int setup_files(struct thread_data *);
21972cde 507extern int open_files(struct thread_data *);
e5b401d4 508extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
53cdc686 509
263e529f
JA
510/*
511 * ETA/status stuff
512 */
513extern void print_thread_status(void);
514extern void print_status_init(int);
515
516/*
517 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
518 * will never back again. It may cycle between running/verififying/fsyncing.
519 * Once the thread reaches TD_EXITED, it is just waiting for the core to
520 * reap it.
521 */
522enum {
523 TD_NOT_CREATED = 0,
524 TD_CREATED,
525 TD_INITIALIZED,
526 TD_RUNNING,
527 TD_VERIFYING,
528 TD_FSYNCING,
529 TD_EXITED,
530 TD_REAPED,
531};
532
e29d1b70
JA
533/*
534 * Verify helpers
535 */
536extern void populate_verify_io_u(struct thread_data *, struct io_u *);
537extern int get_next_verify(struct thread_data *td, struct io_u *);
a9619d44 538extern int do_io_u_verify(struct thread_data *, struct io_u **);
e29d1b70 539
2f9ade3c
JA
540/*
541 * Memory helpers
542 */
543extern int fio_pin_memory(void);
544extern void fio_unpin_memory(void);
545extern int allocate_io_mem(struct thread_data *);
546extern void free_io_mem(struct thread_data *);
547
10ba535a
JA
548/*
549 * io unit handling
550 */
551#define queue_full(td) list_empty(&(td)->io_u_freelist)
552extern struct io_u *__get_io_u(struct thread_data *);
553extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
554extern void put_io_u(struct thread_data *, struct io_u *);
555extern void ios_completed(struct thread_data *, struct io_completion_data *);
556extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
557
558/*
559 * io engine entry points
560 */
8c16d840 561extern int td_io_init(struct thread_data *);
10ba535a
JA
562extern int td_io_prep(struct thread_data *, struct io_u *);
563extern int td_io_queue(struct thread_data *, struct io_u *);
564extern int td_io_sync(struct thread_data *, struct fio_file *);
565extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
566
bbfd6b00
JA
567/*
568 * This is a pretty crappy semaphore implementation, but with the use that fio
569 * has (just signalling start/go conditions), it doesn't have to be better.
570 * Naturally this would not work for any type of contended semaphore or
571 * for real locking.
572 */
1056eaad 573static inline void fio_sem_init(volatile int *sem, int val)
bbfd6b00
JA
574{
575 *sem = val;
576}
577
1056eaad 578static inline void fio_sem_down(volatile int *sem)
bbfd6b00
JA
579{
580 while (*sem == 0)
581 usleep(10000);
582
583 (*sem)--;
584}
585
1056eaad 586static inline void fio_sem_up(volatile int *sem)
bbfd6b00
JA
587{
588 (*sem)++;
589}
590
3b70d7e5
JA
591/*
592 * If logging output to a file, stderr should go to both stderr and f_err
593 */
594#define log_err(args...) do { \
595 fprintf(f_err, ##args); \
596 if (f_err != stderr) \
597 fprintf(stderr, ##args); \
598 } while (0)
599
2866c82d 600struct ioengine_ops {
5f350952 601 struct list_head list;
2866c82d
JA
602 char name[16];
603 int version;
604 int flags;
ea2877a4 605 int (*setup)(struct thread_data *);
2866c82d
JA
606 int (*init)(struct thread_data *);
607 int (*prep)(struct thread_data *, struct io_u *);
608 int (*queue)(struct thread_data *, struct io_u *);
609 int (*getevents)(struct thread_data *, int, int, struct timespec *);
610 struct io_u *(*event)(struct thread_data *, int);
611 int (*cancel)(struct thread_data *, struct io_u *);
612 void (*cleanup)(struct thread_data *);
2866c82d
JA
613 void *data;
614 void *dlhandle;
615};
616
87dc1ab1 617#define FIO_IOOPS_VERSION 3
2866c82d 618
b4692828 619extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
5f350952
JA
620extern int register_ioengine(struct ioengine_ops *);
621extern void unregister_ioengine(struct ioengine_ops *);
2866c82d
JA
622extern void close_ioengine(struct thread_data *);
623
624/*
625 * Mark unused variables passed to ops functions as unused, to silence gcc
626 */
627#define fio_unused __attribute((__unused__))
5f350952
JA
628#define fio_init __attribute__((constructor))
629#define fio_exit __attribute__((destructor))
2866c82d 630
34572e28
JA
631#define for_each_td(td, i) \
632 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686 633#define for_each_file(td, f, i) \
34572e28 634 for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
53cdc686 635
ebac4655 636#endif