Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 1 | #ifndef FIO_FILE_H |
| 2 | #define FIO_FILE_H |
| 3 | |
Jens Axboe | e2e5888 | 2011-01-04 08:36:06 +0100 | [diff] [blame] | 4 | #include <string.h> |
Bruce Cran | ecc314b | 2011-01-04 10:59:30 +0100 | [diff] [blame] | 5 | #include "compiler/compiler.h" |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 6 | #include "io_ddir.h" |
Bruce Cran | ecc314b | 2011-01-04 10:59:30 +0100 | [diff] [blame] | 7 | #include "flist.h" |
Jens Axboe | 9c6f631 | 2012-11-07 09:15:45 +0100 | [diff] [blame] | 8 | #include "lib/zipf.h" |
Jens Axboe | 7ebd796 | 2012-11-28 21:24:46 +0100 | [diff] [blame] | 9 | #include "lib/axmap.h" |
Jens Axboe | 8055e41 | 2012-11-26 08:43:47 +0100 | [diff] [blame] | 10 | #include "lib/lfsr.h" |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 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 */ |
Jens Axboe | ed47cbf | 2009-07-03 22:52:38 +0200 | [diff] [blame] | 29 | FIO_FILE_partial_mmap = 1 << 6, /* can't do full mmap */ |
Jens Axboe | d55dd04 | 2014-12-15 09:38:43 -0700 | [diff] [blame] | 30 | FIO_FILE_axmap = 1 << 7, /* uses axmap */ |
| 31 | FIO_FILE_lfsr = 1 << 8, /* lfsr is used */ |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 32 | }; |
| 33 | |
| 34 | enum file_lock_mode { |
| 35 | FILE_LOCK_NONE, |
| 36 | FILE_LOCK_EXCLUSIVE, |
| 37 | FILE_LOCK_READWRITE, |
| 38 | }; |
| 39 | |
| 40 | /* |
Jens Axboe | 590aebd | 2009-06-03 08:54:00 +0200 | [diff] [blame] | 41 | * roundrobin available files, or choose one at random, or do each one |
| 42 | * serially. |
| 43 | */ |
| 44 | enum { |
| 45 | FIO_FSERVICE_RANDOM = 1, |
| 46 | FIO_FSERVICE_RR = 2, |
| 47 | FIO_FSERVICE_SEQ = 3, |
| 48 | }; |
| 49 | |
| 50 | /* |
Eric Gouriou | a596f04 | 2011-06-17 09:11:45 +0200 | [diff] [blame] | 51 | * No pre-allocation when laying down files, or call posix_fallocate(), or |
| 52 | * call fallocate() with FALLOC_FL_KEEP_SIZE set. |
| 53 | */ |
| 54 | enum fio_fallocate_mode { |
| 55 | FIO_FALLOCATE_NONE = 1, |
| 56 | FIO_FALLOCATE_POSIX = 2, |
| 57 | FIO_FALLOCATE_KEEP_SIZE = 3, |
| 58 | }; |
| 59 | |
| 60 | /* |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 61 | * Each thread_data structure has a number of files associated with it, |
| 62 | * this structure holds state information for a single file. |
| 63 | */ |
| 64 | struct fio_file { |
| 65 | struct flist_head hash_list; |
| 66 | enum fio_filetype filetype; |
| 67 | |
Jens Axboe | 0e23857 | 2010-10-08 11:26:43 +0200 | [diff] [blame] | 68 | int fd; |
Jens Axboe | e6c4d73 | 2012-12-12 08:16:27 +0100 | [diff] [blame] | 69 | int shadow_fd; |
Bruce Cran | 93bcfd2 | 2012-02-20 20:18:19 +0100 | [diff] [blame] | 70 | #ifdef WIN32 |
Bruce Cran | 03e20d6 | 2011-01-02 20:14:54 +0100 | [diff] [blame] | 71 | HANDLE hFile; |
| 72 | HANDLE ioCP; |
| 73 | #endif |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 74 | |
| 75 | /* |
| 76 | * filename and possible memory mapping |
| 77 | */ |
| 78 | char *file_name; |
| 79 | unsigned int major, minor; |
Shaohua Li | 89ac1d4 | 2012-06-11 08:56:32 +0200 | [diff] [blame] | 80 | int fileno; |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 81 | |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 82 | /* |
| 83 | * size of the file, offset into file, and io size from that offset |
| 84 | */ |
Jens Axboe | 293b8c1 | 2013-01-04 13:16:54 +0100 | [diff] [blame] | 85 | uint64_t real_file_size; |
| 86 | uint64_t file_offset; |
| 87 | uint64_t io_size; |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 88 | |
Jens Axboe | 08a99be | 2014-12-14 19:01:24 -0700 | [diff] [blame] | 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]; |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 94 | |
Jens Axboe | 293b8c1 | 2013-01-04 13:16:54 +0100 | [diff] [blame] | 95 | uint64_t first_write; |
| 96 | uint64_t last_write; |
Jens Axboe | 44f2969 | 2010-03-09 20:09:44 +0100 | [diff] [blame] | 97 | |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 98 | /* |
Jens Axboe | e943b87 | 2010-02-02 09:48:13 +0100 | [diff] [blame] | 99 | * For use by the io engine |
| 100 | */ |
Jens Axboe | 47f07dd | 2013-02-11 14:35:43 +0100 | [diff] [blame] | 101 | uint64_t engine_data; |
Jens Axboe | e943b87 | 2010-02-02 09:48:13 +0100 | [diff] [blame] | 102 | |
| 103 | /* |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 104 | * if io is protected by a semaphore, this is set |
| 105 | */ |
Jens Axboe | d7df1d1 | 2013-03-20 19:57:01 -0600 | [diff] [blame] | 106 | union { |
| 107 | struct fio_mutex *lock; |
| 108 | struct fio_rwlock *rwlock; |
| 109 | }; |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 110 | |
| 111 | /* |
Jens Axboe | d55dd04 | 2014-12-15 09:38:43 -0700 | [diff] [blame] | 112 | * block map or LFSR for random io |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 113 | */ |
Jens Axboe | d55dd04 | 2014-12-15 09:38:43 -0700 | [diff] [blame] | 114 | union { |
| 115 | struct axmap *io_axmap; |
| 116 | struct fio_lfsr lfsr; |
| 117 | }; |
Jens Axboe | 8055e41 | 2012-11-26 08:43:47 +0100 | [diff] [blame] | 118 | |
Jens Axboe | 9c6f631 | 2012-11-07 09:15:45 +0100 | [diff] [blame] | 119 | /* |
| 120 | * Used for zipf random distribution |
| 121 | */ |
| 122 | struct zipf_state zipf; |
| 123 | |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 124 | int references; |
| 125 | enum fio_file_flags flags; |
| 126 | |
| 127 | struct disk_util *du; |
| 128 | }; |
| 129 | |
Jens Axboe | aa31de7 | 2014-12-15 08:26:11 -0700 | [diff] [blame] | 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 | |
Christian Ehrhardt | bcbfeef | 2014-02-20 09:13:06 -0800 | [diff] [blame] | 134 | struct file_name { |
| 135 | struct flist_head list; |
| 136 | char *filename; |
| 137 | }; |
| 138 | |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 139 | #define FILE_FLAG_FNS(name) \ |
| 140 | static inline void fio_file_set_##name(struct fio_file *f) \ |
| 141 | { \ |
Daniel Gollub | bea5c23 | 2014-02-12 15:51:54 +0100 | [diff] [blame] | 142 | (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name); \ |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 143 | } \ |
| 144 | static inline void fio_file_clear_##name(struct fio_file *f) \ |
| 145 | { \ |
Daniel Gollub | bea5c23 | 2014-02-12 15:51:54 +0100 | [diff] [blame] | 146 | (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name); \ |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 147 | } \ |
| 148 | static inline int fio_file_##name(struct fio_file *f) \ |
| 149 | { \ |
| 150 | return ((f)->flags & FIO_FILE_##name) != 0; \ |
| 151 | } |
| 152 | |
| 153 | FILE_FLAG_FNS(open); |
| 154 | FILE_FLAG_FNS(closing); |
| 155 | FILE_FLAG_FNS(extend); |
| 156 | FILE_FLAG_FNS(done); |
| 157 | FILE_FLAG_FNS(size_known); |
| 158 | FILE_FLAG_FNS(hashed); |
Jens Axboe | ed47cbf | 2009-07-03 22:52:38 +0200 | [diff] [blame] | 159 | FILE_FLAG_FNS(partial_mmap); |
Jens Axboe | d55dd04 | 2014-12-15 09:38:43 -0700 | [diff] [blame] | 160 | FILE_FLAG_FNS(axmap); |
| 161 | FILE_FLAG_FNS(lfsr); |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 162 | #undef FILE_FLAG_FNS |
| 163 | |
Jens Axboe | 4cd02b3 | 2009-06-03 08:46:38 +0200 | [diff] [blame] | 164 | /* |
| 165 | * File setup/shutdown |
| 166 | */ |
| 167 | struct thread_data; |
| 168 | extern void close_files(struct thread_data *); |
| 169 | extern void close_and_free_files(struct thread_data *); |
Jens Axboe | bedc9dc | 2014-03-17 12:51:09 -0600 | [diff] [blame] | 170 | extern uint64_t get_start_offset(struct thread_data *, struct fio_file *); |
Jens Axboe | 4cd02b3 | 2009-06-03 08:46:38 +0200 | [diff] [blame] | 171 | extern int __must_check setup_files(struct thread_data *); |
| 172 | extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *); |
| 173 | extern int __must_check generic_open_file(struct thread_data *, struct fio_file *); |
| 174 | extern int __must_check generic_close_file(struct thread_data *, struct fio_file *); |
| 175 | extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *); |
Dmitry Monakhov | 1ccc6dc | 2012-09-19 23:22:53 +0400 | [diff] [blame] | 176 | extern int __must_check file_lookup_open(struct fio_file *f, int flags); |
Jens Axboe | 4cd02b3 | 2009-06-03 08:46:38 +0200 | [diff] [blame] | 177 | extern int __must_check pre_read_files(struct thread_data *); |
Jens Axboe | 5903e7b | 2014-02-26 13:42:13 -0800 | [diff] [blame] | 178 | extern int add_file(struct thread_data *, const char *, int, int); |
Jens Axboe | 49ffb4a | 2010-08-24 15:01:37 +0200 | [diff] [blame] | 179 | extern int add_file_exclusive(struct thread_data *, const char *); |
Jens Axboe | 4cd02b3 | 2009-06-03 08:46:38 +0200 | [diff] [blame] | 180 | extern void get_file(struct fio_file *); |
| 181 | extern int __must_check put_file(struct thread_data *, struct fio_file *); |
Jens Axboe | e8462bd | 2009-07-06 12:59:04 +0200 | [diff] [blame] | 182 | extern void put_file_log(struct thread_data *, struct fio_file *); |
Jens Axboe | 4cd02b3 | 2009-06-03 08:46:38 +0200 | [diff] [blame] | 183 | extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir); |
| 184 | extern void unlock_file(struct thread_data *, struct fio_file *); |
| 185 | extern void unlock_file_all(struct thread_data *, struct fio_file *); |
| 186 | extern int add_dir_files(struct thread_data *, const char *); |
| 187 | extern int init_random_map(struct thread_data *); |
| 188 | extern void dup_files(struct thread_data *, struct thread_data *); |
| 189 | extern int get_fileno(struct thread_data *, const char *); |
| 190 | extern void free_release_files(struct thread_data *); |
Christian Ehrhardt | bcbfeef | 2014-02-20 09:13:06 -0800 | [diff] [blame] | 191 | extern void filesetup_mem_free(void); |
Jens Axboe | 33c4881 | 2013-01-21 09:46:06 -0700 | [diff] [blame] | 192 | void fio_file_reset(struct thread_data *, struct fio_file *); |
Jens Axboe | 002fe73 | 2014-02-11 08:31:13 -0700 | [diff] [blame] | 193 | int fio_files_done(struct thread_data *); |
Jens Axboe | c592b9f | 2009-06-03 09:29:28 +0200 | [diff] [blame] | 194 | |
Jens Axboe | d6aed79 | 2009-06-03 08:41:15 +0200 | [diff] [blame] | 195 | #endif |