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 };
  24
  25 enum file_lock_mode {
  26         FILE_LOCK_NONE,
  27         FILE_LOCK_EXCLUSIVE,
  28         FILE_LOCK_READWRITE,
  29 };
  30
  31 /*
  32  * roundrobin available files, or choose one at random, or do each one
  33  * serially.
  34  */
  35 enum {
  36         FIO_FSERVICE_RANDOM     = 1,
  37         FIO_FSERVICE_RR         = 2,
  38         FIO_FSERVICE_SEQ        = 3,
  39 };
  40
  41 /*
  42  * Each thread_data structure has a number of files associated with it,
  43  * this structure holds state information for a single file.
  44  */
  45 struct fio_file {
  46         struct flist_head hash_list;
  47         enum fio_filetype filetype;
  48
  49         /*
  50          * A file may not be a file descriptor, let the io engine decide
  51          */
  52         union {
  53                 unsigned long file_data;
  54                 int fd;
  55         };
  56
  57         /*
  58          * filename and possible memory mapping
  59          */
  60         char *file_name;
  61         unsigned int major, minor;
  62
  63         void *mmap_ptr;
  64         size_t mmap_sz;
  65         off_t mmap_off;
  66
  67         /*
  68          * size of the file, offset into file, and io size from that offset
  69          */
  70         unsigned long long real_file_size;
  71         unsigned long long file_offset;
  72         unsigned long long io_size;
  73
  74         unsigned long long last_pos;
  75
  76         /*
  77          * if io is protected by a semaphore, this is set
  78          */
  79         struct fio_mutex *lock;
  80         void *lock_owner;
  81         unsigned int lock_batch;
  82         enum fio_ddir lock_ddir;
  83
  84         /*
  85          * block map for random io
  86          */
  87         unsigned int *file_map;
  88         unsigned int num_maps;
  89         unsigned int last_free_lookup;
  90
  91         int references;
  92         enum fio_file_flags flags;
  93
  94         struct disk_util *du;
  95 };
  96
  97 #define FILE_FLAG_FNS(name)                                             \
  98 static inline void fio_file_set_##name(struct fio_file *f)              \
  99 {                                                                       \
 100         (f)->flags |= FIO_FILE_##name;                                  \
 101 }                                                                       \
 102 static inline void fio_file_clear_##name(struct fio_file *f)            \
 103 {                                                                       \
 104         (f)->flags &= ~FIO_FILE_##name;                                 \
 105 }                                                                       \
 106 static inline int fio_file_##name(struct fio_file *f)                   \
 107 {                                                                       \
 108         return ((f)->flags & FIO_FILE_##name) != 0;                     \
 109 }
 110
 111 FILE_FLAG_FNS(open);
 112 FILE_FLAG_FNS(closing);
 113 FILE_FLAG_FNS(extend);
 114 FILE_FLAG_FNS(done);
 115 FILE_FLAG_FNS(size_known);
 116 FILE_FLAG_FNS(hashed);
 117 #undef FILE_FLAG_FNS
 118
 119 /*
 120  * File setup/shutdown
 121  */
 122 struct thread_data;
 123 extern void close_files(struct thread_data *);
 124 extern void close_and_free_files(struct thread_data *);
 125 extern int __must_check setup_files(struct thread_data *);
 126 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
 127 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
 128 extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
 129 extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
 130 extern int __must_check pre_read_files(struct thread_data *);
 131 extern int add_file(struct thread_data *, const char *);
 132 extern void get_file(struct fio_file *);
 133 extern int __must_check put_file(struct thread_data *, struct fio_file *);
 134 extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
 135 extern void unlock_file(struct thread_data *, struct fio_file *);
 136 extern void unlock_file_all(struct thread_data *, struct fio_file *);
 137 extern int add_dir_files(struct thread_data *, const char *);
 138 extern int init_random_map(struct thread_data *);
 139 extern void dup_files(struct thread_data *, struct thread_data *);
 140 extern int get_fileno(struct thread_data *, const char *);
 141 extern void free_release_files(struct thread_data *);
 142
 143 static inline void fio_file_reset(struct fio_file *f)
 144 {
 145         f->last_free_lookup = 0;
 146         f->last_pos = f->file_offset;
 147         if (f->file_map)
 148                 memset(f->file_map, 0, f->num_maps * sizeof(int));
 149 }
 150
 151 #endif