[PATCH] Make ctrl-c work with network io and accept loop
[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 enum fio_ddir {
22         DDIR_READ = 0,
23         DDIR_WRITE,
24         DDIR_SYNC,
25 };
26
27 struct io_stat {
28         unsigned long max_val;
29         unsigned long min_val;
30         unsigned long samples;
31
32         double mean;
33         double S;
34 };
35
36 struct io_sample {
37         unsigned long time;
38         unsigned long val;
39         enum fio_ddir ddir;
40 };
41
42 struct io_log {
43         unsigned long nr_samples;
44         unsigned long max_samples;
45         struct io_sample *log;
46 };
47
48 struct io_piece {
49         struct list_head list;
50         struct fio_file *file;
51         unsigned long long offset;
52         unsigned int len;
53         enum fio_ddir ddir;
54 };
55
56 /*
57  * The io unit
58  */
59 struct 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
74         void *buf;
75         unsigned int buflen;
76         unsigned long long offset;
77
78         void *xfer_buf;
79         unsigned int xfer_buflen;
80
81         unsigned int resid;
82         unsigned int error;
83
84         enum fio_ddir ddir;
85
86         /*
87          * io engine private data
88          */
89         union {
90                 unsigned int index;
91                 unsigned int seen;
92         };
93
94         struct fio_file *file;
95
96         struct list_head list;
97 };
98
99 #define FIO_HDR_MAGIC   0xf00baaef
100
101 enum {
102         VERIFY_NONE = 0,
103         VERIFY_MD5,
104         VERIFY_CRC32,
105 };
106
107 struct 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
117 struct group_run_stats {
118         unsigned long long max_run[2], min_run[2];
119         unsigned long long max_bw[2], min_bw[2];
120         unsigned long long io_kb[2];
121         unsigned long long agg[2];
122 };
123
124 /*
125  * What type of allocation to use for io buffers
126  */
127 enum fio_memtype {
128         MEM_MALLOC = 0, /* ordinary malloc */
129         MEM_SHM,        /* use shared memory segments */
130         MEM_SHMHUGE,    /* use shared memory segments with huge pages */
131         MEM_MMAP,       /* use anonynomous mmap */
132         MEM_MMAPHUGE,   /* memory mapped huge file */
133 };
134
135 /*
136  * The type of object we are working on
137  */
138 enum fio_filetype {
139         FIO_TYPE_FILE = 1,
140         FIO_TYPE_BD,
141         FIO_TYPE_CHAR,
142 };
143
144 enum fio_ioengine_flags {
145         FIO_SYNCIO      = 1 << 0,
146         FIO_CPUIO       = 1 << 1,
147         FIO_MMAPIO      = 1 << 2,
148         FIO_RAWIO       = 1 << 3,
149         FIO_NETIO       = 1 << 4,
150         FIO_NULLIO      = 1 << 5,
151 };
152
153 struct 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;
167         unsigned long long last_completed_pos;
168
169         unsigned long *file_map;
170         unsigned int num_maps;
171
172         unsigned int unlink;
173
174         unsigned int last_free_lookup;
175 };
176
177 /*
178  * How many depth levels to log
179  */
180 #define FIO_IO_U_MAP_NR 8
181
182 /*
183  * This describes a single thread/process executing a fio job.
184  */
185 struct thread_data {
186         char *description;
187         char *name;
188         char *directory;
189         char *filename;
190         char verror[80];
191         pthread_t thread;
192         int thread_number;
193         int groupid;
194         enum fio_filetype filetype;
195         struct fio_file *files;
196         unsigned int nr_files;
197         unsigned int nr_uniq_files;
198         unsigned int next_file;
199         int error;
200         pid_t pid;
201         char *orig_buffer;
202         size_t orig_buffer_size;
203         volatile int terminate;
204         volatile int runstate;
205         enum fio_ddir ddir;
206         unsigned int iomix;
207         unsigned int ioprio;
208         unsigned int last_was_sync;
209
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;
225         unsigned int norandommap;
226         unsigned int bs_unaligned;
227
228         unsigned int bs[2];
229         unsigned int min_bs[2];
230         unsigned int max_bs[2];
231         unsigned int hugepage_size;
232         unsigned int rw_min_bs;
233         unsigned int thinktime;
234         unsigned int thinktime_blocks;
235         unsigned int fsync_blocks;
236         unsigned int start_delay;
237         unsigned long timeout;
238         unsigned int overwrite;
239         unsigned int bw_avg_time;
240         unsigned int loops;
241         unsigned long long zone_size;
242         unsigned long long zone_skip;
243         enum fio_memtype mem_type;
244         char *mmapfile;
245         int mmapfd;
246         unsigned int stonewall;
247         unsigned int numjobs;
248         unsigned int iodepth;
249         os_cpu_mask_t cpumask;
250         unsigned int iolog;
251         unsigned int read_iolog;
252         unsigned int rwmixcycle;
253         unsigned int rwmixread;
254         unsigned int rwmixwrite;
255         unsigned int nice;
256
257         char *read_iolog_file;
258         char *write_iolog_file;
259         void *iolog_buf;
260         FILE *iolog_f;
261
262         char *sysfs_root;
263         char *ioscheduler;
264
265         os_random_state_t bsrange_state;
266         os_random_state_t verify_state;
267
268         int shm_id;
269
270         /*
271          * IO engine hooks, contains everything needed to submit an io_u
272          * to any of the available IO engines.
273          */
274         struct ioengine_ops *io_ops;
275
276         /*
277          * Current IO depth and list of free and busy io_u's.
278          */
279         unsigned int cur_depth;
280         unsigned int io_u_map[FIO_IO_U_MAP_NR];
281         unsigned long total_io_u;
282         struct list_head io_u_freelist;
283         struct list_head io_u_busylist;
284
285         /*
286          * Rate state
287          */
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;
298         unsigned long long total_file_size;
299         unsigned long long start_offset;
300         unsigned long long total_io_size;
301
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];
306         volatile int mutex;
307
308         /*
309          * State for random io, a bitmap of blocks done vs not done
310          */
311         os_random_state_t random_state;
312
313         /*
314          * CPU "io" cycle burner
315          */
316         unsigned int cpuload;
317         unsigned int cpucycle;
318
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
326         unsigned long long stat_io_bytes[2];
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 */
335         struct timeval end_time;/* time job ended */
336
337         /*
338          * fio system usage accounting
339          */
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
346         /*
347          * read/write mixed workload state
348          */
349         os_random_state_t rwmix_state;
350         struct timeval rwmix_switch;
351         enum fio_ddir rwmix_ddir;
352
353         /*
354          * Pre-run and post-run shell
355          */
356         char *exec_prerun;
357         char *exec_postrun;
358
359         /*
360          * IO historic logs
361          */
362         struct list_head io_hist_list;
363         struct list_head io_log_list;
364 };
365
366 #define __td_verror(td, err, msg)                                       \
367         do {                                                            \
368                 int e = (err);                                          \
369                 (td)->error = e;                                        \
370                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg));        \
371         } while (0)
372
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
377 extern int exitall_on_terminate;
378 extern int thread_number;
379 extern int shm_id;
380 extern int groupid;
381 extern int terse_output;
382 extern FILE *f_out;
383 extern FILE *f_err;
384 extern int temp_stall_ts;
385 extern unsigned long long mlock_size;
386
387 extern struct thread_data *threads;
388
389 #define td_read(td)             ((td)->ddir == DDIR_READ)
390 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
391 #define td_rw(td)               ((td)->iomix != 0)
392
393 #define BLOCKS_PER_MAP          (8 * sizeof(long))
394 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->rw_min_bs))
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))
397
398 #define MAX_JOBS        (1024)
399
400 static 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
412 struct 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
421 struct 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
435 struct io_completion_data {
436         int nr;                         /* input */
437
438         int error;                      /* output */
439         unsigned long bytes_done[2];    /* output */
440         struct timeval time;            /* output */
441 };
442
443 #define DISK_UTIL_MSEC  (250)
444
445 #ifndef min
446 #define min(a, b)       ((a) < (b) ? (a) : (b))
447 #endif
448 #ifndef max
449 #define max(a, b)       ((a) > (b) ? (a) : (b))
450 #endif
451
452 /*
453  * Log exports
454  */
455 extern int read_iolog_get(struct thread_data *, struct io_u *);
456 extern void write_iolog_put(struct thread_data *, struct io_u *);
457 extern int init_iolog(struct thread_data *td);
458 extern void log_io_piece(struct thread_data *, struct io_u *);
459 extern void prune_io_piece_log(struct thread_data *);
460 extern void write_iolog_close(struct thread_data *);
461
462 /*
463  * Logging
464  */
465 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
466 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
467 extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
468 extern void show_run_stats(void);
469 extern void init_disk_util(struct thread_data *);
470 extern void update_rusage_stat(struct thread_data *);
471 extern void update_io_ticks(void);
472 extern void disk_util_timer_arm(void);
473 extern void setup_log(struct io_log **);
474 extern void finish_log(struct thread_data *, struct io_log *, const char *);
475 extern void __finish_log(struct io_log *, const char *);
476 extern int setup_rate(struct thread_data *);
477 extern struct io_log *agg_io_log[2];
478 extern int write_bw_log;
479 extern void add_agg_sample(unsigned long, enum fio_ddir);
480
481 /*
482  * Time functions
483  */
484 extern unsigned long utime_since(struct timeval *, struct timeval *);
485 extern unsigned long utime_since_now(struct timeval *);
486 extern unsigned long mtime_since(struct timeval *, struct timeval *);
487 extern unsigned long mtime_since_now(struct timeval *);
488 extern unsigned long time_since_now(struct timeval *);
489 extern unsigned long mtime_since_genesis(void);
490 extern void __usec_sleep(unsigned int);
491 extern void usec_sleep(struct thread_data *, unsigned long);
492 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
493 extern void fill_start_time(struct timeval *);
494 extern void fio_gettime(struct timeval *, void *);
495
496 /*
497  * Init functions
498  */
499 extern int parse_options(int, char **);
500 extern int init_random_state(struct thread_data *);
501
502 /*
503  * File setup/shutdown
504  */
505 extern void close_files(struct thread_data *);
506 extern int setup_files(struct thread_data *);
507 extern int open_files(struct thread_data *);
508 extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
509
510 /*
511  * ETA/status stuff
512  */
513 extern void print_thread_status(void);
514 extern 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  */
522 enum {
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
533 /*
534  * Verify helpers
535  */
536 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
537 extern int get_next_verify(struct thread_data *td, struct io_u *);
538 extern int do_io_u_verify(struct thread_data *, struct io_u **);
539
540 /*
541  * Memory helpers
542  */
543 extern int fio_pin_memory(void);
544 extern void fio_unpin_memory(void);
545 extern int allocate_io_mem(struct thread_data *);
546 extern void free_io_mem(struct thread_data *);
547
548 /*
549  * io unit handling
550  */
551 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
552 extern struct io_u *__get_io_u(struct thread_data *);
553 extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
554 extern void put_io_u(struct thread_data *, struct io_u *);
555 extern void ios_completed(struct thread_data *, struct io_completion_data *);
556 extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
557
558 /*
559  * io engine entry points
560  */
561 extern int td_io_init(struct thread_data *);
562 extern int td_io_prep(struct thread_data *, struct io_u *);
563 extern int td_io_queue(struct thread_data *, struct io_u *);
564 extern int td_io_sync(struct thread_data *, struct fio_file *);
565 extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
566
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  */
573 static inline void fio_sem_init(volatile int *sem, int val)
574 {
575         *sem = val;
576 }
577
578 static inline void fio_sem_down(volatile int *sem)
579 {
580         while (*sem == 0)
581                 usleep(10000);
582
583         (*sem)--;
584 }
585
586 static inline void fio_sem_up(volatile int *sem)
587 {
588         (*sem)++;
589 }
590
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
600 struct ioengine_ops {
601         struct list_head list;
602         char name[16];
603         int version;
604         int flags;
605         int (*setup)(struct thread_data *);
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 *);
613         void *data;
614         void *dlhandle;
615 };
616
617 #define FIO_IOOPS_VERSION       3
618
619 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
620 extern int register_ioengine(struct ioengine_ops *);
621 extern void unregister_ioengine(struct ioengine_ops *);
622 extern 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__))
628 #define fio_init        __attribute__((constructor))
629 #define fio_exit        __attribute__((destructor))
630
631 #define for_each_td(td, i)      \
632         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
633 #define for_each_file(td, f, i) \
634         for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
635
636 #endif