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