| 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 | * Each thread_data structure has a number of files associated with it, |
| 47 | * this structure holds state information for a single file. |
| 48 | */ |
| 49 | struct fio_file { |
| 50 | struct flist_head hash_list; |
| 51 | enum fio_filetype filetype; |
| 52 | |
| 53 | void *file_data; |
| 54 | int fd; |
| 55 | #ifdef __CYGWIN__ |
| 56 | HANDLE hFile; |
| 57 | HANDLE ioCP; |
| 58 | #endif |
| 59 | |
| 60 | /* |
| 61 | * filename and possible memory mapping |
| 62 | */ |
| 63 | char *file_name; |
| 64 | unsigned int major, minor; |
| 65 | |
| 66 | void *mmap_ptr; |
| 67 | size_t mmap_sz; |
| 68 | off_t mmap_off; |
| 69 | |
| 70 | /* |
| 71 | * size of the file, offset into file, and io size from that offset |
| 72 | */ |
| 73 | unsigned long long real_file_size; |
| 74 | unsigned long long file_offset; |
| 75 | unsigned long long io_size; |
| 76 | |
| 77 | unsigned long long last_pos; |
| 78 | unsigned long long last_start; |
| 79 | |
| 80 | unsigned long long first_write; |
| 81 | unsigned long long last_write; |
| 82 | |
| 83 | /* |
| 84 | * For use by the io engine |
| 85 | */ |
| 86 | unsigned long long file_pos; |
| 87 | |
| 88 | /* |
| 89 | * if io is protected by a semaphore, this is set |
| 90 | */ |
| 91 | struct fio_mutex *lock; |
| 92 | void *lock_owner; |
| 93 | unsigned int lock_batch; |
| 94 | enum fio_ddir lock_ddir; |
| 95 | |
| 96 | /* |
| 97 | * block map for random io |
| 98 | */ |
| 99 | unsigned int *file_map; |
| 100 | unsigned int num_maps; |
| 101 | unsigned int last_free_lookup; |
| 102 | |
| 103 | int references; |
| 104 | enum fio_file_flags flags; |
| 105 | |
| 106 | struct disk_util *du; |
| 107 | }; |
| 108 | |
| 109 | #define FILE_FLAG_FNS(name) \ |
| 110 | static inline void fio_file_set_##name(struct fio_file *f) \ |
| 111 | { \ |
| 112 | (f)->flags |= FIO_FILE_##name; \ |
| 113 | } \ |
| 114 | static inline void fio_file_clear_##name(struct fio_file *f) \ |
| 115 | { \ |
| 116 | (f)->flags &= ~FIO_FILE_##name; \ |
| 117 | } \ |
| 118 | static inline int fio_file_##name(struct fio_file *f) \ |
| 119 | { \ |
| 120 | return ((f)->flags & FIO_FILE_##name) != 0; \ |
| 121 | } |
| 122 | |
| 123 | FILE_FLAG_FNS(open); |
| 124 | FILE_FLAG_FNS(closing); |
| 125 | FILE_FLAG_FNS(extend); |
| 126 | FILE_FLAG_FNS(done); |
| 127 | FILE_FLAG_FNS(size_known); |
| 128 | FILE_FLAG_FNS(hashed); |
| 129 | FILE_FLAG_FNS(partial_mmap); |
| 130 | #undef FILE_FLAG_FNS |
| 131 | |
| 132 | /* |
| 133 | * File setup/shutdown |
| 134 | */ |
| 135 | struct thread_data; |
| 136 | extern void close_files(struct thread_data *); |
| 137 | extern void close_and_free_files(struct thread_data *); |
| 138 | extern int __must_check setup_files(struct thread_data *); |
| 139 | extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *); |
| 140 | extern int __must_check generic_open_file(struct thread_data *, struct fio_file *); |
| 141 | extern int __must_check generic_close_file(struct thread_data *, struct fio_file *); |
| 142 | extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *); |
| 143 | extern int __must_check pre_read_files(struct thread_data *); |
| 144 | extern int add_file(struct thread_data *, const char *); |
| 145 | extern int add_file_exclusive(struct thread_data *, const char *); |
| 146 | extern void get_file(struct fio_file *); |
| 147 | extern int __must_check put_file(struct thread_data *, struct fio_file *); |
| 148 | extern void put_file_log(struct thread_data *, struct fio_file *); |
| 149 | extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir); |
| 150 | extern void unlock_file(struct thread_data *, struct fio_file *); |
| 151 | extern void unlock_file_all(struct thread_data *, struct fio_file *); |
| 152 | extern int add_dir_files(struct thread_data *, const char *); |
| 153 | extern int init_random_map(struct thread_data *); |
| 154 | extern void dup_files(struct thread_data *, struct thread_data *); |
| 155 | extern int get_fileno(struct thread_data *, const char *); |
| 156 | extern void free_release_files(struct thread_data *); |
| 157 | |
| 158 | static inline void fio_file_reset(struct fio_file *f) |
| 159 | { |
| 160 | f->last_free_lookup = 0; |
| 161 | f->last_pos = f->file_offset; |
| 162 | f->last_start = -1ULL; |
| 163 | f->file_pos = -1ULL; |
| 164 | if (f->file_map) |
| 165 | memset(f->file_map, 0, f->num_maps * sizeof(int)); |
| 166 | } |
| 167 | |
| 168 | #endif |