Fix problem with mutexes and MONOTONIC clock
[fio.git] / 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          * if io is protected by a semaphore, this is set
79          */
80         struct fio_mutex *lock;
81         void *lock_owner;
82         unsigned int lock_batch;
83         enum fio_ddir lock_ddir;
84
85         /*
86          * block map for random io
87          */
88         unsigned int *file_map;
89         unsigned int num_maps;
90         unsigned int last_free_lookup;
91
92         int references;
93         enum fio_file_flags flags;
94
95         struct disk_util *du;
96 };
97
98 #define FILE_FLAG_FNS(name)                                             \
99 static inline void fio_file_set_##name(struct fio_file *f)              \
100 {                                                                       \
101         (f)->flags |= FIO_FILE_##name;                                  \
102 }                                                                       \
103 static inline void fio_file_clear_##name(struct fio_file *f)            \
104 {                                                                       \
105         (f)->flags &= ~FIO_FILE_##name;                                 \
106 }                                                                       \
107 static inline int fio_file_##name(struct fio_file *f)                   \
108 {                                                                       \
109         return ((f)->flags & FIO_FILE_##name) != 0;                     \
110 }
111
112 FILE_FLAG_FNS(open);
113 FILE_FLAG_FNS(closing);
114 FILE_FLAG_FNS(extend);
115 FILE_FLAG_FNS(done);
116 FILE_FLAG_FNS(size_known);
117 FILE_FLAG_FNS(hashed);
118 FILE_FLAG_FNS(partial_mmap);
119 #undef FILE_FLAG_FNS
120
121 /*
122  * File setup/shutdown
123  */
124 struct thread_data;
125 extern void close_files(struct thread_data *);
126 extern void close_and_free_files(struct thread_data *);
127 extern int __must_check setup_files(struct thread_data *);
128 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
129 extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
130 extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
131 extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
132 extern int __must_check pre_read_files(struct thread_data *);
133 extern int add_file(struct thread_data *, const char *);
134 extern void get_file(struct fio_file *);
135 extern int __must_check put_file(struct thread_data *, struct fio_file *);
136 extern void put_file_log(struct thread_data *, struct fio_file *);
137 extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
138 extern void unlock_file(struct thread_data *, struct fio_file *);
139 extern void unlock_file_all(struct thread_data *, struct fio_file *);
140 extern int add_dir_files(struct thread_data *, const char *);
141 extern int init_random_map(struct thread_data *);
142 extern void dup_files(struct thread_data *, struct thread_data *);
143 extern int get_fileno(struct thread_data *, const char *);
144 extern void free_release_files(struct thread_data *);
145
146 static inline void fio_file_reset(struct fio_file *f)
147 {
148         f->last_free_lookup = 0;
149         f->last_pos = f->file_offset;
150         if (f->file_map)
151                 memset(f->file_map, 0, f->num_maps * sizeof(int));
152 }
153
154 #endif