Merge branch 't/image-0.5'
[paraslash.git] / buffer_tree.c
1 /*
2 * Copyright (C) 2009-2013 Andre Noll <maan@systemlinux.org>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file buffer_tree.c Buffer tree and buffer pool implementations. */
8 #include <regex.h>
9
10 #include "para.h"
11 #include "list.h"
12 #include "string.h"
13 #include "buffer_tree.h"
14 #include "error.h"
15 #include "sched.h"
16
17 /* whead = NULL means area full */
18 struct btr_pool {
19 char *name;
20 char *area_start;
21 char *area_end;
22 char *rhead;
23 char *whead;
24 };
25
26 struct btr_buffer {
27 char *buf;
28 size_t size;
29 /** The number of references to this buffer. */
30 int refcount;
31 /* NULL means no buffer pool but a malloced buffer. */
32 struct btr_pool *pool;
33 /* Only relevant if pool is NULL. */
34 bool dont_free;
35 };
36
37 struct btr_buffer_reference {
38 struct btr_buffer *btrb;
39 size_t consumed;
40 /* Each buffer reference belongs to the buffer queue list of some buffer tree node. */
41 struct list_head node;
42 size_t wrap_count;
43 };
44
45 struct btr_node {
46 char *name;
47 struct btr_node *parent;
48 /* The position of this btr node in the buffer tree. */
49 struct list_head node;
50 /* The children nodes of this btr node are linked together in a list. */
51 struct list_head children;
52 /* Time of first data transfer. */
53 struct timeval start;
54 /**
55 * The input queue is a list of references to btr buffers. Each item on
56 * the list represents an input buffer which has not been completely
57 * used by this btr node.
58 */
59 struct list_head input_queue;
60 btr_command_handler execute;
61 void *context;
62 };
63
64 /**
65 * Create a new buffer pool.
66 *
67 * \param name The name of the new buffer pool.
68 * \param area_size The size in bytes of the pool area.
69 *
70 * \return An opaque pointer to the newly created buffer pool. It must be
71 * passed to btr_pool_free() after it is no longer used to deallocate all
72 * resources.
73 */
74 struct btr_pool *btr_pool_new(const char *name, size_t area_size)
75 {
76 struct btr_pool *btrp;
77
78 PARA_INFO_LOG("%s, %zu bytes\n", name, area_size);
79 btrp = para_malloc(sizeof(*btrp));
80 btrp->area_start = para_malloc(area_size);
81 btrp->area_end = btrp->area_start + area_size;
82 btrp->rhead = btrp->area_start;
83 btrp->whead = btrp->area_start;
84 btrp->name = para_strdup(name);
85 return btrp;
86 }
87
88 /**
89 * Deallocate resources used by a buffer pool.
90 *
91 * \param btrp A pointer obtained via btr_pool_new().
92 */
93 void btr_pool_free(struct btr_pool *btrp)
94 {
95 if (!btrp)
96 return;
97 free(btrp->area_start);
98 free(btrp->name);
99 free(btrp);
100 }
101
102 /**
103 * Return the size of the buffer pool area.
104 *
105 * \param btrp The buffer pool.
106 *
107 * \return The same value which was passed during creation time to
108 * btr_pool_new().
109 */
110 size_t btr_pool_size(struct btr_pool *btrp)
111 {
112 return btrp->area_end - btrp->area_start;
113 }
114
115 static size_t btr_pool_filled(struct btr_pool *btrp)
116 {
117 if (!btrp->whead)
118 return btr_pool_size(btrp);
119 if (btrp->rhead <= btrp->whead)
120 return btrp->whead - btrp->rhead;
121 return btr_pool_size(btrp) - (btrp->rhead - btrp->whead);
122 }
123
124 /**
125 * Get the number of unused bytes in the buffer pool.
126 *
127 * \param btrp The pool.
128 *
129 * \return The number of bytes that can currently be allocated.
130 *
131 * Note that in general the returned number of bytes is not available as a
132 * single contiguous buffer. Use btr_pool_available() to obtain the length of
133 * the largest contiguous buffer that can currently be allocated from the
134 * buffer pool.
135 */
136 size_t btr_pool_unused(struct btr_pool *btrp)
137 {
138 return btr_pool_size(btrp) - btr_pool_filled(btrp);
139 }
140
141 /*
142 * Return maximal size available for one read. This is
143 * smaller than the value returned by btr_pool_unused().
144 */
145 static size_t btr_pool_available(struct btr_pool *btrp)
146 {
147 if (!btrp->whead)
148 return 0;
149 if (btrp->rhead <= btrp->whead)
150 return btrp->area_end - btrp->whead;
151 return btrp->rhead - btrp->whead;
152 }
153
154 /**
155 * Obtain the current write head.
156 *
157 * \param btrp The buffer pool.
158 * \param result The write head is returned here.
159 *
160 * \return The maximal amount of bytes that may be written to the returned
161 * buffer.
162 */
163 size_t btr_pool_get_buffer(struct btr_pool *btrp, char **result)
164 {
165 if (result)
166 *result = btrp->whead;
167 return btr_pool_available(btrp);
168 }
169
170 /**
171 * Get references to buffers pointing to free space of the buffer pool area.
172 *
173 * \param btrp The buffer pool.
174 * \param iov The scatter array.
175 *
176 * \return Zero if the buffer pool is full, one if the free space of the buffer
177 * pool area is available as a single contiguous buffer, two if the free space
178 * consists of two buffers. If this function returns the value n, then n
179 * elements of \a iov are initialized.
180 */
181 int btr_pool_get_buffers(struct btr_pool *btrp, struct iovec iov[2])
182 {
183 size_t sz, unused;
184 char *buf;
185
186 sz = btr_pool_get_buffer(btrp, &buf);
187 if (sz == 0)
188 return 0;
189 iov[0].iov_len = sz;
190 iov[0].iov_base = buf;
191 unused = btr_pool_unused(btrp);
192 if (sz == unused)
193 return 1;
194 iov[1].iov_len = unused - sz;
195 iov[1].iov_base = btrp->area_start;
196 return 2;
197 }
198
199 /**
200 * Mark a part of the buffer pool area as allocated.
201 *
202 * \param btrp The buffer pool.
203 * \param size The amount of bytes to be allocated.
204 *
205 * This is usually called after the caller wrote to the buffer obtained by
206 * btr_pool_get_buffer().
207 */
208 static void btr_pool_allocate(struct btr_pool *btrp, size_t size)
209 {
210 char *end;
211
212 if (size == 0)
213 return;
214 assert(size <= btr_pool_available(btrp));
215 end = btrp->whead + size;
216 assert(end <= btrp->area_end);
217
218 if (end == btrp->area_end) {
219 PARA_DEBUG_LOG("%s: end of pool area reached\n", btrp->name);
220 end = btrp->area_start;
221 }
222 if (end == btrp->rhead) {
223 PARA_DEBUG_LOG("%s btrp buffer full\n", btrp->name);
224 end = NULL; /* buffer full */
225 }
226 btrp->whead = end;
227 }
228
229 static void btr_pool_deallocate(struct btr_pool *btrp, size_t size)
230 {
231 char *end = btrp->rhead + size;
232
233 if (size == 0)
234 return;
235 assert(end <= btrp->area_end);
236 assert(size <= btr_pool_filled(btrp));
237 if (end == btrp->area_end)
238 end = btrp->area_start;
239 if (!btrp->whead)
240 btrp->whead = btrp->rhead;
241 btrp->rhead = end;
242 if (btrp->rhead == btrp->whead)
243 btrp->rhead = btrp->whead = btrp->area_start;
244 }
245
246 #define FOR_EACH_CHILD(_tn, _btrn) list_for_each_entry((_tn), \
247 &((_btrn)->children), node)
248 #define FOR_EACH_CHILD_SAFE(_tn, _tmp, _btrn) \
249 list_for_each_entry_safe((_tn), (_tmp), &((_btrn)->children), node)
250
251 #define FOR_EACH_BUFFER_REF(_br, _btrn) \
252 list_for_each_entry((_br), &(_btrn)->input_queue, node)
253 #define FOR_EACH_BUFFER_REF_SAFE(_br, _tmp, _btrn) \
254 list_for_each_entry_safe((_br), (_tmp), &(_btrn)->input_queue, node)
255
256 /**
257 * Create a new buffer tree node.
258 *
259 * \param bnd Specifies how to create the new node.
260 *
261 * \return A pointer to the newly allocated node.
262 *
263 * This function always succeeds (or calls exit()). The returned pointer must
264 * be freed using btr_free_node() after the node has been removed from the
265 * buffer tree via btr_remove_node().
266 */
267 struct btr_node *btr_new_node(struct btr_node_description *bnd)
268 {
269 struct btr_node *btrn = para_malloc(sizeof(*btrn));
270
271 btrn->name = para_strdup(bnd->name);
272 btrn->parent = bnd->parent;
273 btrn->execute = bnd->handler;
274 btrn->context = bnd->context;
275 btrn->start.tv_sec = 0;
276 btrn->start.tv_usec = 0;
277 INIT_LIST_HEAD(&btrn->children);
278 INIT_LIST_HEAD(&btrn->input_queue);
279 if (!bnd->child) {
280 if (bnd->parent) {
281 list_add_tail(&btrn->node, &bnd->parent->children);
282 PARA_INFO_LOG("new leaf node: %s (child of %s)\n",
283 bnd->name, bnd->parent->name);
284 } else
285 PARA_INFO_LOG("added %s as btr root\n", bnd->name);
286 goto out;
287 }
288 if (!bnd->parent) {
289 assert(!bnd->child->parent);
290 PARA_INFO_LOG("new root: %s (was %s)\n",
291 bnd->name, bnd->child->name);
292 btrn->parent = NULL;
293 list_add_tail(&bnd->child->node, &btrn->children);
294 /* link it in */
295 bnd->child->parent = btrn;
296 goto out;
297 }
298 list_add_tail(&btrn->node, &bnd->parent->children);
299 list_move(&bnd->child->node, &btrn->children);
300 bnd->child->parent = btrn;
301 PARA_INFO_LOG("added %s as internal node\n", bnd->name);
302 out:
303 return btrn;
304 }
305
306 /*
307 * Allocate a new btr buffer.
308 *
309 * The freshly allocated buffer will have a zero refcount and will
310 * not be associated with a btr pool.
311 */
312 static struct btr_buffer *new_btrb(char *buf, size_t size)
313 {
314 struct btr_buffer *btrb = para_calloc(sizeof(*btrb));
315
316 btrb->buf = buf;
317 btrb->size = size;
318 return btrb;
319 }
320
321 static void dealloc_buffer(struct btr_buffer *btrb)
322 {
323 if (btrb->pool)
324 btr_pool_deallocate(btrb->pool, btrb->size);
325 else if (!btrb->dont_free)
326 free(btrb->buf);
327 }
328
329 static struct btr_buffer_reference *get_first_input_br(struct btr_node *btrn)
330 {
331 if (list_empty(&btrn->input_queue))
332 return NULL;
333 return list_first_entry(&btrn->input_queue,
334 struct btr_buffer_reference, node);
335 }
336
337 /*
338 * Deallocate the reference, release the resources if refcount drops to zero.
339 */
340 static void btr_drop_buffer_reference(struct btr_buffer_reference *br)
341 {
342 struct btr_buffer *btrb = br->btrb;
343
344 list_del(&br->node);
345 free(br);
346 btrb->refcount--;
347 if (btrb->refcount == 0) {
348 dealloc_buffer(btrb);
349 free(btrb);
350 }
351 }
352
353 static void add_btrb_to_children(struct btr_buffer *btrb,
354 struct btr_node *btrn, size_t consumed)
355 {
356 struct btr_node *ch;
357
358 if (btrn->start.tv_sec == 0)
359 btrn->start = *now;
360 FOR_EACH_CHILD(ch, btrn) {
361 struct btr_buffer_reference *br = para_calloc(sizeof(*br));
362 br->btrb = btrb;
363 br->consumed = consumed;
364 list_add_tail(&br->node, &ch->input_queue);
365 btrb->refcount++;
366 if (ch->start.tv_sec == 0)
367 ch->start = *now;
368 }
369 }
370
371 /**
372 * Insert a malloced buffer into the buffer tree.
373 *
374 * \param buf The buffer to insert.
375 * \param size The size of \a buf in bytes.
376 * \param btrn Position in the buffer tree to create the output.
377 *
378 * This creates references to \a buf and adds these references to each child of
379 * \a btrn. The buffer will be freed using standard free() once no buffer tree
380 * node is referencing it any more.
381 *
382 * Note that this function must not be used if \a buf was obtained from a
383 * buffer pool. Use btr_add_output_pool() in this case.
384 */
385 void btr_add_output(char *buf, size_t size, struct btr_node *btrn)
386 {
387 struct btr_buffer *btrb;
388
389 if (size == 0)
390 return;
391 if (list_empty(&btrn->children)) {
392 free(buf);
393 return;
394 }
395 btrb = new_btrb(buf, size);
396 add_btrb_to_children(btrb, btrn, 0);
397 }
398
399 /**
400 * Insert a buffer into the buffer tree, non-freeing variant.
401 *
402 * \param buf See \ref btr_add_output().
403 * \param size See \ref btr_add_output().
404 * \param btrn See \ref btr_add_output().
405 *
406 * This is similar to btr_add_output() but additionally sets the \p dont_free
407 * flag on \a buf. If the refcount for the buffer drops to zero, \a buf will
408 * not be deallocated if this flag is set.
409 *
410 * The \p dont_free bit also prevents the children of \a btrn from modifying
411 * the buffer contents inplace. Specifically, \ref btr_inplace_ok() returns
412 * false if there is any buffer in the input queue with the \p dont_free bit
413 * set.
414 */
415 void btr_add_output_dont_free(const char *buf, size_t size, struct btr_node *btrn)
416 {
417 struct btr_buffer *btrb;
418
419 if (size == 0)
420 return;
421 if (list_empty(&btrn->children))
422 return;
423 btrb = new_btrb((char *)buf, size);
424 btrb->dont_free = true;
425 add_btrb_to_children(btrb, btrn, 0);
426 }
427
428 /**
429 * Feed data to child nodes of a buffer tree node.
430 *
431 * \param btrp The buffer pool.
432 * \param size The number of bytes to be allocated and fed to each child.
433 * \param btrn The node whose children are to be fed.
434 *
435 * This function allocates the amount of bytes from the buffer pool area,
436 * starting at the current value of the write head, and creates buffer
437 * references to the resulting part of the buffer pool area, one for each child
438 * of \a btrn. The references are then fed into the input queue of each child.
439 */
440 void btr_add_output_pool(struct btr_pool *btrp, size_t size,
441 struct btr_node *btrn)
442 {
443 struct btr_buffer *btrb;
444 char *buf;
445 size_t avail;
446
447 if (size == 0)
448 return;
449 if (list_empty(&btrn->children))
450 return;
451 avail = btr_pool_get_buffer(btrp, &buf);
452 assert(avail >= size);
453 btr_pool_allocate(btrp, size);
454 btrb = new_btrb(buf, size);
455 btrb->pool = btrp;
456 add_btrb_to_children(btrb, btrn, 0);
457 }
458
459 /**
460 * Copy data to write head of a buffer pool and feed it to all children nodes.
461 *
462 * \param src The source buffer.
463 * \param n The size of the source buffer in bytes.
464 * \param btrp The destination buffer pool.
465 * \param btrn Add the data as output of this node.
466 *
467 * This is expensive. The caller must make sure the data fits into the buffer
468 * pool area.
469 */
470 void btr_copy(const void *src, size_t n, struct btr_pool *btrp,
471 struct btr_node *btrn)
472 {
473 char *buf;
474 size_t sz, copy;
475
476 if (n == 0)
477 return;
478 assert(n <= btr_pool_unused(btrp));
479 sz = btr_pool_get_buffer(btrp, &buf);
480 copy = PARA_MIN(sz, n);
481 memcpy(buf, src, copy);
482 btr_add_output_pool(btrp, copy, btrn);
483 if (copy == n)
484 return;
485 sz = btr_pool_get_buffer(btrp, &buf);
486 assert(sz >= n - copy);
487 memcpy(buf, src + copy, n - copy);
488 btr_add_output_pool(btrp, n - copy, btrn);
489 }
490
491 static void btr_pushdown_br(struct btr_buffer_reference *br, struct btr_node *btrn)
492 {
493 add_btrb_to_children(br->btrb, btrn, br->consumed);
494 btr_drop_buffer_reference(br);
495 }
496
497 /**
498 * Feed all buffer references of the input queue through the output channel.
499 *
500 * \param btrn The node whose buffer references should be pushed down.
501 *
502 * This function is useful for filters that do not change the contents of the
503 * buffers at all, like the wav filter or the amp filter if no amplification
504 * was specified. This function is rather cheap.
505 *
506 * \sa \ref btr_pushdown_one().
507 */
508 void btr_pushdown(struct btr_node *btrn)
509 {
510 struct btr_buffer_reference *br, *tmp;
511
512 FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn)
513 btr_pushdown_br(br, btrn);
514 }
515
516 /**
517 * Feed the next buffer of the input queue through the output channel.
518 *
519 * \param btrn The node whose first input queue buffer should be pushed down.
520 *
521 * This works like \ref btr_pushdown() but pushes down only one buffer
522 * reference.
523 */
524 void btr_pushdown_one(struct btr_node *btrn)
525 {
526 struct btr_buffer_reference *br;
527
528 if (list_empty(&btrn->input_queue))
529 return;
530 br = list_first_entry(&btrn->input_queue, struct btr_buffer_reference, node);
531 btr_pushdown_br(br, btrn);
532 }
533
534 /*
535 * Find out whether a node is a leaf node.
536 *
537 * \param btrn The node to check.
538 *
539 * \return True if this node has no children. False otherwise.
540 */
541 static bool btr_no_children(struct btr_node *btrn)
542 {
543 return list_empty(&btrn->children);
544 }
545
546 /**
547 * Find out whether a node is an orphan node.
548 *
549 * \param btrn The buffer tree node.
550 *
551 * \return True if \a btrn has no parent.
552 *
553 * This function will always return true for the root node. However in case
554 * nodes have been removed from the tree, other nodes may become orphans too.
555 */
556 bool btr_no_parent(struct btr_node *btrn)
557 {
558 return !btrn->parent;
559 }
560
561 /**
562 * Find out whether it is OK to change an input buffer.
563 *
564 * \param btrn The buffer tree node to check.
565 *
566 * This is used by filters that produce exactly the same amount of output as
567 * there is input. The amp filter which multiplies each sample by some number
568 * is an example of such a filter. If there are no other nodes in the buffer
569 * tree that read the same input stream (i.e. if \a btrn has no siblings), a
570 * node may modify its input buffer directly and push down the modified buffer
571 * to its children, thereby avoiding to allocate a possibly large additional
572 * buffer.
573 *
574 * Since the buffer tree may change at any time, this function should be called
575 * during each post_select call.
576 *
577 * \return True if \a btrn has no siblings.
578 */
579 bool btr_inplace_ok(struct btr_node *btrn)
580 {
581 struct btr_buffer_reference *br;
582 FOR_EACH_BUFFER_REF(br, btrn) {
583 struct btr_buffer *btrb = br->btrb;
584 if (btrb->refcount > 1)
585 return false;
586 if (btrb->dont_free == true)
587 return false;
588 }
589 return true;
590 }
591
592 static inline size_t br_available_bytes(struct btr_buffer_reference *br)
593 {
594 return br->btrb->size - br->consumed;
595 }
596
597 static size_t btr_get_buffer_by_reference(struct btr_buffer_reference *br, char **buf)
598 {
599 if (buf)
600 *buf = br->btrb->buf + br->consumed;
601 return br_available_bytes(br);
602 }
603
604 /**
605 * Obtain the next buffer of the input queue, omitting data.
606 *
607 * \param btrn The node whose input queue is to be queried.
608 * \param omit Number of bytes to be omitted.
609 * \param bufp Result pointer. It is OK to pass \p NULL here.
610 *
611 * If a buffer tree node needs more input data but can not consume the data it
612 * already has (because it might be needed again later) this function can be
613 * used instead of btr_next_buffer() to get a reference to the buffer obtained
614 * by skipping the given number of bytes. Skipped input bytes are not consumed.
615 *
616 * With a zero \a omit argument, this function is equivalent to \ref
617 * btr_next_buffer().
618 *
619 * \return Number of bytes in \a bufp. If there are less than or equal to \a
620 * omit many bytes available in the input queue of the buffer tree node pointed
621 * to by \a btrn, the function returns zero and the value of \a bufp is
622 * undefined.
623 */
624 size_t btr_next_buffer_omit(struct btr_node *btrn, size_t omit, char **bufp)
625 {
626 struct btr_buffer_reference *br;
627 size_t wrap_count, sz, rv = 0;
628 char *buf, *result = NULL;
629
630 br = get_first_input_br(btrn);
631 if (!br)
632 return 0;
633 wrap_count = br->wrap_count;
634 if (wrap_count > 0) { /* we have a wrap buffer */
635 sz = btr_get_buffer_by_reference(br, &buf);
636 if (sz > omit) { /* and it's big enough */
637 result = buf + omit;
638 rv = sz - omit;
639 /*
640 * Wrap buffers are allocated by malloc(), so the next
641 * buffer ref will not align nicely, so we return the
642 * tail of the wrap buffer.
643 */
644 goto out;
645 }
646 /*
647 * The next wrap_count bytes exist twice, in the wrap buffer
648 * and as a buffer reference in the buffer tree pool.
649 */
650 omit += wrap_count;
651 }
652 /*
653 * For buffer tree pools, the buffers in the list align, i.e. the next
654 * buffer in the list starts directly at the end of its predecessor. In
655 * this case we merge adjacent buffers and return one larger buffer
656 * instead.
657 */
658 FOR_EACH_BUFFER_REF(br, btrn) {
659 sz = btr_get_buffer_by_reference(br, &buf);
660 if (result) {
661 if (result + rv != buf)
662 goto out;
663 rv += sz;
664 } else if (sz > omit) {
665 result = buf + omit;
666 rv = sz - omit;
667 } else
668 omit -= sz;
669 }
670 if (!result)
671 return 0;
672 out:
673 if (bufp)
674 *bufp = result;
675 return rv;
676 }
677
678 /**
679 * Obtain the next buffer of the input queue of a buffer tree node.
680 *
681 * \param btrn The node whose input queue is to be queried.
682 * \param bufp Result pointer.
683 *
684 * \return The number of bytes that can be read from buf.
685 *
686 * The call of this function is is equivalent to calling \ref
687 * btr_next_buffer_omit() with an \a omit value of zero.
688 */
689 size_t btr_next_buffer(struct btr_node *btrn, char **bufp)
690 {
691 return btr_next_buffer_omit(btrn, 0, bufp);
692 }
693
694 /**
695 * Deallocate the given number of bytes from the input queue.
696 *
697 * \param btrn The buffer tree node.
698 * \param numbytes The number of bytes to be deallocated.
699 *
700 * This function must be used to get rid of existing buffer references in the
701 * node's input queue. If no references to a buffer remain, the underlying
702 * buffers are either freed (in the non-buffer pool case) or the read head of
703 * the buffer pool is being advanced.
704 *
705 * Note that \a numbytes may be smaller than the buffer size. In this case the
706 * buffer is not deallocated and subsequent calls to btr_next_buffer() return
707 * the remaining part of the buffer.
708 */
709 void btr_consume(struct btr_node *btrn, size_t numbytes)
710 {
711 struct btr_buffer_reference *br, *tmp;
712 size_t sz;
713
714 if (numbytes == 0)
715 return;
716 br = get_first_input_br(btrn);
717 assert(br);
718
719 if (br->wrap_count == 0) {
720 /*
721 * No wrap buffer. Drop buffer references whose buffer
722 * has been fully used. */
723 FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn) {
724 if (br->consumed + numbytes <= br->btrb->size) {
725 br->consumed += numbytes;
726 if (br->consumed == br->btrb->size)
727 btr_drop_buffer_reference(br);
728 return;
729 }
730 numbytes -= br->btrb->size - br->consumed;
731 btr_drop_buffer_reference(br);
732 }
733 assert(false);
734 }
735 /*
736 * We have a wrap buffer, consume from it. If in total, i.e. including
737 * previous calls to brt_consume(), less than wrap_count has been
738 * consumed, there's nothing more we can do.
739 *
740 * Otherwise we drop the wrap buffer and consume from subsequent
741 * buffers of the input queue the correct amount of bytes. This is the
742 * total number of bytes that have been consumed from the wrap buffer.
743 */
744 PARA_DEBUG_LOG("consuming %zu/%zu bytes from wrap buffer\n", numbytes,
745 br_available_bytes(br));
746
747 assert(numbytes <= br_available_bytes(br));
748 if (br->consumed + numbytes < br->wrap_count) {
749 br->consumed += numbytes;
750 return;
751 }
752 PARA_DEBUG_LOG("dropping wrap buffer (%zu bytes)\n", br->btrb->size);
753 /* get rid of the wrap buffer */
754 sz = br->consumed + numbytes;
755 btr_drop_buffer_reference(br);
756 return btr_consume(btrn, sz);
757 }
758
759 /**
760 * Clear the input queue of a buffer tree node.
761 *
762 * \param btrn The node whose input queue should be cleared.
763 */
764 void btr_drain(struct btr_node *btrn)
765 {
766 struct btr_buffer_reference *br, *tmp;
767
768 FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn)
769 btr_drop_buffer_reference(br);
770 }
771
772 /**
773 * Remove a node from a buffer tree.
774 *
775 * \param btrnp Determines the node to remove.
776 *
777 * This orphans all children of the node given by \a btrnp and removes this
778 * node from the child list of its parent. Moreover, the input queue is flushed
779 * and the node pointer given by \a btrp is set to \p NULL.
780 *
781 * \sa \ref btr_splice_out_node.
782 */
783 void btr_remove_node(struct btr_node **btrnp)
784 {
785 struct btr_node *ch;
786 struct btr_node *btrn;
787
788 if (!btrnp)
789 return;
790 btrn = *btrnp;
791 if (!btrn)
792 goto out;
793 PARA_INFO_LOG("removing btr node %s from buffer tree\n", btrn->name);
794 FOR_EACH_CHILD(ch, btrn)
795 ch->parent = NULL;
796 btr_drain(btrn);
797 if (btrn->parent)
798 list_del(&btrn->node);
799 free(btrn->name);
800 free(btrn);
801 out:
802 *btrnp = NULL;
803 }
804
805 /**
806 * Return the amount of available input bytes of a buffer tree node.
807 *
808 * \param btrn The node whose input size should be computed.
809 *
810 * \return The total number of bytes available in the node's input
811 * queue.
812 *
813 * This simply iterates over all buffer references in the input queue and
814 * returns the sum of the sizes of all references.
815 */
816 size_t btr_get_input_queue_size(struct btr_node *btrn)
817 {
818 struct btr_buffer_reference *br;
819 size_t size = 0, wrap_consumed = 0;
820
821 FOR_EACH_BUFFER_REF(br, btrn) {
822 if (br->wrap_count != 0) {
823 wrap_consumed = br->consumed;
824 continue;
825 }
826 size += br_available_bytes(br);
827 }
828 assert(wrap_consumed <= size);
829 size -= wrap_consumed;
830 return size;
831 }
832
833 /**
834 * Remove a node from the buffer tree, reconnecting parent and children.
835 *
836 * \param btrn The node to splice out.
837 *
838 * This function is used by buffer tree nodes that do not exist during the
839 * whole lifetime of the buffer tree. Unlike btr_remove_node(), calling
840 * btr_splice_out_node() does not split the tree into disconnected components
841 * but reconnects the buffer tree by making all child nodes of \a btrn children
842 * of the parent of \a btrn.
843 */
844 void btr_splice_out_node(struct btr_node *btrn)
845 {
846 struct btr_node *ch, *tmp;
847
848 assert(btrn);
849 PARA_NOTICE_LOG("splicing out %s\n", btrn->name);
850 btr_pushdown(btrn);
851 if (btrn->parent)
852 list_del(&btrn->node);
853 FOR_EACH_CHILD_SAFE(ch, tmp, btrn) {
854 PARA_INFO_LOG("parent(%s): %s\n", ch->name,
855 btrn->parent? btrn->parent->name : "NULL");
856 ch->parent = btrn->parent;
857 if (btrn->parent)
858 list_move(&ch->node, &btrn->parent->children);
859 }
860 assert(list_empty(&btrn->children));
861 btrn->parent = NULL;
862 }
863
864 /**
865 * Return number of queued output bytes of a buffer tree node.
866 *
867 * \param btrn The node whose output queue size should be computed.
868 *
869 * \return This function iterates over all children of the given node and
870 * returns the size of the largest input queue.
871 */
872 size_t btr_get_output_queue_size(struct btr_node *btrn)
873 {
874 size_t max_size = 0;
875 struct btr_node *ch;
876
877 FOR_EACH_CHILD(ch, btrn) {
878 size_t size = btr_get_input_queue_size(ch);
879 max_size = PARA_MAX(max_size, size);
880 }
881 return max_size;
882 }
883
884 /**
885 * Execute an inter-node command on the given node or on a parent node.
886 *
887 * \param btrn The node to start looking.
888 * \param command The command to execute.
889 * \param value_result Additional arguments and result value.
890 *
891 * This function traverses the buffer tree from \a btrn upwards and looks for
892 * the first node that understands \a command. On this node \a command is
893 * executed, and the result is stored in \a value_result.
894 *
895 * \return \p -ENOTSUP if no parent node of \a btrn understands \a command.
896 * Otherwise the return value of the command handler is returned.
897 *
898 * \sa \ref receiver::execute, filter::execute, writer::execute.
899 */
900 int btr_exec_up(struct btr_node *btrn, const char *command, char **value_result)
901 {
902 int ret;
903
904 for (; btrn; btrn = btrn->parent) {
905 if (!btrn->execute)
906 continue;
907 PARA_INFO_LOG("executing %s on %s\n", command, btrn->name);
908 ret = btrn->execute(btrn, command, value_result);
909 if (ret == -ERRNO_TO_PARA_ERROR(ENOTSUP))
910 continue;
911 if (ret < 0)
912 return ret;
913 if (value_result && *value_result)
914 PARA_INFO_LOG("%s(%s): %s\n", command, btrn->name,
915 *value_result);
916 return 1;
917 }
918 return -ERRNO_TO_PARA_ERROR(ENOTSUP);
919 }
920
921 /**
922 * Obtain the context of a buffer node tree.
923 *
924 * \param btrn The node whose output queue size should be computed.
925 *
926 * \return A pointer to the \a context address specified at node creation time.
927 *
928 * \sa btr_new_node(), struct \ref btr_node_description.
929 */
930 void *btr_context(struct btr_node *btrn)
931 {
932 return btrn->context;
933 }
934
935 static bool need_buffer_pool_merge(struct btr_node *btrn)
936 {
937 struct btr_buffer_reference *br = get_first_input_br(btrn);
938
939 if (!br)
940 return false;
941 if (br->wrap_count != 0)
942 return true;
943 if (br->btrb->pool)
944 return true;
945 return false;
946 }
947
948 static void merge_input_pool(struct btr_node *btrn, size_t dest_size)
949 {
950 struct btr_buffer_reference *br, *wbr = NULL;
951 int num_refs; /* including wrap buffer */
952 char *buf, *buf1 = NULL, *buf2 = NULL;
953 size_t sz, sz1 = 0, sz2 = 0, wb_consumed = 0;
954
955 br = get_first_input_br(btrn);
956 if (!br || br_available_bytes(br) >= dest_size)
957 return;
958 num_refs = 0;
959 FOR_EACH_BUFFER_REF(br, btrn) {
960 num_refs++;
961 sz = btr_get_buffer_by_reference(br, &buf);
962 if (sz == 0)
963 break;
964 if (br->wrap_count != 0) {
965 assert(!wbr);
966 assert(num_refs == 1);
967 wbr = br;
968 if (sz >= dest_size)
969 return;
970 wb_consumed = br->consumed;
971 continue;
972 }
973 if (!buf1) {
974 buf1 = buf;
975 sz1 = sz;
976 goto next;
977 }
978 if (buf1 + sz1 == buf) {
979 sz1 += sz;
980 goto next;
981 }
982 if (!buf2) {
983 buf2 = buf;
984 sz2 = sz;
985 goto next;
986 }
987 assert(buf2 + sz2 == buf);
988 sz2 += sz;
989 next:
990 if (sz1 + sz2 >= dest_size + wb_consumed)
991 break;
992 }
993 if (!buf2) /* nothing to do */
994 return;
995 assert(buf1 && sz2 > 0);
996 /*
997 * If the second buffer is large, we only take the first part of it to
998 * avoid having to memcpy() huge buffers.
999 */
1000 sz2 = PARA_MIN(sz2, (size_t)(64 * 1024));
1001 if (!wbr) {
1002 /* Make a new wrap buffer combining buf1 and buf2. */
1003 sz = sz1 + sz2;
1004 buf = para_malloc(sz);
1005 PARA_DEBUG_LOG("merging input buffers: (%p:%zu, %p:%zu) -> %p:%zu\n",
1006 buf1, sz1, buf2, sz2, buf, sz);
1007 memcpy(buf, buf1, sz1);
1008 memcpy(buf + sz1, buf2, sz2);
1009 br = para_calloc(sizeof(*br));
1010 br->btrb = new_btrb(buf, sz);
1011 br->btrb->refcount = 1;
1012 br->consumed = 0;
1013 /* This is a wrap buffer */
1014 br->wrap_count = sz1;
1015 para_list_add(&br->node, &btrn->input_queue);
1016 return;
1017 }
1018 /*
1019 * We already have a wrap buffer, but it is too small. It might be
1020 * partially used.
1021 */
1022 if (wbr->wrap_count == sz1 && wbr->btrb->size >= sz1 + sz2) /* nothing we can do about it */
1023 return;
1024 sz = sz1 + sz2 - wbr->btrb->size; /* amount of new data */
1025 PARA_DEBUG_LOG("increasing wrap buffer %zu -> %zu\n", wbr->btrb->size,
1026 wbr->btrb->size + sz);
1027 wbr->btrb->size += sz;
1028 wbr->btrb->buf = para_realloc(wbr->btrb->buf, wbr->btrb->size);
1029 /* copy the new data to the end of the reallocated buffer */
1030 assert(sz2 >= sz);
1031 memcpy(wbr->btrb->buf + wbr->btrb->size - sz, buf2 + sz2 - sz, sz);
1032 }
1033
1034 /**
1035 * Merge the first two input buffers into one.
1036 *
1037 * This is a quite expensive operation.
1038 *
1039 * \return The number of buffers that have been available (zero, one or two).
1040 */
1041 static int merge_input(struct btr_node *btrn)
1042 {
1043 struct btr_buffer_reference *brs[2], *br;
1044 char *bufs[2], *buf;
1045 size_t szs[2], sz;
1046 int i;
1047
1048 if (list_empty(&btrn->input_queue))
1049 return 0;
1050 if (list_is_singular(&btrn->input_queue))
1051 return 1;
1052 i = 0;
1053 /* get references to the first two buffers */
1054 FOR_EACH_BUFFER_REF(br, btrn) {
1055 brs[i] = br;
1056 szs[i] = btr_get_buffer_by_reference(brs[i], bufs + i);
1057 i++;
1058 if (i == 2)
1059 break;
1060 }
1061 assert(i == 2);
1062 /* make a new btrb that combines the two buffers and a br to it. */
1063 sz = szs[0] + szs[1];
1064 buf = para_malloc(sz);
1065 PARA_DEBUG_LOG("%s: memory merging input buffers: (%zu, %zu) -> %zu\n",
1066 btrn->name, szs[0], szs[1], sz);
1067 memcpy(buf, bufs[0], szs[0]);
1068 memcpy(buf + szs[0], bufs[1], szs[1]);
1069
1070 br = para_calloc(sizeof(*br));
1071 br->btrb = new_btrb(buf, sz);
1072 br->btrb->refcount = 1;
1073
1074 /* replace the first two refs by the new one */
1075 btr_drop_buffer_reference(brs[0]);
1076 btr_drop_buffer_reference(brs[1]);
1077 para_list_add(&br->node, &btrn->input_queue);
1078 return 2;
1079 }
1080
1081 /**
1082 * Combine input queue buffers.
1083 *
1084 * \param btrn The buffer tree node whose input should be merged.
1085 * \param dest_size Stop merging if a buffer of at least this size exists.
1086 *
1087 * Used to combine as many buffers as needed into a single buffer whose size is
1088 * at least \a dest_size. This function is rather cheap in case the parent node
1089 * uses buffer pools and rather expensive otherwise.
1090 *
1091 * Note that if less than \a dest_size bytes are available in total, this
1092 * function does nothing and subsequent calls to btr_next_buffer() will still
1093 * return a buffer size less than \a dest_size.
1094 */
1095 void btr_merge(struct btr_node *btrn, size_t dest_size)
1096 {
1097 if (need_buffer_pool_merge(btrn))
1098 return merge_input_pool(btrn, dest_size);
1099 for (;;) {
1100 char *buf;
1101 size_t len = btr_next_buffer(btrn, &buf);
1102 if (len >= dest_size)
1103 return;
1104 PARA_DEBUG_LOG("input size = %zu < %zu = dest\n", len, dest_size);
1105 if (merge_input(btrn) < 2)
1106 return;
1107 }
1108 }
1109
1110 static bool btr_eof(struct btr_node *btrn)
1111 {
1112 char *buf;
1113 size_t len = btr_next_buffer(btrn, &buf);
1114
1115 return (len == 0 && btr_no_parent(btrn));
1116 }
1117
1118 static void log_tree_recursively(struct btr_node *btrn, int loglevel, int depth)
1119 {
1120 struct btr_node *ch;
1121 const char spaces[] = " ", *space = spaces + 16 - depth;
1122
1123 if (depth > 16)
1124 return;
1125 para_log(loglevel, "%s%s\n", space, btrn->name);
1126 FOR_EACH_CHILD(ch, btrn)
1127 log_tree_recursively(ch, loglevel, depth + 1);
1128 }
1129
1130 /**
1131 * Write the current buffer (sub-)tree to the log.
1132 *
1133 * \param btrn Start logging at this node.
1134 * \param loglevel Set severity with which the tree should be logged.
1135 */
1136 void btr_log_tree(struct btr_node *btrn, int loglevel)
1137 {
1138 return log_tree_recursively(btrn, loglevel, 0);
1139 }
1140
1141 /**
1142 * Find the node with the given name in the buffer tree.
1143 *
1144 * \param name The name of the node to search.
1145 * \param root Where to start the search.
1146 *
1147 * \return A pointer to the node with the given name on success. If \a name is
1148 * \p NULL, the function returns \a root. If there is no node with the given
1149 * name, \p NULL is returned.
1150 */
1151 struct btr_node *btr_search_node(const char *name, struct btr_node *root)
1152 {
1153 struct btr_node *ch;
1154
1155 if (!name)
1156 return root;
1157 if (!strcmp(root->name, name))
1158 return root;
1159 FOR_EACH_CHILD(ch, root) {
1160 struct btr_node *result = btr_search_node(name, ch);
1161 if (result)
1162 return result;
1163 }
1164 return NULL;
1165 }
1166
1167 /** 640K ought to be enough for everybody ;) */
1168 #define BTRN_MAX_PENDING (96 * 1024)
1169
1170 /**
1171 * Return the current state of a buffer tree node.
1172 *
1173 * \param btrn The node whose state should be queried.
1174 * \param min_iqs The minimal input queue size.
1175 * \param type The supposed type of \a btrn.
1176 *
1177 * Most users of the buffer tree subsystem call this function from both
1178 * their pre_select and the post_select methods.
1179 *
1180 * \return Negative if an error condition was detected, zero if there
1181 * is nothing to do and positive otherwise.
1182 *
1183 * Examples:
1184 *
1185 * - If a non-root node has no parent and an empty input queue, the function
1186 * returns \p -E_BTR_EOF. Similarly, if a non-leaf node has no children, \p
1187 * -E_BTR_NO_CHILD is returned.
1188 *
1189 * - If less than \a min_iqs many bytes are available in the input queue and no
1190 * EOF condition was detected, the function returns zero.
1191 *
1192 * - If there's plenty of data left in the input queue of the children of \a
1193 * btrn, the function also returns zero in order to bound the memory usage of
1194 * the buffer tree.
1195 */
1196 int btr_node_status(struct btr_node *btrn, size_t min_iqs,
1197 enum btr_node_type type)
1198 {
1199 size_t iqs;
1200
1201 assert(btrn);
1202 if (type != BTR_NT_LEAF) {
1203 if (btr_no_children(btrn))
1204 return -E_BTR_NO_CHILD;
1205 if (btr_get_output_queue_size(btrn) > BTRN_MAX_PENDING)
1206 return 0;
1207 }
1208 if (type != BTR_NT_ROOT) {
1209 if (btr_eof(btrn))
1210 return -E_BTR_EOF;
1211 iqs = btr_get_input_queue_size(btrn);
1212 if (iqs == 0) /* we have a parent, because not eof */
1213 return 0;
1214 if (iqs < min_iqs && !btr_no_parent(btrn))
1215 return 0;
1216 }
1217 return 1;
1218 }
1219
1220 /**
1221 * Get the time of the first I/O for a buffer tree node.
1222 *
1223 * \param btrn The node whose I/O time should be obtained.
1224 * \param tv Result pointer.
1225 *
1226 * Mainly useful for the time display of para_audiod.
1227 */
1228 void btr_get_node_start(struct btr_node *btrn, struct timeval *tv)
1229 {
1230 *tv = btrn->start;
1231 }
1232
1233 /**
1234 * Get the parent node of a buffer tree node.
1235 *
1236 * \param btrn The node whose parent should be returned.
1237 *
1238 * \a btrn must not be \p NULL.
1239 *
1240 * \return The parent of \a btrn, or \p NULL if \a btrn is the
1241 * root node of the buffer tree.
1242 */
1243 struct btr_node *btr_parent(struct btr_node *btrn)
1244 {
1245 return btrn->parent;
1246 }