blob: d7e05f4fb22e0aaf97b5cb0c7453f1ce4cdc1051 [file] [log] [blame]
Jens Axboed6aed792009-06-03 08:41:15 +02001#ifndef FIO_FILE_H
2#define FIO_FILE_H
3
Jens Axboee2e58882011-01-04 08:36:06 +01004#include <string.h>
Bruce Cranecc314b2011-01-04 10:59:30 +01005#include "compiler/compiler.h"
Jens Axboed6aed792009-06-03 08:41:15 +02006#include "io_ddir.h"
Bruce Cranecc314b2011-01-04 10:59:30 +01007#include "flist.h"
Jens Axboe9c6f6312012-11-07 09:15:45 +01008#include "lib/zipf.h"
Jens Axboe7ebd7962012-11-28 21:24:46 +01009#include "lib/axmap.h"
Jens Axboe8055e412012-11-26 08:43:47 +010010#include "lib/lfsr.h"
Jens Axboed6aed792009-06-03 08:41:15 +020011
12/*
13 * The type of object we are working on
14 */
15enum fio_filetype {
16 FIO_TYPE_FILE = 1, /* plain file */
17 FIO_TYPE_BD, /* block device */
18 FIO_TYPE_CHAR, /* character device */
19 FIO_TYPE_PIPE, /* pipe */
20};
21
22enum fio_file_flags {
23 FIO_FILE_open = 1 << 0, /* file is open */
24 FIO_FILE_closing = 1 << 1, /* file being closed */
25 FIO_FILE_extend = 1 << 2, /* needs extend */
26 FIO_FILE_done = 1 << 3, /* io completed to this file */
27 FIO_FILE_size_known = 1 << 4, /* size has been set */
28 FIO_FILE_hashed = 1 << 5, /* file is on hash */
Jens Axboeed47cbf2009-07-03 22:52:38 +020029 FIO_FILE_partial_mmap = 1 << 6, /* can't do full mmap */
Jens Axboed6aed792009-06-03 08:41:15 +020030};
31
32enum file_lock_mode {
33 FILE_LOCK_NONE,
34 FILE_LOCK_EXCLUSIVE,
35 FILE_LOCK_READWRITE,
36};
37
38/*
Jens Axboe590aebd2009-06-03 08:54:00 +020039 * roundrobin available files, or choose one at random, or do each one
40 * serially.
41 */
42enum {
43 FIO_FSERVICE_RANDOM = 1,
44 FIO_FSERVICE_RR = 2,
45 FIO_FSERVICE_SEQ = 3,
46};
47
48/*
Eric Gourioua596f042011-06-17 09:11:45 +020049 * No pre-allocation when laying down files, or call posix_fallocate(), or
50 * call fallocate() with FALLOC_FL_KEEP_SIZE set.
51 */
52enum fio_fallocate_mode {
53 FIO_FALLOCATE_NONE = 1,
54 FIO_FALLOCATE_POSIX = 2,
55 FIO_FALLOCATE_KEEP_SIZE = 3,
56};
57
58/*
Jens Axboed6aed792009-06-03 08:41:15 +020059 * Each thread_data structure has a number of files associated with it,
60 * this structure holds state information for a single file.
61 */
62struct fio_file {
63 struct flist_head hash_list;
64 enum fio_filetype filetype;
65
Jens Axboe0e238572010-10-08 11:26:43 +020066 int fd;
Jens Axboee6c4d732012-12-12 08:16:27 +010067 int shadow_fd;
Bruce Cran93bcfd22012-02-20 20:18:19 +010068#ifdef WIN32
Bruce Cran03e20d62011-01-02 20:14:54 +010069 HANDLE hFile;
70 HANDLE ioCP;
71#endif
Jens Axboed6aed792009-06-03 08:41:15 +020072
73 /*
74 * filename and possible memory mapping
75 */
76 char *file_name;
77 unsigned int major, minor;
Shaohua Li89ac1d42012-06-11 08:56:32 +020078 int fileno;
Jens Axboed6aed792009-06-03 08:41:15 +020079
80 void *mmap_ptr;
81 size_t mmap_sz;
82 off_t mmap_off;
83
84 /*
85 * size of the file, offset into file, and io size from that offset
86 */
Jens Axboe293b8c12013-01-04 13:16:54 +010087 uint64_t real_file_size;
88 uint64_t file_offset;
89 uint64_t io_size;
Jens Axboed6aed792009-06-03 08:41:15 +020090
Jens Axboe293b8c12013-01-04 13:16:54 +010091 uint64_t last_pos;
92 uint64_t last_start;
Jens Axboed6aed792009-06-03 08:41:15 +020093
Jens Axboe293b8c12013-01-04 13:16:54 +010094 uint64_t first_write;
95 uint64_t last_write;
Jens Axboe44f29692010-03-09 20:09:44 +010096
Jens Axboed6aed792009-06-03 08:41:15 +020097 /*
Jens Axboee943b872010-02-02 09:48:13 +010098 * For use by the io engine
99 */
Jens Axboe47f07dd2013-02-11 14:35:43 +0100100 uint64_t engine_data;
Jens Axboee943b872010-02-02 09:48:13 +0100101
102 /*
Jens Axboed6aed792009-06-03 08:41:15 +0200103 * if io is protected by a semaphore, this is set
104 */
Jens Axboed7df1d12013-03-20 19:57:01 -0600105 union {
106 struct fio_mutex *lock;
107 struct fio_rwlock *rwlock;
108 };
Jens Axboed6aed792009-06-03 08:41:15 +0200109
110 /*
111 * block map for random io
112 */
Jens Axboe7ebd7962012-11-28 21:24:46 +0100113 struct axmap *io_axmap;
Jens Axboed6aed792009-06-03 08:41:15 +0200114
Jens Axboe8055e412012-11-26 08:43:47 +0100115 struct fio_lfsr lfsr;
116
Jens Axboe9c6f6312012-11-07 09:15:45 +0100117 /*
118 * Used for zipf random distribution
119 */
120 struct zipf_state zipf;
121
Jens Axboed6aed792009-06-03 08:41:15 +0200122 int references;
123 enum fio_file_flags flags;
124
125 struct disk_util *du;
126};
127
128#define FILE_FLAG_FNS(name) \
129static inline void fio_file_set_##name(struct fio_file *f) \
130{ \
131 (f)->flags |= FIO_FILE_##name; \
132} \
133static inline void fio_file_clear_##name(struct fio_file *f) \
134{ \
135 (f)->flags &= ~FIO_FILE_##name; \
136} \
137static inline int fio_file_##name(struct fio_file *f) \
138{ \
139 return ((f)->flags & FIO_FILE_##name) != 0; \
140}
141
142FILE_FLAG_FNS(open);
143FILE_FLAG_FNS(closing);
144FILE_FLAG_FNS(extend);
145FILE_FLAG_FNS(done);
146FILE_FLAG_FNS(size_known);
147FILE_FLAG_FNS(hashed);
Jens Axboeed47cbf2009-07-03 22:52:38 +0200148FILE_FLAG_FNS(partial_mmap);
Jens Axboed6aed792009-06-03 08:41:15 +0200149#undef FILE_FLAG_FNS
150
Jens Axboe4cd02b32009-06-03 08:46:38 +0200151/*
152 * File setup/shutdown
153 */
154struct thread_data;
155extern void close_files(struct thread_data *);
156extern void close_and_free_files(struct thread_data *);
Jens Axboe293b8c12013-01-04 13:16:54 +0100157extern uint64_t get_start_offset(struct thread_data *);
Jens Axboe4cd02b32009-06-03 08:46:38 +0200158extern int __must_check setup_files(struct thread_data *);
159extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
160extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
161extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
162extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
Dmitry Monakhov1ccc6dc2012-09-19 23:22:53 +0400163extern int __must_check file_lookup_open(struct fio_file *f, int flags);
Jens Axboe4cd02b32009-06-03 08:46:38 +0200164extern int __must_check pre_read_files(struct thread_data *);
165extern int add_file(struct thread_data *, const char *);
Jens Axboe49ffb4a2010-08-24 15:01:37 +0200166extern int add_file_exclusive(struct thread_data *, const char *);
Jens Axboe4cd02b32009-06-03 08:46:38 +0200167extern void get_file(struct fio_file *);
168extern int __must_check put_file(struct thread_data *, struct fio_file *);
Jens Axboee8462bd2009-07-06 12:59:04 +0200169extern void put_file_log(struct thread_data *, struct fio_file *);
Jens Axboe4cd02b32009-06-03 08:46:38 +0200170extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
171extern void unlock_file(struct thread_data *, struct fio_file *);
172extern void unlock_file_all(struct thread_data *, struct fio_file *);
173extern int add_dir_files(struct thread_data *, const char *);
174extern int init_random_map(struct thread_data *);
175extern void dup_files(struct thread_data *, struct thread_data *);
176extern int get_fileno(struct thread_data *, const char *);
177extern void free_release_files(struct thread_data *);
Jens Axboe33c48812013-01-21 09:46:06 -0700178void fio_file_reset(struct thread_data *, struct fio_file *);
Jens Axboec592b9f2009-06-03 09:29:28 +0200179
Jens Axboed6aed792009-06-03 08:41:15 +0200180#endif