1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*
* Copyright (C) 2012 Tobias Brunner
* Hochschule fuer Technik Rapperswil
*
* Copyright (C) 2010 Martin Willi
* Copyright (C) 2010 revosec AG
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
/**
* @defgroup bio_reader bio_reader
* @{ @ingroup bio
*/
#ifndef BIO_READER_H_
#define BIO_READER_H_
typedef struct bio_reader_t bio_reader_t;
#include <library.h>
/**
* Buffered input parser.
*
* @note Integers are returned in host byte order.
*/
struct bio_reader_t {
/**
* Get the number of remaining bytes.
*
* @return number of remaining bytes in buffer
*/
uint32_t (*remaining)(bio_reader_t *this);
/**
* Peek the remaining data, not consuming any bytes.
*
* @return remaining data
*/
chunk_t (*peek)(bio_reader_t *this);
/**
* Read a 8-bit integer from the buffer, advance.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint8)(bio_reader_t *this, uint8_t *res);
/**
* Read a 16-bit integer from the buffer, advance.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint16)(bio_reader_t *this, uint16_t *res);
/**
* Read a 24-bit integer from the buffer, advance.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint24)(bio_reader_t *this, uint32_t *res);
/**
* Read a 32-bit integer from the buffer, advance.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint32)(bio_reader_t *this, uint32_t *res);
/**
* Read a 64-bit integer from the buffer, advance.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint64)(bio_reader_t *this, uint64_t *res);
/**
* Read a chunk of len bytes, advance.
*
* @param len number of bytes to read
* @param res pointer to result, not cloned
* @return TRUE if data read successfully
*/
bool (*read_data)(bio_reader_t *this, uint32_t len, chunk_t *res);
/**
* Read a 8-bit integer from the end of the buffer, reduce remaining.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint8_end)(bio_reader_t *this, uint8_t *res);
/**
* Read a 16-bit integer from the end of the buffer, reduce remaining.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint16_end)(bio_reader_t *this, uint16_t *res);
/**
* Read a 24-bit integer from the end of the buffer, reduce remaining.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint24_end)(bio_reader_t *this, uint32_t *res);
/**
* Read a 32-bit integer from the end of the buffer, reduce remaining.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint32_end)(bio_reader_t *this, uint32_t *res);
/**
* Read a 64-bit integer from the end of the buffer, reduce remaining.
*
* @param res pointer to result
* @return TRUE if integer read successfully
*/
bool (*read_uint64_end)(bio_reader_t *this, uint64_t *res);
/**
* Read a chunk of len bytes from the end of the buffer, reduce remaining.
*
* @param len number of bytes to read
* @param res ponter to result, not cloned
* @return TRUE if data read successfully
*/
bool (*read_data_end)(bio_reader_t *this, uint32_t len, chunk_t *res);
/**
* Read a chunk of bytes with a 8-bit length header, advance.
*
* @param res pointer to result, not cloned
* @return TRUE if data read successfully
*/
bool (*read_data8)(bio_reader_t *this, chunk_t *res);
/**
* Read a chunk of bytes with a 16-bit length header, advance.
*
* @param res pointer to result, not cloned
* @return TRUE if data read successfully
*/
bool (*read_data16)(bio_reader_t *this, chunk_t *res);
/**
* Read a chunk of bytes with a 24-bit length header, advance.
*
* @param res pointer to result, not cloned
* @return TRUE if data read successfully
*/
bool (*read_data24)(bio_reader_t *this, chunk_t *res);
/**
* Read a chunk of bytes with a 32-bit length header, advance.
*
* @param res pointer to result, not cloned
* @return TRUE if data read successfully
*/
bool (*read_data32)(bio_reader_t *this, chunk_t *res);
/**
* Destroy a bio_reader_t.
*/
void (*destroy)(bio_reader_t *this);
};
/**
* Create a bio_reader instance.
*
* @param data data buffer, must survive lifetime of reader
* @return reader
*/
bio_reader_t *bio_reader_create(chunk_t data);
/**
* Create a bio_reader instance owning buffer.
*
* @param data data buffer, gets freed with destroy()
* @return reader
*/
bio_reader_t *bio_reader_create_own(chunk_t data);
#endif /** BIO_READER_H_ @}*/
|
