filesetup: pre_read_files() can use a bool
[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
JA
12
13/*
14 * The type of object we are working on
15 */
16enum fio_filetype {
17 FIO_TYPE_FILE = 1, /* plain file */
686fbd31 18 FIO_TYPE_BLOCK, /* block device */
d6aed795
JA
19 FIO_TYPE_CHAR, /* character device */
20 FIO_TYPE_PIPE, /* pipe */
21};
22
23enum 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
35enum 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 */
46enum {
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 */
62enum fio_fallocate_mode {
63 FIO_FALLOCATE_NONE = 1,
64 FIO_FALLOCATE_POSIX = 2,
65 FIO_FALLOCATE_KEEP_SIZE = 3,
2c3e17be 66 FIO_FALLOCATE_NATIVE = 4,
a596f047
EG
67};
68
d6aed795
JA
69/*
70 * Each thread_data structure has a number of files associated with it,
71 * this structure holds state information for a single file.
72 */
73struct fio_file {
74 struct flist_head hash_list;
75 enum fio_filetype filetype;
76
0e238572 77 int fd;
e6c4d732 78 int shadow_fd;
93bcfd20 79#ifdef WIN32
03e20d68
BC
80 HANDLE hFile;
81 HANDLE ioCP;
82#endif
d6aed795
JA
83
84 /*
85 * filename and possible memory mapping
86 */
d6aed795 87 unsigned int major, minor;
89ac1d48 88 int fileno;
26e616d0 89 int bs;
d8f1f7d4 90 char *file_name;
d6aed795 91
d6aed795
JA
92 /*
93 * size of the file, offset into file, and io size from that offset
79591fa9 94 * (be aware io_size is different from thread_options::io_size)
d6aed795 95 */
293b8c1f
JA
96 uint64_t real_file_size;
97 uint64_t file_offset;
98 uint64_t io_size;
d6aed795 99
f1dfb668
JA
100 /*
101 * Track last end and last start of IO for a given data direction
102 */
103 uint64_t last_pos[DDIR_RWDIR_CNT];
104 uint64_t last_start[DDIR_RWDIR_CNT];
d6aed795 105
293b8c1f
JA
106 uint64_t first_write;
107 uint64_t last_write;
44f29692 108
94a6e1bb
JA
109 /*
110 * Tracks the last iodepth number of completed writes, if data
111 * verification is enabled
112 */
113 uint64_t *last_write_comp;
114 unsigned int last_write_idx;
115
e943b878 116 /*
710bf9c5 117 * For use by the io engine for offset or private data storage
e943b878 118 */
710bf9c5
TK
119 union {
120 uint64_t engine_pos;
121 void *engine_data;
122 };
e943b878 123
d6aed795
JA
124 /*
125 * if io is protected by a semaphore, this is set
126 */
d7df1d13
JA
127 union {
128 struct fio_mutex *lock;
129 struct fio_rwlock *rwlock;
130 };
d6aed795
JA
131
132 /*
967d1b63 133 * block map or LFSR for random io
d6aed795 134 */
967d1b63
JA
135 union {
136 struct axmap *io_axmap;
137 struct fio_lfsr lfsr;
138 };
8055e41d 139
9c6f6316
JA
140 /*
141 * Used for zipf random distribution
142 */
56d9fa4b
JA
143 union {
144 struct zipf_state zipf;
145 struct gauss_state gauss;
146 };
9c6f6316 147
d6aed795
JA
148 int references;
149 enum fio_file_flags flags;
150
151 struct disk_util *du;
152};
153
710bf9c5
TK
154#define FILE_ENG_DATA(f) ((f)->engine_data)
155#define FILE_SET_ENG_DATA(f, data) ((f)->engine_data = (data))
e19ccb55 156
d6aed795
JA
157#define FILE_FLAG_FNS(name) \
158static inline void fio_file_set_##name(struct fio_file *f) \
159{ \
bea5c23d 160 (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name); \
d6aed795
JA
161} \
162static inline void fio_file_clear_##name(struct fio_file *f) \
163{ \
bea5c23d 164 (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name); \
d6aed795
JA
165} \
166static inline int fio_file_##name(struct fio_file *f) \
167{ \
168 return ((f)->flags & FIO_FILE_##name) != 0; \
169}
170
171FILE_FLAG_FNS(open);
172FILE_FLAG_FNS(closing);
173FILE_FLAG_FNS(extend);
174FILE_FLAG_FNS(done);
175FILE_FLAG_FNS(size_known);
176FILE_FLAG_FNS(hashed);
ed47cbf7 177FILE_FLAG_FNS(partial_mmap);
967d1b63
JA
178FILE_FLAG_FNS(axmap);
179FILE_FLAG_FNS(lfsr);
d6aed795
JA
180#undef FILE_FLAG_FNS
181
4cd02b3f
JA
182/*
183 * File setup/shutdown
184 */
185struct thread_data;
186extern void close_files(struct thread_data *);
187extern void close_and_free_files(struct thread_data *);
bedc9dc2 188extern uint64_t get_start_offset(struct thread_data *, struct fio_file *);
4cd02b3f
JA
189extern int __must_check setup_files(struct thread_data *);
190extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
966fcbd4 191#ifdef __cplusplus
192extern "C" {
193#endif
4cd02b3f
JA
194extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
195extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
196extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
966fcbd4 197#ifdef __cplusplus
198}
199#endif
1ccc6dc7 200extern int __must_check file_lookup_open(struct fio_file *f, int flags);
c139f3b4 201extern bool __must_check pre_read_files(struct thread_data *);
a3f001f5 202extern unsigned long long get_rand_file_size(struct thread_data *td);
5903e7b7 203extern int add_file(struct thread_data *, const char *, int, int);
49ffb4a2 204extern int add_file_exclusive(struct thread_data *, const char *);
4cd02b3f
JA
205extern void get_file(struct fio_file *);
206extern int __must_check put_file(struct thread_data *, struct fio_file *);
e8462bd8 207extern void put_file_log(struct thread_data *, struct fio_file *);
4cd02b3f
JA
208extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
209extern void unlock_file(struct thread_data *, struct fio_file *);
210extern void unlock_file_all(struct thread_data *, struct fio_file *);
211extern int add_dir_files(struct thread_data *, const char *);
212extern int init_random_map(struct thread_data *);
213extern void dup_files(struct thread_data *, struct thread_data *);
214extern int get_fileno(struct thread_data *, const char *);
215extern void free_release_files(struct thread_data *);
bcbfeefa 216extern void filesetup_mem_free(void);
8aa89d70 217extern void fio_file_reset(struct thread_data *, struct fio_file *);
747b3105 218extern bool fio_files_done(struct thread_data *);
04d6530f 219extern bool exists_and_not_regfile(const char *);
47534cda 220extern int fio_set_directio(struct thread_data *, struct fio_file *);
c592b9fe 221
d6aed795 222#endif