[fio.git] / verify.h

#ifndef FIO_VERIFY_H
#define FIO_VERIFY_H

#include <stdint.h>

#define FIO_HDR_MAGIC	0xacca

enum {
	VERIFY_NONE = 0,		/* no verification */
	VERIFY_HDR_ONLY,		/* verify header only, kept for sake of
					 * compatibility with old configurations
					 * which use 'verify=meta' */
	VERIFY_MD5,			/* md5 sum data blocks */
	VERIFY_CRC64,			/* crc64 sum data blocks */
	VERIFY_CRC32,			/* crc32 sum data blocks */
	VERIFY_CRC32C,			/* crc32c sum data blocks */
	VERIFY_CRC32C_INTEL,		/* crc32c sum data blocks with hw */
	VERIFY_CRC16,			/* crc16 sum data blocks */
	VERIFY_CRC7,			/* crc7 sum data blocks */
	VERIFY_SHA256,			/* sha256 sum data blocks */
	VERIFY_SHA512,			/* sha512 sum data blocks */
	VERIFY_XXHASH,			/* xxhash sum data blocks */
	VERIFY_SHA1,			/* sha1 sum data blocks */
	VERIFY_PATTERN,			/* verify specific patterns */
	VERIFY_PATTERN_NO_HDR,		/* verify specific patterns, no hdr */
	VERIFY_NULL,			/* pretend to verify */
};

/*
 * A header structure associated with each checksummed data block. It is
 * followed by a checksum specific header that contains the verification
 * data.
 */
struct verify_header {
	uint16_t magic;
	uint16_t verify_type;
	uint32_t len;
	uint64_t rand_seed;
	uint64_t offset;
	uint32_t time_sec;
	uint32_t time_usec;
	uint16_t thread;
	uint16_t numberio;
	uint32_t crc32;
};

struct vhdr_md5 {
	uint32_t md5_digest[4];
};
struct vhdr_sha512 {
	uint8_t sha512[128];
};
struct vhdr_sha256 {
	uint8_t sha256[64];
};
struct vhdr_sha1 {
	uint32_t sha1[5];
};
struct vhdr_crc64 {
	uint64_t crc64;
};
struct vhdr_crc32 {
	uint32_t crc32;
};
struct vhdr_crc16 {
	uint16_t crc16;
};
struct vhdr_crc7 {
	uint8_t crc7;
};
struct vhdr_xxhash {
	uint32_t hash;
};

/*
 * Verify helpers
 */
extern void populate_verify_io_u(struct thread_data *, struct io_u *);
extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
extern int __must_check verify_io_u(struct thread_data *, struct io_u **);
extern int verify_io_u_async(struct thread_data *, struct io_u **);
extern void fill_verify_pattern(struct thread_data *td, void *p, unsigned int len, struct io_u *io_u, unsigned long seed, int use_seed);
extern void fill_buffer_pattern(struct thread_data *td, void *p, unsigned int len);
extern void fio_verify_init(struct thread_data *td);

/*
 * Async verify offload
 */
extern int verify_async_init(struct thread_data *);
extern void verify_async_exit(struct thread_data *);

/*
 * Callbacks for pasting formats in the pattern buffer
 */
extern int paste_blockoff(char *buf, unsigned int len, void *priv);

struct thread_rand32_state {
	uint32_t s[4];
};

struct thread_rand64_state {
	uint64_t s[6];
};

struct thread_rand_state {
	uint64_t use64;
	union {
		struct thread_rand32_state state32;
		struct thread_rand64_state state64;
	};
};

/*
 * For dumping current write state
 */
struct thread_io_list {
	uint64_t no_comps;
	uint64_t depth;
	uint64_t numberio;
	uint64_t index;
	struct thread_rand_state rand;
	uint8_t name[64];
	uint64_t offsets[0];
};

struct thread_io_list_v1 {
	uint64_t no_comps;
	uint64_t depth;
	uint64_t numberio;
	uint64_t index;
	struct thread_rand32_state rand;
	uint8_t name[64];
	uint64_t offsets[0];
};

struct all_io_list {
	uint64_t threads;
	struct thread_io_list state[0];
};

#define VSTATE_HDR_VERSION_V1	0x01
#define VSTATE_HDR_VERSION	0x02

struct verify_state_hdr {
	uint64_t version;
	uint64_t size;
	uint64_t crc;
};

