X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=buffer_tree.c;h=88fb8362bb0c9233d9a5916519b4acf47f4a63ed;hp=9be53201f76c9400a320688cde6540c4ca227d05;hb=eb9722e8763a9b2a2ae99d98a9715bd932081c3c;hpb=635ffa801ce0d4f5055ad022a5de935acd83b056

diff --git a/buffer_tree.c b/buffer_tree.c
index 9be53201..88fb8362 100644
--- a/buffer_tree.c
+++ b/buffer_tree.c
@@ -1,3 +1,10 @@
+/*
+ * Copyright (C) 2009-2011 Andre Noll <maan@systemlinux.org>
+ *
+ * Licensed under the GPL v2. For licencing details see COPYING.
+ */
+
+/** \file buffer_tree.c Buffer tree and buffer pool implementations. */
 #include <regex.h>
 #include <stdbool.h>
 
@@ -250,6 +257,8 @@ static void btr_pool_deallocate(struct btr_pool *btrp, size_t size)
  *
  * \param bnd Specifies how to create the new node.
  *
+ * \return A pointer to the newly allocated node.
+ *
  * This function always succeeds (or calls exit()). The returned pointer must
  * be freed using btr_free_node() after the node has been removed from the
  * buffer tree via btr_remove_node().
@@ -596,7 +605,7 @@ size_t btr_next_buffer(struct btr_node *btrn, char **bufp)
  *
  * This function must be used to get rid of existing buffer references in the
  * node's input queue. If no references to a buffer remain, the underlying
- * buffers are either freed (in the non-buffer tree case) or the read head of
+ * buffers are either freed (in the non-buffer pool case) or the read head of
  * the buffer pool is being advanced.
  *
  * Note that \a numbytes may be smaller than the buffer size. In this case the
@@ -627,7 +636,7 @@ void btr_consume(struct btr_node *btrn, size_t numbytes)
 			numbytes -= br->btrb->size - br->consumed;
 			btr_drop_buffer_reference(br);
 		}
-		assert(true);
+		assert(false);
 	}
 	/*
 	 * We have a wrap buffer, consume from it. If in total, i.e. including
@@ -653,9 +662,15 @@ void btr_consume(struct btr_node *btrn, size_t numbytes)
 	return btr_consume(btrn, sz);
 }
 
-static void flush_input_queue(struct btr_node *btrn)
+/**
+ * Clear the input queue of a buffer tree node.
+ *
+ * \param btrn The node whose input queue should be cleared.
+ */
+void btr_drain(struct btr_node *btrn)
 {
 	struct btr_buffer_reference *br, *tmp;
+
 	FOR_EACH_BUFFER_REF_SAFE(br, tmp, btrn)
 		btr_drop_buffer_reference(br);
 }
@@ -663,6 +678,8 @@ static void flush_input_queue(struct btr_node *btrn)
 /**
  * Free all resources allocated by btr_new_node().
  *
+ * \param btrn Pointer to a btr node obtained by \ref btr_new_node().
+ *
  * Like free(3), it is OK to call this with a \p NULL pointer argument.
  */
 void btr_free_node(struct btr_node *btrn)
@@ -693,7 +710,7 @@ void btr_remove_node(struct btr_node *btrn)
 	PARA_NOTICE_LOG("removing btr node %s from buffer tree\n", btrn->name);
 	FOR_EACH_CHILD(ch, btrn)
 		ch->parent = NULL;
-	flush_input_queue(btrn);
+	btr_drain(btrn);
 	if (btrn->parent)
 		list_del(&btrn->node);
 }
@@ -761,8 +778,8 @@ void btr_splice_out_node(struct btr_node *btrn)
  *
  * \param btrn The node whose output queue size should be computed.
  *
- * This function iterates over all children of the given node and returns the
- * size of the largest input queue.
+ * \return This function iterates over all children of the given node and
+ * returns the size of the largest input queue.
  */
 size_t btr_get_output_queue_size(struct btr_node *btrn)
 {
@@ -776,15 +793,6 @@ size_t btr_get_output_queue_size(struct btr_node *btrn)
 	return max_size;
 }
 
-int btr_exec(struct btr_node *btrn, const char *command, char **value_result)
-{
-	if (!btrn)
-		return -ERRNO_TO_PARA_ERROR(EINVAL);
-	if (!btrn->execute)
-		return -ERRNO_TO_PARA_ERROR(ENOTSUP);
-	return btrn->execute(btrn, command, value_result);
-}
-
 /**
  * Execute a inter-node command on a parent node.
  *
@@ -826,8 +834,9 @@ int btr_exec_up(struct btr_node *btrn, const char *command, char **value_result)
 /**
  * Obtain the context of a buffer node tree.
  *
- * The returned pointer equals the context pointer used at creation time of the
- * node.
+ * \param btrn The node whose output queue size should be computed.
+ *
+ * \return A pointer to the \a context address specified at node creation time.
  *
  * \sa btr_new_node(), struct \ref btr_node_description.
  */
@@ -854,7 +863,7 @@ static void merge_input_pool(struct btr_node *btrn, size_t dest_size)
 	struct btr_buffer_reference *br, *wbr = NULL;
 	int num_refs; /* including wrap buffer */
 	char *buf, *buf1 = NULL, *buf2 = NULL;
-	size_t sz, sz1 = 0, sz2 = 0;
+	size_t sz, sz1 = 0, sz2 = 0, wb_consumed = 0;
 
 	br = get_first_input_br(btrn);
 	if (!br || br_available_bytes(br) >= dest_size)
@@ -871,6 +880,7 @@ static void merge_input_pool(struct btr_node *btrn, size_t dest_size)
 			wbr = br;
 			if (sz >= dest_size)
 				return;
+			wb_consumed = br->consumed;
 			continue;
 		}
 		if (!buf1) {
@@ -890,7 +900,7 @@ static void merge_input_pool(struct btr_node *btrn, size_t dest_size)
 		assert(buf2 + sz2 == buf);
 		sz2 += sz;
 next:
-		if (sz1 + sz2 >= dest_size)
+		if (sz1 + sz2 >= dest_size + wb_consumed)
 			break;
 	}
 	if (!buf2) /* nothing to do */
@@ -1068,7 +1078,7 @@ struct btr_node *btr_search_node(const char *name, struct btr_node *root)
 }
 
 /** 640K ought to be enough for everybody ;) */
-#define BTRN_MAX_PENDING (640 * 1024)
+#define BTRN_MAX_PENDING (96 * 1024)
 
 /**
  * Return the current state of a buffer tree node.