summaryrefslogtreecommitdiff
path: root/src/utils/buffer.c
blob: b56894858ecf637b49253817e968ef379a3ab838 (plain)
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
/*
 * This file is part of LibParserUtils.
 * Licensed under the MIT License,
 *                http://www.opensource.org/licenses/mit-license.php
 * Copyright 2008 John-Mark Bell <jmb@netsurf-browser.org>
 */

#include <string.h>
#include <stdarg.h>

#include <parserutils/utils/buffer.h>

#define DEFAULT_SIZE (4096)

/**
 * Create a memory buffer
 *
 * \param buffer  Pointer to location to receive memory buffer
 * \return PARSERUTILS_OK on success,
 *         PARSERUTILS_BADPARM on bad parameters,
 *         PARSERUTILS_NOMEM on memory exhausion
 */
parserutils_error parserutils_buffer_create(parserutils_buffer **buffer)
{
	parserutils_buffer *b;

	if (buffer == NULL)
		return PARSERUTILS_BADPARM;

	b = malloc(sizeof(parserutils_buffer));
	if (b == NULL)
		return PARSERUTILS_NOMEM;

	b->alloc = malloc(DEFAULT_SIZE);
	if (b->alloc == NULL) {
		free(b);
		return PARSERUTILS_NOMEM;
	}

	b->data = b->alloc;
	b->length = 0;
	b->allocated = DEFAULT_SIZE;

	*buffer = b;

	return PARSERUTILS_OK;
}

/**
 * Destroy a memory buffer
 *
 * \param buffer  The buffer to destroy
 * \return PARSERUTILS_OK on success, appropriate error otherwise
 */
parserutils_error parserutils_buffer_destroy(parserutils_buffer *buffer)
{
	if (buffer == NULL)
		return PARSERUTILS_BADPARM;

	free(buffer->alloc);
	free(buffer);

	return PARSERUTILS_OK;
}

/**
 * Get current data offset within buffer's allocation.
 *
 * \param[in]  buffer  The buffer object.
 * \return data offset in bytes.
 */
static inline size_t get_offset(parserutils_buffer *buffer)
{
	return buffer->data - buffer->alloc;
}

/**
 * Try moving the data to the start of the allocation.
 *
 * \param[in]  buffer  The buffer object.
 */
static inline void try_rebase(parserutils_buffer *buffer)
{
	if (get_offset(buffer) >= buffer->length) {
		memcpy(buffer->alloc, buffer->data, buffer->length);
		buffer->data = buffer->alloc;
	}
}

/**
 * Ensure that the buffer has enough space at the end to add len bytes.
 *
 * \param[in]  buffer  The buffer object.
 * \param[in]  len     Number of bytes to ensure there is space for.
 * \return PARSERUTILS_OK on success, appropriate error otherwise.
 */
static inline parserutils_error ensure_space(
		parserutils_buffer *buffer,
		size_t len)
{
	try_rebase(buffer);

	while (len >= buffer->allocated - buffer->length - get_offset(buffer)) {
		parserutils_error error = parserutils_buffer_grow(buffer);
		if (error != PARSERUTILS_OK)
			return error;
	}

	return PARSERUTILS_OK;
}

/**
 * Append data to a memory buffer
 *
 * \param buffer  The buffer to append to
 * \param data    The data to append
 * \param len     The length, in bytes, of the data to append
 * \return PARSERUTILS_OK on success, appropriate error otherwise.
 */
parserutils_error parserutils_buffer_append(parserutils_buffer *buffer, 
		const uint8_t *data, size_t len)
{
	parserutils_error error = ensure_space(buffer, len);
	if (error != PARSERUTILS_OK)
		return error;

	memcpy(buffer->data + buffer->length, data, len);

	buffer->length += len;

	return PARSERUTILS_OK;
}

