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