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 */ 15 enum 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 22 enum 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 32 enum 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 */ 42 enum { 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 */ 52 enum 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 */ 62 struct fio_file { 63 struct flist_head hash_list; 64 enum fio_filetype filetype; 65 66 int fd; 67 int shadow_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 uint64_t real_file_size; 88 uint64_t file_offset; 89 uint64_t io_size; 90 91 uint64_t last_pos; 92 uint64_t last_start; 93 94 uint64_t first_write; 95 uint64_t last_write; 96 97 /* 98 * For use by the io engine 99 */ 100 uint64_t engine_data; 101 102 /* 103 * if io is protected by a semaphore, this is set 104 */ 105 union { 106 struct fio_mutex *lock; 107 struct fio_rwlock *rwlock; 108 }; 109 110 /* 111 * block map for random io 112 */ 113 struct axmap *io_axmap; 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 struct file_name { 129 struct flist_head list; 130 char *filename; 131 }; 132 133 #define FILE_FLAG_FNS(name) \ 134 static inline void fio_file_set_##name(struct fio_file *f) \ 135 { \ 136 (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name); \ 137 } \ 138 static inline void fio_file_clear_##name(struct fio_file *f) \ 139 { \ 140 (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name); \ 141 } \ 142 static inline int fio_file_##name(struct fio_file *f) \ 143 { \ 144 return ((f)->flags & FIO_FILE_##name) != 0; \ 145 } 146 147 FILE_FLAG_FNS(open); 148 FILE_FLAG_FNS(closing); 149 FILE_FLAG_FNS(extend); 150 FILE_FLAG_FNS(done); 151 FILE_FLAG_FNS(size_known); 152 FILE_FLAG_FNS(hashed); 153 FILE_FLAG_FNS(partial_mmap); 154 #undef FILE_FLAG_FNS 155 156 /* 157 * File setup/shutdown 158 */ 159 struct thread_data; 160 extern void close_files(struct thread_data *); 161 extern void close_and_free_files(struct thread_data *); 162 extern uint64_t get_start_offset(struct thread_data *, struct fio_file *); 163 extern int __must_check setup_files(struct thread_data *); 164 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *); 165 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *); 166 extern int __must_check generic_close_file(struct thread_data *, struct fio_file *); 167 extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *); 168 extern int __must_check file_lookup_open(struct fio_file *f, int flags); 169 extern int __must_check pre_read_files(struct thread_data *); 170 extern int add_file(struct thread_data *, const char *, int, int); 171 extern int add_file_exclusive(struct thread_data *, const char *); 172 extern void get_file(struct fio_file *); 173 extern int __must_check put_file(struct thread_data *, struct fio_file *); 174 extern void put_file_log(struct thread_data *, struct fio_file *); 175 extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir); 176 extern void unlock_file(struct thread_data *, struct fio_file *); 177 extern void unlock_file_all(struct thread_data *, struct fio_file *); 178 extern int add_dir_files(struct thread_data *, const char *); 179 extern int init_random_map(struct thread_data *); 180 extern void dup_files(struct thread_data *, struct thread_data *); 181 extern int get_fileno(struct thread_data *, const char *); 182 extern void free_release_files(struct thread_data *); 183 extern void filesetup_mem_free(void); 184 void fio_file_reset(struct thread_data *, struct fio_file *); 185 int fio_files_done(struct thread_data *); 186 187 #endif 188