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