bitmap: fix off-by-8 allocation error
[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/bitmap.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};
31
32enum file_lock_mode {
33 FILE_LOCK_NONE,
34 FILE_LOCK_EXCLUSIVE,
35 FILE_LOCK_READWRITE,
36};
37
38/*
39 * roundrobin available files, or choose one at random, or do each one
40 * serially.
41 */
42enum {
43 FIO_FSERVICE_RANDOM = 1,
44 FIO_FSERVICE_RR = 2,
45 FIO_FSERVICE_SEQ = 3,
46};
47
48/*
49 * No pre-allocation when laying down files, or call posix_fallocate(), or
50 * call fallocate() with FALLOC_FL_KEEP_SIZE set.
51 */
52enum fio_fallocate_mode {
53 FIO_FALLOCATE_NONE = 1,
54 FIO_FALLOCATE_POSIX = 2,
55 FIO_FALLOCATE_KEEP_SIZE = 3,
56};
57
58/*
59 * Each thread_data structure has a number of files associated with it,
60 * this structure holds state information for a single file.
61 */
62struct fio_file {
63 struct flist_head hash_list;
64 enum fio_filetype filetype;
65
66 void *file_data;
67 int fd;
68#ifdef WIN32
69 HANDLE hFile;
70 HANDLE ioCP;
71#endif
72
73 /*
74 * filename and possible memory mapping
75 */
76 char *file_name;
77 unsigned int major, minor;
78 int fileno;
79
80 void *mmap_ptr;
81 size_t mmap_sz;
82 off_t mmap_off;
83
84 /*
85 * size of the file, offset into file, and io size from that offset
86 */
87 unsigned long long real_file_size;
88 unsigned long long file_offset;
89 unsigned long long io_size;
90
91 unsigned long long last_pos;
92 unsigned long long last_start;
93
94 unsigned long long first_write;
95 unsigned long long last_write;
96
97 /*
98 * For use by the io engine
99 */
100 unsigned long long file_pos;
101
102 /*
103 * if io is protected by a semaphore, this is set
104 */
105 struct fio_mutex *lock;
106 void *lock_owner;
107 unsigned int lock_batch;
108 enum fio_ddir lock_ddir;
109
110 /*
111 * block map for random io
112 */
113 struct bitmap *io_bitmap;
114
115 struct fio_lfsr lfsr;
116
117 /*
118 * Used for zipf random distribution
119 */
120 struct zipf_state zipf;
121
122 int references;
123 enum fio_file_flags flags;
124
125 struct disk_util *du;
126};
127
128#define FILE_FLAG_FNS(name) \
129static inline void fio_file_set_##name(struct fio_file *f) \
130{ \
131 (f)->flags |= FIO_FILE_##name; \
132} \
133static inline void fio_file_clear_##name(struct fio_file *f) \
134{ \
135 (f)->flags &= ~FIO_FILE_##name; \
136} \
137static inline int fio_file_##name(struct fio_file *f) \
138{ \
139 return ((f)->flags & FIO_FILE_##name) != 0; \
140}
141
142FILE_FLAG_FNS(open);
143FILE_FLAG_FNS(closing);
144FILE_FLAG_FNS(extend);
145FILE_FLAG_FNS(done);
146FILE_FLAG_FNS(size_known);
147FILE_FLAG_FNS(hashed);
148FILE_FLAG_FNS(partial_mmap);
149#undef FILE_FLAG_FNS
150
151/*
152 * File setup/shutdown
153 */
154struct thread_data;
155extern void close_files(struct thread_data *);
156extern void close_and_free_files(struct thread_data *);
157extern unsigned long long get_start_offset(struct thread_data *);
158extern int __must_check setup_files(struct thread_data *);
159extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
160extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
161extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
162extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
163extern int __must_check file_lookup_open(struct fio_file *f, int flags);
164extern int __must_check pre_read_files(struct thread_data *);
165extern int add_file(struct thread_data *, const char *);
166extern int add_file_exclusive(struct thread_data *, const char *);
167extern void get_file(struct fio_file *);
168extern int __must_check put_file(struct thread_data *, struct fio_file *);
169extern void put_file_log(struct thread_data *, struct fio_file *);
170extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
171extern void unlock_file(struct thread_data *, struct fio_file *);
172extern void unlock_file_all(struct thread_data *, struct fio_file *);
173extern int add_dir_files(struct thread_data *, const char *);
174extern int init_random_map(struct thread_data *);
175extern void dup_files(struct thread_data *, struct thread_data *);
176extern int get_fileno(struct thread_data *, const char *);
177extern void free_release_files(struct thread_data *);
178
179static inline void fio_file_reset(struct fio_file *f)
180{
181 f->last_pos = f->file_offset;
182 f->last_start = -1ULL;
183 f->file_pos = -1ULL;
184 if (f->io_bitmap)
185 bitmap_reset(f->io_bitmap);
186}
187
188#endif