Add lttng_dynamic_buffer_append_view util

[lttng-tools.git] / src / common / dynamic-buffer.h

diff --git a/src/common/dynamic-buffer.h b/src/common/dynamic-buffer.h
index d05356b73a2d8c2d002861011b1fb08d0dee4c6d..efd63fb9c3bb27638c32a571274f8e28416949b9 100644 (file)
--- a/src/common/dynamic-buffer.h
+++ b/src/common/dynamic-buffer.h
@@ -20,6 +20,9 @@
 
 #include <stddef.h>
 #include <stdint.h>
+#include <common/macros.h>
+
+struct lttng_buffer_view;
 
 struct lttng_dynamic_buffer {
        char *data;
@@ -36,6 +39,7 @@ struct lttng_dynamic_buffer {
  * 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);
 
 /*
@@ -43,6 +47,7 @@ void lttng_dynamic_buffer_init(struct lttng_dynamic_buffer *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);
 
@@ -51,9 +56,19 @@ int lttng_dynamic_buffer_append(struct lttng_dynamic_buffer *buffer,
  * 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);
 
+/*
+ * Performs the same action as lttng_dynamic_buffer_append(), but using a
+ * buffer view as the source buffer. The source buffer's size is used in lieu
+ * of "len".
+ */
+LTTNG_HIDDEN
+int lttng_dynamic_buffer_append_view(struct lttng_dynamic_buffer *buffer,
+               const struct lttng_buffer_view *view);
+
 /*
  * 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
@@ -70,6 +85,7 @@ int lttng_dynamic_buffer_append_buffer(struct lttng_dynamic_buffer *dst_buffer,
  * 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);
 
@@ -81,10 +97,17 @@ int lttng_dynamic_buffer_set_size(struct lttng_dynamic_buffer *buffer,
  *
  * 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);
 
+/* Get the space left in the buffer before a new resize is needed. */
+LTTNG_HIDDEN
+size_t lttng_dynamic_buffer_get_capacity_left(
+               struct lttng_dynamic_buffer *buffer);
+
 #endif /* LTTNG_DYNAMIC_BUFFER_H */