aboutsummaryrefslogtreecommitdiff
path: root/src/util/fifo_buffer.c
blob: 162ddf94606c5aa43eeb89a9f634737f326de2ac (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
/*
 * Copyright (C) 2003-2011 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the
 * distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"
#include "fifo_buffer.h"

#include <glib.h>

#include <assert.h>
#include <string.h>

struct fifo_buffer {
	size_t size, start, end;
	unsigned char buffer[sizeof(size_t)];
};

struct fifo_buffer *
fifo_buffer_new(size_t size)
{
	struct fifo_buffer *buffer;

	assert(size > 0);

	buffer = (struct fifo_buffer *)g_malloc(sizeof(*buffer) -
						sizeof(buffer->buffer) + size);

	buffer->size = size;
	buffer->start = 0;
	buffer->end = 0;

	return buffer;
}

void
fifo_buffer_init(struct fifo_buffer *buffer, size_t size)
{
	buffer->size = size - (sizeof(*buffer) - sizeof(buffer->buffer));
	buffer->start = 0;
	buffer->end = 0;
}

static void
fifo_buffer_move(struct fifo_buffer *buffer);

struct fifo_buffer *
fifo_buffer_realloc(struct fifo_buffer *buffer, size_t new_size)
{
	if (buffer == NULL)
		return new_size > 0
			? fifo_buffer_new(new_size)
			: NULL;

	/* existing data must fit in new size */
	assert(new_size >= buffer->end - buffer->start);

	if (new_size == 0) {
		fifo_buffer_free(buffer);
		return NULL;
	}

	/* compress the buffer when we're shrinking and the tail of
	   the buffer would exceed the new size */
	if (buffer->end > new_size)
		fifo_buffer_move(buffer);

	/* existing data must fit in new size: second check */
	assert(buffer->end <= new_size);

	buffer = g_realloc(buffer, sizeof(*buffer) - sizeof(buffer->buffer) +
			   new_size);
	buffer->size = new_size;
	return buffer;
}

void
fifo_buffer_free(struct fifo_buffer *buffer)
{
	assert(buffer != NULL);

	g_free(buffer);
}

size_t
fifo_buffer_capacity(const struct fifo_buffer *buffer)
{
	assert(buffer != NULL);

	return buffer->size;
}

size_t
fifo_buffer_available(const struct fifo_buffer *buffer)
{
	assert(buffer != NULL);

	return buffer->end - buffer->start;
}

void
fifo_buffer_clear(struct fifo_buffer *buffer)
{
	assert(buffer != NULL);

	buffer->start = 0;
	buffer->end = 0;
}

const void *
fifo_buffer_read(const struct fifo_buffer *buffer, size_t *length_r)
{
	assert(buffer != NULL);
	assert(buffer->end >= buffer->start);
	assert(length_r != NULL);

	if (buffer->start == buffer->end)
		/* the buffer is empty */
		return NULL;

	*length_r = buffer->end - buffer->start;
	return buffer->buffer + buffer->start;
}

void
fifo_buffer_consume(struct fifo_buffer *buffer, size_t length)
{
	assert(buffer != NULL);
	assert(buffer->end >= buffer->start);
	assert(buffer->start + length <= buffer->end);

	buffer->start += length;
}

/**
 * Move data to the beginning of the buffer, to make room at the end.
 */
static void
fifo_buffer_move(struct fifo_buffer *buffer)
{
	if (buffer->start == 0)
		return;

	if (buffer->end > buffer->start)
		memmove(buffer->buffer,
			buffer->buffer + buffer->start,
			buffer->end - buffer->start);

	buffer->end -= buffer->start;
	buffer->start = 0;
}

void *
fifo_buffer_write(struct fifo_buffer *buffer, size_t *max_length_r)
{
	assert(buffer != NULL);
	assert(buffer->end <= buffer->size);
	assert(max_length_r != NULL);

	if (buffer->end == buffer->size) {
		fifo_buffer_move(buffer);
		if (buffer->end == buffer->size)
			return NULL;
	} else if (buffer->start > 0 && buffer->start == buffer->end) {
		buffer->start = 0;
		buffer->end = 0;
	}

	*max_length_r = buffer->size - buffer->end;
	return buffer->buffer + buffer->end;
}

void
fifo_buffer_append(struct fifo_buffer *buffer, size_t length)
{
	assert(buffer != NULL);
	assert(buffer->end >= buffer->start);
	assert(buffer->end + length <= buffer->size);

	buffer->end += length;
}

bool
fifo_buffer_is_empty(struct fifo_buffer *buffer)
{
	return buffer->start == buffer->end;
}

bool
fifo_buffer_is_full(struct fifo_buffer *buffer)
{
	return buffer->start == 0 && buffer->end == buffer->size;
}