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