projects / fio.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Define struct file_name as a file local structure
[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,
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 */
72struct 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
79591fa9 93 * (be aware io_size is different from thread_options::io_size)
d6aed795 94 */
293b8c1f
JA		 95 uint64_t real_file_size;
96 uint64_t file_offset;
97 uint64_t io_size;
d6aed795 98
f1dfb668
JA		 99 /*
100 * Track last end and last start of IO for a given data direction
101 */
102 uint64_t last_pos[DDIR_RWDIR_CNT];
103 uint64_t last_start[DDIR_RWDIR_CNT];
d6aed795 104
293b8c1f
JA		 105 uint64_t first_write;
106 uint64_t last_write;
44f29692 107
94a6e1bb
JA		 108 /*
109 * Tracks the last iodepth number of completed writes, if data
110 * verification is enabled
111 */
112 uint64_t *last_write_comp;
113 unsigned int last_write_idx;
114
e943b878
JA		 115 /*
116 * For use by the io engine
117 */
47f07ddc 118 uint64_t engine_data;
e943b878 119
d6aed795
JA		 120 /*
121 * if io is protected by a semaphore, this is set
122 */
d7df1d13
JA		 123 union {
124 struct fio_mutex *lock;
125 struct fio_rwlock *rwlock;
126 };
d6aed795
JA		 127
128 /*
967d1b63 129 * block map or LFSR for random io
d6aed795 130 */
967d1b63
JA		 131 union {
132 struct axmap *io_axmap;
133 struct fio_lfsr lfsr;
134 };
8055e41d 135
9c6f6316
JA		 136 /*
137 * Used for zipf random distribution
138 */
56d9fa4b
JA		 139 union {
140 struct zipf_state zipf;
141 struct gauss_state gauss;
142 };
9c6f6316 143
d6aed795
JA		 144 int references;
145 enum fio_file_flags flags;
146
147 struct disk_util *du;
148};
149
e19ccb55
JA		 150#define FILE_ENG_DATA(f) ((void *) (uintptr_t) (f)->engine_data)
151#define FILE_SET_ENG_DATA(f, data) \
152 ((f)->engine_data = (uintptr_t) (data))
153
d6aed795
JA		 154#define FILE_FLAG_FNS(name) \
155static inline void fio_file_set_##name(struct fio_file *f) \
156{ \
bea5c23d 157 (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name); \
d6aed795
JA		 158} \
159static inline void fio_file_clear_##name(struct fio_file *f) \
160{ \
bea5c23d 161 (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name); \
d6aed795
JA		 162} \
163static inline int fio_file_##name(struct fio_file *f) \
164{ \
165 return ((f)->flags & FIO_FILE_##name) != 0; \
166}
167
168FILE_FLAG_FNS(open);
169FILE_FLAG_FNS(closing);
170FILE_FLAG_FNS(extend);
171FILE_FLAG_FNS(done);
172FILE_FLAG_FNS(size_known);
173FILE_FLAG_FNS(hashed);
ed47cbf7 174FILE_FLAG_FNS(partial_mmap);
967d1b63
JA		 175FILE_FLAG_FNS(axmap);
176FILE_FLAG_FNS(lfsr);
d6aed795
JA		 177#undef FILE_FLAG_FNS
178
4cd02b3f
JA		 179/*
180 * File setup/shutdown
181 */
182struct thread_data;
183extern void close_files(struct thread_data *);
184extern void close_and_free_files(struct thread_data *);
bedc9dc2 185extern uint64_t get_start_offset(struct thread_data *, struct fio_file *);
4cd02b3f
JA		 186extern int __must_check setup_files(struct thread_data *);
187extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
188extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
189extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
190extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
1ccc6dc7 191extern int __must_check file_lookup_open(struct fio_file *f, int flags);
4cd02b3f 192extern int __must_check pre_read_files(struct thread_data *);
a3f001f5 193extern unsigned long long get_rand_file_size(struct thread_data *td);
5903e7b7 194extern int add_file(struct thread_data *, const char *, int, int);
49ffb4a2 195extern int add_file_exclusive(struct thread_data *, const char *);
4cd02b3f
JA		 196extern void get_file(struct fio_file *);
197extern int __must_check put_file(struct thread_data *, struct fio_file *);
e8462bd8 198extern void put_file_log(struct thread_data *, struct fio_file *);
4cd02b3f
JA		 199extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
200extern void unlock_file(struct thread_data *, struct fio_file *);
201extern void unlock_file_all(struct thread_data *, struct fio_file *);
202extern int add_dir_files(struct thread_data *, const char *);
203extern int init_random_map(struct thread_data *);
204extern void dup_files(struct thread_data *, struct thread_data *);
205extern int get_fileno(struct thread_data *, const char *);
206extern void free_release_files(struct thread_data *);
bcbfeefa 207extern void filesetup_mem_free(void);
8aa89d70 208extern void fio_file_reset(struct thread_data *, struct fio_file *);
747b3105 209extern bool fio_files_done(struct thread_data *);
04d6530f 210extern bool exists_and_not_regfile(const char *);
c592b9fe 211
d6aed795 212#endif
fio - Flexible IO Tester