[fio.git] / file.h

#ifndef FIO_FILE_H
#define FIO_FILE_H

#include "io_ddir.h"

/*
 * The type of object we are working on
 */
enum fio_filetype {
	FIO_TYPE_FILE = 1,		/* plain file */
	FIO_TYPE_BD,			/* block device */
	FIO_TYPE_CHAR,			/* character device */
	FIO_TYPE_PIPE,			/* pipe */
};

enum fio_file_flags {
	FIO_FILE_open		= 1 << 0,	/* file is open */
	FIO_FILE_closing	= 1 << 1,	/* file being closed */
	FIO_FILE_extend		= 1 << 2,	/* needs extend */
	FIO_FILE_done		= 1 << 3,	/* io completed to this file */
	FIO_FILE_size_known	= 1 << 4,	/* size has been set */
	FIO_FILE_hashed		= 1 << 5,	/* file is on hash */
	FIO_FILE_partial_mmap	= 1 << 6,	/* can't do full mmap */
};

enum file_lock_mode {
	FILE_LOCK_NONE,
	FILE_LOCK_EXCLUSIVE,
	FILE_LOCK_READWRITE,
};

/*
 * roundrobin available files, or choose one at random, or do each one
 * serially.
 */
enum {
	FIO_FSERVICE_RANDOM	= 1,
	FIO_FSERVICE_RR		= 2,
	FIO_FSERVICE_SEQ	= 3,
};

/*
 * Each thread_data structure has a number of files associated with it,
 * this structure holds state information for a single file.
 */
struct fio_file {
	struct flist_head hash_list;
	enum fio_filetype filetype;

	/*
	 * A file may not be a file descriptor, let the io engine decide
	 */
	union {
		unsigned long file_data;
		int fd;
	};

	/*
	 * filename and possible memory mapping
	 */
	char *file_name;
	unsigned int major, minor;

	void *mmap_ptr;
	size_t mmap_sz;
	off_t mmap_off;

	/*
	 * size of the file, offset into file, and io size from that offset
	 */
	unsigned long long real_file_size;
	unsigned long long file_offset;
	unsigned long long io_size;

	unsigned long long last_pos;

	unsigned long long first_write;
	unsigned long long last_write;

	/*
	 * For use by the io engine
	 */
	unsigned long long file_pos;

	/*
	 * if io is protected by a semaphore, this is set
	 */
	struct fio_mutex *lock;
	void *lock_owner;
	unsigned int lock_batch;
	enum fio_ddir lock_ddir;

	/*
	 * block map for random io
	 */
	unsigned int *file_map;
	unsigned int num_maps;
	unsigned int last_free_lookup;

	int references;
	enum fio_file_flags flags;

	struct disk_util *du;
};

#define FILE_FLAG_FNS(name)						\
static inline void fio_file_set_##name(struct fio_file *f)		\
{									\
	(f)->flags |= FIO_FILE_##name;					\
}									\
static inline void fio_file_clear_##name(struct fio_file *f)		\
{									\
	(f)->flags &= ~FIO_FILE_##name;					\
}									\
static inline int fio_file_##name(struct fio_file *f)			\
{									\
	return ((f)->flags & FIO_FILE_##name) != 0;			\
}

FILE_FLAG_FNS(open);
FILE_FLAG_FNS(closing);
FILE_FLAG_FNS(extend);
FILE_FLAG_FNS(done);
FILE_FLAG_FNS(size_known);
FILE_FLAG_FNS(hashed);
FILE_FLAG_FNS(partial_mmap);
#undef FILE_FLAG_FNS

/*
 * File setup/shutdown
 */
struct thread_data;
extern void close_files(struct thread_data *);
extern void close_and_free_files(struct thread_data *);
extern int __must_check setup_files(struct thread_data *);
extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
extern int __must_check generic_close_file(struct thread_data *, struct fio_file *);
extern int __must_check generic_get_file_size(struct thread_data *, struct fio_file *);
extern int __must_check pre_read_files(struct thread_data *);
extern int add_file(struct thread_data *, const char *);
extern void get_file(struct fio_file *);
extern int __must_check put_file(struct thread_data *, struct fio_file *);
extern void put_file_log(struct thread_data *, struct fio_file *);
extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
extern void unlock_file(struct thread_data *, struct fio_file *);
extern void unlock_file_all(struct thread_data *, struct fio_file *);
extern int add_dir_files(struct thread_data *, const char *);
extern int init_random_map(struct thread_data *);
extern void dup_files(struct thread_data *, struct thread_data *);
extern int get_fileno(struct thread_data *, const char *);
extern void free_release_files(struct thread_data *);

static inline void fio_file_reset(struct fio_file *f)
{
	f->last_free_lookup = 0;
	f->last_pos = f->file_offset;
	f->file_pos = -1ULL;
	if (f->file_map)
		memset(f->file_map, 0, f->num_maps * sizeof(int));
}

#endif
Commit	Line	Data
d6aed795 JA	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 */
ed47cbf7	23	FIO_FILE_partial_mmap = 1 << 6, /* can't do full mmap */
d6aed795 JA	24	};
	25
	26	enum file_lock_mode {
	27	FILE_LOCK_NONE,
	28	FILE_LOCK_EXCLUSIVE,
	29	FILE_LOCK_READWRITE,
	30	};
	31
