doc: update about size
[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 "log.h"
24 #include "debug.h"
25 #include "file.h"
26 #include "io_ddir.h"
27 #include "ioengines.h"
28 #include "iolog.h"
29 #include "helpers.h"
30 #include "minmax.h"
31 #include "options.h"
32 #include "profile.h"
33 #include "fio_time.h"
34 #include "gettime.h"
35 #include "oslib/getopt.h"
36 #include "lib/rand.h"
37 #include "lib/rbtree.h"
38 #include "lib/num2str.h"
39 #include "lib/memalign.h"
40 #include "smalloc.h"
41 #include "client.h"
42 #include "server.h"
43 #include "stat.h"
44 #include "flow.h"
45 #include "io_u.h"
46 #include "io_u_queue.h"
47 #include "workqueue.h"
48 #include "steadystate.h"
49 #include "lib/nowarn_snprintf.h"
50 #include "dedupe.h"
51
52 #ifdef CONFIG_SOLARISAIO
53 #include <sys/asynch.h>
54 #endif
55
56 #ifdef CONFIG_LIBNUMA
57 #include <linux/mempolicy.h>
58 #include <numa.h>
59
60 /*
61  * "local" is pseudo-policy
62  */
63 #ifndef MPOL_LOCAL
64 #define MPOL_LOCAL 4
65 #endif
66 #endif
67
68 #ifdef CONFIG_CUDA
69 #include <cuda.h>
70 #endif
71
72 struct fio_sem;
73
74 /*
75  * offset generator types
76  */
77 enum {
78         RW_SEQ_SEQ      = 0,
79         RW_SEQ_IDENT,
80 };
81
82 enum {
83         __TD_F_VER_BACKLOG      = 0,
84         __TD_F_TRIM_BACKLOG,
85         __TD_F_READ_IOLOG,
86         __TD_F_REFILL_BUFFERS,
87         __TD_F_SCRAMBLE_BUFFERS,
88         __TD_F_DO_VERIFY,
89         __TD_F_PROFILE_OPS,
90         __TD_F_COMPRESS,
91         __TD_F_COMPRESS_LOG,
92         __TD_F_VSTATE_SAVED,
93         __TD_F_NEED_LOCK,
94         __TD_F_CHILD,
95         __TD_F_NO_PROGRESS,
96         __TD_F_REGROW_LOGS,
97         __TD_F_MMAP_KEEP,
98         __TD_F_DIRS_CREATED,
99         __TD_F_CHECK_RATE,
100         __TD_F_SYNCS,
101         __TD_F_LAST,            /* not a real bit, keep last */
102 };
103
104 enum {
105         TD_F_VER_BACKLOG        = 1U << __TD_F_VER_BACKLOG,
106         TD_F_TRIM_BACKLOG       = 1U << __TD_F_TRIM_BACKLOG,
107         TD_F_READ_IOLOG         = 1U << __TD_F_READ_IOLOG,
108         TD_F_REFILL_BUFFERS     = 1U << __TD_F_REFILL_BUFFERS,
109         TD_F_SCRAMBLE_BUFFERS   = 1U << __TD_F_SCRAMBLE_BUFFERS,
110         TD_F_DO_VERIFY          = 1U << __TD_F_DO_VERIFY,
111         TD_F_PROFILE_OPS        = 1U << __TD_F_PROFILE_OPS,
112         TD_F_COMPRESS           = 1U << __TD_F_COMPRESS,
113         TD_F_COMPRESS_LOG       = 1U << __TD_F_COMPRESS_LOG,
114         TD_F_VSTATE_SAVED       = 1U << __TD_F_VSTATE_SAVED,
115         TD_F_NEED_LOCK          = 1U << __TD_F_NEED_LOCK,
116         TD_F_CHILD              = 1U << __TD_F_CHILD,
117         TD_F_NO_PROGRESS        = 1U << __TD_F_NO_PROGRESS,
118         TD_F_REGROW_LOGS        = 1U << __TD_F_REGROW_LOGS,
119         TD_F_MMAP_KEEP          = 1U << __TD_F_MMAP_KEEP,
120         TD_F_DIRS_CREATED       = 1U << __TD_F_DIRS_CREATED,
121         TD_F_CHECK_RATE         = 1U << __TD_F_CHECK_RATE,
122         TD_F_SYNCS              = 1U << __TD_F_SYNCS,
123 };
124
125 enum {
126         FIO_RAND_BS_OFF         = 0,
127         FIO_RAND_BS1_OFF,
128         FIO_RAND_BS2_OFF,
129         FIO_RAND_VER_OFF,
130         FIO_RAND_MIX_OFF,
131         FIO_RAND_FILE_OFF,
132         FIO_RAND_BLOCK_OFF,
133         FIO_RAND_FILE_SIZE_OFF,
134         FIO_RAND_TRIM_OFF,
135         FIO_RAND_BUF_OFF,
136         FIO_RAND_SEQ_RAND_READ_OFF,
137         FIO_RAND_SEQ_RAND_WRITE_OFF,
138         FIO_RAND_SEQ_RAND_TRIM_OFF,
139         FIO_RAND_START_DELAY,
140         FIO_DEDUPE_OFF,
141         FIO_RAND_POISSON_OFF,
142         FIO_RAND_ZONE_OFF,
143         FIO_RAND_POISSON2_OFF,
144         FIO_RAND_POISSON3_OFF,
145         FIO_RAND_PRIO_CMDS,
146         FIO_RAND_DEDUPE_WORKING_SET_IX,
147         FIO_RAND_NR_OFFS,
148 };
149
150 enum {
151         IO_MODE_INLINE = 0,
152         IO_MODE_OFFLOAD = 1,
153
154         RATE_PROCESS_LINEAR = 0,
155         RATE_PROCESS_POISSON = 1,
156
157         THINKTIME_BLOCKS_TYPE_COMPLETE = 0,
158         THINKTIME_BLOCKS_TYPE_ISSUE = 1,
159 };
160
161 enum {
162         F_ADV_NONE = 0,
163         F_ADV_TYPE,
164         F_ADV_RANDOM,
165         F_ADV_SEQUENTIAL,
166 };
167
168 /*
169  * Per-thread/process specific data. Only used for the network client
170  * for now.
171  */
172 void sk_out_assign(struct sk_out *);
173 void sk_out_drop(void);
174
175 struct zone_split_index {
176         uint8_t size_perc;
177         uint8_t size_perc_prev;
178         uint64_t size;
179         uint64_t size_prev;
180 };
181
182 /*
183  * This describes a single thread/process executing a fio job.
184  */
185 struct thread_data {
186         struct flist_head opt_list;
187         unsigned long long flags;
188         struct thread_options o;
189         void *eo;
190         pthread_t thread;
191         unsigned int thread_number;
192         unsigned int subjob_number;
193         unsigned int groupid;
194         struct thread_stat ts __attribute__ ((aligned(8)));
195
196         int client_type;
197
198         struct io_log *slat_log;
199         struct io_log *clat_log;
200         struct io_log *clat_hist_log;
201         struct io_log *lat_log;
202         struct io_log *bw_log;
203         struct io_log *iops_log;
204
205         struct workqueue log_compress_wq;
206
207         struct thread_data *parent;
208
209         uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
210         struct timespec bw_sample_time;
211
212         uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
213         struct timespec iops_sample_time;
214
215         volatile int update_rusage;
216         struct fio_sem *rusage_sem;
217         struct rusage ru_start;
218         struct rusage ru_end;
219
220         struct fio_file **files;
221         unsigned char *file_locks;
222         unsigned int files_size;
223         unsigned int files_index;
224         unsigned int nr_open_files;
225         unsigned int nr_done_files;
226         union {
227                 unsigned int next_file;
228                 struct frand_state next_file_state;
229         };
230         union {
231                 struct zipf_state next_file_zipf;
232                 struct gauss_state next_file_gauss;
233         };
234         union {
235                 double zipf_theta;
236                 double pareto_h;
237                 double gauss_dev;
238         };
239         double random_center;
240         int error;
241         int sig;
242         int done;
243         int stop_io;
244         pid_t pid;
245         char *orig_buffer;
246         size_t orig_buffer_size;
247         volatile int runstate;
248         volatile bool terminate;
249         bool last_was_sync;
250         enum fio_ddir last_ddir;
251
252         int mmapfd;
253
254         void *iolog_buf;
255         FILE *iolog_f;
256
257         uint64_t rand_seeds[FIO_RAND_NR_OFFS];
258
259         struct frand_state bsrange_state[DDIR_RWDIR_CNT];
260         struct frand_state verify_state;
261         struct frand_state trim_state;
262         struct frand_state delay_state;
263
264         struct frand_state buf_state;
265         struct frand_state buf_state_prev;
266         struct frand_state buf_state_ret;
267         struct frand_state dedupe_state;
268         struct frand_state zone_state;
269         struct frand_state prio_state;
270         struct frand_state dedupe_working_set_index_state;
271         struct frand_state *dedupe_working_set_states;
272
273         unsigned long long num_unique_pages;
274
275         struct zone_split_index **zone_state_index;
276         unsigned int num_open_zones;
277
278         unsigned int verify_batch;
279         unsigned int trim_batch;
280
281         struct thread_io_list *vstate;
282
283         int shm_id;
284
285         /*
286          * Job default IO priority set with prioclass and prio options.
287          */
288         unsigned int ioprio;
289
290         /*
291          * IO engine hooks, contains everything needed to submit an io_u
292          * to any of the available IO engines.
293          */
294         struct ioengine_ops *io_ops;
295         int io_ops_init;
296
297         /*
298          * IO engine private data and dlhandle.
299          */
300         void *io_ops_data;
301
302         /*
303          * Queue depth of io_u's that fio MIGHT do
304          */
305         unsigned int cur_depth;
306
307         /*
308          * io_u's about to be committed
309          */
310         unsigned int io_u_queued;
311
312         /*
313          * io_u's submitted but not completed yet
314          */
315         unsigned int io_u_in_flight;
316
317         /*
318          * List of free and busy io_u's
319          */
320         struct io_u_ring io_u_requeues;
321         struct io_u_queue io_u_freelist;
322         struct io_u_queue io_u_all;
323         pthread_mutex_t io_u_lock;
324         pthread_cond_t free_cond;
325
326         /*
327          * async verify offload
328          */
329         struct flist_head verify_list;
330         pthread_t *verify_threads;
331         unsigned int nr_verify_threads;
332         pthread_cond_t verify_cond;
333         int verify_thread_exit;
334
335         /*
336          * Rate state
337          */
338         uint64_t rate_bps[DDIR_RWDIR_CNT];
339         uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
340         unsigned long long last_rate_check_bytes[DDIR_RWDIR_CNT];
341         unsigned long last_rate_check_blocks[DDIR_RWDIR_CNT];
342         unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
343         struct timespec last_rate_check_time[DDIR_RWDIR_CNT];
344         int64_t last_usec[DDIR_RWDIR_CNT];
345         struct frand_state poisson_state[DDIR_RWDIR_CNT];
346
347         /*
348          * Enforced rate submission/completion workqueue
349          */
350         struct workqueue io_wq;
351
352         uint64_t total_io_size;
353         uint64_t fill_device_size;
354
355         /*
356          * Issue side
357          */
358         uint64_t io_issues[DDIR_RWDIR_CNT];
359         uint64_t verify_read_issues;
360         uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
361         uint64_t loops;
362
363         /*
364          * Completions
365          */
366         uint64_t io_blocks[DDIR_RWDIR_CNT];
367         uint64_t this_io_blocks[DDIR_RWDIR_CNT];
368         uint64_t io_bytes[DDIR_RWDIR_CNT];
369         uint64_t this_io_bytes[DDIR_RWDIR_CNT];
370         uint64_t io_skip_bytes;
371         uint64_t zone_bytes;
372         struct fio_sem *sem;
373         uint64_t bytes_done[DDIR_RWDIR_CNT];
374         uint64_t bytes_verified;
375
376         uint64_t *thinktime_blocks_counter;
377         struct timespec last_thinktime;
378         uint64_t last_thinktime_blocks;
379
380         /*
381          * State for random io, a bitmap of blocks done vs not done
382          */
383         struct frand_state random_state;
384
385         struct timespec start;  /* start of this loop */
386         struct timespec epoch;  /* time job was started */
387         unsigned long long alternate_epoch; /* Time job was started, clock_gettime's clock_id epoch based. */
388         struct timespec last_issue;
389         long time_offset;
390         struct timespec ts_cache;
391         struct timespec terminate_time;
392         unsigned int ts_cache_nr;
393         unsigned int ts_cache_mask;
394         bool ramp_time_over;
395
396         /*
397          * Time since last latency_window was started
398          */
399         struct timespec latency_ts;
400         unsigned int latency_qd;
401         unsigned int latency_qd_high;
402         unsigned int latency_qd_low;
403         unsigned int latency_failed;
404         unsigned int latency_stable_count;
405         uint64_t latency_ios;
406         int latency_end_run;
407
408         /*
409          * read/write mixed workload state
410          */
411         struct frand_state rwmix_state;
412         unsigned long rwmix_issues;
413         enum fio_ddir rwmix_ddir;
414         unsigned int ddir_seq_nr;
415
416         /*
417          * rand/seq mixed workload state
418          */
419         struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
420
421         /*
422          * IO history logs for verification. We use a tree for sorting,
423          * if we are overwriting. Otherwise just use a fifo.
424          */
425         struct rb_root io_hist_tree;
426         struct flist_head io_hist_list;
427         unsigned long io_hist_len;
428
429         /*
430          * For IO replaying
431          */
432         struct flist_head io_log_list;
433         FILE *io_log_rfile;
434         unsigned int io_log_blktrace;
435         unsigned int io_log_blktrace_swap;
436         unsigned long long io_log_last_ttime;
437         struct timespec io_log_start_time;
438         unsigned int io_log_current;
439         unsigned int io_log_checkmark;
440         unsigned int io_log_highmark;
441         unsigned int io_log_version;
442         struct timespec io_log_highmark_time;
443
444         /*
445          * For tracking/handling discards
446          */
447         struct flist_head trim_list;
448         unsigned long trim_entries;
449
450         /*
451          * for fileservice, how often to switch to a new file
452          */
453         unsigned int file_service_nr;
454         unsigned int file_service_left;
455         struct fio_file *file_service_file;
456
457         unsigned int sync_file_range_nr;
458
459         /*
460          * For generating file sizes
461          */
462         struct frand_state file_size_state;
463
464         /*
465          * Error counts
466          */
467         unsigned int total_err_count;
468         int first_error;
469
470         struct fio_flow *flow;
471         unsigned long long flow_counter;
472
473         /*
474          * Can be overloaded by profiles
475          */
476         struct prof_io_ops prof_io_ops;
477         void *prof_data;
478
479         void *pinned_mem;
480
481         struct steadystate_data ss;
482
483         char verror[FIO_VERROR_SIZE];
484
485 #ifdef CONFIG_CUDA
486         /*
487          * for GPU memory management
488          */
489         int gpu_dev_cnt;
490         int gpu_dev_id;
491         CUdevice  cu_dev;
492         CUcontext cu_ctx;
493         CUdeviceptr dev_mem_ptr;
494 #endif
495
496 };
497
498 struct thread_segment {
499         struct thread_data *threads;
500         int shm_id;
501         int nr_threads;
502 };
503
504 /*
505  * when should interactive ETA output be generated
506  */
507 enum {
508         FIO_ETA_AUTO,
509         FIO_ETA_ALWAYS,
510         FIO_ETA_NEVER,
511 };
512
513 #define __td_verror(td, err, msg, func)                                 \
514         do {                                                            \
515                 unsigned int ____e = (err);                             \
516                 if ((td)->error)                                        \
517                         break;                                          \
518                 (td)->error = ____e;                                    \
519                 if (!(td)->first_error)                                 \
520                         nowarn_snprintf(td->verror, sizeof(td->verror), \
521                                         "file:%s:%d, func=%s, error=%s", \
522                                         __FILE__, __LINE__, (func), (msg)); \
523         } while (0)
524
525
526 #define td_clear_error(td)              do {            \
527         (td)->error = 0;                                \
528         if ((td)->parent)                               \
529                 (td)->parent->error = 0;                \
530 } while (0)
531
532 #define td_verror(td, err, func)        do {                    \
533         __td_verror((td), (err), strerror((err)), (func));      \
534         if ((td)->parent)                                       \
535                 __td_verror((td)->parent, (err), strerror((err)), (func)); \
536 } while (0)
537
538 #define td_vmsg(td, err, msg, func)     do {                    \
539         __td_verror((td), (err), (msg), (func));                \
540         if ((td)->parent)                                       \
541                 __td_verror((td)->parent, (err), (msg), (func));        \
542 } while (0)
543
544 #define __fio_stringify_1(x)    #x
545 #define __fio_stringify(x)      __fio_stringify_1(x)
546
547 #define REAL_MAX_JOBS           4096
548 #define JOBS_PER_SEG            8
549 #define REAL_MAX_SEG            (REAL_MAX_JOBS / JOBS_PER_SEG)
550
551 extern bool exitall_on_terminate;
552 extern unsigned int thread_number;
553 extern unsigned int stat_number;
554 extern unsigned int nr_segments;
555 extern unsigned int cur_segment;
556 extern int groupid;
557 extern int output_format;
558 extern int append_terse_output;
559 extern int temp_stall_ts;
560 extern uintptr_t page_mask, page_size;
561 extern bool read_only;
562 extern int eta_print;
563 extern int eta_new_line;
564 extern unsigned int eta_interval_msec;
565 extern unsigned long done_secs;
566 extern int fio_gtod_offload;
567 extern int fio_gtod_cpu;
568 extern enum fio_cs fio_clock_source;
569 extern int fio_clock_source_set;
570 extern int warnings_fatal;
571 extern int terse_version;
572 extern bool is_backend;
573 extern bool is_local_backend;
574 extern int nr_clients;
575 extern bool log_syslog;
576 extern int status_interval;
577 extern const char fio_version_string[];
578 extern char *trigger_file;
579 extern char *trigger_cmd;
580 extern char *trigger_remote_cmd;
581 extern long long trigger_timeout;
582 extern char *aux_path;
583
584 extern struct thread_segment segments[REAL_MAX_SEG];
585
586 static inline struct thread_data *tnumber_to_td(unsigned int tnumber)
587 {
588         struct thread_segment *seg;
589
590         seg = &segments[tnumber / JOBS_PER_SEG];
591         return &seg->threads[tnumber & (JOBS_PER_SEG - 1)];
592 }
593
594 static inline bool is_running_backend(void)
595 {
596         return is_backend || is_local_backend;
597 }
598
599 extern bool eta_time_within_slack(unsigned int time);
600
601 static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
602 {
603         assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)) &&
604                !(io_u->ddir == DDIR_TRIM && !td_trim(td)));
605 }
606
607 static inline bool should_fsync(struct thread_data *td)
608 {
609         if (td->last_was_sync)
610                 return false;
611         if (td_write(td) || td->o.override_sync)
612                 return true;
613
614         return false;
615 }
616
617 /*
618  * Init/option functions
619  */
620 extern int __must_check fio_init_options(void);
621 extern int __must_check parse_options(int, char **);
622 extern int parse_jobs_ini(char *, int, int, int);
623 extern int parse_cmd_line(int, char **, int);
624 extern int fio_backend(struct sk_out *);
625 extern void reset_fio_state(void);
626 extern void clear_io_state(struct thread_data *, int);
627 extern int fio_options_parse(struct thread_data *, char **, int);
628 extern void fio_keywords_init(void);
629 extern void fio_keywords_exit(void);
630 extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
631 extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
632 extern void fio_fill_default_options(struct thread_data *);
633 extern int fio_show_option_help(const char *);
634 extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
635 extern void fio_options_dup_and_init(struct option *);
636 extern char *fio_option_dup_subs(const char *);
637 extern void fio_options_mem_dupe(struct thread_data *);
638 extern void td_fill_rand_seeds(struct thread_data *);
639 extern void td_fill_verify_state_seed(struct thread_data *);
640 extern void add_job_opts(const char **, int);
641 extern int ioengine_load(struct thread_data *);
642 extern bool parse_dryrun(void);
643 extern int fio_running_or_pending_io_threads(void);
644 extern int fio_set_fd_nonblocking(int, const char *);
645 extern void sig_show_status(int sig);
646 extern struct thread_data *get_global_options(void);
647
648 extern uintptr_t page_mask;
649 extern uintptr_t page_size;
650 extern int initialize_fio(char *envp[]);
651 extern void deinitialize_fio(void);
652
653 #define FIO_GETOPT_JOB          0x89000000
654 #define FIO_GETOPT_IOENGINE     0x98000000
655 #define FIO_NR_OPTIONS          (FIO_MAX_OPTS + 128)
656
657 /*
658  * ETA/status stuff
659  */
660 extern void print_thread_status(void);
661 extern void print_status_init(int);
662 extern char *fio_uint_to_kmg(unsigned int val);
663
664 /*
665  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
666  * will never back again. It may cycle between running/verififying/fsyncing.
667  * Once the thread reaches TD_EXITED, it is just waiting for the core to
668  * reap it.
669  */
670 enum {
671         TD_NOT_CREATED = 0,
672         TD_CREATED,
673         TD_INITIALIZED,
674         TD_RAMP,
675         TD_SETTING_UP,
676         TD_RUNNING,
677         TD_PRE_READING,
678         TD_VERIFYING,
679         TD_FSYNCING,
680         TD_FINISHING,
681         TD_EXITED,
682         TD_REAPED,
683         TD_LAST,
684         TD_NR,
685 };
686
687 #define TD_ENG_FLAG_SHIFT       18
688 #define TD_ENG_FLAG_MASK        ((1ULL << 18) - 1)
689
690 static inline void td_set_ioengine_flags(struct thread_data *td)
691 {
692         td->flags = (~(TD_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & td->flags) |
693                     ((unsigned long long)td->io_ops->flags << TD_ENG_FLAG_SHIFT);
694 }
695
696 static inline bool td_ioengine_flagged(struct thread_data *td,
697                                        enum fio_ioengine_flags flags)
698 {
699         return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
700 }
701
702 extern void td_set_runstate(struct thread_data *, int);
703 extern int td_bump_runstate(struct thread_data *, int);
704 extern void td_restore_runstate(struct thread_data *, int);
705 extern const char *runstate_to_name(int runstate);
706
707 /*
708  * Allow 60 seconds for a job to quit on its own, otherwise reap with
709  * a vengeance.
710  */
711 #define FIO_REAP_TIMEOUT        300
712
713 enum {
714         TERMINATE_NONE = 0,
715         TERMINATE_GROUP = 1,
716         TERMINATE_STONEWALL = 2,
717         TERMINATE_ALL = -1,
718 };
719
720 extern void fio_terminate_threads(unsigned int, unsigned int);
721 extern void fio_mark_td_terminate(struct thread_data *);
722
723 /*
724  * Memory helpers
725  */
726 extern int __must_check fio_pin_memory(struct thread_data *);
727 extern void fio_unpin_memory(struct thread_data *);
728 extern int __must_check allocate_io_mem(struct thread_data *);
729 extern void free_io_mem(struct thread_data *);
730 extern void free_threads_shm(void);
731
732 #ifdef FIO_INTERNAL
733 #define PTR_ALIGN(ptr, mask)    \
734         (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
735 #endif
736
737 /*
738  * Reset stats after ramp time completes
739  */
740 extern void reset_all_stats(struct thread_data *);
741
742 extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
743                    enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
744                    struct timespec *comp_time);
745
746 /*
747  * Latency target helpers
748  */
749 extern void lat_target_check(struct thread_data *);
750 extern void lat_target_init(struct thread_data *);
751 extern void lat_target_reset(struct thread_data *);
752
753 /*
754  * Iterates all threads/processes within all the defined jobs
755  */
756 #define for_each_td(td, i)      \
757         for ((i) = 0, (td) = &segments[0].threads[0]; (i) < (int) thread_number; (i)++, (td) = tnumber_to_td((i)))
758 #define for_each_file(td, f, i) \
759         if ((td)->files_index)                                          \
760                 for ((i) = 0, (f) = (td)->files[0];                     \
761                  (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
762                  (i)++)
763
764 static inline bool fio_fill_issue_time(struct thread_data *td)
765 {
766         if (td->o.read_iolog_file ||
767             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
768                 return true;
769
770         return false;
771 }
772
773 static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
774 {
775         struct thread_options *o = &td->o;
776
777         /*
778          * If some rate setting was given, we need to check it
779          */
780         if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
781             o->rate_iops_min[ddir])
782                 return true;
783
784         return false;
785 }
786
787 static inline bool should_check_rate(struct thread_data *td)
788 {
789         return (td->flags & TD_F_CHECK_RATE) != 0;
790 }
791
792 static inline unsigned long long td_max_bs(struct thread_data *td)
793 {
794         unsigned long long max_bs;
795
796         max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
797         return max(td->o.max_bs[DDIR_TRIM], max_bs);
798 }
799
800 static inline unsigned long long td_min_bs(struct thread_data *td)
801 {
802         unsigned long long min_bs;
803
804         min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
805         return min(td->o.min_bs[DDIR_TRIM], min_bs);
806 }
807
808 static inline bool td_async_processing(struct thread_data *td)
809 {
810         return (td->flags & TD_F_NEED_LOCK) != 0;
811 }
812
813 static inline bool td_offload_overlap(struct thread_data *td)
814 {
815         return td->o.serialize_overlap && td->o.io_submit_mode == IO_MODE_OFFLOAD;
816 }
817
818 /*
819  * We currently only need to do locking if we have verifier threads
820  * accessing our internal structures too
821  */
822 static inline void __td_io_u_lock(struct thread_data *td)
823 {
824         pthread_mutex_lock(&td->io_u_lock);
825 }
826
827 static inline void __td_io_u_unlock(struct thread_data *td)
828 {
829         pthread_mutex_unlock(&td->io_u_lock);
830 }
831
832 static inline void td_io_u_free_notify(struct thread_data *td)
833 {
834         if (td_async_processing(td))
835                 pthread_cond_signal(&td->free_cond);
836 }
837
838 static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
839                                   unsigned int value)
840 {
841         if (!td_async_processing(td))
842                 *flags &= ~value;
843         else
844                 __sync_fetch_and_and(flags, ~value);
845 }
846
847 static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
848                                 unsigned int value)
849 {
850         if (!td_async_processing(td))
851                 *flags |= value;
852         else
853                 __sync_fetch_and_or(flags, value);
854 }
855
856 extern const char *fio_get_arch_string(int);
857 extern const char *fio_get_os_string(int);
858
859 enum {
860         __FIO_OUTPUT_TERSE      = 0,
861         __FIO_OUTPUT_JSON       = 1,
862         __FIO_OUTPUT_NORMAL     = 2,
863         __FIO_OUTPUT_JSON_PLUS  = 3,
864         FIO_OUTPUT_NR           = 4,
865
866         FIO_OUTPUT_TERSE        = 1U << __FIO_OUTPUT_TERSE,
867         FIO_OUTPUT_JSON         = 1U << __FIO_OUTPUT_JSON,
868         FIO_OUTPUT_NORMAL       = 1U << __FIO_OUTPUT_NORMAL,
869         FIO_OUTPUT_JSON_PLUS    = 1U << __FIO_OUTPUT_JSON_PLUS,
870 };
871
872 enum {
873         FIO_RAND_DIST_RANDOM    = 0,
874         FIO_RAND_DIST_ZIPF,
875         FIO_RAND_DIST_PARETO,
876         FIO_RAND_DIST_GAUSS,
877         FIO_RAND_DIST_ZONED,
878         FIO_RAND_DIST_ZONED_ABS,
879 };
880
881 #define FIO_DEF_ZIPF            1.1
882 #define FIO_DEF_PARETO          0.2
883
884 enum {
885         FIO_RAND_GEN_TAUSWORTHE = 0,
886         FIO_RAND_GEN_LFSR,
887         FIO_RAND_GEN_TAUSWORTHE64,
888 };
889
890 enum {
891         FIO_CPUS_SHARED         = 0,
892         FIO_CPUS_SPLIT,
893 };
894
895 extern void exec_trigger(const char *);
896 extern void check_trigger_file(void);
897
898 extern bool in_flight_overlap(struct io_u_queue *q, struct io_u *io_u);
899 extern pthread_mutex_t overlap_check;
900
901 static inline void *fio_memalign(size_t alignment, size_t size, bool shared)
902 {
903         return __fio_memalign(alignment, size, shared ? smalloc : malloc);
904 }
905
906 static inline void fio_memfree(void *ptr, size_t size, bool shared)
907 {
908         return __fio_memfree(ptr, size, shared ? sfree : free);
909 }
910
911 #endif