#define IO_LIST_ALL		0xffffffff
extern struct all_io_list *get_all_io_list(int, size_t *);
extern void __verify_save_state(struct all_io_list *, const char *);
extern void verify_save_state(int mask);
extern int verify_load_state(struct thread_data *, const char *);
extern void verify_free_state(struct thread_data *);
extern int verify_state_should_stop(struct thread_data *, struct io_u *);
extern void verify_convert_assign_state(struct thread_data *, void *, int);
extern int verify_state_hdr(struct verify_state_hdr *, struct thread_io_list *,
				int *);

static inline size_t __thread_io_list_sz(uint64_t depth)
{
	return sizeof(struct thread_io_list) + depth * sizeof(uint64_t);
}

static inline size_t thread_io_list_sz(struct thread_io_list *s)
{
	return __thread_io_list_sz(le64_to_cpu(s->depth));
}

static inline struct thread_io_list *io_list_next(struct thread_io_list *s)
{
	return (void *) s + thread_io_list_sz(s);
}

static inline void verify_state_gen_name(char *out, size_t size,
					 const char *name, const char *prefix,
					 int num)
{
	snprintf(out, size, "%s-%s-%d-verify.state", prefix, name, num);
	out[size - 1] = '\0';
}

#endif
Commit	Line	Data
4f5af7b2 JA	1	#ifndef FIO_VERIFY_H
	2	#define FIO_VERIFY_H
	3
03e20d68 BC	4	#include <stdint.h>
03e20d68 BC	5
d3a173a9	6	#define FIO_HDR_MAGIC 0xacca
4f5af7b2 JA	7
	8	enum {
	9	VERIFY_NONE = 0, /* no verification */
b638d82f RP	10	VERIFY_HDR_ONLY, /* verify header only, kept for sake of
	11	* compatibility with old configurations
	12	* which use 'verify=meta' */
4f5af7b2 JA	13	VERIFY_MD5, /* md5 sum data blocks */
	14	VERIFY_CRC64, /* crc64 sum data blocks */
	15	VERIFY_CRC32, /* crc32 sum data blocks */
	16	VERIFY_CRC32C, /* crc32c sum data blocks */
	17	VERIFY_CRC32C_INTEL, /* crc32c sum data blocks with hw */
	18	VERIFY_CRC16, /* crc16 sum data blocks */
	19	VERIFY_CRC7, /* crc7 sum data blocks */
	20	VERIFY_SHA256, /* sha256 sum data blocks */
	21	VERIFY_SHA512, /* sha512 sum data blocks */
844ea602	22	VERIFY_XXHASH, /* xxhash sum data blocks */
7c353ceb	23	VERIFY_SHA1, /* sha1 sum data blocks */
92bf48d5	24	VERIFY_PATTERN, /* verify specific patterns */
59245381	25	VERIFY_PATTERN_NO_HDR, /* verify specific patterns, no hdr */
4f5af7b2 JA	26	VERIFY_NULL, /* pretend to verify */
	27	};
	28
	29	/*
	30	* A header structure associated with each checksummed data block. It is
	31	* followed by a checksum specific header that contains the verification
	32	* data.
	33	*/
	34	struct verify_header {
d3a173a9 JA	35	uint16_t magic;
d3a173a9 JA	36	uint16_t verify_type;
f65d1c26	37	uint32_t len;
f65d1c26	38	uint64_t rand_seed;
b638d82f RP	39	uint64_t offset;
	40	uint32_t time_sec;
	41	uint32_t time_usec;
	42	uint16_t thread;
	43	uint16_t numberio;
f65d1c26	44	uint32_t crc32;
4f5af7b2 JA	45	};
	46
	47	struct vhdr_md5 {
34644af5	48	uint32_t md5_digest[4];
4f5af7b2 JA	49	};
	50	struct vhdr_sha512 {
	51	uint8_t sha512[128];
	52	};
	53	struct vhdr_sha256 {
bc77f56f	54	uint8_t sha256[64];
4f5af7b2	55	};
7c353ceb JA	56	struct vhdr_sha1 {
	57	uint32_t sha1[5];
	58	};
4f5af7b2 JA	59	struct vhdr_crc64 {
	60	uint64_t crc64;
	61	};
	62	struct vhdr_crc32 {
	63	uint32_t crc32;
	64	};
	65	struct vhdr_crc16 {
	66	uint16_t crc16;
	67	};
	68	struct vhdr_crc7 {
	69	uint8_t crc7;
	70	};
844ea602 JA	71	struct vhdr_xxhash {
	72	uint32_t hash;
	73	};
