aboutsummaryrefslogtreecommitdiffstats
path: root/src/ring.c
blob: 00ea90f0496d7db40f8b46d0194d95363eec08cd (plain) (blame)
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
/**
 * coopgammad -- Cooperative gamma server
 * Copyright (C) 2016  Mattias Andrée (maandree@kth.se)
 * 
 * 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 3 of the License, or
 * (at your option) any later version.
 * 
 * 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.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#include "ring.h"

#include <stdlib.h>
#include <string.h>



/**
 * Initialise a ring buffer
 * 
 * @param  this  The ring buffer
 */
void ring_initialise(struct ring* this)
{
  this->start  = 0;
  this->end    = 0;
  this->size   = 0;
  this->buffer = NULL;
}


/**
 * Release resource allocated to a ring buffer
 * 
 * @param  this  The ring buffer
 */
void ring_destroy(struct ring* this)
{
  free(this->buffer);
}


/**
 * Marshal a ring buffer
 * 
 * @param   this  The ring buffer
 * @param   buf   Output buffer for the marshalled data,
 *                `NULL` to only measure how large buffer
 *                is needed
 * @return        The number of marshalled bytes
 */
size_t ring_marshal(const struct ring* this, void* buf)
{
  size_t off = 0, n = this->end - this->start;
  char* bs = buf;
  
  if (bs != NULL)
    *(size_t*)(bs + off) = n;
  off += sizeof(size_t);
  
  if (bs != NULL)
    memcpy(bs + off, this->buffer + this->start, n);
  off += n;
  
  return off;
}


/**
 * Unmarshal a ring buffer
 * 
 * @param   this  Output parameter for the ring buffer
 * @param   buf   Buffer with the marshalled data
 * @return        The number of unmarshalled bytes, 0 on error
 */
size_t ring_unmarshal(struct ring* this, const void* buf)
{
  size_t off = 0;
  const char* bs = buf;
  
  ring_initialise(this);
  
  this->size = this->end = *(const size_t*)(bs + off);
  off += sizeof(size_t);
  
  if (this->end > 0)
    {
      if (!(this->buffer = malloc(this->end)))
	return 0;
      
      memcpy(this->buffer, bs + off, this->end);
      off += this->end;
    }
  
  return off;
}


/**
 * Append data to a ring buffer
 * 
 * @param   this  The ring buffer
 * @param   data  The new data
 * @param   n     The number of bytes in `data`
 * @return        Zero on success, -1 on error
 */
int ring_push(struct ring* this, void* data, size_t n)
{
  size_t used = 0;
  
  if (this->start == this->end)
    {
      if (this->buffer != NULL)
	used = this->size;
    }
  else if (this->start > this->end)
    used = this->size - this->start + this->end;
  else
    used = this->start - this->end;
  
  if (used + n > this->size)
    {
      char* new = malloc(used + n);
      if (new == NULL)
	return -1;
      if (this->buffer)
	{
	  if (this->start < this->end)
	    memcpy(new, this->buffer + this->start, this->end - this->start);
	  else
	    {
	      memcpy(new, this->buffer + this->start, this->size - this->start);
	      memcpy(new + this->size - this->start, this->buffer, this->end);
	    }
	}
      memcpy(new + used, data, n);
      this->buffer = new;
      this->start = 0;
      this->end = used + n;
      this->size = used + n;
    }
  else if ((this->start >= this->end) || (this->end + n <= this->size))
    {
      memcpy(this->buffer + this->end, data, n);
      this->end += n;
    }
  else
    {
      memcpy(this->buffer + this->end, data, this->size - this->end);
      data = (char*)data + (this->size - this->end);
      n -= this->size - this->end;
      memcpy(this->buffer, data, n);
      this->end = n;
    }
  
  return 0;
}


/**
 * Get queued data from a ring buffer
 * 
 * It can take up to two calls (with `ring_pop` between)
 * to get all queued data
 * 
 * @param   this  The ring buffer
 * @param   n     Output parameter for the length
 *                of the returned segment
 * @return        The beginning of the queued data,
 *                `NULL` if there is nothing more
 */
void* ring_peek(struct ring* this, size_t* n)
{
  if (this->buffer == NULL)
    return *n = 0, NULL;
  
  if (this->start < this->end)
    *n = this->end - this->start;
  else
    *n = this->size - this->start;
  return this->buffer + this->start;
}


/**
 * Dequeue data from a ring bubber
 * 
 * @param  this  The ring buffer
 * @param  n     The number of bytes to dequeue
 */
void ring_pop(struct ring* this, size_t n)
{
  this->start += n;
  this->start %= this->size;
  if (this->start == this->end)
    {
      free(this->buffer);
      this->start  = 0;
      this->end    = 0;
      this->size   = 0;
      this->buffer = NULL;
    }
}