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