1 | //buffer.c: |
---|
2 | |
---|
3 | /* |
---|
4 | * Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012 |
---|
5 | * |
---|
6 | * This file is part of libroar a part of RoarAudio, |
---|
7 | * a cross-platform sound system for both, home and professional use. |
---|
8 | * See README for details. |
---|
9 | * |
---|
10 | * This file is free software; you can redistribute it and/or modify |
---|
11 | * it under the terms of the GNU General Public License version 3 |
---|
12 | * as published by the Free Software Foundation. |
---|
13 | * |
---|
14 | * libroar is distributed in the hope that it will be useful, |
---|
15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
17 | * GNU General Public License for more details. |
---|
18 | * |
---|
19 | * You should have received a copy of the GNU General Public License |
---|
20 | * along with this software; see the file COPYING. If not, write to |
---|
21 | * the Free Software Foundation, 51 Franklin Street, Fifth Floor, |
---|
22 | * Boston, MA 02110-1301, USA. |
---|
23 | * |
---|
24 | * NOTE for everyone want's to change something and send patches: |
---|
25 | * read README and HACKING! There a addition information on |
---|
26 | * the license of this document you need to read before you send |
---|
27 | * any patches. |
---|
28 | * |
---|
29 | * NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc |
---|
30 | * or libpulse*: |
---|
31 | * The libs libroaresd, libroararts and libroarpulse link this lib |
---|
32 | * and are therefore GPL. Because of this it may be illigal to use |
---|
33 | * them with any software that uses libesd, libartsc or libpulse*. |
---|
34 | */ |
---|
35 | |
---|
36 | #include "libroar.h" |
---|
37 | |
---|
38 | struct roar_buffer_ring { |
---|
39 | size_t read_pos; |
---|
40 | size_t write_pos; |
---|
41 | }; |
---|
42 | |
---|
43 | struct roar_buffer { |
---|
44 | size_t refc; |
---|
45 | size_t len; |
---|
46 | size_t user_len; |
---|
47 | int flags; |
---|
48 | void * data; |
---|
49 | void * user_data; |
---|
50 | union { |
---|
51 | void * vp; |
---|
52 | int32_t i32; |
---|
53 | struct roar_buffer_ring ring; |
---|
54 | } meta; |
---|
55 | int type; |
---|
56 | struct roar_buffer * next; |
---|
57 | }; |
---|
58 | |
---|
59 | #define _ckbuf_free(m) if ( buf == NULL || (m) ) { roar_err_set(ROAR_ERROR_FAULT); return -1; } |
---|
60 | #define _ckbuf(m) if ( _ckmem_corruption(buf, (m)) == -1 ) return -1; |
---|
61 | |
---|
62 | // if we use the 'inline' keyword here the program segfaults. why? |
---|
63 | static int _ckmem_corruption(volatile struct roar_buffer * buf, int m) { |
---|
64 | int flags; |
---|
65 | |
---|
66 | ROAR_DBG("_ckmem_corruption(buf=%p) = ?", buf); |
---|
67 | |
---|
68 | // we need to recheck here, why? |
---|
69 | // gcc changes the order of the above macros. why? |
---|
70 | // this is a strange world. |
---|
71 | if ( buf == NULL || m ) { |
---|
72 | ROAR_DBG("_ckmem_corruption(buf=%p) = -1 // FAULT", buf); |
---|
73 | roar_err_set(ROAR_ERROR_FAULT); |
---|
74 | return -1; |
---|
75 | } |
---|
76 | |
---|
77 | ROAR_DBG("_ckmem_corruption(buf=%p) = ?", buf); |
---|
78 | |
---|
79 | flags = buf->flags & (ROAR_BUFFER_FLAG_USEABLE|ROAR_BUFFER_FLAG_FREED); |
---|
80 | |
---|
81 | ROAR_DBG("_ckmem_corruption(buf=%p{.flags=0x%.4x, ...}) = ?", buf, buf->flags); |
---|
82 | |
---|
83 | if ( flags == ROAR_BUFFER_FLAG_USEABLE ) { |
---|
84 | // seems ok, continue with next check. |
---|
85 | } else if ( flags == ROAR_BUFFER_FLAG_FREED ) { |
---|
86 | roar_panic(ROAR_FATAL_ERROR_MEMORY_USED_AFTER_FREE, NULL); |
---|
87 | roar_err_set(ROAR_ERROR_FAULT); |
---|
88 | return -1; |
---|
89 | } else { |
---|
90 | roar_panic(ROAR_FATAL_ERROR_MEMORY_CORRUPTION, NULL); |
---|
91 | roar_err_set(ROAR_ERROR_BADCKSUM); |
---|
92 | return -1; |
---|
93 | } |
---|
94 | |
---|
95 | if ( buf->refc == 0 ) { |
---|
96 | roar_panic(ROAR_FATAL_ERROR_MEMORY_CORRUPTION, NULL); |
---|
97 | roar_err_set(ROAR_ERROR_FAULT); |
---|
98 | return -1; |
---|
99 | } |
---|
100 | |
---|
101 | return 0; |
---|
102 | } |
---|
103 | |
---|
104 | int roar_buffer_new_data (struct roar_buffer ** buf, size_t len, void ** data) { |
---|
105 | void * bufdata; |
---|
106 | int err; |
---|
107 | |
---|
108 | if ((bufdata = roar_mm_malloc(len)) == NULL) { |
---|
109 | return -1; |
---|
110 | } |
---|
111 | |
---|
112 | if ( roar_buffer_new_no_ma(buf, len, bufdata) == -1 ) { |
---|
113 | err = roar_error; |
---|
114 | roar_mm_free(bufdata); |
---|
115 | roar_err_set(err); |
---|
116 | return -1; |
---|
117 | } |
---|
118 | |
---|
119 | if ( roar_buffer_set_flag(*buf, ROAR_BUFFER_FLAG_NOFREE, ROAR_BUFFER_RESET) == -1 ) { |
---|
120 | err = roar_error; |
---|
121 | roar_buffer_free(*buf); |
---|
122 | roar_mm_free(bufdata); |
---|
123 | roar_err_set(err); |
---|
124 | return -1; |
---|
125 | } |
---|
126 | |
---|
127 | if ( data != NULL ) |
---|
128 | *data = bufdata; |
---|
129 | |
---|
130 | return 0; |
---|
131 | } |
---|
132 | |
---|
133 | int roar_buffer_new_no_ma(struct roar_buffer ** buf, size_t len, void * data) { // no internal malloc |
---|
134 | struct roar_buffer * new; |
---|
135 | |
---|
136 | ROAR_DBG("buffer_new(buf=%p, len=%i) = ?", buf, len); |
---|
137 | |
---|
138 | _ckbuf_free(data == NULL) |
---|
139 | |
---|
140 | if ((new = roar_mm_malloc(sizeof(struct roar_buffer))) == NULL) { |
---|
141 | *buf = NULL; |
---|
142 | return -1; |
---|
143 | } |
---|
144 | |
---|
145 | new->refc = 1; |
---|
146 | |
---|
147 | new->data = data; |
---|
148 | |
---|
149 | new->flags = ROAR_BUFFER_FLAG_NONE|ROAR_BUFFER_FLAG_NOFREE|ROAR_BUFFER_FLAG_USEABLE; |
---|
150 | new->type = -1; |
---|
151 | |
---|
152 | new->user_data = new->data; |
---|
153 | |
---|
154 | new->next = NULL; |
---|
155 | |
---|
156 | new->len = len; |
---|
157 | new->user_len = len; |
---|
158 | *buf = new; |
---|
159 | |
---|
160 | ROAR_DBG("buffer_new(buf=%p, len=%i): New buffer at %p", buf, len, new); |
---|
161 | |
---|
162 | return 0; |
---|
163 | } |
---|
164 | |
---|
165 | int roar_buffer_new_str (struct roar_buffer ** buf, const char * str, int terminate) { |
---|
166 | size_t len; |
---|
167 | void * data; |
---|
168 | |
---|
169 | if ( buf == NULL || str == NULL ) { |
---|
170 | roar_err_set(ROAR_ERROR_FAULT); |
---|
171 | return -1; |
---|
172 | } |
---|
173 | |
---|
174 | len = roar_mm_strlen(str); |
---|
175 | if ( terminate ) |
---|
176 | len++; |
---|
177 | |
---|
178 | if ( roar_buffer_new_data(buf, len, &data) == -1 ) |
---|
179 | return -1; |
---|
180 | |
---|
181 | if ( len ) |
---|
182 | memcpy(data, str, len); |
---|
183 | return 0; |
---|
184 | } |
---|
185 | |
---|
186 | int roar_buffer_ref (struct roar_buffer * buf) { |
---|
187 | _ckbuf(0) |
---|
188 | |
---|
189 | buf->refc++; |
---|
190 | |
---|
191 | return 0; |
---|
192 | } |
---|
193 | |
---|
194 | int roar_buffer_unref (struct roar_buffer * buf) { |
---|
195 | struct roar_buffer * next, * cur; |
---|
196 | int flags; |
---|
197 | |
---|
198 | ROAR_DBG("roar_buffer_unref(buf=%p) = ?", buf); |
---|
199 | |
---|
200 | _ckbuf_free(0) |
---|
201 | |
---|
202 | ROAR_DBG("roar_buffer_unref(buf=%p) = ?", buf); |
---|
203 | |
---|
204 | cur = buf; |
---|
205 | while (cur != NULL) { |
---|
206 | flags = cur->flags & (ROAR_BUFFER_FLAG_USEABLE|ROAR_BUFFER_FLAG_FREED); |
---|
207 | if ( flags == ROAR_BUFFER_FLAG_FREED ) { |
---|
208 | roar_panic(ROAR_FATAL_ERROR_MEMORY_DOUBLE_FREE, NULL); |
---|
209 | } |
---|
210 | |
---|
211 | _ckmem_corruption(cur, 0); |
---|
212 | |
---|
213 | if ( cur->refc == 0 ) { |
---|
214 | ROAR_WARN("roar_buffer_unref(buf=%p): Ref counter for buffer at %p is wrong. assuming one.", cur, cur); |
---|
215 | cur->refc = 1; |
---|
216 | roar_panic(ROAR_FATAL_ERROR_MEMORY_CORRUPTION, NULL); |
---|
217 | } else if ( cur->refc > 1 ) { |
---|
218 | cur->refc--; |
---|
219 | return 0; |
---|
220 | } |
---|
221 | |
---|
222 | ROAR_DBG("roar_buffer_unref(buf=%p) = ?", buf); |
---|
223 | |
---|
224 | if ( roar_buffer_get_flag(cur, ROAR_BUFFER_FLAG_NOFREE) != 1 ) |
---|
225 | roar_mm_free(cur->data); |
---|
226 | |
---|
227 | cur->flags = ROAR_BUFFER_FLAG_FREED; |
---|
228 | next = cur->next; |
---|
229 | roar_mm_free(cur); |
---|
230 | cur = next; |
---|
231 | } |
---|
232 | |
---|
233 | ROAR_DBG("roar_buffer_unref(buf=%p) = 0", buf); |
---|
234 | return 0; |
---|
235 | } |
---|
236 | |
---|
237 | int roar_buffer_delete (struct roar_buffer * buf, struct roar_buffer ** next) { |
---|
238 | if ( buf == NULL ) { |
---|
239 | if ( next != NULL ) |
---|
240 | *next = NULL; |
---|
241 | roar_err_set(ROAR_ERROR_FAULT); |
---|
242 | return -1; |
---|
243 | } |
---|
244 | |
---|
245 | ROAR_DBG("roar_buffer_delete(buf=%p, next=%p) = ?", buf, next); |
---|
246 | |
---|
247 | if ( next != NULL ) { |
---|
248 | *next = buf; |
---|
249 | return roar_buffer_next(next); |
---|
250 | } else { |
---|
251 | return roar_buffer_unref(buf); |
---|
252 | } |
---|
253 | } |
---|
254 | |
---|
255 | int roar_buffer_next (struct roar_buffer ** buf) { |
---|
256 | struct roar_buffer * ret; |
---|
257 | |
---|
258 | if ( buf == NULL || *buf == NULL ) { |
---|
259 | roar_err_set(ROAR_ERROR_FAULT); |
---|
260 | } |
---|
261 | |
---|
262 | ret = (*buf)->next; |
---|
263 | |
---|
264 | if ( ret != NULL ) |
---|
265 | roar_buffer_ref(ret); |
---|
266 | |
---|
267 | roar_buffer_unref(*buf); |
---|
268 | |
---|
269 | *buf = ret; |
---|
270 | |
---|
271 | return 0; |
---|
272 | } |
---|
273 | |
---|
274 | int roar_buffer_add (struct roar_buffer * buf, struct roar_buffer * next) { |
---|
275 | if ( roar_buffer_ref(next) == -1 ) |
---|
276 | return -1; |
---|
277 | return roar_buffer_moveinto(buf, &next); |
---|
278 | } |
---|
279 | |
---|
280 | int roar_buffer_moveinto (struct roar_buffer * buf, struct roar_buffer ** next) { |
---|
281 | unsigned int deep = 0; |
---|
282 | |
---|
283 | _ckbuf(next == NULL || _ckmem_corruption(*next, 0)) |
---|
284 | |
---|
285 | ROAR_DBG("buffer_add(buf=%p, next=%p) = ?", buf, next); |
---|
286 | ROAR_DBG("buffer_add(buf=%p, next=%p): *next=%p", buf, next, *next); |
---|
287 | |
---|
288 | if ( buf->flags & ROAR_BUFFER_FLAG_RING ) { |
---|
289 | roar_err_set(ROAR_ERROR_INVAL); |
---|
290 | return -1; |
---|
291 | } |
---|
292 | |
---|
293 | if ( buf == *next ) { |
---|
294 | ROAR_ERR("buffer_add(*): both pointer are of the same destination, This is a error in the application"); |
---|
295 | roar_err_set(ROAR_ERROR_INVAL); |
---|
296 | return -1; |
---|
297 | } |
---|
298 | |
---|
299 | while ( buf->next != NULL ) { |
---|
300 | ROAR_DBG("buffer_add(*): buf=%p, next=%p (len=%i)", buf, buf->next, buf->user_len); |
---|
301 | // ROAR_DBG("buffer_add(): buf=%p, buf->next=%p", buf, buf->next); |
---|
302 | buf = buf->next; |
---|
303 | deep++; |
---|
304 | |
---|
305 | if ( buf == *next ) { |
---|
306 | ROAR_ERR("buffer_add(*): Can not add buffer: loop detected at deep %u. This is a error in the application", deep); |
---|
307 | // why don't we return here? |
---|
308 | } |
---|
309 | } |
---|
310 | |
---|
311 | buf->next = *next; |
---|
312 | |
---|
313 | ROAR_DBG("buffer_add(*): adding buffer at deep %u", deep); |
---|
314 | |
---|
315 | *next = NULL; |
---|
316 | |
---|
317 | return 0; |
---|
318 | } |
---|
319 | |
---|
320 | int roar_buffer_moveintoqueue(struct roar_buffer ** buf, struct roar_buffer ** next) { |
---|
321 | if ( buf == NULL || next == NULL ) { |
---|
322 | roar_err_set(ROAR_ERROR_FAULT); |
---|
323 | return -1; |
---|
324 | } |
---|
325 | |
---|
326 | if ( *buf == NULL ) { |
---|
327 | *buf = *next; |
---|
328 | *next = NULL; |
---|
329 | return 0; |
---|
330 | } else { |
---|
331 | return roar_buffer_moveinto(*buf, next); |
---|
332 | } |
---|
333 | } |
---|
334 | |
---|
335 | int roar_buffer_get_next (struct roar_buffer * buf, struct roar_buffer ** next) { |
---|
336 | _ckbuf(0) |
---|
337 | |
---|
338 | *next = buf->next; |
---|
339 | |
---|
340 | return roar_buffer_ref(*next); |
---|
341 | } |
---|
342 | |
---|
343 | int roar_buffer_ring_new (struct roar_buffer ** buf, size_t len, int free_running) { |
---|
344 | struct roar_buffer * n; |
---|
345 | |
---|
346 | _ckbuf_free(0) |
---|
347 | |
---|
348 | if ( len == 0 ) { |
---|
349 | roar_err_set(ROAR_ERROR_RANGE); |
---|
350 | return -1; |
---|
351 | } |
---|
352 | |
---|
353 | // just to be sure: |
---|
354 | *buf = NULL; |
---|
355 | |
---|
356 | if ( roar_buffer_new(&n, len) == -1 ) |
---|
357 | return -1; |
---|
358 | |
---|
359 | n->flags |= ROAR_BUFFER_FLAG_RING; |
---|
360 | |
---|
361 | if ( free_running ) |
---|
362 | n->flags |= ROAR_BUFFER_FLAG_FREE_RUNNING; |
---|
363 | |
---|
364 | n->meta.ring.read_pos = 0; |
---|
365 | n->meta.ring.write_pos = 0; |
---|
366 | |
---|
367 | memset(n->data, 0, n->len); |
---|
368 | |
---|
369 | *buf = n; |
---|
370 | |
---|
371 | return 0; |
---|
372 | } |
---|
373 | |
---|
374 | int roar_buffer_get_data (struct roar_buffer * buf, void ** data) { |
---|
375 | _ckbuf(data == NULL) |
---|
376 | |
---|
377 | *data = buf->user_data; |
---|
378 | |
---|
379 | return 0; |
---|
380 | } |
---|
381 | |
---|
382 | int roar_buffer_get_datalen(struct roar_buffer * buf, void ** data, size_t * len) { |
---|
383 | _ckbuf(0) |
---|
384 | |
---|
385 | if ( data != NULL ) |
---|
386 | *data = buf->user_data; |
---|
387 | if ( len != NULL ) |
---|
388 | *len = buf->user_len; |
---|
389 | |
---|
390 | return 0; |
---|
391 | } |
---|
392 | |
---|
393 | int roar_buffer_set_offset (struct roar_buffer * buf, size_t off) { |
---|
394 | _ckbuf(0) |
---|
395 | |
---|
396 | if ( off > buf->user_len ) { |
---|
397 | roar_err_set(ROAR_ERROR_RANGE); |
---|
398 | return -1; |
---|
399 | } |
---|
400 | |
---|
401 | buf->user_len -= off; |
---|
402 | buf->user_data += off; |
---|
403 | |
---|
404 | return 0; |
---|
405 | } |
---|
406 | |
---|
407 | int roar_buffer_shift_out (struct roar_buffer ** buf, void * data, size_t * len) { |
---|
408 | size_t todo, cl; |
---|
409 | struct roar_buffer * cur; |
---|
410 | void * cd; |
---|
411 | |
---|
412 | _ckbuf_free(len == NULL || data == NULL); |
---|
413 | |
---|
414 | if ( *buf == NULL ) { |
---|
415 | ROAR_DBG("roar_buffer_shift_out(buf=%p, data=%p, len={%lu}) = -1 // Invalid pointer to buffer ring", buf, data, (unsigned long)len); |
---|
416 | roar_err_set(ROAR_ERROR_FAULT); |
---|
417 | return -1; |
---|
418 | } |
---|
419 | |
---|
420 | todo = *len; |
---|
421 | cur = *buf; |
---|
422 | |
---|
423 | *len = 0; |
---|
424 | |
---|
425 | while (todo && cur != NULL) { |
---|
426 | ROAR_DBG("roar_buffer_shift_out(*): todo=%u, cur=%p", (unsigned int) todo, cur); |
---|
427 | |
---|
428 | _ckmem_corruption(cur, 0); |
---|
429 | |
---|
430 | if ( roar_buffer_get_len(cur, &cl) == -1 ) |
---|
431 | return -1; |
---|
432 | |
---|
433 | if ( cl > todo ) { |
---|
434 | if ( roar_buffer_get_data(cur, &cd) == -1 ) |
---|
435 | return -1; |
---|
436 | |
---|
437 | cl = todo; |
---|
438 | |
---|
439 | memcpy(data, cd, cl); |
---|
440 | todo -= cl; |
---|
441 | data += cl; |
---|
442 | *len += cl; |
---|
443 | |
---|
444 | if ( roar_buffer_set_offset(cur, cl) == -1 ) |
---|
445 | return -1; |
---|
446 | } else { |
---|
447 | if ( roar_buffer_get_data(cur, &cd) == -1 ) |
---|
448 | return -1; |
---|
449 | |
---|
450 | memcpy(data, cd, cl); |
---|
451 | todo -= cl; |
---|
452 | data += cl; |
---|
453 | *len += cl; |
---|
454 | |
---|
455 | if ( roar_buffer_next(&cur) == -1 ) |
---|
456 | return -1; |
---|
457 | } |
---|
458 | |
---|
459 | /* |
---|
460 | if ( cur == NULL ) |
---|
461 | break; |
---|
462 | */ |
---|
463 | } |
---|
464 | |
---|
465 | *buf = cur; |
---|
466 | |
---|
467 | return 0; |
---|
468 | } |
---|
469 | |
---|
470 | int roar_buffer_set_meta (struct roar_buffer * buf, void * meta) { |
---|
471 | _ckbuf(0) |
---|
472 | |
---|
473 | buf->meta.vp = meta; |
---|
474 | |
---|
475 | return 0; |
---|
476 | } |
---|
477 | |
---|
478 | int roar_buffer_get_meta (struct roar_buffer * buf, void ** meta) { |
---|
479 | _ckbuf(meta == NULL) |
---|
480 | |
---|
481 | *meta = buf->meta.vp; |
---|
482 | |
---|
483 | return 0; |
---|
484 | } |
---|
485 | |
---|
486 | int roar_buffer_set_meta_i32(struct roar_buffer * buf, int32_t meta) { |
---|
487 | _ckbuf(0) |
---|
488 | |
---|
489 | buf->meta.i32 = meta; |
---|
490 | |
---|
491 | return 0; |
---|
492 | } |
---|
493 | |
---|
494 | int roar_buffer_get_meta_i32(struct roar_buffer * buf, int32_t * meta) { |
---|
495 | _ckbuf(meta == NULL) |
---|
496 | |
---|
497 | *meta = buf->meta.i32; |
---|
498 | |
---|
499 | return 0; |
---|
500 | } |
---|
501 | |
---|
502 | int roar_buffer_set_type (struct roar_buffer * buf, int type) { |
---|
503 | _ckbuf(0) |
---|
504 | |
---|
505 | switch (type) { |
---|
506 | case ROAR_VIO_DFT_RAW: |
---|
507 | case ROAR_VIO_DFT_PACKET: |
---|
508 | case ROAR_VIO_DFT_UNFRAMED: |
---|
509 | case ROAR_VIO_DFT_OGG_PACKET: |
---|
510 | case ROAR_VIO_DFT_OGG_PAGE: |
---|
511 | break; |
---|
512 | default: |
---|
513 | roar_err_set(ROAR_ERROR_NOTSUP); |
---|
514 | return -1; |
---|
515 | } |
---|
516 | |
---|
517 | buf->type = type; |
---|
518 | |
---|
519 | return 0; |
---|
520 | } |
---|
521 | |
---|
522 | int roar_buffer_get_type (struct roar_buffer * buf, int * type) { |
---|
523 | _ckbuf(type == NULL) |
---|
524 | |
---|
525 | *type = buf->type; |
---|
526 | |
---|
527 | return 0; |
---|
528 | } |
---|
529 | |
---|
530 | int roar_buffer_set_len (struct roar_buffer * buf, size_t len) { |
---|
531 | size_t totlen; |
---|
532 | void * newbuf; |
---|
533 | size_t true_len; |
---|
534 | |
---|
535 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu) = ?", buf, (long unsigned int)len); |
---|
536 | |
---|
537 | _ckbuf(0) |
---|
538 | |
---|
539 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu) = ?", buf, (long unsigned int)len); |
---|
540 | |
---|
541 | // handle special case where user length is zero: |
---|
542 | if ( len && !buf->user_len ) { |
---|
543 | buf->user_data = buf->data; |
---|
544 | buf->user_len = buf->len; |
---|
545 | } |
---|
546 | |
---|
547 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu) = ?", buf, (long unsigned int)len); |
---|
548 | |
---|
549 | // calculate the true length of our buffer starting at buf->user_data. |
---|
550 | true_len = buf->len - (buf->user_data - buf->data); |
---|
551 | |
---|
552 | if ( len > true_len ) { |
---|
553 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu): We need to enlarge the buffer.", buf, (long unsigned int)len); |
---|
554 | |
---|
555 | // we can only enlage a buffer if it's one of our own memory segments |
---|
556 | if ( buf->flags & ROAR_BUFFER_FLAG_NOFREE ) { |
---|
557 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu) = -1 //error=NOTSUP", buf, (long unsigned int)len); |
---|
558 | roar_err_set(ROAR_ERROR_NOTSUP); |
---|
559 | return -1; |
---|
560 | } |
---|
561 | |
---|
562 | totlen = (buf->len - buf->user_len) + len; |
---|
563 | newbuf = roar_mm_realloc(buf->data, totlen); |
---|
564 | if ( newbuf == NULL ) |
---|
565 | return -1; |
---|
566 | |
---|
567 | buf->user_data = newbuf + (buf->user_data - buf->data); |
---|
568 | buf->user_len = len; |
---|
569 | buf->data = newbuf; |
---|
570 | buf->len = totlen; |
---|
571 | } else { |
---|
572 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu): No need to enlarge the buffer.", buf, (long unsigned int)len); |
---|
573 | buf->user_len = len; |
---|
574 | } |
---|
575 | |
---|
576 | ROAR_DBG("roar_buffer_set_len(buf=%p, len=%lu) = 0", buf, (long unsigned int)len); |
---|
577 | return 0; |
---|
578 | } |
---|
579 | |
---|
580 | int roar_buffer_get_len (struct roar_buffer * buf, size_t * len) { |
---|
581 | _ckbuf(0) |
---|
582 | |
---|
583 | *len = buf->user_len; |
---|
584 | |
---|
585 | return 0; |
---|
586 | } |
---|
587 | |
---|
588 | int roar_buffer_set_flag (struct roar_buffer * buf, int flag, int reset) { |
---|
589 | _ckbuf(0) |
---|
590 | |
---|
591 | buf->flags |= flag; |
---|
592 | |
---|
593 | if ( reset ) |
---|
594 | buf->flags -= flag; |
---|
595 | |
---|
596 | return 0; |
---|
597 | } |
---|
598 | |
---|
599 | int roar_buffer_get_flag (struct roar_buffer * buf, int flag) { |
---|
600 | _ckbuf(0) |
---|
601 | |
---|
602 | return buf->flags & flag; |
---|
603 | } |
---|
604 | |
---|
605 | int roar_buffer_duplicate (struct roar_buffer * buf, struct roar_buffer ** copy) { |
---|
606 | struct roar_buffer * cur = buf; |
---|
607 | struct roar_buffer * new; |
---|
608 | void * od, * nd; |
---|
609 | int err; |
---|
610 | |
---|
611 | _ckbuf(copy == NULL) |
---|
612 | |
---|
613 | *copy = NULL; |
---|
614 | |
---|
615 | // TODO: This function does not handle ring buffers. |
---|
616 | // FIXME: This function does not error out in case of wrong buffer type in buf. |
---|
617 | // TODO: This function does not handle buffer meta data. |
---|
618 | |
---|
619 | while (cur != NULL) { |
---|
620 | if ( roar_buffer_new(&new, cur->user_len) == -1 ) { |
---|
621 | err = roar_error; |
---|
622 | roar_buffer_free(*copy); |
---|
623 | roar_err_set(err); |
---|
624 | return -1; |
---|
625 | } |
---|
626 | |
---|
627 | if ( *copy == NULL ) |
---|
628 | *copy = new; |
---|
629 | |
---|
630 | _LIBROAR_IGNORE_RET(roar_buffer_get_data(cur, &od)); |
---|
631 | _LIBROAR_IGNORE_RET(roar_buffer_get_data(new, &nd)); |
---|
632 | memcpy(nd, od, cur->user_len); |
---|
633 | |
---|
634 | if ( *copy != new ) { |
---|
635 | _LIBROAR_IGNORE_RET(roar_buffer_moveinto(*copy, &new)); |
---|
636 | } |
---|
637 | |
---|
638 | cur = cur->next; |
---|
639 | } |
---|
640 | |
---|
641 | return 0; |
---|
642 | } |
---|
643 | |
---|
644 | int roar_buffer_ring_stats (struct roar_buffer * buf, struct roar_buffer_stats * stats) { |
---|
645 | ROAR_DBG("roar_buffer_ring_stats(buf=%p, stats=%p) = ?", buf, stats); |
---|
646 | |
---|
647 | _ckbuf(0) |
---|
648 | |
---|
649 | ROAR_DBG("roar_buffer_ring_stats(buf=%p, stats=%p) = ?", buf, stats); |
---|
650 | |
---|
651 | stats->parts = 0; |
---|
652 | stats->bytes = 0; |
---|
653 | stats->memory_usage = 0; |
---|
654 | |
---|
655 | while (buf != NULL ) { |
---|
656 | stats->parts++; |
---|
657 | stats->bytes += buf->user_len; |
---|
658 | stats->memory_usage += buf->len + sizeof(struct roar_buffer); |
---|
659 | buf = buf->next; |
---|
660 | } |
---|
661 | |
---|
662 | return 0; |
---|
663 | } |
---|
664 | |
---|
665 | int roar_buffer_ring_read (struct roar_buffer * buf, void * data, size_t * len) { |
---|
666 | struct roar_buffer_ring * ring; |
---|
667 | size_t havelen; |
---|
668 | size_t done; |
---|
669 | size_t tmp; |
---|
670 | |
---|
671 | _ckbuf(len == NULL) |
---|
672 | |
---|
673 | if ( buf == NULL || len == NULL ) |
---|
674 | return -1; |
---|
675 | |
---|
676 | if ( data == NULL && *len != 0 ) { |
---|
677 | roar_err_set(ROAR_ERROR_FAULT); |
---|
678 | return -1; |
---|
679 | } |
---|
680 | |
---|
681 | if ( !(buf->flags & ROAR_BUFFER_FLAG_RING) ) { |
---|
682 | roar_err_set(ROAR_ERROR_TYPEMM); |
---|
683 | return -1; |
---|
684 | } |
---|
685 | |
---|
686 | if ( *len == 0 ) |
---|
687 | return 0; |
---|
688 | |
---|
689 | // we may handle this later: |
---|
690 | if ( *len > buf->user_len ) { |
---|
691 | roar_err_set(ROAR_ERROR_NOTSUP); |
---|
692 | return -1; |
---|
693 | } |
---|
694 | |
---|
695 | if ( (buf->flags & ROAR_BUFFER_FLAG_FREE_RUNNING) ) { |
---|
696 | if ( buf->meta.ring.read_pos >= buf->user_len ) |
---|
697 | buf->meta.ring.read_pos -= buf->user_len; |
---|
698 | |
---|
699 | if ( (*len + buf->meta.ring.read_pos) > buf->user_len ) { |
---|
700 | // wraped mode: |
---|
701 | memcpy(data, buf->user_data+buf->meta.ring.read_pos, buf->user_len - buf->meta.ring.read_pos); |
---|
702 | memcpy(data, buf->user_data, *len + buf->meta.ring.read_pos - buf->user_len); |
---|
703 | |
---|
704 | buf->meta.ring.read_pos += *len; |
---|
705 | buf->meta.ring.read_pos -= buf->user_len; |
---|
706 | return 0; |
---|
707 | } else { |
---|
708 | // unwarped mode: |
---|
709 | memcpy(data, buf->user_data+buf->meta.ring.read_pos, *len); |
---|
710 | buf->meta.ring.read_pos += *len; |
---|
711 | return 0; |
---|
712 | } |
---|
713 | } else { |
---|
714 | ring = &(buf->meta.ring); |
---|
715 | |
---|
716 | if ( ring->read_pos == ring->write_pos ) { |
---|
717 | *len = 0; |
---|
718 | return 0; |
---|
719 | } else if ( ring->read_pos < ring->write_pos ) { |
---|
720 | havelen = ring->write_pos - ring->read_pos; |
---|
721 | |
---|
722 | if ( havelen > *len ) |
---|
723 | havelen = *len; |
---|
724 | |
---|
725 | memcpy(data, buf->user_data+ring->read_pos, havelen); |
---|
726 | ring->read_pos += havelen; |
---|
727 | |
---|
728 | *len = havelen; |
---|
729 | return 0; |
---|
730 | } else { // write_pos < read_pos |
---|
731 | done = 0; |
---|
732 | |
---|
733 | // first pass: use data up to end of buffer |
---|
734 | |
---|
735 | havelen = buf->user_len - ring->read_pos; |
---|
736 | |
---|
737 | if ( havelen > *len ) |
---|
738 | havelen = *len; |
---|
739 | |
---|
740 | memcpy(data, buf->user_data+ring->read_pos, havelen); |
---|
741 | ring->read_pos += havelen; |
---|
742 | |
---|
743 | done += havelen; |
---|
744 | |
---|
745 | if ( ring->read_pos == buf->user_len ) { |
---|
746 | ring->read_pos = 0; |
---|
747 | } |
---|
748 | |
---|
749 | // second pass: use data from strat of buffer to write pointer |
---|
750 | |
---|
751 | if ( *len > done ) { |
---|
752 | tmp = *len - done; |
---|
753 | if ( roar_buffer_ring_read(buf, data+done, &tmp) == 0 ) { |
---|
754 | done += tmp; |
---|
755 | } |
---|
756 | } |
---|
757 | |
---|
758 | *len = done; |
---|
759 | return 0; |
---|
760 | } |
---|
761 | } |
---|
762 | |
---|
763 | roar_err_set(ROAR_ERROR_UNKNOWN); |
---|
764 | return -1; |
---|
765 | } |
---|
766 | |
---|
767 | int roar_buffer_ring_write (struct roar_buffer * buf, void * data, size_t * len) { |
---|
768 | struct roar_buffer_ring * ring; |
---|
769 | size_t havelen; |
---|
770 | size_t done; |
---|
771 | size_t tmp; |
---|
772 | |
---|
773 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = ?", buf, data, len); |
---|
774 | |
---|
775 | _ckbuf(len == NULL) |
---|
776 | |
---|
777 | if ( data == NULL && *len != 0 ) { |
---|
778 | roar_err_set(ROAR_ERROR_FAULT); |
---|
779 | return -1; |
---|
780 | } |
---|
781 | |
---|
782 | if ( !(buf->flags & ROAR_BUFFER_FLAG_RING) ) { |
---|
783 | roar_err_set(ROAR_ERROR_TYPEMM); |
---|
784 | return -1; |
---|
785 | } |
---|
786 | |
---|
787 | if ( *len == 0 ) |
---|
788 | return 0; |
---|
789 | |
---|
790 | // we may handle this later: |
---|
791 | if ( *len > buf->user_len ) { |
---|
792 | roar_err_set(ROAR_ERROR_NOTSUP); |
---|
793 | return -1; |
---|
794 | } |
---|
795 | |
---|
796 | if ( (buf->flags & ROAR_BUFFER_FLAG_FREE_RUNNING) ) { |
---|
797 | if ( buf->meta.ring.write_pos >= buf->user_len ) |
---|
798 | buf->meta.ring.write_pos -= buf->user_len; |
---|
799 | |
---|
800 | if ( (*len + buf->meta.ring.write_pos) > buf->user_len ) { |
---|
801 | // wraped mode: |
---|
802 | memcpy(buf->user_data+buf->meta.ring.write_pos, data, buf->user_len - buf->meta.ring.write_pos); |
---|
803 | memcpy(buf->user_data, data, *len + buf->meta.ring.write_pos - buf->user_len); |
---|
804 | |
---|
805 | buf->meta.ring.write_pos += *len; |
---|
806 | buf->meta.ring.write_pos -= buf->user_len; |
---|
807 | return 0; |
---|
808 | } else { |
---|
809 | // unwarped mode: |
---|
810 | memcpy(buf->user_data+buf->meta.ring.write_pos, data, *len); |
---|
811 | buf->meta.ring.write_pos += *len; |
---|
812 | return 0; |
---|
813 | } |
---|
814 | } else { |
---|
815 | ring = &(buf->meta.ring); |
---|
816 | done = 0; |
---|
817 | |
---|
818 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p): write_pos=%u, read_pos=%u, user_len=%u", buf, data, len, (unsigned int)ring->write_pos, (unsigned int)ring->read_pos, (unsigned int)buf->user_len); |
---|
819 | |
---|
820 | if ( ring->write_pos >= ring->read_pos ) { |
---|
821 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = ?", buf, data, len); |
---|
822 | |
---|
823 | havelen = buf->user_len - ring->write_pos; |
---|
824 | |
---|
825 | if ( ring->read_pos == 0 ) |
---|
826 | havelen--; |
---|
827 | |
---|
828 | if ( havelen > *len ) |
---|
829 | havelen = *len; |
---|
830 | |
---|
831 | memcpy(buf->user_data+ring->write_pos, data, havelen); |
---|
832 | |
---|
833 | done += havelen; |
---|
834 | ring->write_pos += havelen; |
---|
835 | |
---|
836 | if ( ring->write_pos == buf->user_len ) |
---|
837 | ring->write_pos = 0; |
---|
838 | |
---|
839 | if ( *len > done && ring->read_pos != 0 ) { |
---|
840 | tmp = *len - done; |
---|
841 | if ( roar_buffer_ring_write(buf, data+done, &tmp) == 0 ) { |
---|
842 | done += tmp; |
---|
843 | } |
---|
844 | } |
---|
845 | |
---|
846 | *len = done; |
---|
847 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = 0", buf, data, len); |
---|
848 | return 0; |
---|
849 | } else { |
---|
850 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = ?", buf, data, len); |
---|
851 | |
---|
852 | // test for buffer-is-full: |
---|
853 | if ( (ring->write_pos + 1) == ring->read_pos ) { |
---|
854 | *len = 0; |
---|
855 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = 0", buf, data, len); |
---|
856 | return 0; |
---|
857 | } |
---|
858 | |
---|
859 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = ?", buf, data, len); |
---|
860 | |
---|
861 | havelen = ring->read_pos - ring->write_pos - 1; |
---|
862 | |
---|
863 | if ( havelen > *len ) |
---|
864 | havelen = *len; |
---|
865 | |
---|
866 | memcpy(buf->user_data+ring->write_pos, data, havelen); |
---|
867 | |
---|
868 | ring->write_pos += havelen; |
---|
869 | *len = havelen; |
---|
870 | |
---|
871 | ROAR_DBG("roar_buffer_ring_write(buf=%p, data=%p, len=%p) = 0", buf, data, len); |
---|
872 | return 0; |
---|
873 | } |
---|
874 | } |
---|
875 | |
---|
876 | roar_err_set(ROAR_ERROR_UNKNOWN); |
---|
877 | return -1; |
---|
878 | } |
---|
879 | |
---|
880 | int roar_buffer_ring_avail(struct roar_buffer * buf, size_t * readlen, size_t * writelen) { |
---|
881 | struct roar_buffer_ring * ring; |
---|
882 | size_t have; |
---|
883 | |
---|
884 | _ckbuf(0) |
---|
885 | |
---|
886 | if ( !(buf->flags & ROAR_BUFFER_FLAG_RING) ) { |
---|
887 | roar_err_set(ROAR_ERROR_TYPEMM); |
---|
888 | return -1; |
---|
889 | } |
---|
890 | |
---|
891 | ring = &(buf->meta.ring); |
---|
892 | |
---|
893 | ROAR_DBG("roar_buffer_ring_avail(buf=%p, readlen=%p, writelen=%p) = ?", buf, readlen, writelen); |
---|
894 | |
---|
895 | if ( readlen != NULL ) { |
---|
896 | have = 0; |
---|
897 | |
---|
898 | if ( ring->write_pos >= ring->read_pos ) { |
---|
899 | have = ring->write_pos - ring->read_pos; |
---|
900 | } else { |
---|
901 | have = buf->user_len - ring->read_pos; |
---|
902 | have += ring->write_pos; |
---|
903 | have -= 1; |
---|
904 | } |
---|
905 | |
---|
906 | *readlen = have; |
---|
907 | ROAR_DBG("roar_buffer_ring_avail(buf=%p, readlen=%p, writelen=%p): readlen=%llu", buf, readlen, writelen, (unsigned long long int)have); |
---|
908 | } |
---|
909 | |
---|
910 | if ( writelen != NULL ) { |
---|
911 | have = 0; |
---|
912 | |
---|
913 | if ( ring->read_pos > ring->write_pos ) { |
---|
914 | have = ring->read_pos - ring->write_pos - 1; |
---|
915 | } else { |
---|
916 | have = buf->user_len - ring->write_pos; |
---|
917 | have += ring->read_pos; |
---|
918 | have -= 1; |
---|
919 | } |
---|
920 | |
---|
921 | *writelen = have; |
---|
922 | ROAR_DBG("roar_buffer_ring_avail(buf=%p, readlen=%p, writelen=%p): readlen=%llu", buf, readlen, writelen, (unsigned long long int)have); |
---|
923 | } |
---|
924 | |
---|
925 | ROAR_DBG("roar_buffer_ring_avail(buf=%p, readlen=%p, writelen=%p) = 0", buf, readlen, writelen); |
---|
926 | |
---|
927 | return 0; |
---|
928 | } |
---|
929 | |
---|
930 | int roar_buffer_ring_reset(struct roar_buffer * buf) { |
---|
931 | _ckbuf(0) |
---|
932 | |
---|
933 | if ( !(buf->flags & ROAR_BUFFER_FLAG_RING) ) { |
---|
934 | roar_err_set(ROAR_ERROR_TYPEMM); |
---|
935 | return -1; |
---|
936 | } |
---|
937 | |
---|
938 | buf->meta.ring.read_pos = buf->meta.ring.write_pos = 0; |
---|
939 | |
---|
940 | return 0; |
---|
941 | } |
---|
942 | |
---|
943 | //ll |
---|