file.h

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