[PATCH] Improve time accounting for a job
[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         unsigned long long last_completed_pos;
160
161         unsigned long *file_map;
162         unsigned int num_maps;
163 };
164
165 /*
166  * This describes a single thread/process executing a fio job.
167  */
168 struct thread_data {
169         char *name;
170         char *directory;
171         char *filename;
172         char verror[80];
173         pthread_t thread;
174         int thread_number;
175         int groupid;
176         enum fio_filetype filetype;
177         struct fio_file *files;
178         unsigned int nr_files;
179         unsigned int nr_uniq_files;
180         unsigned int next_file;
181         int error;
182         pid_t pid;
183         char *orig_buffer;
184         size_t orig_buffer_size;
185         volatile int terminate;
186         volatile int runstate;
187         enum fio_ddir ddir;
188         unsigned int iomix;
189         unsigned int ioprio;
190         unsigned int last_was_sync;
191
192         unsigned int sequential;
193         unsigned int odirect;
194         unsigned int invalidate_cache;
195         unsigned int create_serialize;
196         unsigned int create_fsync;
197         unsigned int end_fsync;
198         unsigned int sync_io;
199         unsigned int verify;
200         unsigned int use_thread;
201         unsigned int unlink;
202         unsigned int do_disk_util;
203         unsigned int override_sync;
204         unsigned int rand_repeatable;
205         unsigned int write_lat_log;
206         unsigned int write_bw_log;
207         unsigned int norandommap;
208         unsigned int bs_unaligned;
209
210         unsigned int bs[2];
211         unsigned int min_bs[2];
212         unsigned int max_bs[2];
213         unsigned int rw_min_bs;
214         unsigned int thinktime;
215         unsigned int fsync_blocks;
216         unsigned int start_delay;
217         unsigned long timeout;
218         unsigned int overwrite;
219         unsigned int bw_avg_time;
220         unsigned int loops;
221         unsigned long long zone_size;
222         unsigned long long zone_skip;
223         enum fio_memtype mem_type;
224         unsigned int stonewall;
225         unsigned int numjobs;
226         unsigned int iodepth;
227         os_cpu_mask_t cpumask;
228         unsigned int iolog;
229         unsigned int read_iolog;
230         unsigned int rwmixcycle;
231         unsigned int rwmixread;
232         unsigned int rwmixwrite;
233         unsigned int nice;
234
235         char *read_iolog_file;
236         char *write_iolog_file;
237         void *iolog_buf;
238         FILE *iolog_f;
239
240         char *sysfs_root;
241         char *ioscheduler;
242
243         os_random_state_t bsrange_state;
244         os_random_state_t verify_state;
245
246         int shm_id;
247
248         /*
249          * IO engine hooks, contains everything needed to submit an io_u
250          * to any of the available IO engines.
251          */
252         struct ioengine_ops *io_ops;
253
254         /*
255          * Current IO depth and list of free and busy io_u's.
256          */
257         unsigned int cur_depth;
258         struct list_head io_u_freelist;
259         struct list_head io_u_busylist;
260
261         /*
262          * Rate state
263          */
264         unsigned int rate;
265         unsigned int ratemin;
266         unsigned int ratecycle;
267         unsigned long rate_usec_cycle;
268         long rate_pending_usleep;
269         unsigned long rate_bytes;
270         struct timeval lastrate;
271
272         unsigned long runtime[2];               /* msec */
273         unsigned long long io_size;
274         unsigned long long total_file_size;
275         unsigned long long start_offset;
276         unsigned long long total_io_size;
277
278         unsigned long long io_blocks[2];
279         unsigned long long io_bytes[2];
280         unsigned long long zone_bytes;
281         unsigned long long this_io_bytes[2];
282         volatile int mutex;
283
284         /*
285          * State for random io, a bitmap of blocks done vs not done
286          */
287         os_random_state_t random_state;
288
289         /*
290          * CPU "io" cycle burner
291          */
292         unsigned int cpuload;
293         unsigned int cpucycle;
294
295         /*
296          * bandwidth and latency stats
297          */
298         struct io_stat clat_stat[2];            /* completion latency */
299         struct io_stat slat_stat[2];            /* submission latency */
300         struct io_stat bw_stat[2];              /* bandwidth stats */
301
302         unsigned long long stat_io_bytes[2];
303         struct timeval stat_sample_time[2];
304
305         struct io_log *slat_log;
306         struct io_log *clat_log;
307         struct io_log *bw_log;
308
309         struct timeval start;   /* start of this loop */
310         struct timeval epoch;   /* time job was started */
311         struct timeval end_time;/* time job ended */
312
313         /*
314          * fio system usage accounting
315          */
316         struct rusage ru_start;
317         struct rusage ru_end;
318         unsigned long usr_time;
319         unsigned long sys_time;
320         unsigned long ctx;
321
322         /*
323          * read/write mixed workload state
324          */
325         os_random_state_t rwmix_state;
326         struct timeval rwmix_switch;
327         enum fio_ddir rwmix_ddir;
328
329         /*
330          * Pre-run and post-run shell
331          */
332         char *exec_prerun;
333         char *exec_postrun;
334
335         /*
336          * IO historic logs
337          */
338         struct list_head io_hist_list;
339         struct list_head io_log_list;
340 };
341
342 #define __td_verror(td, err, msg)                                       \
343         do {                                                            \
344                 int e = (err);                                          \
345                 (td)->error = e;                                        \
346                 snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg));        \
347         } while (0)
348
349
350 #define td_verror(td, err)      __td_verror((td), (err), strerror((err)))
351 #define td_vmsg(td, err, msg)   __td_verror((td), (err), (msg))
352
353 extern int exitall_on_terminate;
354 extern int thread_number;
355 extern int shm_id;
356 extern int groupid;
357 extern int terse_output;
358 extern FILE *f_out;
359 extern FILE *f_err;
360 extern int temp_stall_ts;
361
362 extern struct thread_data *threads;
363
364 #define td_read(td)             ((td)->ddir == DDIR_READ)
365 #define td_write(td)            ((td)->ddir == DDIR_WRITE)
366 #define td_rw(td)               ((td)->iomix != 0)
367
368 #define BLOCKS_PER_MAP          (8 * sizeof(long))
369 #define TO_MAP_BLOCK(td, f, b)  ((b) - ((f)->file_offset / (td)->rw_min_bs))
370 #define RAND_MAP_IDX(td, f, b)  (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
371 #define RAND_MAP_BIT(td, f, b)  (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
372
373 #define MAX_JOBS        (1024)
374
375 static inline int should_fsync(struct thread_data *td)
376 {
377         if (td->last_was_sync)
378                 return 0;
379         if (td->odirect)
380                 return 0;
381         if (td_write(td) || td_rw(td) || td->override_sync)
382                 return 1;
383
384         return 0;
385 }
386
387 struct disk_util_stat {
388         unsigned ios[2];
389         unsigned merges[2];
390         unsigned long long sectors[2];
391         unsigned ticks[2];
392         unsigned io_ticks;
393         unsigned time_in_queue;
394 };
395
396 struct disk_util {
397         struct list_head list;
398
399         char *name;
400         char path[256];
401         dev_t dev;
402
403         struct disk_util_stat dus;
404         struct disk_util_stat last_dus;
405
406         unsigned long msec;
407         struct timeval time;
408 };
409
410 struct io_completion_data {
411         int nr;                         /* input */
412
413         int error;                      /* output */
414         unsigned long bytes_done[2];    /* output */
415         struct timeval time;            /* output */
416 };
417
418 #define DISK_UTIL_MSEC  (250)
419
420 #ifndef min
421 #define min(a, b)       ((a) < (b) ? (a) : (b))
422 #endif
423 #ifndef max
424 #define max(a, b)       ((a) > (b) ? (a) : (b))
425 #endif
426
427 /*
428  * Log exports
429  */
430 extern int read_iolog_get(struct thread_data *, struct io_u *);
431 extern void write_iolog_put(struct thread_data *, struct io_u *);
432 extern int init_iolog(struct thread_data *td);
433 extern void log_io_piece(struct thread_data *, struct io_u *);
434 extern void prune_io_piece_log(struct thread_data *);
435 extern void write_iolog_close(struct thread_data *);
436
437 /*
438  * Logging
439  */
440 extern void add_clat_sample(struct thread_data *, int, unsigned long);
441 extern void add_slat_sample(struct thread_data *, int, unsigned long);
442 extern void add_bw_sample(struct thread_data *, int, struct timeval *);
443 extern void show_run_stats(void);
444 extern void init_disk_util(struct thread_data *);
445 extern void update_rusage_stat(struct thread_data *);
446 extern void update_io_ticks(void);
447 extern void disk_util_timer_arm(void);
448 extern void setup_log(struct io_log **);
449 extern void finish_log(struct thread_data *, struct io_log *, const char *);
450 extern int setup_rate(struct thread_data *);
451
452 /*
453  * Time functions
454  */
455 extern unsigned long utime_since(struct timeval *, struct timeval *);
456 extern unsigned long utime_since_now(struct timeval *);
457 extern unsigned long mtime_since(struct timeval *, struct timeval *);
458 extern unsigned long mtime_since_now(struct timeval *);
459 extern unsigned long time_since_now(struct timeval *);
460 extern unsigned long mtime_since_genesis(void);
461 extern void __usec_sleep(unsigned int);
462 extern void usec_sleep(struct thread_data *, unsigned long);
463 extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
464 extern void fill_start_time(struct timeval *);
465 extern void fio_gettime(struct timeval *, void *);
466
467 /*
468  * Init functions
469  */
470 extern int parse_options(int, char **);
471 extern int init_random_state(struct thread_data *);
472
473 /*
474  * File setup/shutdown
475  */
476 extern void close_files(struct thread_data *);
477 extern int setup_files(struct thread_data *);
478 extern int open_files(struct thread_data *);
479 extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
480
481 /*
482  * ETA/status stuff
483  */
484 extern void print_thread_status(void);
485 extern void print_status_init(int);
486
487 /*
488  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
489  * will never back again. It may cycle between running/verififying/fsyncing.
490  * Once the thread reaches TD_EXITED, it is just waiting for the core to
491  * reap it.
492  */
493 enum {
494         TD_NOT_CREATED = 0,
495         TD_CREATED,
496         TD_INITIALIZED,
497         TD_RUNNING,
498         TD_VERIFYING,
499         TD_FSYNCING,
500         TD_EXITED,
501         TD_REAPED,
502 };
503
504 /*
505  * Verify helpers
506  */
507 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
508 extern int get_next_verify(struct thread_data *td, struct io_u *);
509 extern int do_io_u_verify(struct thread_data *, struct io_u **);
510
511 /*
512  * Memory helpers
513  */
514 extern int fio_pin_memory(void);
515 extern void fio_unpin_memory(void);
516 extern int allocate_io_mem(struct thread_data *);
517 extern void free_io_mem(struct thread_data *);
518
519 /*
520  * io unit handling
521  */
522 #define queue_full(td)  list_empty(&(td)->io_u_freelist)
523 extern struct io_u *__get_io_u(struct thread_data *);
524 extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
525 extern void put_io_u(struct thread_data *, struct io_u *);
526 extern void ios_completed(struct thread_data *, struct io_completion_data *);
527 extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
528
529 /*
530  * io engine entry points
531  */
532 extern int td_io_init(struct thread_data *);
533 extern int td_io_prep(struct thread_data *, struct io_u *);
534 extern int td_io_queue(struct thread_data *, struct io_u *);
535 extern int td_io_sync(struct thread_data *, struct fio_file *);
536 extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
537
538 /*
539  * This is a pretty crappy semaphore implementation, but with the use that fio
540  * has (just signalling start/go conditions), it doesn't have to be better.
541  * Naturally this would not work for any type of contended semaphore or
542  * for real locking.
543  */
544 static inline void fio_sem_init(volatile int *sem, int val)
545 {
546         *sem = val;
547 }
548
549 static inline void fio_sem_down(volatile int *sem)
550 {
551         while (*sem == 0)
552                 usleep(10000);
553
554         (*sem)--;
555 }
556
557 static inline void fio_sem_up(volatile int *sem)
558 {
559         (*sem)++;
560 }
561
562 /*
563  * If logging output to a file, stderr should go to both stderr and f_err
564  */
565 #define log_err(args...)        do {            \
566         fprintf(f_err, ##args);                 \
567         if (f_err != stderr)                    \
568                 fprintf(stderr, ##args);        \
569         } while (0)
570
571 struct ioengine_ops {
572         struct list_head list;
573         char name[16];
574         int version;
575         int flags;
576         int (*setup)(struct thread_data *);
577         int (*init)(struct thread_data *);
578         int (*prep)(struct thread_data *, struct io_u *);
579         int (*queue)(struct thread_data *, struct io_u *);
580         int (*getevents)(struct thread_data *, int, int, struct timespec *);
581         struct io_u *(*event)(struct thread_data *, int);
582         int (*cancel)(struct thread_data *, struct io_u *);
583         void (*cleanup)(struct thread_data *);
584         void *data;
585         void *dlhandle;
586 };
587
588 #define FIO_IOOPS_VERSION       3
589
590 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
591 extern int register_ioengine(struct ioengine_ops *);
592 extern void unregister_ioengine(struct ioengine_ops *);
593 extern void close_ioengine(struct thread_data *);
594
595 /*
596  * Mark unused variables passed to ops functions as unused, to silence gcc
597  */
598 #define fio_unused      __attribute((__unused__))
599 #define fio_init        __attribute__((constructor))
600 #define fio_exit        __attribute__((destructor))
601
602 #define for_each_td(td, i)      \
603         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
604 #define for_each_file(td, f, i) \
605         for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
606
607 #endif