X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fcommon%2Fdynamic-buffer.h;h=d42a6a61df8401ba62732d3a79a8b8f3ea44b875;hb=3e25d926e1c03011c68430e3a358d1e9a10ca9ab;hp=19097f927e219bdb4e7eb69defe1f4e12db1f447;hpb=5966417eba59c9014c1f67ae37257e7266e647b5;p=lttng-tools.git

diff --git a/src/common/dynamic-buffer.h b/src/common/dynamic-buffer.h
index 19097f927..d42a6a61d 100644
--- a/src/common/dynamic-buffer.h
+++ b/src/common/dynamic-buffer.h
@@ -20,43 +20,78 @@
 
 #include <stddef.h>
 #include <stdint.h>
+#include <common/macros.h>
 
 struct lttng_dynamic_buffer {
 	char *data;
+	/* size is the buffer's currently used capacity. */
 	size_t size;
-	size_t capacity;
+	/*
+	 * capacity shall not be accessed by users directly, it is meant for
+	 * internal use only.
+	 */
+	size_t _capacity;
 };
 
+/*
+ * Initialize a dynamic buffer. This performs no allocation and is meant
+ * to be used instead of memset or explicit initialization of the buffer.
+ */
+LTTNG_HIDDEN
 void lttng_dynamic_buffer_init(struct lttng_dynamic_buffer *buffer);
 
+/*
+ * Append the content of a raw memory buffer to the end of a dynamic buffer
+ * (after its current "size"). The dynamic buffer's size is increased by
+ * "len", and its capacity is adjusted automatically.
+ */
+LTTNG_HIDDEN
 int lttng_dynamic_buffer_append(struct lttng_dynamic_buffer *buffer,
 		const void *buf, size_t len);
 
+/*
+ * Performs the same action as lttng_dynamic_buffer_append(), but using another
+ * dynamic buffer as the source buffer. The source buffer's size is used in lieu
+ * of "len".
+ */
+LTTNG_HIDDEN
 int lttng_dynamic_buffer_append_buffer(struct lttng_dynamic_buffer *dst_buffer,
 		struct lttng_dynamic_buffer *src_buffer);
 
 /*
  * Set the buffer's size to new_size. The capacity of the buffer will
  * be expanded (if necessary) to accomodate new_size. Areas acquired by
- * an enlarging new_size _will be zeroed_.
+ * a size increase will be zeroed.
  *
  * Be careful to expand the buffer's size _before_ calling out external
  * APIs (e.g. read(3)) which may populate the buffer as setting the size
- * _after_ will zero-out the result of the operation.
+ * after will zero-out the result of the operation.
+ *
+ * Shrinking a buffer does not zero the old content. If the buffer may contain
+ * sensititve information, it must be cleared manually _before_ changing the
+ * size.
+ *
+ * NOTE: It is striclty _invalid_ to access memory after _size_, regardless
+ *       of prior calls to set_capacity().
  */
+LTTNG_HIDDEN
 int lttng_dynamic_buffer_set_size(struct lttng_dynamic_buffer *buffer,
 		size_t new_size);
 
 /*
  * Set the buffer's capacity to accomodate the new_capacity, allocating memory
- * as necessary. The buffer's content is preserved.
+ * as necessary. The buffer's content is preserved. Setting a buffer's capacity
+ * is meant as a _hint_ to the underlying buffer and is only optimization; no
+ * guarantee is offered that subsequent calls to append or set_size will succeed.
  *
  * If the current size > new_capacity, the operation will fail.
  */
+LTTNG_HIDDEN
 int lttng_dynamic_buffer_set_capacity(struct lttng_dynamic_buffer *buffer,
 		size_t new_capacity);
 
 /* Release any memory used by the dynamic buffer. */
+LTTNG_HIDDEN
 void lttng_dynamic_buffer_reset(struct lttng_dynamic_buffer *buffer);
 
 #endif /* LTTNG_DYNAMIC_BUFFER_H */