blob: f6880841b048353ed027698ba67003b3f0998454 [file] [log] [blame]
Jens Axboeebac4652005-12-08 15:25:21 +01001#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>
Jens Axboe3c39a372006-06-06 20:56:12 +02009#include <errno.h>
10#include <stdlib.h>
11#include <stdio.h>
Jens Axboe6d6f0312006-06-07 21:39:13 +020012#include <unistd.h>
Jens Axboe34cfcda2006-11-03 14:00:45 +010013#include <string.h>
Jens Axboecd14cc12007-07-30 10:59:33 +020014#include <inttypes.h>
Jens Axboe7101d9c2007-09-12 13:12:39 +020015#include <assert.h>
Jens Axboeebac4652005-12-08 15:25:21 +010016
Jens Axboe317b95d2007-04-02 21:36:44 +020017#include "compiler/compiler.h"
Jens Axboe8062f522013-04-10 15:01:42 +020018#include "thread_options.h"
Jens Axboe01743ee2008-06-02 12:19:19 +020019#include "flist.h"
Jens Axboee2887562007-05-16 09:25:09 +020020#include "fifo.h"
Jens Axboe317b95d2007-04-02 21:36:44 +020021#include "arch/arch.h"
22#include "os/os.h"
Jens Axboe07739b52007-03-08 20:25:46 +010023#include "mutex.h"
Jens Axboea3d741f2008-02-27 18:32:33 +010024#include "log.h"
25#include "debug.h"
Jens Axboed6aed792009-06-03 08:41:15 +020026#include "file.h"
27#include "io_ddir.h"
Jens Axboedcefb582009-06-03 08:49:39 +020028#include "ioengine.h"
Jens Axboe5995a6a2009-06-03 08:53:28 +020029#include "iolog.h"
Jens Axboec5c8bd52009-11-24 13:01:41 +010030#include "helpers.h"
Jens Axboe07b32322010-03-05 09:48:44 +010031#include "options.h"
Jens Axboe7eb36572010-03-08 13:58:49 +010032#include "profile.h"
Daniel Gollubef3c94b2014-04-30 11:25:04 +020033#include "fio_time.h"
Jens Axboea7346812012-02-09 15:02:39 +010034#include "gettime.h"
Cigy Cyriacbf2e8212010-08-10 19:51:11 -040035#include "lib/getopt.h"
Jens Axboe2615cc42011-03-28 09:35:09 +020036#include "lib/rand.h"
Jens Axboe7fb6d452013-04-10 20:48:31 +020037#include "lib/rbtree.h"
Stephen M. Camerondd366722012-02-24 08:17:30 +010038#include "client.h"
Jens Axboe37db14f2011-09-30 17:00:42 -060039#include "server.h"
Jens Axboea64e88d2011-10-03 14:20:01 +020040#include "stat.h"
Dan Ehrenberg9e684a42012-02-20 11:05:14 +010041#include "flow.h"
Jens Axboe2ae0b202013-05-28 14:16:55 +020042#include "io_u_queue.h"
Jens Axboeebac4652005-12-08 15:25:21 +010043
Jens Axboe4700b232013-01-24 15:33:33 -070044#ifdef CONFIG_SOLARISAIO
Jens Axboe417f0062008-06-02 11:59:30 +020045#include <sys/asynch.h>
46#endif
47
Jens Axboe67bf9822013-01-10 11:23:19 +010048#ifdef CONFIG_LIBNUMA
Yufei Rend0b937e2012-10-19 23:11:52 -040049#include <linux/mempolicy.h>
50#include <numa.h>
51
52/*
53 * "local" is pseudo-policy
54 */
55#define MPOL_LOCAL MPOL_MAX
56#endif
57
Jens Axboee9c047a2006-06-07 21:13:04 +020058/*
Jens Axboe38dad622010-07-20 14:46:00 -060059 * offset generator types
60 */
61enum {
62 RW_SEQ_SEQ = 0,
63 RW_SEQ_IDENT,
64};
65
Jens Axboed72be542012-11-30 19:37:46 +010066enum {
67 TD_F_VER_BACKLOG = 1,
68 TD_F_TRIM_BACKLOG = 2,
69 TD_F_READ_IOLOG = 4,
70 TD_F_REFILL_BUFFERS = 8,
71 TD_F_SCRAMBLE_BUFFERS = 16,
72 TD_F_VER_NONE = 32,
73 TD_F_PROFILE_OPS = 64,
Jens Axboebedc9dc2014-03-17 12:51:09 -060074 TD_F_COMPRESS = 128,
Jens Axboe046395d2014-04-09 13:57:38 -060075 TD_F_NOIO = 256,
Jens Axboe38a812d2014-07-03 09:10:39 -060076 TD_F_COMPRESS_LOG = 512,
Jens Axboede54cfd2014-11-10 20:34:00 -070077 TD_F_VSTATE_SAVED = 1024,
Jens Axboed72be542012-11-30 19:37:46 +010078};
79
Jens Axboed24945f2012-12-04 13:10:29 +010080enum {
81 FIO_RAND_BS_OFF = 0,
82 FIO_RAND_VER_OFF,
83 FIO_RAND_MIX_OFF,
84 FIO_RAND_FILE_OFF,
85 FIO_RAND_BLOCK_OFF,
86 FIO_RAND_FILE_SIZE_OFF,
87 FIO_RAND_TRIM_OFF,
88 FIO_RAND_BUF_OFF,
Jens Axboed9472272013-07-25 10:20:45 -060089 FIO_RAND_SEQ_RAND_READ_OFF,
90 FIO_RAND_SEQ_RAND_WRITE_OFF,
91 FIO_RAND_SEQ_RAND_TRIM_OFF,
Christian Ehrhardt23ed19b2014-02-20 09:07:02 -080092 FIO_RAND_START_DELAY,
Jens Axboee66dac22014-09-22 10:02:07 -060093 FIO_DEDUPE_OFF,
Jens Axboed24945f2012-12-04 13:10:29 +010094 FIO_RAND_NR_OFFS,
95};
96
Jens Axboe2dc1bbe2007-03-15 15:01:33 +010097/*
98 * This describes a single thread/process executing a fio job.
99 */
100struct thread_data {
101 struct thread_options o;
Jens Axboed72be542012-11-30 19:37:46 +0100102 unsigned long flags;
Steven Langde890a12011-11-09 14:03:34 +0100103 void *eo;
Jens Axboee4e33252007-03-21 13:07:54 +0100104 char verror[FIO_VERROR_SIZE];
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100105 pthread_t thread;
Jens Axboe2f122b12012-03-15 13:10:19 +0100106 unsigned int thread_number;
Jiri Horky5a65b4e2014-07-25 09:55:03 +0200107 unsigned int subjob_number;
Jens Axboe2f122b12012-03-15 13:10:19 +0100108 unsigned int groupid;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100109 struct thread_stat ts;
Jens Axboe7b9f7332011-10-03 10:06:44 +0200110
Jens Axboe46bcd492012-03-14 11:31:21 +0100111 int client_type;
112
Jens Axboe7b9f7332011-10-03 10:06:44 +0200113 struct io_log *slat_log;
114 struct io_log *clat_log;
115 struct io_log *lat_log;
116 struct io_log *bw_log;
Jens Axboec8eeb9d2011-10-05 14:02:22 +0200117 struct io_log *iops_log;
Jens Axboe7b9f7332011-10-03 10:06:44 +0200118
Jens Axboe38a812d2014-07-03 09:10:39 -0600119 struct tp_data *tp_data;
120
Shaohua Li6eaf09d2012-09-14 08:49:43 +0200121 uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
Jens Axboec8eeb9d2011-10-05 14:02:22 +0200122 struct timeval bw_sample_time;
123
Shaohua Li6eaf09d2012-09-14 08:49:43 +0200124 uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
Jens Axboec8eeb9d2011-10-05 14:02:22 +0200125 struct timeval iops_sample_time;
Jens Axboef0505a12011-10-03 12:12:03 +0200126
Jens Axboede54cfd2014-11-10 20:34:00 -0700127 /*
128 * Tracks the last iodepth number of completed writes, if data
129 * verification is enabled
130 */
131 uint64_t *last_write_comp;
132 unsigned int last_write_idx;
133
Jens Axboec97f1ad2013-03-28 15:08:49 -0600134 volatile int update_rusage;
135 struct fio_mutex *rusage_sem;
Jens Axboec8aaba12011-10-03 12:14:19 +0200136 struct rusage ru_start;
137 struct rusage ru_end;
138
Jens Axboe126d65c2008-03-01 18:04:31 +0100139 struct fio_file **files;
Jens Axboed7df1d12013-03-20 19:57:01 -0600140 unsigned char *file_locks;
Jens Axboedd87b2c2009-03-04 15:28:31 +0100141 unsigned int files_size;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100142 unsigned int files_index;
143 unsigned int nr_open_files;
Jens Axboe1020a132007-03-29 11:15:06 +0200144 unsigned int nr_done_files;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100145 unsigned int nr_normal_files;
146 union {
147 unsigned int next_file;
Jens Axboef6787012014-11-05 18:39:23 -0700148 struct frand_state next_file_state;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100149 };
150 int error;
Jens Axboea5e371a2012-04-02 09:47:09 -0700151 int sig;
Jens Axboe20e354e2007-07-23 14:36:16 +0200152 int done;
Jens Axboede54cfd2014-11-10 20:34:00 -0700153 int stop_io;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100154 pid_t pid;
155 char *orig_buffer;
156 size_t orig_buffer_size;
157 volatile int terminate;
158 volatile int runstate;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100159 unsigned int last_was_sync;
Jens Axboe9e144182010-06-15 14:25:36 +0200160 enum fio_ddir last_ddir;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100161
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100162 int mmapfd;
163
Jens Axboe843a7412006-06-01 21:14:21 -0700164 void *iolog_buf;
165 FILE *iolog_f;
Jens Axboeebac4652005-12-08 15:25:21 +0100166
Jens Axboeda867742006-06-06 10:39:10 -0700167 char *sysfs_root;
Jens Axboeda867742006-06-06 10:39:10 -0700168
Jens Axboed24945f2012-12-04 13:10:29 +0100169 unsigned long rand_seeds[FIO_RAND_NR_OFFS];
Jens Axboe5bfc35d2009-04-07 13:28:12 +0200170
Jens Axboef6787012014-11-05 18:39:23 -0700171 struct frand_state bsrange_state;
172 struct frand_state verify_state;
173 struct frand_state trim_state;
174 struct frand_state delay_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100175
Jens Axboe3545a102011-08-31 15:20:15 -0600176 struct frand_state buf_state;
Jens Axboee66dac22014-09-22 10:02:07 -0600177 struct frand_state buf_state_prev;
178 struct frand_state dedupe_state;
Jens Axboe3545a102011-08-31 15:20:15 -0600179
Jens Axboe9e144182010-06-15 14:25:36 +0200180 unsigned int verify_batch;
Jens Axboe0d29de82010-09-01 13:54:15 +0200181 unsigned int trim_batch;
Jens Axboe9e144182010-06-15 14:25:36 +0200182
Jens Axboede54cfd2014-11-10 20:34:00 -0700183 struct thread_io_list *vstate;
184
Jens Axboeebac4652005-12-08 15:25:21 +0100185 int shm_id;
186
Jens Axboee9c047a2006-06-07 21:13:04 +0200187 /*
188 * IO engine hooks, contains everything needed to submit an io_u
189 * to any of the available IO engines.
190 */
Jens Axboe2866c822006-10-09 15:57:48 +0200191 struct ioengine_ops *io_ops;
Jens Axboeebac4652005-12-08 15:25:21 +0100192
Jens Axboee9c047a2006-06-07 21:13:04 +0200193 /*
Ryan Marchand422f9e42012-01-31 14:05:32 +0100194 * Queue depth of io_u's that fio MIGHT do
Jens Axboee9c047a2006-06-07 21:13:04 +0200195 */
Jens Axboeebac4652005-12-08 15:25:21 +0100196 unsigned int cur_depth;
Ryan Marchand422f9e42012-01-31 14:05:32 +0100197
198 /*
199 * io_u's about to be committed
200 */
Jens Axboed8005752008-05-15 09:49:09 +0200201 unsigned int io_u_queued;
Ryan Marchand422f9e42012-01-31 14:05:32 +0100202
203 /*
204 * io_u's submitted but not completed yet
205 */
206 unsigned int io_u_in_flight;
207
208 /*
209 * List of free and busy io_u's
210 */
Jens Axboe2ae0b202013-05-28 14:16:55 +0200211 struct io_u_ring io_u_requeues;
212 struct io_u_queue io_u_freelist;
213 struct io_u_queue io_u_all;
Jens Axboee8462bd2009-07-06 12:59:04 +0200214 pthread_mutex_t io_u_lock;
215 pthread_cond_t free_cond;
216
217 /*
218 * async verify offload
219 */
220 struct flist_head verify_list;
221 pthread_t *verify_threads;
222 unsigned int nr_verify_threads;
223 pthread_cond_t verify_cond;
224 int verify_thread_exit;
Jens Axboeebac4652005-12-08 15:25:21 +0100225
Jens Axboee9c047a2006-06-07 21:13:04 +0200226 /*
227 * Rate state
228 */
Jens Axboebdb6d202013-03-19 07:48:46 -0600229 uint64_t rate_bps[DDIR_RWDIR_CNT];
Shaohua Li6eaf09d2012-09-14 08:49:43 +0200230 long rate_pending_usleep[DDIR_RWDIR_CNT];
231 unsigned long rate_bytes[DDIR_RWDIR_CNT];
232 unsigned long rate_blocks[DDIR_RWDIR_CNT];
233 struct timeval lastrate[DDIR_RWDIR_CNT];
Jens Axboeebac4652005-12-08 15:25:21 +0100234
Jens Axboebdb6d202013-03-19 07:48:46 -0600235 uint64_t total_io_size;
236 uint64_t fill_device_size;
Jens Axboeebac4652005-12-08 15:25:21 +0100237
Jens Axboe5d61d112015-01-16 10:03:11 -0700238 /*
239 * Issue side
240 */
Jens Axboede54cfd2014-11-10 20:34:00 -0700241 uint64_t io_issues[DDIR_RWDIR_CNT];
Jens Axboe5d61d112015-01-16 10:03:11 -0700242 uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
Jens Axboe842d2e22015-02-24 14:50:57 -0800243 uint64_t loops;
Jens Axboe5d61d112015-01-16 10:03:11 -0700244
245 /*
246 * Completions
247 */
Jens Axboebdb6d202013-03-19 07:48:46 -0600248 uint64_t io_blocks[DDIR_RWDIR_CNT];
249 uint64_t this_io_blocks[DDIR_RWDIR_CNT];
250 uint64_t io_bytes[DDIR_RWDIR_CNT];
251 uint64_t io_skip_bytes;
252 uint64_t this_io_bytes[DDIR_RWDIR_CNT];
253 uint64_t zone_bytes;
Jens Axboecdd18ad2008-02-27 18:58:00 +0100254 struct fio_mutex *mutex;
Jens Axboeebac4652005-12-08 15:25:21 +0100255
Jens Axboee9c047a2006-06-07 21:13:04 +0200256 /*
257 * State for random io, a bitmap of blocks done vs not done
258 */
Jens Axboef6787012014-11-05 18:39:23 -0700259 struct frand_state random_state;
Jens Axboeebac4652005-12-08 15:25:21 +0100260
Jens Axboeebac4652005-12-08 15:25:21 +0100261 struct timeval start; /* start of this loop */
262 struct timeval epoch; /* time job was started */
Jens Axboea61edde2007-05-15 14:29:58 +0200263 struct timeval last_issue;
Jens Axboef15b9e52014-11-21 14:33:33 -0700264 long time_offset;
Jens Axboe993bf482008-11-14 13:04:53 +0100265 struct timeval tv_cache;
Jens Axboe958b8912014-07-09 08:46:12 +0200266 struct timeval terminate_time;
Jens Axboe993bf482008-11-14 13:04:53 +0100267 unsigned int tv_cache_nr;
268 unsigned int tv_cache_mask;
Jens Axboe721938a2008-09-10 09:46:16 +0200269 unsigned int ramp_time_over;
Jens Axboeebac4652005-12-08 15:25:21 +0100270
Jens Axboee9c047a2006-06-07 21:13:04 +0200271 /*
Jens Axboe3e260a42013-12-09 12:38:53 -0700272 * Time since last latency_window was started
273 */
274 struct timeval latency_ts;
275 unsigned int latency_qd;
276 unsigned int latency_qd_high;
277 unsigned int latency_qd_low;
278 unsigned int latency_failed;
279 uint64_t latency_ios;
Jens Axboe6bb58212014-02-21 13:55:31 -0800280 int latency_end_run;
Jens Axboe3e260a42013-12-09 12:38:53 -0700281
282 /*
Jens Axboee9c047a2006-06-07 21:13:04 +0200283 * read/write mixed workload state
284 */
Jens Axboef6787012014-11-05 18:39:23 -0700285 struct frand_state rwmix_state;
Jens Axboee4928662008-04-07 09:19:46 +0200286 unsigned long rwmix_issues;
Jens Axboee9c047a2006-06-07 21:13:04 +0200287 enum fio_ddir rwmix_ddir;
Jens Axboe5736c102010-07-20 12:03:25 -0600288 unsigned int ddir_seq_nr;
Jens Axboea6ccc7b2006-06-02 10:14:15 +0200289
Jens Axboe4e0ba8a2006-06-06 09:36:28 +0200290 /*
Jens Axboe211c9b82013-04-26 08:56:17 -0600291 * rand/seq mixed workload state
292 */
Jens Axboef6787012014-11-05 18:39:23 -0700293 struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
Jens Axboe211c9b82013-04-26 08:56:17 -0600294
295 /*
Jens Axboe8de8f042007-03-27 10:36:12 +0200296 * IO history logs for verification. We use a tree for sorting,
297 * if we are overwriting. Otherwise just use a fifo.
Jens Axboee9c047a2006-06-07 21:13:04 +0200298 */
Jens Axboe4b878982007-03-26 09:32:22 +0200299 struct rb_root io_hist_tree;
Jens Axboe01743ee2008-06-02 12:19:19 +0200300 struct flist_head io_hist_list;
Jens Axboe9e144182010-06-15 14:25:36 +0200301 unsigned long io_hist_len;
Jens Axboe8de8f042007-03-27 10:36:12 +0200302
303 /*
304 * For IO replaying
305 */
Jens Axboe01743ee2008-06-02 12:19:19 +0200306 struct flist_head io_log_list;
Jens Axboe433afcb2007-02-22 10:39:01 +0100307
308 /*
Jens Axboe0d29de82010-09-01 13:54:15 +0200309 * For tracking/handling discards
310 */
311 struct flist_head trim_list;
312 unsigned long trim_entries;
313
Jens Axboe1ae83d42013-01-12 01:44:15 -0700314 struct flist_head next_rand_list;
315
Jens Axboe0d29de82010-09-01 13:54:15 +0200316 /*
Jens Axboe1907dbc2007-03-12 11:44:28 +0100317 * for fileservice, how often to switch to a new file
318 */
319 unsigned int file_service_nr;
320 unsigned int file_service_left;
321 struct fio_file *file_service_file;
Jens Axboe9c60ce62007-03-15 09:14:47 +0100322
Jens Axboe44f29692010-03-09 20:09:44 +0100323 unsigned int sync_file_range_nr;
324
Jens Axboe9c60ce62007-03-15 09:14:47 +0100325 /*
326 * For generating file sizes
327 */
Jens Axboef6787012014-11-05 18:39:23 -0700328 struct frand_state file_size_state;
Radha Ramachandranf2bba182009-06-15 08:40:16 +0200329
330 /*
331 * Error counts
332 */
333 unsigned int total_err_count;
334 int first_error;
Jens Axboe15dc1932010-03-05 10:59:06 +0100335
Dan Ehrenberg9e684a42012-02-20 11:05:14 +0100336 struct fio_flow *flow;
337
Jens Axboe15dc1932010-03-05 10:59:06 +0100338 /*
339 * Can be overloaded by profiles
340 */
Jens Axboe7eb36572010-03-08 13:58:49 +0100341 struct prof_io_ops prof_io_ops;
Jens Axboe58c55ba2010-03-09 12:20:08 +0100342 void *prof_data;
Jens Axboe9a3f1102012-03-28 20:50:15 +0200343
344 void *pinned_mem;
Jens Axboeebac4652005-12-08 15:25:21 +0100345};
346
Jens Axboe433afcb2007-02-22 10:39:01 +0100347/*
Aaron Carrolle592a062007-09-14 09:49:41 +0200348 * when should interactive ETA output be generated
349 */
350enum {
351 FIO_ETA_AUTO,
352 FIO_ETA_ALWAYS,
353 FIO_ETA_NEVER,
354};
355
Jens Axboee1161c32007-02-22 19:36:48 +0100356#define __td_verror(td, err, msg, func) \
Jens Axboeebac4652005-12-08 15:25:21 +0100357 do { \
Jens Axboe21beb602014-04-14 09:04:48 -0600358 unsigned int ____e = (err); \
Jens Axboe19abcd32007-02-21 20:14:33 +0100359 if ((td)->error) \
360 break; \
Jens Axboe82719632014-02-12 09:10:10 -0700361 (td)->error = ____e; \
Radha Ramachandranf2bba182009-06-15 08:40:16 +0200362 if (!(td)->first_error) \
Ken Raeburn98ffb8f2013-01-30 22:31:09 +0100363 snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
Jens Axboeebac4652005-12-08 15:25:21 +0100364 } while (0)
365
Jens Axboeb990b5c2006-09-14 09:48:22 +0200366
Radha Ramachandranf2bba182009-06-15 08:40:16 +0200367#define td_clear_error(td) \
368 (td)->error = 0;
Jens Axboee1161c32007-02-22 19:36:48 +0100369#define td_verror(td, err, func) \
370 __td_verror((td), (err), strerror((err)), (func))
371#define td_vmsg(td, err, msg, func) \
372 __td_verror((td), (err), (msg), (func))
Jens Axboeb990b5c2006-09-14 09:48:22 +0200373
Jens Axboe81179ee2011-10-04 12:42:06 +0200374#define __fio_stringify_1(x) #x
375#define __fio_stringify(x) __fio_stringify_1(x)
376
Jens Axboeebac4652005-12-08 15:25:21 +0100377extern int exitall_on_terminate;
Jens Axboe11e950b2011-10-16 21:34:14 +0200378extern unsigned int thread_number;
Jens Axboe108fea72012-11-14 13:09:45 -0700379extern unsigned int stat_number;
Jens Axboeebac4652005-12-08 15:25:21 +0100380extern int shm_id;
381extern int groupid;
Jens Axboef3afa572012-09-17 13:34:16 +0200382extern int output_format;
Christian Ehrhardt2b8c71b2014-02-20 14:20:04 +0100383extern int append_terse_output;
Jens Axboe53cdc682006-10-18 11:50:58 +0200384extern int temp_stall_ts;
Bruce Cran70781062012-04-03 18:00:00 -0600385extern uintptr_t page_mask, page_size;
Jens Axboe4241ea82007-09-12 08:18:36 +0200386extern int read_only;
Aaron Carrolle592a062007-09-14 09:49:41 +0200387extern int eta_print;
Jens Axboee382e662013-02-22 20:48:56 +0100388extern int eta_new_line;
Jens Axboed3eeeab2008-04-06 12:19:05 +0200389extern unsigned long done_secs;
Jens Axboe01f06b62008-02-18 20:53:47 +0100390extern char *job_section;
Jens Axboebe4ecfd2008-12-08 14:10:52 +0100391extern int fio_gtod_offload;
392extern int fio_gtod_cpu;
Jens Axboec223da82010-03-24 13:23:53 +0100393extern enum fio_cs fio_clock_source;
Jens Axboefa80fea2012-12-09 20:29:00 +0100394extern int fio_clock_source_set;
Jens Axboea9523c62011-01-17 16:49:54 -0700395extern int warnings_fatal;
Jens Axboef57a9c52011-09-09 21:01:37 +0200396extern int terse_version;
Jens Axboe5c341e92011-09-29 18:00:35 -0600397extern int is_backend;
Jens Axboea37f69b2011-10-01 12:24:21 -0600398extern int nr_clients;
Jens Axboee46d8092011-10-03 09:11:02 +0200399extern int log_syslog;
Jens Axboe06464902013-04-24 20:38:54 -0600400extern int status_interval;
Jens Axboe5e726d02011-10-14 08:08:10 +0200401extern const char fio_version_string[];
Jens Axboe7fe36312014-10-23 23:16:50 -0600402extern int helper_do_stat;
403extern pthread_cond_t helper_cond;
Jens Axboede54cfd2014-11-10 20:34:00 -0700404extern char *trigger_file;
405extern char *trigger_cmd;
Jens Axboea4432072014-11-19 08:36:12 -0700406extern char *trigger_remote_cmd;
Jens Axboede54cfd2014-11-10 20:34:00 -0700407extern long long trigger_timeout;
Jens Axboeebac4652005-12-08 15:25:21 +0100408
409extern struct thread_data *threads;
410
Jens Axboe5a48d302014-09-30 13:29:57 -0600411static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
Jens Axboe7101d9c2007-09-12 13:12:39 +0200412{
413 assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
414}
415
Jens Axboefca70352011-07-06 20:12:54 +0200416#define REAL_MAX_JOBS 2048
Jens Axboeebac4652005-12-08 15:25:21 +0100417
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200418static inline int should_fsync(struct thread_data *td)
419{
420 if (td->last_was_sync)
421 return 0;
Jens Axboe2dc1bbe2007-03-15 15:01:33 +0100422 if (td_write(td) || td_rw(td) || td->o.override_sync)
Jens Axboe87dc1ab2006-10-24 14:41:26 +0200423 return 1;
424
425 return 0;
426}
427
Jens Axboe1c9e06e2007-02-11 04:07:57 +0100428/*
Jens Axboe214e1ec2007-03-15 10:48:13 +0100429 * Init/option functions
Jens Axboe8914a9d2006-06-07 11:14:56 +0200430 */
Jens Axboe0420ba62012-02-29 11:16:52 +0100431extern int __must_check fio_init_options(void);
Jens Axboe72cb9712007-02-20 20:54:45 +0100432extern int __must_check parse_options(int, char **);
Jens Axboe46bcd492012-03-14 11:31:21 +0100433extern int parse_jobs_ini(char *, int, int, int);
434extern int parse_cmd_line(int, char **, int);
Jens Axboe2e1df072012-02-09 11:15:02 +0100435extern int fio_backend(void);
Jens Axboe50d16972011-09-29 17:45:28 -0600436extern void reset_fio_state(void);
Jens Axboe2e1df072012-02-09 11:15:02 +0100437extern void clear_io_state(struct thread_data *);
Jens Axboe292cc472013-11-26 20:39:35 -0700438extern int fio_options_parse(struct thread_data *, char **, int, int);
Jens Axboe74929ac2009-08-05 11:42:37 +0200439extern void fio_keywords_init(void);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100440extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
Steven Langde890a12011-11-09 14:03:34 +0100441extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100442extern void fio_fill_default_options(struct thread_data *);
443extern int fio_show_option_help(const char *);
Steven Langde890a12011-11-09 14:03:34 +0100444extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
Jens Axboe214e1ec2007-03-15 10:48:13 +0100445extern void fio_options_dup_and_init(struct option *);
Steven Langde890a12011-11-09 14:03:34 +0100446extern void fio_options_mem_dupe(struct thread_data *);
447extern void options_mem_dupe(void *data, struct fio_option *options);
Jens Axboe5bfc35d2009-04-07 13:28:12 +0200448extern void td_fill_rand_seeds(struct thread_data *);
Jens Axboe46bcd492012-03-14 11:31:21 +0100449extern void add_job_opts(const char **, int);
Jens Axboede54cfd2014-11-10 20:34:00 -0700450extern char *num2str(uint64_t, int, int, int, int);
Steven Langde890a12011-11-09 14:03:34 +0100451extern int ioengine_load(struct thread_data *);
Jens Axboef9633d72013-09-06 09:59:56 -0600452extern int parse_dryrun(void);
Jens Axboe046395d2014-04-09 13:57:38 -0600453extern int fio_running_or_pending_io_threads(void);
Jens Axboe3a358452014-04-15 09:07:44 -0600454extern int fio_set_fd_nonblocking(int, const char *);
Jens Axboe1ec3d692010-09-16 09:35:34 +0200455
Jens Axboea569b452013-04-11 11:51:35 +0200456extern uintptr_t page_mask;
457extern uintptr_t page_size;
458extern int initialize_fio(char *envp[]);
459
Steven Langde890a12011-11-09 14:03:34 +0100460#define FIO_GETOPT_JOB 0x89000000
461#define FIO_GETOPT_IOENGINE 0x98000000
Jens Axboe07b32322010-03-05 09:48:44 +0100462#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
Jens Axboe8914a9d2006-06-07 11:14:56 +0200463
Jens Axboebbfd6b02006-06-07 19:42:54 +0200464/*
Jens Axboe263e5292006-10-18 15:37:01 +0200465 * ETA/status stuff
466 */
467extern void print_thread_status(void);
468extern void print_status_init(int);
Jens Axboe0a428b22013-04-11 12:26:55 +0200469extern char *fio_uint_to_kmg(unsigned int val);
Jens Axboe263e5292006-10-18 15:37:01 +0200470
471/*
472 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
473 * will never back again. It may cycle between running/verififying/fsyncing.
474 * Once the thread reaches TD_EXITED, it is just waiting for the core to
475 * reap it.
476 */
477enum {
478 TD_NOT_CREATED = 0,
479 TD_CREATED,
480 TD_INITIALIZED,
Jens Axboeb29ee5b2008-09-11 10:17:26 +0200481 TD_RAMP,
Jens Axboe36d80bc2012-11-30 21:46:06 +0100482 TD_SETTING_UP,
Jens Axboe263e5292006-10-18 15:37:01 +0200483 TD_RUNNING,
Jens Axboeb0f65862009-05-20 11:52:15 +0200484 TD_PRE_READING,
Jens Axboe263e5292006-10-18 15:37:01 +0200485 TD_VERIFYING,
486 TD_FSYNCING,
Jens Axboe3d434052014-04-02 15:46:22 -0600487 TD_FINISHING,
Jens Axboe263e5292006-10-18 15:37:01 +0200488 TD_EXITED,
489 TD_REAPED,
490};
491
Jens Axboeb29ee5b2008-09-11 10:17:26 +0200492extern void td_set_runstate(struct thread_data *, int);
Jens Axboe8edd9732014-03-01 08:24:03 -0700493extern int td_bump_runstate(struct thread_data *, int);
494extern void td_restore_runstate(struct thread_data *, int);
495
Jens Axboe958b8912014-07-09 08:46:12 +0200496/*
497 * Allow 60 seconds for a job to quit on its own, otherwise reap with
498 * a vengeance.
499 */
500#define FIO_REAP_TIMEOUT 60
501
Jens Axboecc0df002011-10-03 20:53:32 +0200502#define TERMINATE_ALL (-1)
503extern void fio_terminate_threads(int);
Jens Axboe3b44e8b2014-07-09 11:24:12 +0200504extern void fio_mark_td_terminate(struct thread_data *);
Jens Axboeb29ee5b2008-09-11 10:17:26 +0200505
Jens Axboe263e5292006-10-18 15:37:01 +0200506/*
Jens Axboe2f9ade32006-10-20 11:25:52 +0200507 * Memory helpers
508 */
Jens Axboe9a3f1102012-03-28 20:50:15 +0200509extern int __must_check fio_pin_memory(struct thread_data *);
510extern void fio_unpin_memory(struct thread_data *);
Jens Axboeb2fdda42007-02-20 20:52:51 +0100511extern int __must_check allocate_io_mem(struct thread_data *);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200512extern void free_io_mem(struct thread_data *);
Jens Axboe2bb3f0a2012-03-28 12:22:40 +0200513extern void free_threads_shm(void);
Jens Axboe2f9ade32006-10-20 11:25:52 +0200514
515/*
Jens Axboeb29ee5b2008-09-11 10:17:26 +0200516 * Reset stats after ramp time completes
517 */
518extern void reset_all_stats(struct thread_data *);
519
520/*
Jens Axboefb7b71a2007-05-15 08:44:04 +0200521 * blktrace support
522 */
Jens Axboe5e62c222007-05-22 13:27:30 +0200523#ifdef FIO_HAVE_BLKTRACE
Jens Axboed95b34a2013-11-21 09:55:49 -0700524extern int is_blktrace(const char *, int *);
525extern int load_blktrace(struct thread_data *, const char *, int);
Jens Axboe5e62c222007-05-22 13:27:30 +0200526#endif
Jens Axboefb7b71a2007-05-15 08:44:04 +0200527
Jens Axboe3e260a42013-12-09 12:38:53 -0700528/*
529 * Latency target helpers
530 */
531extern void lat_target_check(struct thread_data *);
532extern void lat_target_init(struct thread_data *);
Jens Axboe6bb58212014-02-21 13:55:31 -0800533extern void lat_target_reset(struct thread_data *);
Jens Axboe3e260a42013-12-09 12:38:53 -0700534
Jens Axboe34572e22006-10-20 09:33:18 +0200535#define for_each_td(td, i) \
536 for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200537#define for_each_file(td, f, i) \
Jens Axboe691c8fb2008-03-07 14:26:26 +0100538 if ((td)->files_index) \
539 for ((i) = 0, (f) = (td)->files[0]; \
540 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
541 (i)++)
Jens Axboe53cdc682006-10-18 11:50:58 +0200542
Jens Axboe0032bf92007-02-13 17:39:56 +0100543#define fio_assert(td, cond) do { \
544 if (!(cond)) { \
Jens Axboe340fd242007-02-13 20:09:10 +0100545 int *__foo = NULL; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100546 fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
Jens Axboeac18ea32011-05-02 13:14:26 -0600547 td_set_runstate((td), TD_EXITED); \
Jens Axboe437c9b72007-02-13 18:20:37 +0100548 (td)->error = EFAULT; \
Jens Axboe340fd242007-02-13 20:09:10 +0100549 *__foo = 0; \
Jens Axboe0032bf92007-02-13 17:39:56 +0100550 } \
551} while (0)
552
Jens Axboe12d9d842008-10-16 21:26:10 +0200553static inline int fio_fill_issue_time(struct thread_data *td)
554{
555 if (td->o.read_iolog_file ||
556 !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
557 return 1;
558
559 return 0;
560}
561
Jens Axboe581e7142009-06-09 12:47:16 +0200562static inline int __should_check_rate(struct thread_data *td,
563 enum fio_ddir ddir)
564{
565 struct thread_options *o = &td->o;
566
567 /*
568 * If some rate setting was given, we need to check it
569 */
570 if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
571 o->rate_iops_min[ddir])
572 return 1;
573
574 return 0;
575}
576
577static inline int should_check_rate(struct thread_data *td,
Jens Axboeaa833212013-01-23 13:35:14 -0700578 uint64_t *bytes_done)
Jens Axboe581e7142009-06-09 12:47:16 +0200579{
580 int ret = 0;
581
Shaohua Li6eaf09d2012-09-14 08:49:43 +0200582 if (bytes_done[DDIR_READ])
583 ret |= __should_check_rate(td, DDIR_READ);
584 if (bytes_done[DDIR_WRITE])
585 ret |= __should_check_rate(td, DDIR_WRITE);
586 if (bytes_done[DDIR_TRIM])
587 ret |= __should_check_rate(td, DDIR_TRIM);
Jens Axboe581e7142009-06-09 12:47:16 +0200588
589 return ret;
590}
591
Jens Axboe74f4b022013-03-22 22:56:55 -0600592static inline unsigned int td_max_bs(struct thread_data *td)
593{
594 unsigned int max_bs;
595
596 max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
597 return max(td->o.max_bs[DDIR_TRIM], max_bs);
598}
599
Jens Axboe8d916c92013-04-25 10:11:41 -0600600static inline unsigned int td_min_bs(struct thread_data *td)
601{
602 unsigned int min_bs;
603
604 min_bs = min(td->o.min_bs[DDIR_READ], td->o.min_bs[DDIR_WRITE]);
605 return min(td->o.min_bs[DDIR_TRIM], min_bs);
606}
607
Jens Axboede54cfd2014-11-10 20:34:00 -0700608static inline int is_power_of_2(uint64_t val)
Jens Axboed529ee12009-07-01 10:33:03 +0200609{
610 return (val != 0 && ((val & (val - 1)) == 0));
611}
612
Jens Axboee8462bd2009-07-06 12:59:04 +0200613/*
614 * We currently only need to do locking if we have verifier threads
615 * accessing our internal structures too
616 */
617static inline void td_io_u_lock(struct thread_data *td)
618{
619 if (td->o.verify_async)
620 pthread_mutex_lock(&td->io_u_lock);
621}
622
623static inline void td_io_u_unlock(struct thread_data *td)
624{
625 if (td->o.verify_async)
626 pthread_mutex_unlock(&td->io_u_lock);
627}
628
629static inline void td_io_u_free_notify(struct thread_data *td)
630{
631 if (td->o.verify_async)
632 pthread_cond_signal(&td->free_cond);
633}
634
Jens Axboecca84642011-10-07 12:47:57 +0200635extern const char *fio_get_arch_string(int);
636extern const char *fio_get_os_string(int);
637
Daniel Gollube2c81042014-05-01 14:07:03 +0200638#ifdef FIO_INTERNAL
Jens Axboe05775432012-03-21 14:07:11 +0100639#define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
Daniel Gollube2c81042014-05-01 14:07:03 +0200640#endif
Jens Axboe05775432012-03-21 14:07:11 +0100641
Jens Axboef3afa572012-09-17 13:34:16 +0200642enum {
643 FIO_OUTPUT_TERSE = 0,
644 FIO_OUTPUT_JSON,
645 FIO_OUTPUT_NORMAL,
646};
647
Jens Axboee25839d2012-11-06 10:49:42 +0100648enum {
649 FIO_RAND_DIST_RANDOM = 0,
650 FIO_RAND_DIST_ZIPF,
Jens Axboe925fee32012-11-06 13:50:32 +0100651 FIO_RAND_DIST_PARETO,
Jens Axboee25839d2012-11-06 10:49:42 +0100652};
653
Jens Axboeb357a222015-01-04 10:02:34 -0700654#define FIO_DEF_ZIPF 1.1
655#define FIO_DEF_PARETO 0.2
656
Jens Axboe8055e412012-11-26 08:43:47 +0100657enum {
658 FIO_RAND_GEN_TAUSWORTHE = 0,
659 FIO_RAND_GEN_LFSR,
660};
661
Jens Axboec2acfba2014-02-27 15:52:02 -0800662enum {
663 FIO_CPUS_SHARED = 0,
664 FIO_CPUS_SPLIT,
665};
666
Jens Axboede54cfd2014-11-10 20:34:00 -0700667extern void exec_trigger(const char *);
668extern void check_trigger_file(void);
669
Jens Axboeebac4652005-12-08 15:25:21 +0100670#endif