t/run-fio-tests: relax acceptance criterion for t0011
[fio.git] / file.h
CommitLineData
d6aed795
JA
1#ifndef FIO_FILE_H
2#define FIO_FILE_H
3
e2e58886 4#include <string.h>
ecc314ba 5#include "compiler/compiler.h"
d6aed795 6#include "io_ddir.h"
ecc314ba 7#include "flist.h"
9c6f6316 8#include "lib/zipf.h"
7ebd796f 9#include "lib/axmap.h"
8055e41d 10#include "lib/lfsr.h"
56d9fa4b 11#include "lib/gauss.h"
d6aed795 12
bfbdd35b
BVA
13/* Forward declarations */
14struct zoned_block_device_info;
15
d6aed795
JA
16/*
17 * The type of object we are working on
18 */
19enum fio_filetype {
20 FIO_TYPE_FILE = 1, /* plain file */
686fbd31 21 FIO_TYPE_BLOCK, /* block device */
d6aed795
JA
22 FIO_TYPE_CHAR, /* character device */
23 FIO_TYPE_PIPE, /* pipe */
24};
25
26enum fio_file_flags {
27 FIO_FILE_open = 1 << 0, /* file is open */
28 FIO_FILE_closing = 1 << 1, /* file being closed */
29 FIO_FILE_extend = 1 << 2, /* needs extend */
30 FIO_FILE_done = 1 << 3, /* io completed to this file */
31 FIO_FILE_size_known = 1 << 4, /* size has been set */
32 FIO_FILE_hashed = 1 << 5, /* file is on hash */
ed47cbf7 33 FIO_FILE_partial_mmap = 1 << 6, /* can't do full mmap */
967d1b63
JA
34 FIO_FILE_axmap = 1 << 7, /* uses axmap */
35 FIO_FILE_lfsr = 1 << 8, /* lfsr is used */
d6aed795
JA
36};
37
38enum file_lock_mode {
39 FILE_LOCK_NONE,
40 FILE_LOCK_EXCLUSIVE,
41 FILE_LOCK_READWRITE,
42};
43
590aebda 44/*
8c07860d
JA
45 * How fio chooses what file to service next. Choice of uniformly random, or
46 * some skewed random variants, or just sequentially go through them or
47 * roundrobing.
590aebda
JA
48 */
49enum {
8c07860d
JA
50 FIO_FSERVICE_RANDOM = 1,
51 FIO_FSERVICE_RR = 2,
52 FIO_FSERVICE_SEQ = 3,
53 __FIO_FSERVICE_NONUNIFORM = 0x100,
54 FIO_FSERVICE_ZIPF = __FIO_FSERVICE_NONUNIFORM | 4,
55 FIO_FSERVICE_PARETO = __FIO_FSERVICE_NONUNIFORM | 5,
56 FIO_FSERVICE_GAUSS = __FIO_FSERVICE_NONUNIFORM | 6,
57
58 FIO_FSERVICE_SHIFT = 10,
590aebda
JA
59};
60
a596f047
EG
61/*
62 * No pre-allocation when laying down files, or call posix_fallocate(), or
63 * call fallocate() with FALLOC_FL_KEEP_SIZE set.
64 */
65enum fio_fallocate_mode {
66 FIO_FALLOCATE_NONE = 1,
67 FIO_FALLOCATE_POSIX = 2,
68 FIO_FALLOCATE_KEEP_SIZE = 3,
2c3e17be 69 FIO_FALLOCATE_NATIVE = 4,
38ca5f03 70 FIO_FALLOCATE_TRUNCATE = 5,
a596f047
EG
71};
72
d6aed795
JA
73/*
74 * Each thread_data structure has a number of files associated with it,
75 * this structure holds state information for a single file.
76 */
77struct fio_file {
78 struct flist_head hash_list;
79 enum fio_filetype filetype;
80
0e238572 81 int fd;
e6c4d732 82 int shadow_fd;
93bcfd20 83#ifdef WIN32
03e20d68
BC
84 HANDLE hFile;
85 HANDLE ioCP;
86#endif
d6aed795
JA
87
88 /*
89 * filename and possible memory mapping
90 */
d6aed795 91 unsigned int major, minor;
89ac1d48 92 int fileno;
d8f1f7d4 93 char *file_name;
d6aed795 94
d6aed795
JA
95 /*
96 * size of the file, offset into file, and io size from that offset
79591fa9 97 * (be aware io_size is different from thread_options::io_size)
d6aed795 98 */
293b8c1f
JA
99 uint64_t real_file_size;
100 uint64_t file_offset;
101 uint64_t io_size;
d6aed795 102
bfbdd35b
BVA
103 /*
104 * Zoned block device information. See also zonemode=zbd.
105 */
106 struct zoned_block_device_info *zbd_info;
107
f1dfb668
JA
108 /*
109 * Track last end and last start of IO for a given data direction
110 */
111 uint64_t last_pos[DDIR_RWDIR_CNT];
112 uint64_t last_start[DDIR_RWDIR_CNT];
d6aed795 113
293b8c1f
JA
114 uint64_t first_write;
115 uint64_t last_write;
44f29692 116
94a6e1bb
JA
117 /*
118 * Tracks the last iodepth number of completed writes, if data
119 * verification is enabled
120 */
121 uint64_t *last_write_comp;
122 unsigned int last_write_idx;
123
e943b878 124 /*
710bf9c5 125 * For use by the io engine for offset or private data storage
e943b878 126 */
710bf9c5
TK
127 union {
128 uint64_t engine_pos;
129 void *engine_data;
130 };
e943b878 131
d6aed795
JA
132 /*
133 * if io is protected by a semaphore, this is set
134 */
d7df1d13 135 union {
971caeb1 136 struct fio_sem *lock;
d7df1d13
JA
137 struct fio_rwlock *rwlock;
138 };
d6aed795
JA
139
140 /*
967d1b63 141 * block map or LFSR for random io
d6aed795 142 */
967d1b63
JA
143 union {
144 struct axmap *io_axmap;
145 struct fio_lfsr lfsr;
146 };
8055e41d 147
9c6f6316
JA
148 /*
149 * Used for zipf random distribution
150 */
56d9fa4b
JA
151 union {
152 struct zipf_state zipf;
153 struct gauss_state gauss;
154 };
9c6f6316 155
d6aed795
JA
156 int references;
157 enum fio_file_flags flags;
158
159 struct disk_util *du;
160};
161
710bf9c5
TK
162#define FILE_ENG_DATA(f) ((f)->engine_data)
163#define FILE_SET_ENG_DATA(f, data) ((f)->engine_data = (data))
e19ccb55 164
d6aed795
JA
165#define FILE_FLAG_FNS(name) \
166static inline void fio_file_set_##name(struct fio_file *f) \
167{ \
bea5c23d 168 (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name); \
d6aed795
JA
169} \
170static inline void fio_file_clear_##name(struct fio_file *f) \
171{ \
bea5c23d 172 (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name); \
d6aed795
JA
173} \
174static inline int fio_file_##name(struct fio_file *f) \
175{ \
176 return ((f)->flags & FIO_FILE_##name) != 0; \
177}
178
179FILE_FLAG_FNS(open);
180FILE_FLAG_FNS(closing);
181FILE_FLAG_FNS(extend);
182FILE_FLAG_FNS(done);
183FILE_FLAG_FNS(size_known);
184FILE_FLAG_FNS(hashed);
ed47cbf7 185FILE_FLAG_FNS(partial_mmap);
967d1b63
JA
186FILE_FLAG_FNS(axmap);
187FILE_FLAG_FNS(lfsr);
d6aed795
JA
188#undef FILE_FLAG_FNS
189
4cd02b3f
JA
190/*
191 * File setup/shutdown
192 */
193struct thread_data;
194extern void close_files(struct thread_data *);
195extern void close_and_free_files(struct thread_data *);
bedc9dc2 196extern uint64_t get_start_offset(struct thread_data *, struct fio_file *);
4cd02b3f
JA
197extern int __must_check setup_files(struct thread_data *);
198extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
966fcbd4 199#ifdef __cplusplus
200extern "C" {
201#endif
4cd02b3f
JA
202extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
203extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
204extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
966fcbd4 205#ifdef __cplusplus
206}
207#endif
1ccc6dc7 208extern int __must_check file_lookup_open(struct fio_file *f, int flags);
c139f3b4 209extern bool __must_check pre_read_files(struct thread_data *);
a3f001f5 210extern unsigned long long get_rand_file_size(struct thread_data *td);
5903e7b7 211extern int add_file(struct thread_data *, const char *, int, int);
49ffb4a2 212extern int add_file_exclusive(struct thread_data *, const char *);
4cd02b3f
JA
213extern void get_file(struct fio_file *);
214extern int __must_check put_file(struct thread_data *, struct fio_file *);
e8462bd8 215extern void put_file_log(struct thread_data *, struct fio_file *);
4cd02b3f
JA
216extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
217extern void unlock_file(struct thread_data *, struct fio_file *);
218extern void unlock_file_all(struct thread_data *, struct fio_file *);
219extern int add_dir_files(struct thread_data *, const char *);
4d832322 220extern bool init_random_map(struct thread_data *);
4cd02b3f
JA
221extern void dup_files(struct thread_data *, struct thread_data *);
222extern int get_fileno(struct thread_data *, const char *);
223extern void free_release_files(struct thread_data *);
bcbfeefa 224extern void filesetup_mem_free(void);
8aa89d70 225extern void fio_file_reset(struct thread_data *, struct fio_file *);
747b3105 226extern bool fio_files_done(struct thread_data *);
04d6530f 227extern bool exists_and_not_regfile(const char *);
47534cda 228extern int fio_set_directio(struct thread_data *, struct fio_file *);
c592b9fe 229
d6aed795 230#endif