projects / fio.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Add support for normal/gaussian random distributions
[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/*
14 * The type of object we are working on
15 */
16enum 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
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 */
30 FIO_FILE_partial_mmap = 1 << 6, /* can't do full mmap */
31 FIO_FILE_axmap = 1 << 7, /* uses axmap */
32 FIO_FILE_lfsr = 1 << 8, /* lfsr is used */
33};
34
35enum file_lock_mode {
36 FILE_LOCK_NONE,
37 FILE_LOCK_EXCLUSIVE,
38 FILE_LOCK_READWRITE,
39};
40
41/*
42 * roundrobin available files, or choose one at random, or do each one
43 * serially.
44 */
45enum {
46 FIO_FSERVICE_RANDOM = 1,
47 FIO_FSERVICE_RR = 2,
48 FIO_FSERVICE_SEQ = 3,
49};
50
51/*
52 * No pre-allocation when laying down files, or call posix_fallocate(), or
53 * call fallocate() with FALLOC_FL_KEEP_SIZE set.
54 */
55enum fio_fallocate_mode {
56 FIO_FALLOCATE_NONE = 1,
57 FIO_FALLOCATE_POSIX = 2,
58 FIO_FALLOCATE_KEEP_SIZE = 3,
59};
60
61/*
62 * Each thread_data structure has a number of files associated with it,
63 * this structure holds state information for a single file.
64 */
65struct fio_file {
66 struct flist_head hash_list;
67 enum fio_filetype filetype;
68
69 int fd;
70 int shadow_fd;
71#ifdef WIN32
72 HANDLE hFile;
73 HANDLE ioCP;
74#endif
75
76 /*
77 * filename and possible memory mapping
78 */
79 unsigned int major, minor;
80 int fileno;
81 char *file_name;
82
83 /*
84 * size of the file, offset into file, and io size from that offset
85 */
86 uint64_t real_file_size;
87 uint64_t file_offset;
88 uint64_t io_size;
89
90 /*
91 * Track last end and last start of IO for a given data direction
92 */
93 uint64_t last_pos[DDIR_RWDIR_CNT];
94 uint64_t last_start[DDIR_RWDIR_CNT];
95
96 uint64_t first_write;
97 uint64_t last_write;
98
99 /*
100 * For use by the io engine
101 */
102 uint64_t engine_data;
103
104 /*
105 * if io is protected by a semaphore, this is set
106 */
107 union {
108 struct fio_mutex *lock;
109 struct fio_rwlock *rwlock;
110 };
111
112 /*
113 * block map or LFSR for random io
114 */
115 union {
116 struct axmap *io_axmap;
117 struct fio_lfsr lfsr;
118 };
119
120 /*
121 * Used for zipf random distribution
122 */
123 union {
124 struct zipf_state zipf;
125 struct gauss_state gauss;
126 };
127
128 int references;
129 enum fio_file_flags flags;
130
131 struct disk_util *du;
132};
133
134#define FILE_ENG_DATA(f) ((void *) (uintptr_t) (f)->engine_data)
135#define FILE_SET_ENG_DATA(f, data) \
136 ((f)->engine_data = (uintptr_t) (data))
137
138struct file_name {
139 struct flist_head list;
140 char *filename;
141};
142
143#define FILE_FLAG_FNS(name) \
144static inline void fio_file_set_##name(struct fio_file *f) \
145{ \
146 (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name); \
147} \
148static inline void fio_file_clear_##name(struct fio_file *f) \
149{ \
150 (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name); \
151} \
152static inline int fio_file_##name(struct fio_file *f) \
153{ \
154 return ((f)->flags & FIO_FILE_##name) != 0; \
155}
156
157FILE_FLAG_FNS(open);
158FILE_FLAG_FNS(closing);
159FILE_FLAG_FNS(extend);
160FILE_FLAG_FNS(done);
161FILE_FLAG_FNS(size_known);
162FILE_FLAG_FNS(hashed);
163FILE_FLAG_FNS(partial_mmap);
164FILE_FLAG_FNS(axmap);
165FILE_FLAG_FNS(lfsr);
166#undef FILE_FLAG_FNS
167
168/*
169 * File setup/shutdown
170 */
171struct thread_data;
172extern void close_files(struct thread_data *);
173extern void close_and_free_files(struct thread_data *);
174extern uint64_t get_start_offset(struct thread_data *, struct fio_file *);
175extern int __must_check setup_files(struct thread_data *);
176extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
177extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
178extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
179extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
180extern int __must_check file_lookup_open(struct fio_file *f, int flags);
181extern int __must_check pre_read_files(struct thread_data *);
182extern int add_file(struct thread_data *, const char *, int, int);
183extern int add_file_exclusive(struct thread_data *, const char *);
184extern void get_file(struct fio_file *);
185extern int __must_check put_file(struct thread_data *, struct fio_file *);
186extern void put_file_log(struct thread_data *, struct fio_file *);
187extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
188extern void unlock_file(struct thread_data *, struct fio_file *);
189extern void unlock_file_all(struct thread_data *, struct fio_file *);
190extern int add_dir_files(struct thread_data *, const char *);
191extern int init_random_map(struct thread_data *);
192extern void dup_files(struct thread_data *, struct thread_data *);
193extern int get_fileno(struct thread_data *, const char *);
194extern void free_release_files(struct thread_data *);
195extern void filesetup_mem_free(void);
196void fio_file_reset(struct thread_data *, struct fio_file *);
197int fio_files_done(struct thread_data *);
198
199#endif
fio - Flexible IO Tester