Remove ->mutex after last use, not on job exit
[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 #include "mutex.h"
21
22 #ifdef FIO_HAVE_SYSLET
23 #include "syslet.h"
24 #endif
25
26 enum fio_ddir {
27         DDIR_READ = 0,
28         DDIR_WRITE,
29         DDIR_SYNC,
30 };
31
32 enum td_ddir {
33         TD_DDIR_READ            = 1 << 0,
34         TD_DDIR_WRITE           = 1 << 1,
35         TD_DDIR_RAND            = 1 << 2,
36         TD_DDIR_RW              = TD_DDIR_READ | TD_DDIR_WRITE,
37         TD_DDIR_RANDREAD        = TD_DDIR_READ | TD_DDIR_RAND,
38         TD_DDIR_RANDWRITE       = TD_DDIR_WRITE | TD_DDIR_RAND,
39         TD_DDIR_RANDRW          = TD_DDIR_RW | TD_DDIR_RAND,
40 };
41
42 /*
43  * Use for maintaining statistics
44  */
45 struct io_stat {
46         unsigned long max_val;
47         unsigned long min_val;
48         unsigned long samples;
49
50         double mean;
51         double S;
52 };
53
54 /*
55  * A single data sample
56  */
57 struct io_sample {
58         unsigned long time;
59         unsigned long val;
60         enum fio_ddir ddir;
61 };
62
63 /*
64  * Dynamically growing data sample log
65  */
66 struct io_log {
67         unsigned long nr_samples;
68         unsigned long max_samples;
69         struct io_sample *log;
70 };
71
72 /*
73  * When logging io actions, this matches a single sent io_u
74  */
75 struct io_piece {
76         struct list_head list;
77         struct fio_file *file;
78         unsigned long long offset;
79         unsigned long len;
80         enum fio_ddir ddir;
81 };
82
83 #ifdef FIO_HAVE_SYSLET
84 struct syslet_req {
85         struct syslet_uatom atom;       /* the atom to submit */
86         struct syslet_uatom *head;      /* head of the sequence */
87         long ret;                       /* syscall return value */
88 };
89 #endif
90
91 enum {
92         IO_U_F_FREE     = 1 << 0,
93         IO_U_F_FLIGHT   = 1 << 1,
94 };
95
96 /*
97  * The io unit
98  */
99 struct io_u {
100         union {
101 #ifdef FIO_HAVE_LIBAIO
102                 struct iocb iocb;
103 #endif
104 #ifdef FIO_HAVE_POSIXAIO
105                 struct aiocb aiocb;
106 #endif
107 #ifdef FIO_HAVE_SGIO
108                 struct sg_io_hdr hdr;
109 #endif
110 #ifdef FIO_HAVE_SYSLET
111                 struct syslet_req req;
112 #endif
113         };
114         struct timeval start_time;
115         struct timeval issue_time;
116
117         /*
118          * Allocated/set buffer and length
119          */
120         void *buf;
121         unsigned long buflen;
122         unsigned long long offset;
123
124         /*
125          * IO engine state, may be different from above when we get
126          * partial transfers / residual data counts
127          */
128         void *xfer_buf;
129         unsigned long xfer_buflen;
130
131         unsigned int resid;
132         unsigned int error;
133
134         enum fio_ddir ddir;
135
136         /*
137          * io engine private data
138          */
139         union {
140                 unsigned int index;
141                 unsigned int seen;
142         };
143
144         unsigned int flags;
145
146         struct fio_file *file;
147
148         struct list_head list;
149
150         /*
151          * Callback for io completion
152          */
153         int (*end_io)(struct io_u *);
154 };
155
156 /*
157  * io_ops->queue() return values
158  */
159 enum {
160         FIO_Q_COMPLETED = 0,            /* completed sync */
161         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
162         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
163 };
164
165 #define FIO_HDR_MAGIC   0xf00baaef
166
167 enum {
168         VERIFY_NONE = 0,                /* no verification */
169         VERIFY_MD5,                     /* md5 sum data blocks */
170         VERIFY_CRC32,                   /* crc32 sum data blocks */
171 };
172
173 /*
174  * A header structure associated with each checksummed data block
175  */
176 struct verify_header {
177         unsigned int fio_magic;
178         unsigned int len;
179         unsigned int verify_type;
180         union {
181                 char md5_digest[MD5_HASH_WORDS * 4];
182                 unsigned long crc32;
183         };
184 };
185
186 struct group_run_stats {
187         unsigned long long max_run[2], min_run[2];
188         unsigned long long max_bw[2], min_bw[2];
189         unsigned long long io_kb[2];
190         unsigned long long agg[2];
191 };
192
193 /*
194  * What type of allocation to use for io buffers
195  */
196 enum fio_memtype {
197         MEM_MALLOC = 0, /* ordinary malloc */
198         MEM_SHM,        /* use shared memory segments */
199         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
200         MEM_MMAP,       /* use anonynomous mmap */
201         MEM_MMAPHUGE,   /* memory mapped huge file */
202 };
203
204 /*
205  * The type of object we are working on
206  */
207 enum fio_filetype {
208         FIO_TYPE_FILE = 1,              /* plain file */
209         FIO_TYPE_BD,                    /* block device */
210         FIO_TYPE_CHAR,                  /* character device */
211 };
212
213 enum fio_ioengine_flags {
214         FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
215         FIO_CPUIO       = 1 << 1,       /* cpu burner, doesn't do real io */
216         FIO_RAWIO       = 1 << 2,       /* some sort of direct/raw io */
217         FIO_DISKLESSIO  = 1 << 3,       /* no disk involved */
218 };
219
220 /*
221  * Each thread_data structure has a number of files associated with it,
222  * this structure holds state information for a single file.
223  */
224 struct fio_file {
225         /*
226          * A file may not be a file descriptor, let the io engine decide
227          */
228         union {
229                 unsigned long file_data;
230                 int fd;
231         };
232         char *file_name;
233         void *mmap;
234         unsigned long long file_size;
235         unsigned long long real_file_size;
236         unsigned long long file_offset;
237         unsigned long long last_pos;
238         unsigned long long last_completed_pos;
239
240         /*
241          * block map for random io
242          */
243         unsigned long *file_map;
244         unsigned int num_maps;
245         unsigned int last_free_lookup;
246
247         unsigned int unlink;
248         unsigned int open;
249 };
250
251 /*
252  * How many depth levels to log
253  */
254 #define FIO_IO_U_MAP_NR 8
255 #define FIO_IO_U_LAT_NR 12
256
257 struct thread_stat {
258         char *name;
259         char *verror;
260         int error;
261         int groupid;
262         pid_t pid;
263         char *description;
264         int members;
265
266         struct io_log *slat_log;
267         struct io_log *clat_log;
268         struct io_log *bw_log;
269
270         /*
271          * bandwidth and latency stats
272          */
273         struct io_stat clat_stat[2];            /* completion latency */
274         struct io_stat slat_stat[2];            /* submission latency */
275         struct io_stat bw_stat[2];              /* bandwidth stats */
276
277         unsigned long long stat_io_bytes[2];
278         struct timeval stat_sample_time[2];
279
280         /*
281          * fio system usage accounting
282          */
283         struct rusage ru_start;
284         struct rusage ru_end;
285         unsigned long usr_time;
286         unsigned long sys_time;
287         unsigned long ctx;
288
289         /*
290          * IO depth and latency stats
291          */
292         unsigned int io_u_map[FIO_IO_U_MAP_NR];
293         unsigned int io_u_lat[FIO_IO_U_LAT_NR];
294         unsigned long total_io_u;
295
296         unsigned long long io_bytes[2];
297         unsigned long runtime[2];
298         unsigned long total_run_time;
299 };
300
301 /*
302  * This describes a single thread/process executing a fio job.
303  */
304 struct thread_data {
305         int pad;
306         char *description;
307         char *name;
308         char *directory;
309         char *filename;
310         char *ioengine;
311         char verror[128];
312         pthread_t thread;
313         int thread_number;
314         int groupid;
315         struct thread_stat ts;
316         enum fio_filetype filetype;
317         struct fio_file *files;
318         unsigned int nr_files;
319         unsigned int nr_open_files;
320         unsigned int nr_uniq_files;
321         union {
322                 unsigned int next_file;
323                 os_random_state_t next_file_state;
324         };
325         int error;
326         pid_t pid;
327         char *orig_buffer;
328         size_t orig_buffer_size;
329         volatile int terminate;
330         volatile int runstate;
331         enum td_ddir td_ddir;
332         unsigned int ioprio;
333         unsigned int last_was_sync;
334
335         unsigned int odirect;
336         unsigned int invalidate_cache;
337         unsigned int create_serialize;
338         unsigned int create_fsync;
339         unsigned int end_fsync;
340         unsigned int sync_io;
341         unsigned int verify;
342         unsigned int use_thread;
343         unsigned int unlink;
344         unsigned int do_disk_util;
345         unsigned int override_sync;
346         unsigned int rand_repeatable;
347         unsigned int write_lat_log;
348         unsigned int write_bw_log;
349         unsigned int norandommap;
350         unsigned int bs_unaligned;
351
352         unsigned int bs[2];
353         unsigned int min_bs[2];
354         unsigned int max_bs[2];
355         unsigned int hugepage_size;
356         unsigned int rw_min_bs;
357         unsigned int thinktime;
358         unsigned int thinktime_spin;
359         unsigned int thinktime_blocks;
360         unsigned int fsync_blocks;
361         unsigned int start_delay;
362         unsigned long timeout;
363         unsigned int overwrite;
364         unsigned int bw_avg_time;
365         unsigned int loops;
366         unsigned long long zone_size;
367         unsigned long long zone_skip;
368         enum fio_memtype mem_type;
369         char *mmapfile;
370         int mmapfd;
371         unsigned int stonewall;
372         unsigned int numjobs;
373         unsigned int iodepth;
374         unsigned int iodepth_low;
375         unsigned int iodepth_batch;
376         os_cpu_mask_t cpumask;
377         unsigned int iolog;
378         unsigned int read_iolog;
379         unsigned int rwmixcycle;
380         unsigned int rwmixread;
381         unsigned int rwmixwrite;
382         unsigned int nice;
383         unsigned int file_service_type;
384         unsigned int group_reporting;
385         unsigned int open_files;
386
387         char *read_iolog_file;
388         char *write_iolog_file;
389         void *iolog_buf;
390         FILE *iolog_f;
391
392         char *sysfs_root;
393         char *ioscheduler;
394
395         os_random_state_t bsrange_state;
396         os_random_state_t verify_state;
397
398         int shm_id;
399
400         /*
401          * IO engine hooks, contains everything needed to submit an io_u
402          * to any of the available IO engines.
403          */
404         struct ioengine_ops *io_ops;
405
406         /*
407          * Current IO depth and list of free and busy io_u's.
408          */
409         unsigned int cur_depth;
410         struct list_head io_u_freelist;
411         struct list_head io_u_busylist;
412         struct list_head io_u_requeues;
413         unsigned int io_u_queued;
414
415         /*
416          * Rate state
417          */
418         unsigned int rate;
419         unsigned int ratemin;
420         unsigned int ratecycle;
421         unsigned long rate_usec_cycle;
422         long rate_pending_usleep;
423         unsigned long rate_bytes;
424         struct timeval lastrate;
425
426         unsigned long long io_size;
427         unsigned long long total_file_size;
428         unsigned long long start_offset;
429         unsigned long long total_io_size;
430
431         unsigned long io_issues[2];
432         unsigned long long io_blocks[2];
433         unsigned long long io_bytes[2];
434         unsigned long long this_io_bytes[2];
435         unsigned long long zone_bytes;
436         struct fio_sem *mutex;
437
438         /*
439          * State for random io, a bitmap of blocks done vs not done
440          */
441         os_random_state_t random_state;
442
443         /*
444          * CPU "io" cycle burner
445          */
446         unsigned int cpuload;
447         unsigned int cpucycle;
448
449         struct timeval start;   /* start of this loop */
450         struct timeval epoch;   /* time job was started */
451
452         /*
453          * read/write mixed workload state
454          */
455         os_random_state_t rwmix_state;
456         struct timeval rwmix_switch;
457         enum fio_ddir rwmix_ddir;
458
459         /*
460          * Pre-run and post-run shell
461          */
462         char *exec_prerun;
463         char *exec_postrun;
464
465         /*
466          * IO historic logs
467          */
468         struct list_head io_hist_list;
469         struct list_head io_log_list;
470
471         /*
472          * timeout handling
473          */
474         struct timeval timeout_end;
475         struct itimerval timer;
476 };
477
478 /*
479  * roundrobin available files, or choose one at random.
480  */
481 enum {
482         FIO_FSERVICE_RANDOM     = 1,
483         FIO_FSERVICE_RR         = 2,
484 };
485
486 /*
487  * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
488  * the timer on each queue operation.
489  */
490 #define IO_U_TIMEOUT_INC        5
491 #define IO_U_TIMEOUT            30
492
493 #define __td_verror(td, err, msg, func)                                 \
494         do {                                                            \
495                 if ((td)->error)                                        \
496                         break;                                          \
497                 int e = (err);                                          \
498                 (td)->error = e;                                        \
499                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
500         } while (0)
501
502
503 #define td_verror(td, err, func)        \
504         __td_verror((td), (err), strerror((err)), (func))
505 #define td_vmsg(td, err, msg, func)     \
506         __td_verror((td), (err), (msg), (func))
507
508 extern int exitall_on_terminate;
509 extern int thread_number;
510 extern int shm_id;
511 extern int groupid;
512 extern int terse_output;
513 extern FILE *f_out;
514 extern FILE *f_err;
515 extern int temp_stall_ts;
516 extern unsigned long long mlock_size;
517
518 extern struct thread_data *threads;
519
520 #define td_read(td)             ((td)->td_ddir & TD_DDIR_READ)
521 #define td_write(td)            ((td)->td_ddir & TD_DDIR_WRITE)
522 #define td_rw(td)               (((td)->td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
523 #define td_random(td)           ((td)->td_ddir & TD_DDIR_RAND)
524
525 #define BLOCKS_PER_MAP          (8 * sizeof(long))
526 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->rw_min_bs))
527 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
528 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
529
530 #define MAX_JOBS        (1024)
531
532 static inline int should_fsync(struct thread_data *td)
533 {
534         if (td->last_was_sync)
535                 return 0;
536         if (td->odirect)
537                 return 0;
538         if (td_write(td) || td_rw(td) || td->override_sync)
539                 return 1;
540
541         return 0;
542 }
543
544 /*
545  * Disk utils as read in /sys/block/<dev>/stat
546  */
547 struct disk_util_stat {
548         unsigned ios[2];
549         unsigned merges[2];
550         unsigned long long sectors[2];
551         unsigned ticks[2];
552         unsigned io_ticks;
553         unsigned time_in_queue;
554 };
555
556 /*
557  * Per-device disk util management
558  */
559 struct disk_util {
560         struct list_head list;
561
562         char *name;
563         char path[256];
564         dev_t dev;
565
566         struct disk_util_stat dus;
567         struct disk_util_stat last_dus;
568
569         unsigned long msec;
570         struct timeval time;
571 };
572
573 #define DISK_UTIL_MSEC  (250)
574
575 #ifndef min
576 #define min(a, b)       ((a) < (b) ? (a) : (b))
577 #endif
578 #ifndef max
579 #define max(a, b)       ((a) > (b) ? (a) : (b))
580 #endif
581
582 /*
583  * Log exports
584  */
585 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
586 extern void write_iolog_put(struct thread_data *, struct io_u *);
587 extern int __must_check init_iolog(struct thread_data *td);
588 extern void log_io_piece(struct thread_data *, struct io_u *);
589 extern void prune_io_piece_log(struct thread_data *);
590 extern void write_iolog_close(struct thread_data *);
591
592 /*
593  * Logging
594  */
595 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
596 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
597 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
598 extern void show_run_stats(void);
599 extern void init_disk_util(struct thread_data *);
600 extern void update_rusage_stat(struct thread_data *);
601 extern void update_io_ticks(void);
602 extern void disk_util_timer_arm(void);
603 extern void setup_log(struct io_log **);
604 extern void finish_log(struct thread_data *, struct io_log *, const char *);
605 extern void __finish_log(struct io_log *, const char *);
606 extern int setup_rate(struct thread_data *);
607 extern struct io_log *agg_io_log[2];
608 extern int write_bw_log;
609 extern void add_agg_sample(unsigned long, enum fio_ddir);
610
611 /*
612  * Time functions
613  */
614 extern unsigned long utime_since(struct timeval *, struct timeval *);
615 extern unsigned long utime_since_now(struct timeval *);
616 extern unsigned long mtime_since(struct timeval *, struct timeval *);
617 extern unsigned long mtime_since_now(struct timeval *);
618 extern unsigned long time_since_now(struct timeval *);
619 extern unsigned long mtime_since_genesis(void);
620 extern void __usec_sleep(unsigned int);
621 extern void usec_sleep(struct thread_data *, unsigned long);
622 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
623 extern void fill_start_time(struct timeval *);
624 extern void fio_gettime(struct timeval *, void *);
625 extern void set_genesis_time(void);
626
627 /*
628  * Init functions
629  */
630 extern int __must_check parse_options(int, char **);
631 extern int __must_check init_random_state(struct thread_data *);
632
633 /*
634  * File setup/shutdown
635  */
636 extern void close_files(struct thread_data *);
637 extern int __must_check setup_files(struct thread_data *);
638 extern int __must_check open_files(struct thread_data *);
639 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
640 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
641 extern void generic_close_file(struct thread_data *, struct fio_file *);
642
643 /*
644  * ETA/status stuff
645  */
646 extern void print_thread_status(void);
647 extern void print_status_init(int);
648
649 /*
650  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
651  * will never back again. It may cycle between running/verififying/fsyncing.
652  * Once the thread reaches TD_EXITED, it is just waiting for the core to
653  * reap it.
654  */
655 enum {
656         TD_NOT_CREATED = 0,
657         TD_CREATED,
658         TD_INITIALIZED,
659         TD_RUNNING,
660         TD_VERIFYING,
661         TD_FSYNCING,
662         TD_EXITED,
663         TD_REAPED,
664 };
665
666 /*
667  * Verify helpers
668  */
669 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
670 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
671 extern int __must_check verify_io_u(struct io_u *);
672
673 /*
674  * Memory helpers
675  */
676 extern int __must_check fio_pin_memory(void);
677 extern void fio_unpin_memory(void);
678 extern int __must_check allocate_io_mem(struct thread_data *);
679 extern void free_io_mem(struct thread_data *);
680
681 /*
682  * io unit handling
683  */
684 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
685 extern struct io_u *__get_io_u(struct thread_data *);
686 extern struct io_u *get_io_u(struct thread_data *);
687 extern void put_io_u(struct thread_data *, struct io_u *);
688 extern void requeue_io_u(struct thread_data *, struct io_u **);
689 extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
690 extern long __must_check io_u_queued_complete(struct thread_data *, int);
691 extern void io_u_queued(struct thread_data *, struct io_u *);
692 extern void io_u_log_error(struct thread_data *, struct io_u *);
693 extern void io_u_init_timeout(void);
694 extern void io_u_set_timeout(struct thread_data *);
695
696 /*
697  * io engine entry points
698  */
699 extern int __must_check td_io_init(struct thread_data *);
700 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
701 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
702 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
703 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
704 extern int __must_check td_io_commit(struct thread_data *);
705 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
706 extern void td_io_close_file(struct thread_data *, struct fio_file *);
707
708 /*
709  * If logging output to a file, stderr should go to both stderr and f_err
710  */
711 #define log_err(args...)        do {            \
712         fprintf(f_err, ##args);                 \
713         if (f_err != stderr)                    \
714                 fprintf(stderr, ##args);        \
715         } while (0)
716
717 FILE *get_f_out(void);
718 FILE *get_f_err(void);
719
720 struct ioengine_ops {
721         struct list_head list;
722         char name[16];
723         int version;
724         int flags;
725         int (*setup)(struct thread_data *);
726         int (*init)(struct thread_data *);
727         int (*prep)(struct thread_data *, struct io_u *);
728         int (*queue)(struct thread_data *, struct io_u *);
729         int (*commit)(struct thread_data *);
730         int (*getevents)(struct thread_data *, int, int, struct timespec *);
731         struct io_u *(*event)(struct thread_data *, int);
732         int (*cancel)(struct thread_data *, struct io_u *);
733         void (*cleanup)(struct thread_data *);
734         int (*open_file)(struct thread_data *, struct fio_file *);
735         void (*close_file)(struct thread_data *, struct fio_file *);
736         void *data;
737         void *dlhandle;
738 };
739
740 #define FIO_IOOPS_VERSION       6
741
742 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
743 extern void register_ioengine(struct ioengine_ops *);
744 extern void unregister_ioengine(struct ioengine_ops *);
745 extern void close_ioengine(struct thread_data *);
746
747 /*
748  * Mark unused variables passed to ops functions as unused, to silence gcc
749  */
750 #define fio_unused      __attribute((__unused__))
751 #define fio_init        __attribute__((constructor))
752 #define fio_exit        __attribute__((destructor))
753
754 #define for_each_td(td, i)      \
755         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
756 #define for_each_file(td, f, i) \
757         for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->open_files; (i)++, (f)++)
758
759 #define fio_assert(td, cond)    do {    \
760         if (!(cond)) {                  \
761                 int *__foo = NULL;      \
762                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
763                 (td)->runstate = TD_EXITED;     \
764                 (td)->error = EFAULT;           \
765                 *__foo = 0;                     \
766         }       \
767 } while (0)
768
769 #endif