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 #include "lib/zipf.h"
   9 #include "lib/axmap.h"
  10 #include "lib/lfsr.h"
  11 #include "lib/gauss.h"
  12
  13 /* Forward declarations */
  14 struct zoned_block_device_info;
  15
  16 /*
  17  * The type of object we are working on
  18  */
  19 enum fio_filetype {
  20         FIO_TYPE_FILE = 1,              /* plain file */
  21         FIO_TYPE_BLOCK,                 /* block device */
  22         FIO_TYPE_CHAR,                  /* character device */
  23         FIO_TYPE_PIPE,                  /* pipe */
  24 };
  25
  26 enum fio_file_flags {
  27         FIO_FILE_open           = 1 << 0,       /* file is open */
  28         FIO_FILE_closing        = 1 << 1,       /* file being closed */
  29         FIO_FILE_extend         = 1 << 2,       /* needs extend */
  30         FIO_FILE_done           = 1 << 3,       /* io completed to this file */
  31         FIO_FILE_size_known     = 1 << 4,       /* size has been set */
  32         FIO_FILE_hashed         = 1 << 5,       /* file is on hash */
  33         FIO_FILE_partial_mmap   = 1 << 6,       /* can't do full mmap */
  34         FIO_FILE_axmap          = 1 << 7,       /* uses axmap */
  35         FIO_FILE_lfsr           = 1 << 8,       /* lfsr is used */
  36 };
  37
  38 enum file_lock_mode {
  39         FILE_LOCK_NONE,
  40         FILE_LOCK_EXCLUSIVE,
  41         FILE_LOCK_READWRITE,
  42 };
  43
  44 /*
  45  * How fio chooses what file to service next. Choice of uniformly random, or
  46  * some skewed random variants, or just sequentially go through them or
  47  * roundrobing.
  48  */
  49 enum {
  50         FIO_FSERVICE_RANDOM             = 1,
  51         FIO_FSERVICE_RR                 = 2,
  52         FIO_FSERVICE_SEQ                = 3,
  53         __FIO_FSERVICE_NONUNIFORM       = 0x100,
  54         FIO_FSERVICE_ZIPF               = __FIO_FSERVICE_NONUNIFORM | 4,
  55         FIO_FSERVICE_PARETO             = __FIO_FSERVICE_NONUNIFORM | 5,
  56         FIO_FSERVICE_GAUSS              = __FIO_FSERVICE_NONUNIFORM | 6,
  57
  58         FIO_FSERVICE_SHIFT              = 10,
  59 };
  60
  61 /*
  62  * No pre-allocation when laying down files, or call posix_fallocate(), or
  63  * call fallocate() with FALLOC_FL_KEEP_SIZE set.
  64  */
  65 enum fio_fallocate_mode {
  66         FIO_FALLOCATE_NONE      = 1,
  67         FIO_FALLOCATE_POSIX     = 2,
  68         FIO_FALLOCATE_KEEP_SIZE = 3,
  69         FIO_FALLOCATE_NATIVE    = 4,
  70 };
  71
  72 /*
  73  * Each thread_data structure has a number of files associated with it,
  74  * this structure holds state information for a single file.
  75  */
  76 struct fio_file {
  77         struct flist_head hash_list;
  78         enum fio_filetype filetype;
  79
  80         int fd;
  81         int shadow_fd;
  82 #ifdef WIN32
  83         HANDLE hFile;
  84         HANDLE ioCP;
  85 #endif
  86
  87         /*
  88          * filename and possible memory mapping
  89          */
  90         unsigned int major, minor;
  91         int fileno;
  92         char *file_name;
  93
  94         /*
  95          * size of the file, offset into file, and io size from that offset
  96          * (be aware io_size is different from thread_options::io_size)
  97          */
  98         uint64_t real_file_size;
  99         uint64_t file_offset;
 100         uint64_t io_size;
 101
 102         /*
 103          * Zoned block device information. See also zonemode=zbd.
 104          */
 105         struct zoned_block_device_info *zbd_info;
 106
 107         /*
 108          * Track last end and last start of IO for a given data direction
 109          */
 110         uint64_t last_pos[DDIR_RWDIR_CNT];
 111         uint64_t last_start[DDIR_RWDIR_CNT];
 112
 113         uint64_t first_write;
 114         uint64_t last_write;
 115
 116         /*
 117          * Tracks the last iodepth number of completed writes, if data
 118          * verification is enabled
 119          */
 120         uint64_t *last_write_comp;
 121         unsigned int last_write_idx;
 122
 123         /*
 124          * For use by the io engine for offset or private data storage
 125          */
 126         union {
 127                 uint64_t engine_pos;
 128                 void *engine_data;
 129         };
 130
 131         /*
 132          * if io is protected by a semaphore, this is set
 133          */
 134         union {
 135                 struct fio_sem *lock;
 136                 struct fio_rwlock *rwlock;
 137         };
 138
 139         /*
 140          * block map or LFSR for random io
 141          */
 142         union {
 143                 struct axmap *io_axmap;
 144                 struct fio_lfsr lfsr;
 145         };
 146
 147         /*
 148          * Used for zipf random distribution
 149          */
 150         union {
 151                 struct zipf_state zipf;
 152                 struct gauss_state gauss;
 153         };
 154
 155         int references;
 156         enum fio_file_flags flags;
 157
 158         struct disk_util *du;
 159 };
 160
 161 #define FILE_ENG_DATA(f)                ((f)->engine_data)
 162 #define FILE_SET_ENG_DATA(f, data)      ((f)->engine_data = (data))
 163
 164 #define FILE_FLAG_FNS(name)                                             \
 165 static inline void fio_file_set_##name(struct fio_file *f)              \
 166 {                                                                       \
 167         (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name);      \
 168 }                                                                       \
 169 static inline void fio_file_clear_##name(struct fio_file *f)            \
 170 {                                                                       \
 171         (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name);     \
 172 }                                                                       \
 173 static inline int fio_file_##name(struct fio_file *f)                   \
 174 {                                                                       \
 175         return ((f)->flags & FIO_FILE_##name) != 0;                     \
 176 }
 177
 178 FILE_FLAG_FNS(open);
 179 FILE_FLAG_FNS(closing);
 180 FILE_FLAG_FNS(extend);
 181 FILE_FLAG_FNS(done);
 182 FILE_FLAG_FNS(size_known);
 183 FILE_FLAG_FNS(hashed);
 184 FILE_FLAG_FNS(partial_mmap);
 185 FILE_FLAG_FNS(axmap);
 186 FILE_FLAG_FNS(lfsr);
 187 #undef FILE_FLAG_FNS
 188
 189 /*
 190  * File setup/shutdown
 191  */
 192 struct thread_data;
 193 extern void close_files(struct thread_data *);
 194 extern void close_and_free_files(struct thread_data *);
 195 extern uint64_t get_start_offset(struct thread_data *, struct fio_file *);
 196 extern int __must_check setup_files(struct thread_data *);
 197 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 198 #ifdef __cplusplus
 199 extern "C" {
 200 #endif
 201 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 202 extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
 203 extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
 204 #ifdef __cplusplus
 205 }
 206 #endif
 207 extern int __must_check file_lookup_open(struct fio_file *f, int flags);
 208 extern bool __must_check pre_read_files(struct thread_data *);
 209 extern unsigned long long get_rand_file_size(struct thread_data *td);
 210 extern int add_file(struct thread_data *, const char *, int, int);
 211 extern int add_file_exclusive(struct thread_data *, const char *);
 212 extern void get_file(struct fio_file *);
 213 extern int __must_check put_file(struct thread_data *, struct fio_file *);
 214 extern void put_file_log(struct thread_data *, struct fio_file *);
 215 extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
 216 extern void unlock_file(struct thread_data *, struct fio_file *);
 217 extern void unlock_file_all(struct thread_data *, struct fio_file *);
 218 extern int add_dir_files(struct thread_data *, const char *);
 219 extern bool init_random_map(struct thread_data *);
 220 extern void dup_files(struct thread_data *, struct thread_data *);
 221 extern int get_fileno(struct thread_data *, const char *);
 222 extern void free_release_files(struct thread_data *);
 223 extern void filesetup_mem_free(void);
 224 extern void fio_file_reset(struct thread_data *, struct fio_file *);
 225 extern bool fio_files_done(struct thread_data *);
 226 extern bool exists_and_not_regfile(const char *);
 227 extern int fio_set_directio(struct thread_data *, struct fio_file *);
 228
 229 #endif