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