Fio 3.34
[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_SYNCS,
101 __TD_F_LAST, /* not a real bit, keep last */
102};
103
104enum {
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
125enum {
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
150enum {
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
161enum {
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 */
172void sk_out_assign(struct sk_out *);
173void sk_out_drop(void);
174
175struct 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 */
185struct 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 verify_state_last_do_io;
262 struct frand_state trim_state;
263 struct frand_state delay_state;
264
265 struct frand_state buf_state;
266 struct frand_state buf_state_prev;
267 struct frand_state buf_state_ret;
268 struct frand_state dedupe_state;
269 struct frand_state zone_state;
270 struct frand_state prio_state;
271 struct frand_state dedupe_working_set_index_state;
272 struct frand_state *dedupe_working_set_states;
273
274 unsigned long long num_unique_pages;
275
276 struct zone_split_index **zone_state_index;
277 unsigned int num_open_zones;
278
279 unsigned int verify_batch;
280 unsigned int trim_batch;
281
282 struct thread_io_list *vstate;
283
284 int shm_id;
285
286 /*
287 * Job default IO priority set with prioclass and prio options.
288 */
289 unsigned int ioprio;
290
291 /*
292 * IO engine hooks, contains everything needed to submit an io_u
293 * to any of the available IO engines.
294 */
295 struct ioengine_ops *io_ops;
296 int io_ops_init;
297
298 /*
299 * IO engine private data and dlhandle.
300 */
301 void *io_ops_data;
302
303 /*
304 * Queue depth of io_u's that fio MIGHT do
305 */
306 unsigned int cur_depth;
307
308 /*
309 * io_u's about to be committed
310 */
311 unsigned int io_u_queued;
312
313 /*
314 * io_u's submitted but not completed yet
315 */
316 unsigned int io_u_in_flight;
317
318 /*
319 * List of free and busy io_u's
320 */
321 struct io_u_ring io_u_requeues;
322 struct io_u_queue io_u_freelist;
323 struct io_u_queue io_u_all;
324 pthread_mutex_t io_u_lock;
325 pthread_cond_t free_cond;
326
327 /*
328 * async verify offload
329 */
330 struct flist_head verify_list;
331 pthread_t *verify_threads;
332 unsigned int nr_verify_threads;
333 pthread_cond_t verify_cond;
334 int verify_thread_exit;
335
336 /*
337 * Rate state
338 */
339 uint64_t rate_bps[DDIR_RWDIR_CNT];
340 uint64_t rate_next_io_time[DDIR_RWDIR_CNT];
341 unsigned long long last_rate_check_bytes[DDIR_RWDIR_CNT];
342 unsigned long last_rate_check_blocks[DDIR_RWDIR_CNT];
343 unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
344 struct timespec last_rate_check_time[DDIR_RWDIR_CNT];
345 int64_t last_usec[DDIR_RWDIR_CNT];
346 struct frand_state poisson_state[DDIR_RWDIR_CNT];
347
348 /*
349 * Enforced rate submission/completion workqueue
350 */
351 struct workqueue io_wq;
352
353 uint64_t total_io_size;
354 uint64_t fill_device_size;
355
356 /*
357 * Issue side
358 */
359 uint64_t io_issues[DDIR_RWDIR_CNT];
360 uint64_t verify_read_issues;
361 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
362 uint64_t loops;
363
364 /*
365 * Completions
366 */
367 uint64_t io_blocks[DDIR_RWDIR_CNT];
368 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
369 uint64_t io_bytes[DDIR_RWDIR_CNT];
370 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
371 uint64_t io_skip_bytes;
372 uint64_t zone_bytes;
373 struct fio_sem *sem;
374 uint64_t bytes_done[DDIR_RWDIR_CNT];
375 uint64_t bytes_verified;
376
377 uint64_t *thinktime_blocks_counter;
378 struct timespec last_thinktime;
379 uint64_t last_thinktime_blocks;
380
381 /*
382 * State for random io, a bitmap of blocks done vs not done
383 */
384 struct frand_state random_state;
385
386 struct timespec start; /* start of this loop */
387 struct timespec epoch; /* time job was started */
388 unsigned long long alternate_epoch; /* Time job was started, clock_gettime's clock_id epoch based. */
389 struct timespec last_issue;
390 long time_offset;
391 struct timespec ts_cache;
392 struct timespec terminate_time;
393 unsigned int ts_cache_nr;
394 unsigned int ts_cache_mask;
395 bool ramp_time_over;
396
397 /*
398 * Time since last latency_window was started
399 */
400 struct timespec latency_ts;
401 unsigned int latency_qd;
402 unsigned int latency_qd_high;
403 unsigned int latency_qd_low;
404 unsigned int latency_failed;
405 unsigned int latency_stable_count;
406 uint64_t latency_ios;
407 int latency_end_run;
408
409 /*
410 * read/write mixed workload state
411 */
412 struct frand_state rwmix_state;
413 unsigned long rwmix_issues;
414 enum fio_ddir rwmix_ddir;
415 unsigned int ddir_seq_nr;
416
417 /*
418 * rand/seq mixed workload state
419 */
420 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
421
422 /*
423 * IO history logs for verification. We use a tree for sorting,
424 * if we are overwriting. Otherwise just use a fifo.
425 */
426 struct rb_root io_hist_tree;
427 struct flist_head io_hist_list;
428 unsigned long io_hist_len;
429
430 /*
431 * For IO replaying
432 */
433 struct flist_head io_log_list;
434 FILE *io_log_rfile;
435 unsigned int io_log_blktrace;
436 unsigned int io_log_blktrace_swap;
437 unsigned long long io_log_last_ttime;
438 struct timespec io_log_start_time;
439 unsigned int io_log_current;
440 unsigned int io_log_checkmark;
441 unsigned int io_log_highmark;
442 unsigned int io_log_version;
443 struct timespec io_log_highmark_time;
444
445 /*
446 * For tracking/handling discards
447 */
448 struct flist_head trim_list;
449 unsigned long trim_entries;
450
451 /*
452 * for fileservice, how often to switch to a new file
453 */
454 unsigned int file_service_nr;
455 unsigned int file_service_left;
456 struct fio_file *file_service_file;
457
458 unsigned int sync_file_range_nr;
459
460 /*
461 * For generating file sizes
462 */
463 struct frand_state file_size_state;
464
465 /*
466 * Error counts
467 */
468 unsigned int total_err_count;
469 int first_error;
470
471 struct fio_flow *flow;
472 unsigned long long flow_counter;
473
474 /*
475 * Can be overloaded by profiles
476 */
477 struct prof_io_ops prof_io_ops;
478 void *prof_data;
479
480 void *pinned_mem;
481
482 struct steadystate_data ss;
483
484 char verror[FIO_VERROR_SIZE];
485
486#ifdef CONFIG_CUDA
487 /*
488 * for GPU memory management
489 */
490 int gpu_dev_cnt;
491 int gpu_dev_id;
492 CUdevice cu_dev;
493 CUcontext cu_ctx;
494 CUdeviceptr dev_mem_ptr;
495#endif
496
497};
498
499struct thread_segment {
500 struct thread_data *threads;
501 int shm_id;
502 int nr_threads;
503};
504
505/*
506 * when should interactive ETA output be generated
507 */
508enum {
509 FIO_ETA_AUTO,
510 FIO_ETA_ALWAYS,
511 FIO_ETA_NEVER,
512};
513
514#define __td_verror(td, err, msg, func) \
515 do { \
516 unsigned int ____e = (err); \
517 if ((td)->error) \
518 break; \
519 (td)->error = ____e; \
520 if (!(td)->first_error) \
521 nowarn_snprintf(td->verror, sizeof(td->verror), \
522 "file:%s:%d, func=%s, error=%s", \
523 __FILE__, __LINE__, (func), (msg)); \
524 } while (0)
525
526
527#define td_clear_error(td) do { \
528 (td)->error = 0; \
529 if ((td)->parent) \
530 (td)->parent->error = 0; \
531} while (0)
532
533#define td_verror(td, err, func) do { \
534 __td_verror((td), (err), strerror((err)), (func)); \
535 if ((td)->parent) \
536 __td_verror((td)->parent, (err), strerror((err)), (func)); \
537} while (0)
538
539#define td_vmsg(td, err, msg, func) do { \
540 __td_verror((td), (err), (msg), (func)); \
541 if ((td)->parent) \
542 __td_verror((td)->parent, (err), (msg), (func)); \
543} while (0)
544
545#define __fio_stringify_1(x) #x
546#define __fio_stringify(x) __fio_stringify_1(x)
547
548#define REAL_MAX_JOBS 4096
549#define JOBS_PER_SEG 8
550#define REAL_MAX_SEG (REAL_MAX_JOBS / JOBS_PER_SEG)
551
552extern bool exitall_on_terminate;
553extern unsigned int thread_number;
554extern unsigned int stat_number;
555extern unsigned int nr_segments;
556extern unsigned int cur_segment;
557extern int groupid;
558extern int output_format;
559extern int append_terse_output;
560extern int temp_stall_ts;
561extern uintptr_t page_mask, page_size;
562extern bool read_only;
563extern int eta_print;
564extern int eta_new_line;
565extern unsigned int eta_interval_msec;
566extern unsigned long done_secs;
567extern int fio_gtod_offload;
568extern int fio_gtod_cpu;
569extern enum fio_cs fio_clock_source;
570extern int fio_clock_source_set;
571extern int warnings_fatal;
572extern int terse_version;
573extern bool is_backend;
574extern bool is_local_backend;
575extern int nr_clients;
576extern bool log_syslog;
577extern int status_interval;
578extern const char fio_version_string[];
579extern char *trigger_file;
580extern char *trigger_cmd;
581extern char *trigger_remote_cmd;
582extern long long trigger_timeout;
583extern char *aux_path;
584
585extern struct thread_segment segments[REAL_MAX_SEG];
586
587static inline struct thread_data *tnumber_to_td(unsigned int tnumber)
588{
589 struct thread_segment *seg;
590
591 seg = &segments[tnumber / JOBS_PER_SEG];
592 return &seg->threads[tnumber & (JOBS_PER_SEG - 1)];
593}
594
595static inline bool is_running_backend(void)
596{
597 return is_backend || is_local_backend;
598}
599
600extern bool eta_time_within_slack(unsigned int time);
601
602static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
603{
604 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)) &&
605 !(io_u->ddir == DDIR_TRIM && !td_trim(td)));
606}
607
608static inline bool should_fsync(struct thread_data *td)
609{
610 if (td->last_was_sync)
611 return false;
612 if (td_write(td) || td->o.override_sync)
613 return true;
614
615 return false;
616}
617
618/*
619 * Init/option functions
620 */
621extern int __must_check fio_init_options(void);
622extern int __must_check parse_options(int, char **);
623extern int parse_jobs_ini(char *, int, int, int);
624extern int parse_cmd_line(int, char **, int);
625extern int fio_backend(struct sk_out *);
626extern void reset_fio_state(void);
627extern void clear_io_state(struct thread_data *, int);
628extern int fio_options_parse(struct thread_data *, char **, int);
629extern void fio_keywords_init(void);
630extern void fio_keywords_exit(void);
631extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
632extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
633extern void fio_fill_default_options(struct thread_data *);
634extern int fio_show_option_help(const char *);
635extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
636extern void fio_options_dup_and_init(struct option *);
637extern char *fio_option_dup_subs(const char *);
638extern void fio_options_mem_dupe(struct thread_data *);
639extern void td_fill_rand_seeds(struct thread_data *);
640extern void td_fill_verify_state_seed(struct thread_data *);
641extern void add_job_opts(const char **, int);
642extern int ioengine_load(struct thread_data *);
643extern bool parse_dryrun(void);
644extern int fio_running_or_pending_io_threads(void);
645extern int fio_set_fd_nonblocking(int, const char *);
646extern void sig_show_status(int sig);
647extern struct thread_data *get_global_options(void);
648
649extern uintptr_t page_mask;
650extern uintptr_t page_size;
651extern int initialize_fio(char *envp[]);
652extern void deinitialize_fio(void);
653
654#define FIO_GETOPT_JOB 0x89000000
655#define FIO_GETOPT_IOENGINE 0x98000000
656#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
657
658/*
659 * ETA/status stuff
660 */
661extern void print_thread_status(void);
662extern void print_status_init(int);
663extern char *fio_uint_to_kmg(unsigned int val);
664
665/*
666 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
667 * will never back again. It may cycle between running/verififying/fsyncing.
668 * Once the thread reaches TD_EXITED, it is just waiting for the core to
669 * reap it.
670 */
671enum {
672 TD_NOT_CREATED = 0,
673 TD_CREATED,
674 TD_INITIALIZED,
675 TD_RAMP,
676 TD_SETTING_UP,
677 TD_RUNNING,
678 TD_PRE_READING,
679 TD_VERIFYING,
680 TD_FSYNCING,
681 TD_FINISHING,
682 TD_EXITED,
683 TD_REAPED,
684 TD_LAST,
685 TD_NR,
686};
687
688#define TD_ENG_FLAG_SHIFT 18
689#define TD_ENG_FLAG_MASK ((1ULL << 18) - 1)
690
691static inline void td_set_ioengine_flags(struct thread_data *td)
692{
693 td->flags = (~(TD_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & td->flags) |
694 ((unsigned long long)td->io_ops->flags << TD_ENG_FLAG_SHIFT);
695}
696
697static inline bool td_ioengine_flagged(struct thread_data *td,
698 enum fio_ioengine_flags flags)
699{
700 return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
701}
702
703extern void td_set_runstate(struct thread_data *, int);
704extern int td_bump_runstate(struct thread_data *, int);
705extern void td_restore_runstate(struct thread_data *, int);
706extern const char *runstate_to_name(int runstate);
707
708/*
709 * Allow 60 seconds for a job to quit on its own, otherwise reap with
710 * a vengeance.
711 */
712#define FIO_REAP_TIMEOUT 300
713
714enum {
715 TERMINATE_NONE = 0,
716 TERMINATE_GROUP = 1,
717 TERMINATE_STONEWALL = 2,
718 TERMINATE_ALL = -1,
719};
720
721extern void fio_terminate_threads(unsigned int, unsigned int);
722extern void fio_mark_td_terminate(struct thread_data *);
723
724/*
725 * Memory helpers
726 */
727extern int __must_check fio_pin_memory(struct thread_data *);
728extern void fio_unpin_memory(struct thread_data *);
729extern int __must_check allocate_io_mem(struct thread_data *);
730extern void free_io_mem(struct thread_data *);
731extern void free_threads_shm(void);
732
733#ifdef FIO_INTERNAL
734#define PTR_ALIGN(ptr, mask) \
735 (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
736#endif
737
738/*
739 * Reset stats after ramp time completes
740 */
741extern void reset_all_stats(struct thread_data *);
742
743extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
744 enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
745 struct timespec *comp_time);
746
747/*
748 * Latency target helpers
749 */
750extern void lat_target_check(struct thread_data *);
751extern void lat_target_init(struct thread_data *);
752extern void lat_target_reset(struct thread_data *);
753
754/*
755 * Iterates all threads/processes within all the defined jobs
756 * Usage:
757 * for_each_td(var_name_for_td) {
758 * << bodoy of your loop >>
759 * Note: internally-scoped loop index availble as __td_index
760 * } end_for_each_td()
761 */
762#define for_each_td(td) \
763{ \
764 int __td_index; \
765 struct thread_data *(td); \
766 for (__td_index = 0, (td) = &segments[0].threads[0];\
767 __td_index < (int) thread_number; __td_index++, (td) = tnumber_to_td(__td_index))
768#define for_each_td_index() \
769{ \
770 int __td_index; \
771 for (__td_index = 0; __td_index < (int) thread_number; __td_index++)
772#define end_for_each() }
773
774#define for_each_file(td, f, i) \
775 if ((td)->files_index) \
776 for ((i) = 0, (f) = (td)->files[0]; \
777 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
778 (i)++)
779
780static inline bool fio_fill_issue_time(struct thread_data *td)
781{
782 if (td->o.read_iolog_file ||
783 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
784 return true;
785
786 return false;
787}
788
789static inline bool option_check_rate(struct thread_data *td, enum fio_ddir ddir)
790{
791 struct thread_options *o = &td->o;
792
793 /*
794 * If some rate setting was given, we need to check it
795 */
796 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
797 o->rate_iops_min[ddir])
798 return true;
799
800 return false;
801}
802
803static inline bool should_check_rate(struct thread_data *td)
804{
805 return (td->flags & TD_F_CHECK_RATE) != 0;
806}
807
808static inline unsigned long long td_max_bs(struct thread_data *td)
809{
810 unsigned long long max_bs;
811
812 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
813 return max(td->o.max_bs[DDIR_TRIM], max_bs);
814}
815
816static inline unsigned long long td_min_bs(struct thread_data *td)
817{
818 unsigned long long min_bs;
819
820 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
821 return min(td->o.min_bs[DDIR_TRIM], min_bs);
822}
823
824static inline bool td_async_processing(struct thread_data *td)
825{
826 return (td->flags & TD_F_NEED_LOCK) != 0;
827}
828
829static inline bool td_offload_overlap(struct thread_data *td)
830{
831 return td->o.serialize_overlap && td->o.io_submit_mode == IO_MODE_OFFLOAD;
832}
833
834/*
835 * We currently only need to do locking if we have verifier threads
836 * accessing our internal structures too
837 */
838static inline void __td_io_u_lock(struct thread_data *td)
839{
840 pthread_mutex_lock(&td->io_u_lock);
841}
842
843static inline void __td_io_u_unlock(struct thread_data *td)
844{
845 pthread_mutex_unlock(&td->io_u_lock);
846}
847
848static inline void td_io_u_free_notify(struct thread_data *td)
849{
850 if (td_async_processing(td))
851 pthread_cond_signal(&td->free_cond);
852}
853
854static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
855 unsigned int value)
856{
857 if (!td_async_processing(td))
858 *flags &= ~value;
859 else
860 __sync_fetch_and_and(flags, ~value);
861}
862
863static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
864 unsigned int value)
865{
866 if (!td_async_processing(td))
867 *flags |= value;
868 else
869 __sync_fetch_and_or(flags, value);
870}
871
872extern const char *fio_get_arch_string(int);
873extern const char *fio_get_os_string(int);
874
875enum {
876 __FIO_OUTPUT_TERSE = 0,
877 __FIO_OUTPUT_JSON = 1,
878 __FIO_OUTPUT_NORMAL = 2,
879 __FIO_OUTPUT_JSON_PLUS = 3,
880 FIO_OUTPUT_NR = 4,
881
882 FIO_OUTPUT_TERSE = 1U << __FIO_OUTPUT_TERSE,
883 FIO_OUTPUT_JSON = 1U << __FIO_OUTPUT_JSON,
884 FIO_OUTPUT_NORMAL = 1U << __FIO_OUTPUT_NORMAL,
885 FIO_OUTPUT_JSON_PLUS = 1U << __FIO_OUTPUT_JSON_PLUS,
886};
887
888enum {
889 FIO_RAND_DIST_RANDOM = 0,
890 FIO_RAND_DIST_ZIPF,
891 FIO_RAND_DIST_PARETO,
892 FIO_RAND_DIST_GAUSS,
893 FIO_RAND_DIST_ZONED,
894 FIO_RAND_DIST_ZONED_ABS,
895};
896
897#define FIO_DEF_ZIPF 1.1
898#define FIO_DEF_PARETO 0.2
899
900enum {
901 FIO_RAND_GEN_TAUSWORTHE = 0,
902 FIO_RAND_GEN_LFSR,
903 FIO_RAND_GEN_TAUSWORTHE64,
904};
905
906enum {
907 FIO_CPUS_SHARED = 0,
908 FIO_CPUS_SPLIT,
909};
910
911extern void exec_trigger(const char *);
912extern void check_trigger_file(void);
913
914extern bool in_flight_overlap(struct io_u_queue *q, struct io_u *io_u);
915extern pthread_mutex_t overlap_check;
916
917static inline void *fio_memalign(size_t alignment, size_t size, bool shared)
918{
919 return __fio_memalign(alignment, size, shared ? smalloc : malloc);
920}
921
922static inline void fio_memfree(void *ptr, size_t size, bool shared)
923{
924 return __fio_memfree(ptr, size, shared ? sfree : free);
925}
926
927#endif