4f5af7b2 JA	74
	75	/*
	76	* Verify helpers
	77	*/
	78	extern void populate_verify_io_u(struct thread_data , struct io_u );
	79	extern int __must_check get_next_verify(struct thread_data td, struct io_u );
f8b0bd10 JA	80	extern int __must_check verify_io_u(struct thread_data , struct io_u *);
f8b0bd10 JA	81	extern int verify_io_u_async(struct thread_data , struct io_u *);
ce35b1ec JA	82	extern void fill_verify_pattern(struct thread_data td, void p, unsigned int len, struct io_u *io_u, unsigned long seed, int use_seed);
ce35b1ec JA	83	extern void fill_buffer_pattern(struct thread_data td, void p, unsigned int len);
dc5bfbb2	84	extern void fio_verify_init(struct thread_data *td);
e8462bd8 JA	85
	86	/*
	87	* Async verify offload
	88	*/
	89	extern int verify_async_init(struct thread_data *);
	90	extern void verify_async_exit(struct thread_data *);
4f5af7b2	91
61b9861d RP	92	/*
	93	* Callbacks for pasting formats in the pattern buffer
	94	*/
	95	extern int paste_blockoff(char buf, unsigned int len, void priv);
	96
c3546b53	97	struct thread_rand32_state {
ca09be4b JA	98	uint32_t s[4];
	99	};
	100
c3546b53 JA	101	struct thread_rand64_state {
	102	uint64_t s[6];
	103	};
	104
	105	struct thread_rand_state {
	106	uint64_t use64;
	107	union {
	108	struct thread_rand32_state state32;
	109	struct thread_rand64_state state64;
	110	};
	111	};
	112
ca09be4b JA	113	/*
	114	* For dumping current write state
	115	*/
	116	struct thread_io_list {
	117	uint64_t no_comps;
	118	uint64_t depth;
	119	uint64_t numberio;
	120	uint64_t index;
	121	struct thread_rand_state rand;
	122	uint8_t name[64];
	123	uint64_t offsets[0];
	124	};
	125
c3546b53 JA	126	struct thread_io_list_v1 {
	127	uint64_t no_comps;
	128	uint64_t depth;
	129	uint64_t numberio;
	130	uint64_t index;
	131	struct thread_rand32_state rand;
	132	uint8_t name[64];
	133	uint64_t offsets[0];
	134	};
	135
ca09be4b JA	136	struct all_io_list {
	137	uint64_t threads;
	138	struct thread_io_list state[0];
	139	};
	140
c3546b53 JA	141	#define VSTATE_HDR_VERSION_V1 0x01
c3546b53 JA	142	#define VSTATE_HDR_VERSION 0x02
ca09be4b JA	143
	144	struct verify_state_hdr {
	145	uint64_t version;
	146	uint64_t size;
	147	uint64_t crc;
	148	};
	149
	150	#define IO_LIST_ALL 0xffffffff
	151	extern struct all_io_list get_all_io_list(int, size_t );
	152	extern void __verify_save_state(struct all_io_list , const char );
d264264a	153	extern void verify_save_state(int mask);
ca09be4b JA	154	extern int verify_load_state(struct thread_data , const char );
	155	extern void verify_free_state(struct thread_data *);
	156	extern int verify_state_should_stop(struct thread_data , struct io_u );
c3546b53 JA	157	extern void verify_convert_assign_state(struct thread_data , void , int);
	158	extern int verify_state_hdr(struct verify_state_hdr , struct thread_io_list ,
	159	int *);
	160
	161	static inline size_t __thread_io_list_sz(uint64_t depth)
	162	{
	163	return sizeof(struct thread_io_list) + depth * sizeof(uint64_t);
	164	}
ca09be4b JA	165
	166	static inline size_t thread_io_list_sz(struct thread_io_list *s)
	167	{
c3546b53	168	return __thread_io_list_sz(le64_to_cpu(s->depth));
ca09be4b JA	169	}
	170
	171	static inline struct thread_io_list io_list_next(struct thread_io_list s)
	172	{
	173	return (void *) s + thread_io_list_sz(s);
	174	}
	175
e499aedc JA	176	static inline void verify_state_gen_name(char *out, size_t size,
	177	const char name, const char prefix,
	178	int num)
ca09be4b	179	{
e499aedc JA	180	snprintf(out, size, "%s-%s-%d-verify.state", prefix, name, num);
e499aedc JA	181	out[size - 1] = '\0';
ca09be4b JA	182	}
ca09be4b JA	183
4f5af7b2	184	#endif