/**
 * Append multiple data blocks to a memory buffer.
 *
 * Each data block must be passed as a pair of const uint8_t* and size_t
 *
 * \param buffer  The buffer to append to
 * \param count   The number of data blocks to append
 * \param ...     The pairs of pointer and size
 * \return PARSERUTILS_OK on success, appropriate error otherwise.
*/
parserutils_error parserutils_buffer_appendv(parserutils_buffer *buffer,
		size_t count, ...)
{
	va_list ap;
	parserutils_error error;
	const uint8_t *data;
	size_t len;

	va_start(ap, count);
	while (count > 0) {
		data = va_arg(ap, const uint8_t *);
		len = va_arg(ap, size_t);
		error = parserutils_buffer_append(buffer, data, len);
		if (error != PARSERUTILS_OK)
			break;
		count--;
	}
	va_end(ap);

	return error;
}

/**
 * Insert data into a memory buffer
 *
 * \param buffer  The buffer to insert into
 * \param offset  The offset into the buffer to insert at
 * \param data    The data to insert
 * \param len     The length, in bytes, of the data to insert
 * \return PARSERUTILS_OK on success, appropriate error otherwise
 */
parserutils_error parserutils_buffer_insert(parserutils_buffer *buffer, 
		size_t offset, const uint8_t *data, size_t len)
{
	parserutils_error error;

	if (offset > buffer->length)
		return PARSERUTILS_BADPARM;

	if (offset == buffer->length)
		return parserutils_buffer_append(buffer, data, len);

	error = ensure_space(buffer, len);
	if (error != PARSERUTILS_OK)
		return error;

	memmove(buffer->data + offset + len,
			buffer->data + offset, buffer->length - offset);

	memcpy(buffer->data + offset, data, len);

	buffer->length += len;

	return PARSERUTILS_OK;
}

/**
 * Discard a section of a memory buffer
 *
 * \param buffer  The buffer to discard data from
 * \param offset  The offset into the buffer of the start of the section
 * \param len     The number of bytes to discard
 * \return PARSERUTILS_OK on success, appropriate error otherwise.
 */
parserutils_error parserutils_buffer_discard(parserutils_buffer *buffer, 
		size_t offset, size_t len)
{
	if (offset >= buffer->length || offset + len > buffer->length)
		return PARSERUTILS_BADPARM;

	if (offset == 0) {
		buffer->data += len;
		buffer->length -= len;
		try_rebase(buffer);
		return PARSERUTILS_OK;
	}

	memmove(buffer->data + offset, buffer->data + offset + len, 
			buffer->length - (len + offset));

	buffer->length -= len;

	return PARSERUTILS_OK;
}

/**
 * Extend the amount of space allocated for a memory buffer
 *
 * \param buffer  The buffer to extend
 * \return PARSERUTILS_OK on success, appropriate error otherwise.
 */
parserutils_error parserutils_buffer_grow(parserutils_buffer *buffer)
{
	size_t offset = get_offset(buffer);
	uint8_t *temp = realloc(buffer->alloc, buffer->allocated * 2);
	if (temp == NULL)
		return PARSERUTILS_NOMEM;

	buffer->alloc = temp;
	buffer->data = buffer->alloc + offset;
	buffer->allocated *= 2;

	return PARSERUTILS_OK;
}

parserutils_error parserutils_buffer_randomise(parserutils_buffer *buffer)
{
#ifndef NDEBUG
	uint8_t *temp;
#endif

	if (buffer == NULL)
		return PARSERUTILS_BADPARM;

#ifndef NDEBUG
	temp = malloc(buffer->allocated);
	if (temp == NULL)
		return PARSERUTILS_NOMEM;

	memcpy(temp, buffer->data, buffer->length);

	memset(buffer->data, 0xff, buffer->length);

	/* Leak the buffer's current data, so we don't reuse it */
	/* buffer->alloc(buffer->data, 0, buffer->pw); */

	buffer->alloc = buffer->data = temp;
#endif


	return PARSERUTILS_OK;
}