+/**
+ * Buffer pools - An alternative to malloc/free buffer management.
+ *
+ * Non-leaf nodes usually create output to be processed by their children. The
+ * data must be fed through the output channel(s) of the node in order to make
+ * that data available to each child.
+ *
+ * The easiest way to do so is to malloc() a buffer, fill it, and then call
+ * btr_add_output(). This adds references to that buffer to all children. The
+ * buffer is automatically freed if no buffer tree node is using it any more.
+ *
+ * This approach, while simple, has some drawbacks, especially affecting the
+ * root nodes of the buffer tree. Often the data source which is represented by
+ * a root node does not know in advance how much data will be available.
+ * Therefore the allocated buffer is either larger than what can currently be
+ * read, or is too small so that multiple buffers have to be used.
+ *
+ * While this could be worked around by using a large buffer and calling
+ * realloc() afterwards to shrink the buffer according to how much has been
+ * read, there is a second problem which comes from the alignment constraints
+ * of some filters, mainly the decoders. These need a minimal amount of data to
+ * proceed, and most of them even need this amount as one contiguous buffer,
+ * i.e. not spread out over two or more buffers.
+ *
+ * Although the buffer tree code handles this case just fine, it can be
+ * expensive because two or more buffers must be combined by copying buffer
+ * contents around in order to satisfy the constraint.
+ *
+ * This is where buffer pools come into play. Buffer pools try to satisfy
+ * alignment constraints without copying buffer content whenever possible. To
+ * avoid spreading out the input data over the address space like in the
+ * malloc/free approach, a fixed large contiguous buffer (the area) is used
+ * instead. A buffer pool consists basically of an area and two pointers, the
+ * read head and the write head.
+ *
+ * Once a buffer pool has been created, its node, e.g. a receiver, obtains the
+ * current value of the write head and writes new data to this location. Then
+ * it calls btr_add_output_pool() to tell much data it has written. This
+ * advances the write head accordingly, and it also creates references to the
+ * newly written part of the area for the children of the node to consume.
+ *
+ * Child nodes consume data by working through their input queue, which is a
+ * list of buffer references. Once the content of a buffer is no longer needed
+ * by a child node, the child calls btr_consume() to indicate the amount of
+ * data which can be dropped from the child's point of view. If no reference
+ * to some region of the buffer pool area remains, the read head of the buffer
+ * pool advances, making space available for the receiver node to fill.
+ *
+ * No matter if malloc() or a buffer pool is used, the buffer tree code takes
+ * care of alignment constraints imposed by the consumers. In the buffer pool
+ * case, automatic merging of references to contiguous buffers is performed.
+ * memcpy is only used if a constraint can not be satisfied by using the
+ * remaining part of the area only. This only happens when the end of the area
+ * is reached.
+ */
+
+struct btr_pool;
+typedef int (*btr_command_handler)(struct btr_node *btrn,
+ const char *command, char **result);
+
+enum btr_node_type {
+ BTR_NT_ROOT,
+ BTR_NT_INTERNAL,
+ BTR_NT_LEAF,
+};
+
+struct btr_node_description {
+ const char *name;
+ struct btr_node *parent;
+ btr_command_handler handler;
+ void *context;
+};
+
+size_t btr_pool_size(struct btr_pool *btrp);
+struct btr_pool *btr_pool_new(const char *name, size_t area_size);
+void btr_pool_free(struct btr_pool *btrp);
+size_t btr_pool_get_buffer(struct btr_pool *btrp, char **result);
+void btr_pool_allocate(struct btr_pool *btrp, size_t size);
+void btr_add_output_pool(struct btr_pool *btrp, size_t size,
+ struct btr_node *btrn);
+size_t btr_pool_unused(struct btr_pool *btrp);
+void btr_copy(const void *src, size_t n, struct btr_pool *btrp,
+ struct btr_node *btrn);
+
+struct btr_node *btr_new_node(struct btr_node_description *bnd);
+void btr_remove_node(struct btr_node *btrn);
+void btr_free_node(struct btr_node *btrn);