590aebda JA	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
d6aed795 JA	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
44f29692 JA	77	unsigned long long first_write;
	78	unsigned long long last_write;
	79
e943b878 JA	80	/*
	81	* For use by the io engine
	82	*/
	83	unsigned long long file_pos;
	84
d6aed795 JA	85	/*
	86	* if io is protected by a semaphore, this is set
	87	*/
	88	struct fio_mutex *lock;
	89	void *lock_owner;
	90	unsigned int lock_batch;
	91	enum fio_ddir lock_ddir;
	92
	93	/*
	94	* block map for random io
	95	*/
	96	unsigned int *file_map;
	97	unsigned int num_maps;
	98	unsigned int last_free_lookup;
	99
	100	int references;
	101	enum fio_file_flags flags;
	102
	103	struct disk_util *du;
	104	};
	105
	106	#define FILE_FLAG_FNS(name) \
	107	static inline void fio_file_set_##name(struct fio_file *f) \
	108	{ \
	109	(f)->flags \|= FIO_FILE_##name; \
	110	} \
	111	static inline void fio_file_clear_##name(struct fio_file *f) \
	112	{ \
	113	(f)->flags &= ~FIO_FILE_##name; \
	114	} \
	115	static inline int fio_file_##name(struct fio_file *f) \
	116	{ \
	117	return ((f)->flags & FIO_FILE_##name) != 0; \
	118	}
	119
	120	FILE_FLAG_FNS(open);
	121	FILE_FLAG_FNS(closing);
	122	FILE_FLAG_FNS(extend);
	123	FILE_FLAG_FNS(done);
	124	FILE_FLAG_FNS(size_known);
	125	FILE_FLAG_FNS(hashed);
ed47cbf7	126	FILE_FLAG_FNS(partial_mmap);
d6aed795 JA	127	#undef FILE_FLAG_FNS
d6aed795 JA	128
4cd02b3f JA	129	/*
	130	* File setup/shutdown
	131	*/
	132	struct thread_data;
	133	extern void close_files(struct thread_data *);
	134	extern void close_and_free_files(struct thread_data *);
	135	extern int __must_check setup_files(struct thread_data *);
	136	extern int __must_check file_invalidate_cache(struct thread_data , struct fio_file );
	137	extern int __must_check generic_open_file(struct thread_data , struct fio_file );
	138	extern int __must_check generic_close_file(struct thread_data , struct fio_file );
	139	extern int __must_check generic_get_file_size(struct thread_data , struct fio_file );
	140	extern int __must_check pre_read_files(struct thread_data *);
	141	extern int add_file(struct thread_data , const char );
	142	extern void get_file(struct fio_file *);
	143	extern int __must_check put_file(struct thread_data , struct fio_file );
e8462bd8	144	extern void put_file_log(struct thread_data , struct fio_file );
4cd02b3f JA	145	extern void lock_file(struct thread_data , struct fio_file , enum fio_ddir);
	146	extern void unlock_file(struct thread_data , struct fio_file );
	147	extern void unlock_file_all(struct thread_data , struct fio_file );
	148	extern int add_dir_files(struct thread_data , const char );
	149	extern int init_random_map(struct thread_data *);
	150	extern void dup_files(struct thread_data , struct thread_data );
	151	extern int get_fileno(struct thread_data , const char );
	152	extern void free_release_files(struct thread_data *);
	153
c592b9fe JA	154	static inline void fio_file_reset(struct fio_file *f)
	155	{
	156	f->last_free_lookup = 0;
	157	f->last_pos = f->file_offset;
e943b878	158	f->file_pos = -1ULL;
c592b9fe JA	159	if (f->file_map)
	160	memset(f->file_map, 0, f->num_maps * sizeof(int));
	161	}
	162
d6aed795	163	#endif