file.h

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