6bb1949f9faed23d2d8977ed3df3f2db32dfd4ab
[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 #include <inttypes.h>
15 #include <assert.h>
16
17 #include "compiler/compiler.h"
18 #include "thread_options.h"
19 #include "flist.h"
20 #include "fifo.h"
21 #include "arch/arch.h"
22 #include "os/os.h"
23 #include "mutex.h"
24 #include "log.h"
25 #include "debug.h"
26 #include "file.h"
27 #include "io_ddir.h"
28 #include "ioengine.h"
29 #include "iolog.h"
30 #include "helpers.h"
31 #include "options.h"
32 #include "profile.h"
33 #include "fio_time.h"
34 #include "gettime.h"
35 #include "lib/getopt.h"
36 #include "lib/rand.h"
37 #include "lib/rbtree.h"
38 #include "client.h"
39 #include "server.h"
40 #include "stat.h"
41 #include "flow.h"
42 #include "io_u_queue.h"
43 #include "workqueue.h"
44
45 #ifdef CONFIG_SOLARISAIO
46 #include <sys/asynch.h>
47 #endif
48
49 #ifdef CONFIG_LIBNUMA
50 #include <linux/mempolicy.h>
51 #include <numa.h>
52
53 /*
54  * "local" is pseudo-policy
55  */
56 #define MPOL_LOCAL MPOL_MAX
57 #endif
58
59 /*
60  * offset generator types
61  */
62 enum {
63         RW_SEQ_SEQ      = 0,
64         RW_SEQ_IDENT,
65 };
66
67 enum {
68         TD_F_VER_BACKLOG        = 1U << 0,
69         TD_F_TRIM_BACKLOG       = 1U << 1,
70         TD_F_READ_IOLOG         = 1U << 2,
71         TD_F_REFILL_BUFFERS     = 1U << 3,
72         TD_F_SCRAMBLE_BUFFERS   = 1U << 4,
73         TD_F_VER_NONE           = 1U << 5,
74         TD_F_PROFILE_OPS        = 1U << 6,
75         TD_F_COMPRESS           = 1U << 7,
76         TD_F_NOIO               = 1U << 8,
77         TD_F_COMPRESS_LOG       = 1U << 9,
78         TD_F_VSTATE_SAVED       = 1U << 10,
79         TD_F_NEED_LOCK          = 1U << 11,
80         TD_F_CHILD              = 1U << 12,
81         TD_F_NO_PROGRESS        = 1U << 13,
82 };
83
84 enum {
85         FIO_RAND_BS_OFF         = 0,
86         FIO_RAND_VER_OFF,
87         FIO_RAND_MIX_OFF,
88         FIO_RAND_FILE_OFF,
89         FIO_RAND_BLOCK_OFF,
90         FIO_RAND_FILE_SIZE_OFF,
91         FIO_RAND_TRIM_OFF,
92         FIO_RAND_BUF_OFF,
93         FIO_RAND_SEQ_RAND_READ_OFF,
94         FIO_RAND_SEQ_RAND_WRITE_OFF,
95         FIO_RAND_SEQ_RAND_TRIM_OFF,
96         FIO_RAND_START_DELAY,
97         FIO_DEDUPE_OFF,
98         FIO_RAND_NR_OFFS,
99 };
100
101 enum {
102         IO_MODE_INLINE = 0,
103         IO_MODE_OFFLOAD,
104 };
105
106 /*
107  * This describes a single thread/process executing a fio job.
108  */
109 struct thread_data {
110         struct thread_options o;
111         unsigned long flags;
112         void *eo;
113         char verror[FIO_VERROR_SIZE];
114         pthread_t thread;
115         unsigned int thread_number;
116         unsigned int subjob_number;
117         unsigned int groupid;
118         struct thread_stat ts;
119
120         int client_type;
121
122         struct io_log *slat_log;
123         struct io_log *clat_log;
124         struct io_log *lat_log;
125         struct io_log *bw_log;
126         struct io_log *iops_log;
127
128         struct tp_data *tp_data;
129
130         struct thread_data *parent;
131
132         uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
133         struct timeval bw_sample_time;
134
135         uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
136         struct timeval iops_sample_time;
137
138         /*
139          * Tracks the last iodepth number of completed writes, if data
140          * verification is enabled
141          */
142         uint64_t *last_write_comp;
143         unsigned int last_write_idx;
144
145         volatile int update_rusage;
146         struct fio_mutex *rusage_sem;
147         struct rusage ru_start;
148         struct rusage ru_end;
149
150         struct fio_file **files;
151         unsigned char *file_locks;
152         unsigned int files_size;
153         unsigned int files_index;
154         unsigned int nr_open_files;
155         unsigned int nr_done_files;
156         unsigned int nr_normal_files;
157         union {
158                 unsigned int next_file;
159                 struct frand_state next_file_state;
160         };
161         int error;
162         int sig;
163         int done;
164         int stop_io;
165         pid_t pid;
166         char *orig_buffer;
167         size_t orig_buffer_size;
168         volatile int terminate;
169         volatile int runstate;
170         unsigned int last_was_sync;
171         enum fio_ddir last_ddir;
172
173         int mmapfd;
174
175         void *iolog_buf;
176         FILE *iolog_f;
177
178         char *sysfs_root;
179
180         unsigned long rand_seeds[FIO_RAND_NR_OFFS];
181
182         struct frand_state bsrange_state;
183         struct frand_state verify_state;
184         struct frand_state trim_state;
185         struct frand_state delay_state;
186
187         struct frand_state buf_state;
188         struct frand_state buf_state_prev;
189         struct frand_state dedupe_state;
190
191         unsigned int verify_batch;
192         unsigned int trim_batch;
193
194         struct thread_io_list *vstate;
195
196         int shm_id;
197
198         /*
199          * IO engine hooks, contains everything needed to submit an io_u
200          * to any of the available IO engines.
201          */
202         struct ioengine_ops *io_ops;
203
204         /*
205          * Queue depth of io_u's that fio MIGHT do
206          */
207         unsigned int cur_depth;
208
209         /*
210          * io_u's about to be committed
211          */
212         unsigned int io_u_queued;
213
214         /*
215          * io_u's submitted but not completed yet
216          */
217         unsigned int io_u_in_flight;
218
219         /*
220          * List of free and busy io_u's
221          */
222         struct io_u_ring io_u_requeues;
223         struct io_u_queue io_u_freelist;
224         struct io_u_queue io_u_all;
225         pthread_mutex_t io_u_lock;
226         pthread_cond_t free_cond;
227
228         /*
229          * async verify offload
230          */
231         struct flist_head verify_list;
232         pthread_t *verify_threads;
233         unsigned int nr_verify_threads;
234         pthread_cond_t verify_cond;
235         int verify_thread_exit;
236
237         /*
238          * Rate state
239          */
240         uint64_t rate_bps[DDIR_RWDIR_CNT];
241         unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
242         unsigned long rate_bytes[DDIR_RWDIR_CNT];
243         unsigned long rate_blocks[DDIR_RWDIR_CNT];
244         unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT];
245         struct timeval lastrate[DDIR_RWDIR_CNT];
246         unsigned long long last_usec;
247
248         /*
249          * Enforced rate submission/completion workqueue
250          */
251         struct workqueue io_wq;
252
253         uint64_t total_io_size;
254         uint64_t fill_device_size;
255
256         /*
257          * Issue side
258          */
259         uint64_t io_issues[DDIR_RWDIR_CNT];
260         uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
261         uint64_t loops;
262
263         /*
264          * Completions
265          */
266         uint64_t io_blocks[DDIR_RWDIR_CNT];
267         uint64_t this_io_blocks[DDIR_RWDIR_CNT];
268         uint64_t io_bytes[DDIR_RWDIR_CNT];
269         uint64_t this_io_bytes[DDIR_RWDIR_CNT];
270         uint64_t io_skip_bytes;
271         uint64_t zone_bytes;
272         struct fio_mutex *mutex;
273         uint64_t bytes_done[DDIR_RWDIR_CNT];
274
275         /*
276          * State for random io, a bitmap of blocks done vs not done
277          */
278         struct frand_state random_state;
279
280         struct timeval start;   /* start of this loop */
281         struct timeval epoch;   /* time job was started */
282         struct timeval last_issue;
283         long time_offset;
284         struct timeval tv_cache;
285         struct timeval terminate_time;
286         unsigned int tv_cache_nr;
287         unsigned int tv_cache_mask;
288         unsigned int ramp_time_over;
289
290         /*
291          * Time since last latency_window was started
292          */
293         struct timeval latency_ts;
294         unsigned int latency_qd;
295         unsigned int latency_qd_high;
296         unsigned int latency_qd_low;
297         unsigned int latency_failed;
298         uint64_t latency_ios;
299         int latency_end_run;
300
301         /*
302          * read/write mixed workload state
303          */
304         struct frand_state rwmix_state;
305         unsigned long rwmix_issues;
306         enum fio_ddir rwmix_ddir;
307         unsigned int ddir_seq_nr;
308
309         /*
310          * rand/seq mixed workload state
311          */
312         struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
313
314         /*
315          * IO history logs for verification. We use a tree for sorting,
316          * if we are overwriting. Otherwise just use a fifo.
317          */
318         struct rb_root io_hist_tree;
319         struct flist_head io_hist_list;
320         unsigned long io_hist_len;
321
322         /*
323          * For IO replaying
324          */
325         struct flist_head io_log_list;
326
327         /*
328          * For tracking/handling discards
329          */
330         struct flist_head trim_list;
331         unsigned long trim_entries;
332
333         struct flist_head next_rand_list;
334
335         /*
336          * for fileservice, how often to switch to a new file
337          */
338         unsigned int file_service_nr;
339         unsigned int file_service_left;
340         struct fio_file *file_service_file;
341
342         unsigned int sync_file_range_nr;
343
344         /*
345          * For generating file sizes
346          */
347         struct frand_state file_size_state;
348
349         /*
350          * Error counts
351          */
352         unsigned int total_err_count;
353         int first_error;
354
355         struct fio_flow *flow;
356
357         /*
358          * Can be overloaded by profiles
359          */
360         struct prof_io_ops prof_io_ops;
361         void *prof_data;
362
363         void *pinned_mem;
364 };
365
366 /*
367  * when should interactive ETA output be generated
368  */
369 enum {
370         FIO_ETA_AUTO,
371         FIO_ETA_ALWAYS,
372         FIO_ETA_NEVER,
373 };
374
375 #define __td_verror(td, err, msg, func)                                 \
376         do {                                                            \
377                 unsigned int ____e = (err);                             \
378                 if ((td)->error)                                        \
379                         break;                                          \
380                 (td)->error = ____e;                                    \
381                 if (!(td)->first_error)                                 \
382                         snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));           \
383         } while (0)
384
385
386 #define td_clear_error(td)              do {            \
387         (td)->error = 0;                                \
388         if ((td)->parent)                               \
389                 (td)->parent->error = 0;                \
390 } while (0)
391
392 #define td_verror(td, err, func)        do {                    \
393         __td_verror((td), (err), strerror((err)), (func));      \
394         if ((td)->parent)                                       \
395                 __td_verror((td)->parent, (err), strerror((err)), (func)); \
396 } while (0)
397
398 #define td_vmsg(td, err, msg, func)     do {                    \
399         __td_verror((td), (err), (msg), (func));                \
400         if ((td)->parent)                                       \
401                 __td_verror((td)->parent, (err), (msg), (func));        \
402 } while (0)
403
404 #define __fio_stringify_1(x)    #x
405 #define __fio_stringify(x)      __fio_stringify_1(x)
406
407 extern int exitall_on_terminate;
408 extern unsigned int thread_number;
409 extern unsigned int stat_number;
410 extern int shm_id;
411 extern int groupid;
412 extern int output_format;
413 extern int append_terse_output;
414 extern int temp_stall_ts;
415 extern uintptr_t page_mask, page_size;
416 extern int read_only;
417 extern int eta_print;
418 extern int eta_new_line;
419 extern unsigned long done_secs;
420 extern char *job_section;
421 extern int fio_gtod_offload;
422 extern int fio_gtod_cpu;
423 extern enum fio_cs fio_clock_source;
424 extern int fio_clock_source_set;
425 extern int warnings_fatal;
426 extern int terse_version;
427 extern int is_backend;
428 extern int nr_clients;
429 extern int log_syslog;
430 extern int status_interval;
431 extern const char fio_version_string[];
432 extern int helper_do_stat;
433 extern pthread_cond_t helper_cond;
434 extern char *trigger_file;
435 extern char *trigger_cmd;
436 extern char *trigger_remote_cmd;
437 extern long long trigger_timeout;
438 extern char *aux_path;
439
440 extern struct thread_data *threads;
441
442 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
443 {
444         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
445 }
446
447 #define REAL_MAX_JOBS           2048
448
449 static inline int should_fsync(struct thread_data *td)
450 {
451         if (td->last_was_sync)
452                 return 0;
453         if (td_write(td) || td_rw(td) || td->o.override_sync)
454                 return 1;
455
456         return 0;
457 }
458
459 /*
460  * Init/option functions
461  */
462 extern int __must_check fio_init_options(void);
463 extern int __must_check parse_options(int, char **);
464 extern int parse_jobs_ini(char *, int, int, int);
465 extern int parse_cmd_line(int, char **, int);
466 extern int fio_backend(void);
467 extern void reset_fio_state(void);
468 extern void clear_io_state(struct thread_data *, int);
469 extern int fio_options_parse(struct thread_data *, char **, int, int);
470 extern void fio_keywords_init(void);
471 extern void fio_keywords_exit(void);
472 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
473 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
474 extern void fio_fill_default_options(struct thread_data *);
475 extern int fio_show_option_help(const char *);
476 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
477 extern void fio_options_dup_and_init(struct option *);
478 extern void fio_options_mem_dupe(struct thread_data *);
479 extern void options_mem_dupe(void *data, struct fio_option *options);
480 extern void td_fill_rand_seeds(struct thread_data *);
481 extern void add_job_opts(const char **, int);
482 extern char *num2str(uint64_t, int, int, int, int);
483 extern int ioengine_load(struct thread_data *);
484 extern int parse_dryrun(void);
485 extern int fio_running_or_pending_io_threads(void);
486 extern int fio_set_fd_nonblocking(int, const char *);
487 extern void sig_show_status(int sig);
488
489 extern uintptr_t page_mask;
490 extern uintptr_t page_size;
491 extern int initialize_fio(char *envp[]);
492 extern void deinitialize_fio(void);
493
494 #define FIO_GETOPT_JOB          0x89000000
495 #define FIO_GETOPT_IOENGINE     0x98000000
496 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
497
498 /*
499  * ETA/status stuff
500  */
501 extern void print_thread_status(void);
502 extern void print_status_init(int);
503 extern char *fio_uint_to_kmg(unsigned int val);
504
505 /*
506  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
507  * will never back again. It may cycle between running/verififying/fsyncing.
508  * Once the thread reaches TD_EXITED, it is just waiting for the core to
509  * reap it.
510  */
511 enum {
512         TD_NOT_CREATED = 0,
513         TD_CREATED,
514         TD_INITIALIZED,
515         TD_RAMP,
516         TD_SETTING_UP,
517         TD_RUNNING,
518         TD_PRE_READING,
519         TD_VERIFYING,
520         TD_FSYNCING,
521         TD_FINISHING,
522         TD_EXITED,
523         TD_REAPED,
524         TD_LAST,
525 };
526
527 extern void td_set_runstate(struct thread_data *, int);
528 extern int td_bump_runstate(struct thread_data *, int);
529 extern void td_restore_runstate(struct thread_data *, int);
530
531 /*
532  * Allow 60 seconds for a job to quit on its own, otherwise reap with
533  * a vengeance.
534  */
535 #define FIO_REAP_TIMEOUT        60
536
537 #define TERMINATE_ALL           (-1)
538 extern void fio_terminate_threads(int);
539 extern void fio_mark_td_terminate(struct thread_data *);
540
541 /*
542  * Memory helpers
543  */
544 extern int __must_check fio_pin_memory(struct thread_data *);
545 extern void fio_unpin_memory(struct thread_data *);
546 extern int __must_check allocate_io_mem(struct thread_data *);
547 extern void free_io_mem(struct thread_data *);
548 extern void free_threads_shm(void);
549
550 /*
551  * Reset stats after ramp time completes
552  */
553 extern void reset_all_stats(struct thread_data *);
554
555 /*
556  * blktrace support
557  */
558 #ifdef FIO_HAVE_BLKTRACE
559 extern int is_blktrace(const char *, int *);
560 extern int load_blktrace(struct thread_data *, const char *, int);
561 #endif
562
563 /*
564  * Latency target helpers
565  */
566 extern void lat_target_check(struct thread_data *);
567 extern void lat_target_init(struct thread_data *);
568 extern void lat_target_reset(struct thread_data *);
569
570 #define for_each_td(td, i)      \
571         for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
572 #define for_each_file(td, f, i) \
573         if ((td)->files_index)                                          \
574                 for ((i) = 0, (f) = (td)->files[0];                     \
575                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
576                  (i)++)
577
578 #define fio_assert(td, cond)    do {    \
579         if (!(cond)) {                  \
580                 int *__foo = NULL;      \
581                 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
582                 td_set_runstate((td), TD_EXITED);       \
583                 (td)->error = EFAULT;           \
584                 *__foo = 0;                     \
585         }       \
586 } while (0)
587
588 static inline int fio_fill_issue_time(struct thread_data *td)
589 {
590         if (td->o.read_iolog_file ||
591             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
592                 return 1;
593
594         return 0;
595 }
596
597 static inline int __should_check_rate(struct thread_data *td,
598                                       enum fio_ddir ddir)
599 {
600         struct thread_options *o = &td->o;
601
602         /*
603          * If some rate setting was given, we need to check it
604          */
605         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
606             o->rate_iops_min[ddir])
607                 return 1;
608
609         return 0;
610 }
611
612 static inline int should_check_rate(struct thread_data *td)
613 {
614         int ret = 0;
615
616         if (td->bytes_done[DDIR_READ])
617                 ret |= __should_check_rate(td, DDIR_READ);
618         if (td->bytes_done[DDIR_WRITE])
619                 ret |= __should_check_rate(td, DDIR_WRITE);
620         if (td->bytes_done[DDIR_TRIM])
621                 ret |= __should_check_rate(td, DDIR_TRIM);
622
623         return ret;
624 }
625
626 static inline unsigned int td_max_bs(struct thread_data *td)
627 {
628         unsigned int max_bs;
629
630         max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
631         return max(td->o.max_bs[DDIR_TRIM], max_bs);
632 }
633
634 static inline unsigned int td_min_bs(struct thread_data *td)
635 {
636         unsigned int min_bs;
637
638         min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
639         return min(td->o.min_bs[DDIR_TRIM], min_bs);
640 }
641
642 static inline int td_async_processing(struct thread_data *td)
643 {
644         return (td->flags & TD_F_NEED_LOCK) != 0;
645 }
646
647 /*
648  * We currently only need to do locking if we have verifier threads
649  * accessing our internal structures too
650  */
651 static inline void td_io_u_lock(struct thread_data *td)
652 {
653         if (td_async_processing(td))
654                 pthread_mutex_lock(&td->io_u_lock);
655 }
656
657 static inline void td_io_u_unlock(struct thread_data *td)
658 {
659         if (td_async_processing(td))
660                 pthread_mutex_unlock(&td->io_u_lock);
661 }
662
663 static inline void td_io_u_free_notify(struct thread_data *td)
664 {
665         if (td_async_processing(td))
666                 pthread_cond_signal(&td->free_cond);
667 }
668
669 extern const char *fio_get_arch_string(int);
670 extern const char *fio_get_os_string(int);
671
672 #ifdef FIO_INTERNAL
673 #define ARRAY_SIZE(x)    (sizeof((x)) / (sizeof((x)[0])))
674 #define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
675 #endif
676
677 enum {
678         __FIO_OUTPUT_TERSE      = 0,
679         __FIO_OUTPUT_JSON       = 1,
680         __FIO_OUTPUT_NORMAL     = 2,
681         __FIO_OUTPUT_JSON_PLUS  = 3,
682         FIO_OUTPUT_NR           = 4,
683
684         FIO_OUTPUT_TERSE        = 1U << __FIO_OUTPUT_TERSE,
685         FIO_OUTPUT_JSON         = 1U << __FIO_OUTPUT_JSON,
686         FIO_OUTPUT_NORMAL       = 1U << __FIO_OUTPUT_NORMAL,
687         FIO_OUTPUT_JSON_PLUS    = 1U << __FIO_OUTPUT_JSON_PLUS,
688 };
689
690 enum {
691         FIO_RAND_DIST_RANDOM    = 0,
692         FIO_RAND_DIST_ZIPF,
693         FIO_RAND_DIST_PARETO,
694         FIO_RAND_DIST_GAUSS,
695 };
696
697 #define FIO_DEF_ZIPF            1.1
698 #define FIO_DEF_PARETO          0.2
699
700 enum {
701         FIO_RAND_GEN_TAUSWORTHE = 0,
702         FIO_RAND_GEN_LFSR,
703         FIO_RAND_GEN_TAUSWORTHE64,
704 };
705
706 enum {
707         FIO_CPUS_SHARED         = 0,
708         FIO_CPUS_SPLIT,
709 };
710
711 extern void exec_trigger(const char *);
712 extern void check_trigger_file(void);
713
714 #endif