blob: 67ef24f109f32da44778745153861249f8490ccd [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 Axboed6aed792009-06-03 08:41:15 +02008
9/*
10 * The type of object we are working on
11 */
12enum fio_filetype {
13 FIO_TYPE_FILE = 1, /* plain file */
14 FIO_TYPE_BD, /* block device */
15 FIO_TYPE_CHAR, /* character device */
16 FIO_TYPE_PIPE, /* pipe */
17};
18
19enum fio_file_flags {
20 FIO_FILE_open = 1 << 0, /* file is open */
21 FIO_FILE_closing = 1 << 1, /* file being closed */
22 FIO_FILE_extend = 1 << 2, /* needs extend */
23 FIO_FILE_done = 1 << 3, /* io completed to this file */
24 FIO_FILE_size_known = 1 << 4, /* size has been set */
25 FIO_FILE_hashed = 1 << 5, /* file is on hash */
Jens Axboeed47cbf2009-07-03 22:52:38 +020026 FIO_FILE_partial_mmap = 1 << 6, /* can't do full mmap */
Jens Axboed6aed792009-06-03 08:41:15 +020027};
28
29enum file_lock_mode {
30 FILE_LOCK_NONE,
31 FILE_LOCK_EXCLUSIVE,
32 FILE_LOCK_READWRITE,
33};
34
35/*
Jens Axboe590aebd2009-06-03 08:54:00 +020036 * roundrobin available files, or choose one at random, or do each one
37 * serially.
38 */
39enum {
40 FIO_FSERVICE_RANDOM = 1,
41 FIO_FSERVICE_RR = 2,
42 FIO_FSERVICE_SEQ = 3,
43};
44
45/*
Eric Gourioua596f042011-06-17 09:11:45 +020046 * No pre-allocation when laying down files, or call posix_fallocate(), or
47 * call fallocate() with FALLOC_FL_KEEP_SIZE set.
48 */
49enum fio_fallocate_mode {
50 FIO_FALLOCATE_NONE = 1,
51 FIO_FALLOCATE_POSIX = 2,
52 FIO_FALLOCATE_KEEP_SIZE = 3,
53};
54
55/*
Jens Axboed6aed792009-06-03 08:41:15 +020056 * Each thread_data structure has a number of files associated with it,
57 * this structure holds state information for a single file.
58 */
59struct fio_file {
60 struct flist_head hash_list;
61 enum fio_filetype filetype;
62
Jens Axboe9e700a72010-10-08 15:06:33 +020063 void *file_data;
Jens Axboe0e238572010-10-08 11:26:43 +020064 int fd;
Bruce Cran03e20d62011-01-02 20:14:54 +010065#ifdef __CYGWIN__
66 HANDLE hFile;
67 HANDLE ioCP;
68#endif
Jens Axboed6aed792009-06-03 08:41:15 +020069
70 /*
71 * filename and possible memory mapping
72 */
73 char *file_name;
74 unsigned int major, minor;
75
76 void *mmap_ptr;
77 size_t mmap_sz;
78 off_t mmap_off;
79
80 /*
81 * size of the file, offset into file, and io size from that offset
82 */
83 unsigned long long real_file_size;
84 unsigned long long file_offset;
85 unsigned long long io_size;
86
87 unsigned long long last_pos;
Jens Axboe38dad622010-07-20 14:46:00 -060088 unsigned long long last_start;
Jens Axboed6aed792009-06-03 08:41:15 +020089
Jens Axboe44f29692010-03-09 20:09:44 +010090 unsigned long long first_write;
91 unsigned long long last_write;
92
Jens Axboed6aed792009-06-03 08:41:15 +020093 /*
Jens Axboee943b872010-02-02 09:48:13 +010094 * For use by the io engine
95 */
96 unsigned long long file_pos;
97
98 /*
Jens Axboed6aed792009-06-03 08:41:15 +020099 * if io is protected by a semaphore, this is set
100 */
101 struct fio_mutex *lock;
102 void *lock_owner;
103 unsigned int lock_batch;
104 enum fio_ddir lock_ddir;
105
106 /*
107 * block map for random io
108 */
Jens Axboe0ce8b112011-01-27 22:25:29 +0100109 unsigned long *file_map;
Jens Axboe0e280ee2012-02-01 20:05:34 +0100110 unsigned long num_maps;
111 unsigned long last_free_lookup;
112 unsigned failed_rands;
Jens Axboed6aed792009-06-03 08:41:15 +0200113
114 int references;
115 enum fio_file_flags flags;
116
117 struct disk_util *du;
118};
119
120#define FILE_FLAG_FNS(name) \
121static inline void fio_file_set_##name(struct fio_file *f) \
122{ \
123 (f)->flags |= FIO_FILE_##name; \
124} \
125static inline void fio_file_clear_##name(struct fio_file *f) \
126{ \
127 (f)->flags &= ~FIO_FILE_##name; \
128} \
129static inline int fio_file_##name(struct fio_file *f) \
130{ \
131 return ((f)->flags & FIO_FILE_##name) != 0; \
132}
133
134FILE_FLAG_FNS(open);
135FILE_FLAG_FNS(closing);
136FILE_FLAG_FNS(extend);
137FILE_FLAG_FNS(done);
138FILE_FLAG_FNS(size_known);
139FILE_FLAG_FNS(hashed);
Jens Axboeed47cbf2009-07-03 22:52:38 +0200140FILE_FLAG_FNS(partial_mmap);
Jens Axboed6aed792009-06-03 08:41:15 +0200141#undef FILE_FLAG_FNS
142
Jens Axboe4cd02b32009-06-03 08:46:38 +0200143/*
144 * File setup/shutdown
145 */
146struct thread_data;
147extern void close_files(struct thread_data *);
148extern void close_and_free_files(struct thread_data *);
149extern int __must_check setup_files(struct thread_data *);
150extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
151extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
152extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
153extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
154extern int __must_check pre_read_files(struct thread_data *);
155extern int add_file(struct thread_data *, const char *);
Jens Axboe49ffb4a2010-08-24 15:01:37 +0200156extern int add_file_exclusive(struct thread_data *, const char *);
Jens Axboe4cd02b32009-06-03 08:46:38 +0200157extern void get_file(struct fio_file *);
158extern int __must_check put_file(struct thread_data *, struct fio_file *);
Jens Axboee8462bd2009-07-06 12:59:04 +0200159extern void put_file_log(struct thread_data *, struct fio_file *);
Jens Axboe4cd02b32009-06-03 08:46:38 +0200160extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
161extern void unlock_file(struct thread_data *, struct fio_file *);
162extern void unlock_file_all(struct thread_data *, struct fio_file *);
163extern int add_dir_files(struct thread_data *, const char *);
164extern int init_random_map(struct thread_data *);
165extern void dup_files(struct thread_data *, struct thread_data *);
166extern int get_fileno(struct thread_data *, const char *);
167extern void free_release_files(struct thread_data *);
168
Jens Axboec592b9f2009-06-03 09:29:28 +0200169static inline void fio_file_reset(struct fio_file *f)
170{
171 f->last_free_lookup = 0;
Jens Axboe0ce8b112011-01-27 22:25:29 +0100172 f->failed_rands = 0;
Jens Axboec592b9f2009-06-03 09:29:28 +0200173 f->last_pos = f->file_offset;
Jens Axboe38dad622010-07-20 14:46:00 -0600174 f->last_start = -1ULL;
Jens Axboee943b872010-02-02 09:48:13 +0100175 f->file_pos = -1ULL;
Jens Axboec592b9f2009-06-03 09:29:28 +0200176 if (f->file_map)
Jens Axboe0ce8b112011-01-27 22:25:29 +0100177 memset(f->file_map, 0, f->num_maps * sizeof(unsigned long));
Jens Axboec592b9f2009-06-03 09:29:28 +0200178}
179
Jens Axboed6aed792009-06-03 08:41:15 +0200180#endif