Merge branch 't/mood_fix'
[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 assert(size != 0);
390 if (list_empty(&btrn->children)) {
391 free(buf);
392 return;
393 }
394 btrb = new_btrb(buf, size);
395 add_btrb_to_children(btrb, btrn, 0);
396 }
397
398 /**
399 * Insert a buffer into the buffer tree, non-freeing variant.
400 *
401 * \param buf See \ref btr_add_output().
402 * \param size See \ref btr_add_output().
403 * \param btrn See \ref btr_add_output().
404 *
405 * This is similar to btr_add_output() but additionally sets the \p dont_free
406 * flag on \a buf. If the refcount for the buffer drops to zero, \a buf will
407 * not be deallocated if this flag is set.
408 *
409 * The \p dont_free bit also prevents the children of \a btrn from modifying
410 * the buffer contents inplace. Specifically, \ref btr_inplace_ok() returns
411 * false if there is any buffer in the input queue with the \p dont_free bit
412 * set.
413 */
414 void btr_add_output_dont_free(const char *buf, size_t size, struct btr_node *btrn)
415 {
416 struct btr_buffer *btrb;
417
418 assert(size != 0);
419 if (list_empty(&btrn->children))
420 return;
421 btrb = new_btrb((char *)buf, size);
422 btrb->dont_free = true;
423 add_btrb_to_children(btrb, btrn, 0);
424 }
425
426 /**
427 * Feed data to child nodes of a buffer tree node.
428 *
429 * \param btrp The buffer pool.
430 * \param size The number of bytes to be allocated and fed to each child.
431 * \param btrn The node whose children are to be fed.
432 *
433 * This function allocates the amount of bytes from the buffer pool area,
434 * starting at the current value of the write head, and creates buffer
435 * references to the resulting part of the buffer pool area, one for each child
436 * of \a btrn. The references are then fed into the input queue of each child.
437 */
438 void btr_add_output_pool(struct btr_pool *btrp, size_t size,
439 struct btr_node *btrn)
440 {
441 struct btr_buffer *btrb;
442 char *buf;
443 size_t avail;
444
445 assert(size != 0);
446 if (list_empty(&btrn->children))
447 return;
448 avail = btr_pool_get_buffer(btrp, &buf);
449 assert(avail >= size);
450 btr_pool_allocate(btrp, size);
451 btrb = new_btrb(buf, size);
452 btrb->pool = btrp;
453 add_btrb_to_children(btrb, btrn, 0);
454 }
455
456 /**
457 * Copy data to write head of a buffer pool and feed it to all children nodes.
458 *
459 * \param src The source buffer.
460 * \param n The size of the source buffer in bytes.
461 * \param btrp The destination buffer pool.
462 * \param btrn Add the data as output of this node.
463 *
464 * This is expensive. The caller must make sure the data fits into the buffer
465 * pool area.
466 */
467 void btr_copy(const void *src, size_t n, struct btr_pool *btrp,
468 struct btr_node *btrn)
469 {
470 char *buf;
471 size_t sz, copy;
472
473 if (n == 0)
474 return;
475 assert(n <= btr_pool_unused(btrp));
476 sz = btr_pool_get_buffer(btrp, &buf);
477 copy = PARA_MIN(sz, n);
478 memcpy(buf, src, copy);
479 btr_add_output_pool(btrp, copy, btrn);
480 if (copy == n)
481 return;
482 sz = btr_pool_get_buffer(btrp, &buf);
483 assert(sz >= n - copy);
484 memcpy(buf, src + copy, n - copy);
485 btr_add_output_pool(btrp, n - copy, btrn);
486 }
487
488 static void btr_pushdown_br(struct btr_buffer_reference *br, struct btr_node *btrn)
489 {
490 add_btrb_to_children(br->btrb, btrn, br->consumed);
491 btr_drop_buffer_reference(br);
492 }
493
494 /**
495 * Feed all buffer references of the input queue through the output channel.
496 *
497 * \param btrn The node whose buffer references should be pushed down.
498 *
499 * This function is useful for filters that do not change the contents of the
500 * buffers at all, like the wav filter or the amp filter if no amplification
501 * was specified. This function is rather cheap.
502 *
503 * \sa \ref btr_pushdown_one().
504 */
505 void btr_pushdown(struct btr_node *btrn)
506 {
507 struct btr_buffer_reference *br, *tmp;
508
509 FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn)
510 btr_pushdown_br(br, btrn);
511 }
512
513 /**
514 * Feed the next buffer of the input queue through the output channel.
515 *
516 * \param btrn The node whose first input queue buffer should be pushed down.
517 *
518 * This works like \ref btr_pushdown() but pushes down only one buffer
519 * reference.
520 */
521 void btr_pushdown_one(struct btr_node *btrn)
522 {
523 struct btr_buffer_reference *br;
524
525 if (list_empty(&btrn->input_queue))
526 return;
527 br = list_first_entry(&btrn->input_queue, struct btr_buffer_reference, node);
528 btr_pushdown_br(br, btrn);
529 }
530
531 /*
532 * Find out whether a node is a leaf node.
533 *
534 * \param btrn The node to check.
535 *
536 * \return True if this node has no children. False otherwise.
537 */
538 static bool btr_no_children(struct btr_node *btrn)
539 {
540 return list_empty(&btrn->children);
541 }
542
543 /**
544 * Find out whether a node is an orphan node.
545 *
546 * \param btrn The buffer tree node.
547 *
548 * \return True if \a btrn has no parent.
549 *
550 * This function will always return true for the root node. However in case
551 * nodes have been removed from the tree, other nodes may become orphans too.
552 */
553 bool btr_no_parent(struct btr_node *btrn)
554 {
555 return !btrn->parent;
556 }
557
558 /**
559 * Find out whether it is OK to change an input buffer.
560 *
561 * \param btrn The buffer tree node to check.
562 *
563 * This is used by filters that produce exactly the same amount of output as
564 * there is input. The amp filter which multiplies each sample by some number
565 * is an example of such a filter. If there are no other nodes in the buffer
566 * tree that read the same input stream (i.e. if \a btrn has no siblings), a
567 * node may modify its input buffer directly and push down the modified buffer
568 * to its children, thereby avoiding to allocate a possibly large additional
569 * buffer.
570 *
571 * Since the buffer tree may change at any time, this function should be called
572 * during each post_select call.
573 *
574 * \return True if \a btrn has no siblings.
575 */
576 bool btr_inplace_ok(struct btr_node *btrn)
577 {
578 struct btr_buffer_reference *br;
579 FOR_EACH_BUFFER_REF(br, btrn) {
580 struct btr_buffer *btrb = br->btrb;
581 if (btrb->refcount > 1)
582 return false;
583 if (btrb->dont_free == true)
584 return false;
585 }
586 return true;
587 }
588
589 static inline size_t br_available_bytes(struct btr_buffer_reference *br)
590 {
591 return br->btrb->size - br->consumed;
592 }
593
594 static size_t btr_get_buffer_by_reference(struct btr_buffer_reference *br, char **buf)
595 {
596 if (buf)
597 *buf = br->btrb->buf + br->consumed;
598 return br_available_bytes(br);
599 }
600
601 /**
602 * Obtain the next buffer of the input queue, omitting data.
603 *
604 * \param btrn The node whose input queue is to be queried.
605 * \param omit Number of bytes to be omitted.
606 * \param bufp Result pointer. It is OK to pass \p NULL here.
607 *
608 * If a buffer tree node needs more input data but can not consume the data it
609 * already has (because it might be needed again later) this function can be
610 * used instead of btr_next_buffer() to get a reference to the buffer obtained
611 * by skipping the given number of bytes. Skipped input bytes are not consumed.
612 *
613 * With a zero \a omit argument, this function is equivalent to \ref
614 * btr_next_buffer().
615 *
616 * \return Number of bytes in \a bufp. If there are less than or equal to \a
617 * omit many bytes available in the input queue of the buffer tree node pointed
618 * to by \a btrn, the function returns zero and the value of \a bufp is
619 * undefined.
620 */
621 size_t btr_next_buffer_omit(struct btr_node *btrn, size_t omit, char **bufp)
622 {
623 struct btr_buffer_reference *br;
624 size_t wrap_count, sz, rv = 0;
625 char *buf, *result = NULL;
626
627 br = get_first_input_br(btrn);
628 if (!br)
629 return 0;
630 wrap_count = br->wrap_count;
631 if (wrap_count > 0) { /* we have a wrap buffer */
632 sz = btr_get_buffer_by_reference(br, &buf);
633 if (sz > omit) { /* and it's big enough */
634 result = buf + omit;
635 rv = sz - omit;
636 /*
637 * Wrap buffers are allocated by malloc(), so the next
638 * buffer ref will not align nicely, so we return the
639 * tail of the wrap buffer.
640 */
641 goto out;
642 }
643 /*
644 * The next wrap_count bytes exist twice, in the wrap buffer
645 * and as a buffer reference in the buffer tree pool.
646 */
647 omit += wrap_count;
648 }
649 /*
650 * For buffer tree pools, the buffers in the list align, i.e. the next
651 * buffer in the list starts directly at the end of its predecessor. In
652 * this case we merge adjacent buffers and return one larger buffer
653 * instead.
654 */
655 FOR_EACH_BUFFER_REF(br, btrn) {
656 sz = btr_get_buffer_by_reference(br, &buf);
657 if (result) {
658 if (result + rv != buf)
659 goto out;
660 rv += sz;
661 } else if (sz > omit) {
662 result = buf + omit;
663 rv = sz - omit;
664 } else
665 omit -= sz;
666 }
667 if (!result)
668 return 0;
669 out:
670 if (bufp)
671 *bufp = result;
672 return rv;
673 }
674
675 /**
676 * Obtain the next buffer of the input queue of a buffer tree node.
677 *
678 * \param btrn The node whose input queue is to be queried.
679 * \param bufp Result pointer.
680 *
681 * \return The number of bytes that can be read from buf.
682 *
683 * The call of this function is is equivalent to calling \ref
684 * btr_next_buffer_omit() with an \a omit value of zero.
685 */
686 size_t btr_next_buffer(struct btr_node *btrn, char **bufp)
687 {
688 return btr_next_buffer_omit(btrn, 0, bufp);
689 }
690
691 /**
692 * Deallocate the given number of bytes from the input queue.
693 *
694 * \param btrn The buffer tree node.
695 * \param numbytes The number of bytes to be deallocated.
696 *
697 * This function must be used to get rid of existing buffer references in the
698 * node's input queue. If no references to a buffer remain, the underlying
699 * buffers are either freed (in the non-buffer pool case) or the read head of
700 * the buffer pool is being advanced.
701 *
702 * Note that \a numbytes may be smaller than the buffer size. In this case the
703 * buffer is not deallocated and subsequent calls to btr_next_buffer() return
704 * the remaining part of the buffer.
705 */
706 void btr_consume(struct btr_node *btrn, size_t numbytes)
707 {
708 struct btr_buffer_reference *br, *tmp;
709 size_t sz;
710
711 if (numbytes == 0)
712 return;
713 br = get_first_input_br(btrn);
714 assert(br);
715
716 if (br->wrap_count == 0) {
717 /*
718 * No wrap buffer. Drop buffer references whose buffer
719 * has been fully used. */
720 FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn) {
721 if (br->consumed + numbytes <= br->btrb->size) {
722 br->consumed += numbytes;
723 if (br->consumed == br->btrb->size)
724 btr_drop_buffer_reference(br);
725 return;
726 }
727 numbytes -= br->btrb->size - br->consumed;
728 btr_drop_buffer_reference(br);
729 }
730 assert(false);
731 }
732 /*
733 * We have a wrap buffer, consume from it. If in total, i.e. including
734 * previous calls to brt_consume(), less than wrap_count has been
735 * consumed, there's nothing more we can do.
736 *
737 * Otherwise we drop the wrap buffer and consume from subsequent
738 * buffers of the input queue the correct amount of bytes. This is the
739 * total number of bytes that have been consumed from the wrap buffer.
740 */
741 PARA_DEBUG_LOG("consuming %zu/%zu bytes from wrap buffer\n", numbytes,
742 br_available_bytes(br));
743
744 assert(numbytes <= br_available_bytes(br));
745 if (br->consumed + numbytes < br->wrap_count) {
746 br->consumed += numbytes;
747 return;
748 }
749 PARA_DEBUG_LOG("dropping wrap buffer (%zu bytes)\n", br->btrb->size);
750 /* get rid of the wrap buffer */
751 sz = br->consumed + numbytes;
752 btr_drop_buffer_reference(br);
753 return btr_consume(btrn, sz);
754 }
755
756 /**
757 * Clear the input queue of a buffer tree node.
758 *
759 * \param btrn The node whose input queue should be cleared.
760 */
761 void btr_drain(struct btr_node *btrn)
762 {
763 struct btr_buffer_reference *br, *tmp;
764
765 FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn)
766 btr_drop_buffer_reference(br);
767 }
768
769 /**
770 * Remove a node from a buffer tree.
771 *
772 * \param btrnp Determines the node to remove.
773 *
774 * This orphans all children of the node given by \a btrnp and removes this
775 * node from the child list of its parent. Moreover, the input queue is flushed
776 * and the node pointer given by \a btrp is set to \p NULL.
777 *
778 * \sa \ref btr_splice_out_node.
779 */
780 void btr_remove_node(struct btr_node **btrnp)
781 {
782 struct btr_node *ch;
783 struct btr_node *btrn;
784
785 if (!btrnp)
786 return;
787 btrn = *btrnp;
788 if (!btrn)
789 goto out;
790 PARA_INFO_LOG("removing btr node %s from buffer tree\n", btrn->name);
791 FOR_EACH_CHILD(ch, btrn)
792 ch->parent = NULL;
793 btr_drain(btrn);
794 if (btrn->parent)
795 list_del(&btrn->node);
796 free(btrn->name);
797 free(btrn);
798 out:
799 *btrnp = NULL;
800 }
801
802 /**
803 * Return the amount of available input bytes of a buffer tree node.
804 *
805 * \param btrn The node whose input size should be computed.
806 *
807 * \return The total number of bytes available in the node's input
808 * queue.
809 *
810 * This simply iterates over all buffer references in the input queue and
811 * returns the sum of the sizes of all references.
812 */
813 size_t btr_get_input_queue_size(struct btr_node *btrn)
814 {
815 struct btr_buffer_reference *br;
816 size_t size = 0, wrap_consumed = 0;
817
818 FOR_EACH_BUFFER_REF(br, btrn) {
819 if (br->wrap_count != 0) {
820 wrap_consumed = br->consumed;
821 continue;
822 }
823 size += br_available_bytes(br);
824 }
825 assert(wrap_consumed <= size);
826 size -= wrap_consumed;
827 return size;
828 }
829
830 /**
831 * Remove a node from the buffer tree, reconnecting parent and children.
832 *
833 * \param btrn The node to splice out.
834 *
835 * This function is used by buffer tree nodes that do not exist during the
836 * whole lifetime of the buffer tree. Unlike btr_remove_node(), calling
837 * btr_splice_out_node() does not split the tree into disconnected components
838 * but reconnects the buffer tree by making all child nodes of \a btrn children
839 * of the parent of \a btrn.
840 */
841 void btr_splice_out_node(struct btr_node *btrn)
842 {
843 struct btr_node *ch, *tmp;
844
845 assert(btrn);
846 PARA_NOTICE_LOG("splicing out %s\n", btrn->name);
847 btr_pushdown(btrn);
848 if (btrn->parent)
849 list_del(&btrn->node);
850 FOR_EACH_CHILD_SAFE(ch, tmp, btrn) {
851 PARA_INFO_LOG("parent(%s): %s\n", ch->name,
852 btrn->parent? btrn->parent->name : "NULL");
853 ch->parent = btrn->parent;
854 if (btrn->parent)
855 list_move(&ch->node, &btrn->parent->children);
856 }
857 assert(list_empty(&btrn->children));
858 btrn->parent = NULL;
859 }
860
861 /**
862 * Return number of queued output bytes of a buffer tree node.
863 *
864 * \param btrn The node whose output queue size should be computed.
865 *
866 * \return This function iterates over all children of the given node and
867 * returns the size of the largest input queue.
868 */
869 size_t btr_get_output_queue_size(struct btr_node *btrn)
870 {
871 size_t max_size = 0;
872 struct btr_node *ch;
873
874 FOR_EACH_CHILD(ch, btrn) {
875 size_t size = btr_get_input_queue_size(ch);
876 max_size = PARA_MAX(max_size, size);
877 }
878 return max_size;
879 }
880
881 /**
882 * Execute an inter-node command on the given node or on a parent node.
883 *
884 * \param btrn The node to start looking.
885 * \param command The command to execute.
886 * \param value_result Additional arguments and result value.
887 *
888 * This function traverses the buffer tree from \a btrn upwards and looks for
889 * the first node that understands \a command. On this node \a command is
890 * executed, and the result is stored in \a value_result.
891 *
892 * \return \p -ENOTSUP if no parent node of \a btrn understands \a command.
893 * Otherwise the return value of the command handler is returned.
894 *
895 * \sa \ref receiver::execute, filter::execute, writer::execute.
896 */
897 int btr_exec_up(struct btr_node *btrn, const char *command, char **value_result)
898 {
899 int ret;
900
901 for (; btrn; btrn = btrn->parent) {
902 if (!btrn->execute)
903 continue;
904 PARA_INFO_LOG("executing %s on %s\n", command, btrn->name);
905 ret = btrn->execute(btrn, command, value_result);
906 if (ret == -ERRNO_TO_PARA_ERROR(ENOTSUP))
907 continue;
908 if (ret < 0)
909 return ret;
910 if (value_result && *value_result)
911 PARA_INFO_LOG("%s(%s): %s\n", command, btrn->name,
912 *value_result);
913 return 1;
914 }
915 return -ERRNO_TO_PARA_ERROR(ENOTSUP);
916 }
917
918 /**
919 * Obtain the context of a buffer node tree.
920 *
921 * \param btrn The node whose output queue size should be computed.
922 *
923 * \return A pointer to the \a context address specified at node creation time.
924 *
925 * \sa btr_new_node(), struct \ref btr_node_description.
926 */
927 void *btr_context(struct btr_node *btrn)
928 {
929 return btrn->context;
930 }
931
932 static bool need_buffer_pool_merge(struct btr_node *btrn)
933 {
934 struct btr_buffer_reference *br = get_first_input_br(btrn);
935
936 if (!br)
937 return false;
938 if (br->wrap_count != 0)
939 return true;
940 if (br->btrb->pool)
941 return true;
942 return false;
943 }
944
945 static void merge_input_pool(struct btr_node *btrn, size_t dest_size)
946 {
947 struct btr_buffer_reference *br, *wbr = NULL;
948 int num_refs; /* including wrap buffer */
949 char *buf, *buf1 = NULL, *buf2 = NULL;
950 size_t sz, sz1 = 0, sz2 = 0, wb_consumed = 0;
951
952 br = get_first_input_br(btrn);
953 if (!br || br_available_bytes(br) >= dest_size)
954 return;
955 num_refs = 0;
956 FOR_EACH_BUFFER_REF(br, btrn) {
957 num_refs++;
958 sz = btr_get_buffer_by_reference(br, &buf);
959 if (sz == 0)
960 break;
961 if (br->wrap_count != 0) {
962 assert(!wbr);
963 assert(num_refs == 1);
964 wbr = br;
965 if (sz >= dest_size)
966 return;
967 wb_consumed = br->consumed;
968 continue;
969 }
970 if (!buf1) {
971 buf1 = buf;
972 sz1 = sz;
973 goto next;
974 }
975 if (buf1 + sz1 == buf) {
976 sz1 += sz;
977 goto next;
978 }
979 if (!buf2) {
980 buf2 = buf;
981 sz2 = sz;
982 goto next;
983 }
984 assert(buf2 + sz2 == buf);
985 sz2 += sz;
986 next:
987 if (sz1 + sz2 >= dest_size + wb_consumed)
988 break;
989 }
990 if (!buf2) /* nothing to do */
991 return;
992 assert(buf1 && sz2 > 0);
993 /*
994 * If the second buffer is large, we only take the first part of it to
995 * avoid having to memcpy() huge buffers.
996 */
997 sz2 = PARA_MIN(sz2, (size_t)(64 * 1024));
998 if (!wbr) {
999 /* Make a new wrap buffer combining buf1 and buf2. */
1000 sz = sz1 + sz2;
1001 buf = para_malloc(sz);
1002 PARA_DEBUG_LOG("merging input buffers: (%p:%zu, %p:%zu) -> %p:%zu\n",
1003 buf1, sz1, buf2, sz2, buf, sz);
1004 memcpy(buf, buf1, sz1);
1005 memcpy(buf + sz1, buf2, sz2);
1006 br = para_calloc(sizeof(*br));
1007 br->btrb = new_btrb(buf, sz);
1008 br->btrb->refcount = 1;
1009 br->consumed = 0;
1010 /* This is a wrap buffer */
1011 br->wrap_count = sz1;
1012 para_list_add(&br->node, &btrn->input_queue);
1013 return;
1014 }
1015 /*
1016 * We already have a wrap buffer, but it is too small. It might be
1017 * partially used.
1018 */
1019 if (wbr->wrap_count == sz1 && wbr->btrb->size >= sz1 + sz2) /* nothing we can do about it */
1020 return;
1021 sz = sz1 + sz2 - wbr->btrb->size; /* amount of new data */
1022 PARA_DEBUG_LOG("increasing wrap buffer %zu -> %zu\n", wbr->btrb->size,
1023 wbr->btrb->size + sz);
1024 wbr->btrb->size += sz;
1025 wbr->btrb->buf = para_realloc(wbr->btrb->buf, wbr->btrb->size);
1026 /* copy the new data to the end of the reallocated buffer */
1027 assert(sz2 >= sz);
1028 memcpy(wbr->btrb->buf + wbr->btrb->size - sz, buf2 + sz2 - sz, sz);
1029 }
1030
1031 /**
1032 * Merge the first two input buffers into one.
1033 *
1034 * This is a quite expensive operation.
1035 *
1036 * \return The number of buffers that have been available (zero, one or two).
1037 */
1038 static int merge_input(struct btr_node *btrn)
1039 {
1040 struct btr_buffer_reference *brs[2], *br;
1041 char *bufs[2], *buf;
1042 size_t szs[2], sz;
1043 int i;
1044
1045 if (list_empty(&btrn->input_queue))
1046 return 0;
1047 if (list_is_singular(&btrn->input_queue))
1048 return 1;
1049 i = 0;
1050 /* get references to the first two buffers */
1051 FOR_EACH_BUFFER_REF(br, btrn) {
1052 brs[i] = br;
1053 szs[i] = btr_get_buffer_by_reference(brs[i], bufs + i);
1054 i++;
1055 if (i == 2)
1056 break;
1057 }
1058 assert(i == 2);
1059 /* make a new btrb that combines the two buffers and a br to it. */
1060 sz = szs[0] + szs[1];
1061 buf = para_malloc(sz);
1062 PARA_DEBUG_LOG("%s: memory merging input buffers: (%zu, %zu) -> %zu\n",
1063 btrn->name, szs[0], szs[1], sz);
1064 memcpy(buf, bufs[0], szs[0]);
1065 memcpy(buf + szs[0], bufs[1], szs[1]);
1066
1067 br = para_calloc(sizeof(*br));
1068 br->btrb = new_btrb(buf, sz);
1069 br->btrb->refcount = 1;
1070
1071 /* replace the first two refs by the new one */
1072 btr_drop_buffer_reference(brs[0]);
1073 btr_drop_buffer_reference(brs[1]);
1074 para_list_add(&br->node, &btrn->input_queue);
1075 return 2;
1076 }
1077
1078 /**
1079 * Combine input queue buffers.
1080 *
1081 * \param btrn The buffer tree node whose input should be merged.
1082 * \param dest_size Stop merging if a buffer of at least this size exists.
1083 *
1084 * Used to combine as many buffers as needed into a single buffer whose size is
1085 * at least \a dest_size. This function is rather cheap in case the parent node
1086 * uses buffer pools and rather expensive otherwise.
1087 *
1088 * Note that if less than \a dest_size bytes are available in total, this
1089 * function does nothing and subsequent calls to btr_next_buffer() will still
1090 * return a buffer size less than \a dest_size.
1091 */
1092 void btr_merge(struct btr_node *btrn, size_t dest_size)
1093 {
1094 if (need_buffer_pool_merge(btrn))
1095 return merge_input_pool(btrn, dest_size);
1096 for (;;) {
1097 char *buf;
1098 size_t len = btr_next_buffer(btrn, &buf);
1099 if (len >= dest_size)
1100 return;
1101 PARA_DEBUG_LOG("input size = %zu < %zu = dest\n", len, dest_size);
1102 if (merge_input(btrn) < 2)
1103 return;
1104 }
1105 }
1106
1107 static bool btr_eof(struct btr_node *btrn)
1108 {
1109 char *buf;
1110 size_t len = btr_next_buffer(btrn, &buf);
1111
1112 return (len == 0 && btr_no_parent(btrn));
1113 }
1114
1115 static void log_tree_recursively(struct btr_node *btrn, int loglevel, int depth)
1116 {
1117 struct btr_node *ch;
1118 const char spaces[] = " ", *space = spaces + 16 - depth;
1119
1120 if (depth > 16)
1121 return;
1122 para_log(loglevel, "%s%s\n", space, btrn->name);
1123 FOR_EACH_CHILD(ch, btrn)
1124 log_tree_recursively(ch, loglevel, depth + 1);
1125 }
1126
1127 /**
1128 * Write the current buffer (sub-)tree to the log.
1129 *
1130 * \param btrn Start logging at this node.
1131 * \param loglevel Set severity with which the tree should be logged.
1132 */
1133 void btr_log_tree(struct btr_node *btrn, int loglevel)
1134 {
1135 return log_tree_recursively(btrn, loglevel, 0);
1136 }
1137
1138 /**
1139 * Find the node with the given name in the buffer tree.
1140 *
1141 * \param name The name of the node to search.
1142 * \param root Where to start the search.
1143 *
1144 * \return A pointer to the node with the given name on success. If \a name is
1145 * \p NULL, the function returns \a root. If there is no node with the given
1146 * name, \p NULL is returned.
1147 */
1148 struct btr_node *btr_search_node(const char *name, struct btr_node *root)
1149 {
1150 struct btr_node *ch;
1151
1152 if (!name)
1153 return root;
1154 if (!strcmp(root->name, name))
1155 return root;
1156 FOR_EACH_CHILD(ch, root) {
1157 struct btr_node *result = btr_search_node(name, ch);
1158 if (result)
1159 return result;
1160 }
1161 return NULL;
1162 }
1163
1164 /** 640K ought to be enough for everybody ;) */
1165 #define BTRN_MAX_PENDING (96 * 1024)
1166
1167 /**
1168 * Return the current state of a buffer tree node.
1169 *
1170 * \param btrn The node whose state should be queried.
1171 * \param min_iqs The minimal input queue size.
1172 * \param type The supposed type of \a btrn.
1173 *
1174 * Most users of the buffer tree subsystem call this function from both
1175 * their pre_select and the post_select methods.
1176 *
1177 * \return Negative if an error condition was detected, zero if there
1178 * is nothing to do and positive otherwise.
1179 *
1180 * Examples:
1181 *
1182 * - If a non-root node has no parent and an empty input queue, the function
1183 * returns \p -E_BTR_EOF. Similarly, if a non-leaf node has no children, \p
1184 * -E_BTR_NO_CHILD is returned.
1185 *
1186 * - If less than \a min_iqs many bytes are available in the input queue and no
1187 * EOF condition was detected, the function returns zero.
1188 *
1189 * - If there's plenty of data left in the input queue of the children of \a
1190 * btrn, the function also returns zero in order to bound the memory usage of
1191 * the buffer tree.
1192 */
1193 int btr_node_status(struct btr_node *btrn, size_t min_iqs,
1194 enum btr_node_type type)
1195 {
1196 size_t iqs;
1197
1198 assert(btrn);
1199 if (type != BTR_NT_LEAF) {
1200 if (btr_no_children(btrn))
1201 return -E_BTR_NO_CHILD;
1202 if (btr_get_output_queue_size(btrn) > BTRN_MAX_PENDING)
1203 return 0;
1204 }
1205 if (type != BTR_NT_ROOT) {
1206 if (btr_eof(btrn))
1207 return -E_BTR_EOF;
1208 iqs = btr_get_input_queue_size(btrn);
1209 if (iqs == 0) /* we have a parent, because not eof */
1210 return 0;
1211 if (iqs < min_iqs && !btr_no_parent(btrn))
1212 return 0;
1213 }
1214 return 1;
1215 }
1216
1217 /**
1218 * Get the time of the first I/O for a buffer tree node.
1219 *
1220 * \param btrn The node whose I/O time should be obtained.
1221 * \param tv Result pointer.
1222 *
1223 * Mainly useful for the time display of para_audiod.
1224 */
1225 void btr_get_node_start(struct btr_node *btrn, struct timeval *tv)
1226 {
1227 *tv = btrn->start;
1228 }
1229
1230 struct btr_node *btr_parent(struct btr_node *btrn)
1231 {
1232 return btrn->parent;
1233 }