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