man: fix broken ioengine specific option format
[fio.git] / verify.h
CommitLineData
4f5af7b2
JA
1#ifndef FIO_VERIFY_H
2#define FIO_VERIFY_H
3
03e20d68 4#include <stdint.h>
9e9d41d7 5#include "verify-state.h"
03e20d68 6
d3a173a9 7#define FIO_HDR_MAGIC 0xacca
4f5af7b2
JA
8
9enum {
10 VERIFY_NONE = 0, /* no verification */
b638d82f
RP
11 VERIFY_HDR_ONLY, /* verify header only, kept for sake of
12 * compatibility with old configurations
13 * which use 'verify=meta' */
4f5af7b2
JA
14 VERIFY_MD5, /* md5 sum data blocks */
15 VERIFY_CRC64, /* crc64 sum data blocks */
16 VERIFY_CRC32, /* crc32 sum data blocks */
17 VERIFY_CRC32C, /* crc32c sum data blocks */
18 VERIFY_CRC32C_INTEL, /* crc32c sum data blocks with hw */
19 VERIFY_CRC16, /* crc16 sum data blocks */
20 VERIFY_CRC7, /* crc7 sum data blocks */
21 VERIFY_SHA256, /* sha256 sum data blocks */
22 VERIFY_SHA512, /* sha512 sum data blocks */
ae3a5acc
JA
23 VERIFY_SHA3_224, /* sha3-224 sum data blocks */
24 VERIFY_SHA3_256, /* sha3-256 sum data blocks */
25 VERIFY_SHA3_384, /* sha3-384 sum data blocks */
26 VERIFY_SHA3_512, /* sha3-512 sum data blocks */
844ea602 27 VERIFY_XXHASH, /* xxhash sum data blocks */
7c353ceb 28 VERIFY_SHA1, /* sha1 sum data blocks */
92bf48d5 29 VERIFY_PATTERN, /* verify specific patterns */
59245381 30 VERIFY_PATTERN_NO_HDR, /* verify specific patterns, no hdr */
4f5af7b2
JA
31 VERIFY_NULL, /* pretend to verify */
32};
33
34/*
35 * A header structure associated with each checksummed data block. It is
36 * followed by a checksum specific header that contains the verification
37 * data.
38 */
39struct verify_header {
d3a173a9
JA
40 uint16_t magic;
41 uint16_t verify_type;
f65d1c26 42 uint32_t len;
f65d1c26 43 uint64_t rand_seed;
b638d82f
RP
44 uint64_t offset;
45 uint32_t time_sec;
46 uint32_t time_usec;
47 uint16_t thread;
48 uint16_t numberio;
f65d1c26 49 uint32_t crc32;
4f5af7b2
JA
50};
51
52struct vhdr_md5 {
34644af5 53 uint32_t md5_digest[4];
4f5af7b2 54};
ae3a5acc
JA
55struct vhdr_sha3_224 {
56 uint8_t sha[224 / 8];
57};
58struct vhdr_sha3_256 {
59 uint8_t sha[256 / 8];
60};
61struct vhdr_sha3_384 {
62 uint8_t sha[384 / 8];
63};
64struct vhdr_sha3_512 {
65 uint8_t sha[512 / 8];
66};
4f5af7b2
JA
67struct vhdr_sha512 {
68 uint8_t sha512[128];
69};
70struct vhdr_sha256 {
bc77f56f 71 uint8_t sha256[64];
4f5af7b2 72};
7c353ceb
JA
73struct vhdr_sha1 {
74 uint32_t sha1[5];
75};
4f5af7b2
JA
76struct vhdr_crc64 {
77 uint64_t crc64;
78};
79struct vhdr_crc32 {
80 uint32_t crc32;
81};
82struct vhdr_crc16 {
83 uint16_t crc16;
84};
85struct vhdr_crc7 {
86 uint8_t crc7;
87};
844ea602
JA
88struct vhdr_xxhash {
89 uint32_t hash;
90};
4f5af7b2
JA
91
92/*
93 * Verify helpers
94 */
95extern void populate_verify_io_u(struct thread_data *, struct io_u *);
96extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
f8b0bd10
JA
97extern int __must_check verify_io_u(struct thread_data *, struct io_u **);
98extern int verify_io_u_async(struct thread_data *, struct io_u **);
ce35b1ec
JA
99extern void fill_verify_pattern(struct thread_data *td, void *p, unsigned int len, struct io_u *io_u, unsigned long seed, int use_seed);
100extern void fill_buffer_pattern(struct thread_data *td, void *p, unsigned int len);
dc5bfbb2 101extern void fio_verify_init(struct thread_data *td);
e8462bd8
JA
102
103/*
104 * Async verify offload
105 */
106extern int verify_async_init(struct thread_data *);
107extern void verify_async_exit(struct thread_data *);
4f5af7b2 108
61b9861d
RP
109/*
110 * Callbacks for pasting formats in the pattern buffer
111 */
112extern int paste_blockoff(char *buf, unsigned int len, void *priv);
113
4f5af7b2 114#endif