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