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