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 /*
  14  * The type of object we are working on
  15  */
  16 enum fio_filetype {
  17         FIO_TYPE_FILE = 1,              /* plain file */
  18         FIO_TYPE_BD,                    /* block device */
  19         FIO_TYPE_CHAR,                  /* character device */
  20         FIO_TYPE_PIPE,                  /* pipe */
  21 };
  22
  23 enum fio_file_flags {
  24         FIO_FILE_open           = 1 << 0,       /* file is open */
  25         FIO_FILE_closing        = 1 << 1,       /* file being closed */
  26         FIO_FILE_extend         = 1 << 2,       /* needs extend */
  27         FIO_FILE_done           = 1 << 3,       /* io completed to this file */
  28         FIO_FILE_size_known     = 1 << 4,       /* size has been set */
  29         FIO_FILE_hashed         = 1 << 5,       /* file is on hash */
  30         FIO_FILE_partial_mmap   = 1 << 6,       /* can't do full mmap */
  31         FIO_FILE_axmap          = 1 << 7,       /* uses axmap */
  32         FIO_FILE_lfsr           = 1 << 8,       /* lfsr is used */
  33 };
  34
  35 enum file_lock_mode {
  36         FILE_LOCK_NONE,
  37         FILE_LOCK_EXCLUSIVE,
  38         FILE_LOCK_READWRITE,
  39 };
  40
  41 /*
  42  * roundrobin available files, or choose one at random, or do each one
  43  * serially.
  44  */
  45 enum {
  46         FIO_FSERVICE_RANDOM     = 1,
  47         FIO_FSERVICE_RR         = 2,
  48         FIO_FSERVICE_SEQ        = 3,
  49 };
  50
  51 /*
  52  * No pre-allocation when laying down files, or call posix_fallocate(), or
  53  * call fallocate() with FALLOC_FL_KEEP_SIZE set.
  54  */
  55 enum fio_fallocate_mode {
  56         FIO_FALLOCATE_NONE      = 1,
  57         FIO_FALLOCATE_POSIX     = 2,
  58         FIO_FALLOCATE_KEEP_SIZE = 3,
  59 };
  60
  61 /*
  62  * Each thread_data structure has a number of files associated with it,
  63  * this structure holds state information for a single file.
  64  */
  65 struct fio_file {
  66         struct flist_head hash_list;
  67         enum fio_filetype filetype;
  68
  69         int fd;
  70         int shadow_fd;
  71 #ifdef WIN32
  72         HANDLE hFile;
  73         HANDLE ioCP;
  74 #endif
  75
  76         /*
  77          * filename and possible memory mapping
  78          */
  79         unsigned int major, minor;
  80         int fileno;
  81         int bs;
  82         char *file_name;
  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         /*
  92          * Track last end and last start of IO for a given data direction
  93          */
  94         uint64_t last_pos[DDIR_RWDIR_CNT];
  95         uint64_t last_start[DDIR_RWDIR_CNT];
  96
  97         uint64_t first_write;
  98         uint64_t last_write;
  99
 100         /*
 101          * For use by the io engine
 102          */
 103         uint64_t engine_data;
 104
 105         /*
 106          * if io is protected by a semaphore, this is set
 107          */
 108         union {
 109                 struct fio_mutex *lock;
 110                 struct fio_rwlock *rwlock;
 111         };
 112
 113         /*
 114          * block map or LFSR for random io
 115          */
 116         union {
 117                 struct axmap *io_axmap;
 118                 struct fio_lfsr lfsr;
 119         };
 120
 121         /*
 122          * Used for zipf random distribution
 123          */
 124         union {
 125                 struct zipf_state zipf;
 126                 struct gauss_state gauss;
 127         };
 128
 129         int references;
 130         enum fio_file_flags flags;
 131
 132         struct disk_util *du;
 133 };
 134
 135 #define FILE_ENG_DATA(f)        ((void *) (uintptr_t) (f)->engine_data)
 136 #define FILE_SET_ENG_DATA(f, data)      \
 137         ((f)->engine_data = (uintptr_t) (data))
 138
 139 struct file_name {
 140         struct flist_head list;
 141         char *filename;
 142 };
 143
 144 #define FILE_FLAG_FNS(name)                                             \
 145 static inline void fio_file_set_##name(struct fio_file *f)              \
 146 {                                                                       \
 147         (f)->flags = (enum fio_file_flags) ((f)->flags | FIO_FILE_##name);      \
 148 }                                                                       \
 149 static inline void fio_file_clear_##name(struct fio_file *f)            \
 150 {                                                                       \
 151         (f)->flags = (enum fio_file_flags) ((f)->flags & ~FIO_FILE_##name);     \
 152 }                                                                       \
 153 static inline int fio_file_##name(struct fio_file *f)                   \
 154 {                                                                       \
 155         return ((f)->flags & FIO_FILE_##name) != 0;                     \
 156 }
 157
 158 FILE_FLAG_FNS(open);
 159 FILE_FLAG_FNS(closing);
 160 FILE_FLAG_FNS(extend);
 161 FILE_FLAG_FNS(done);
 162 FILE_FLAG_FNS(size_known);
 163 FILE_FLAG_FNS(hashed);
 164 FILE_FLAG_FNS(partial_mmap);
 165 FILE_FLAG_FNS(axmap);
 166 FILE_FLAG_FNS(lfsr);
 167 #undef FILE_FLAG_FNS
 168
 169 /*
 170  * File setup/shutdown
 171  */
 172 struct thread_data;
 173 extern void close_files(struct thread_data *);
 174 extern void close_and_free_files(struct thread_data *);
 175 extern uint64_t get_start_offset(struct thread_data *, struct fio_file *);
 176 extern int __must_check setup_files(struct thread_data *);
 177 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 178 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 179 extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
 180 extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
 181 extern int __must_check file_lookup_open(struct fio_file *f, int flags);
 182 extern int __must_check pre_read_files(struct thread_data *);
 183 extern int add_file(struct thread_data *, const char *, int, int);
 184 extern int add_file_exclusive(struct thread_data *, const char *);
 185 extern void get_file(struct fio_file *);
 186 extern int __must_check put_file(struct thread_data *, struct fio_file *);
 187 extern void put_file_log(struct thread_data *, struct fio_file *);
 188 extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
 189 extern void unlock_file(struct thread_data *, struct fio_file *);
 190 extern void unlock_file_all(struct thread_data *, struct fio_file *);
 191 extern int add_dir_files(struct thread_data *, const char *);
 192 extern int init_random_map(struct thread_data *);
 193 extern void dup_files(struct thread_data *, struct thread_data *);
 194 extern int get_fileno(struct thread_data *, const char *);
 195 extern void free_release_files(struct thread_data *);
 196 extern void filesetup_mem_free(void);
 197 void fio_file_reset(struct thread_data *, struct fio_file *);
 198 int fio_files_done(struct thread_data *);
 199
 200 #endif