SoW-2019-0002: Dynamic Snapshot

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

diff --git a/src/common/buffer-view.h b/src/common/buffer-view.h
index e8c351b3f994974a847bf4936812ad073b445ef4..4486558aa9fe497ffb884511d41540b065d5af40 100644 (file)
--- a/src/common/buffer-view.h
+++ b/src/common/buffer-view.h
@@ -8,9 +8,10 @@
 #ifndef LTTNG_BUFFER_VIEW_H
 #define LTTNG_BUFFER_VIEW_H
 
+#include <common/macros.h>
+#include <stdbool.h>
 #include <stddef.h>
 #include <stdint.h>
-#include <common/macros.h>
 
 struct lttng_dynamic_buffer;
 
@@ -70,4 +71,22 @@ struct lttng_buffer_view lttng_buffer_view_from_dynamic_buffer(
                const struct lttng_dynamic_buffer *src, size_t offset,
                ptrdiff_t len);
 
+/**
+ * Validate that string starting at `str` of length `len_with_null_terminator`
+ * (including the NULL terminator) fits within the buffer view, and validate
+ * that it is indeed of that length.
+ *
+ * Return true if the validation passes, false otherwise.
+ *
+ * @buf                                The buffer view
+ * @str                                The start of the string
+ * @len_with_null_terminator   Expected length of the string, including the
+ *                             NULL terminator.
+ *
+ */
+LTTNG_HIDDEN
+bool lttng_buffer_view_validate_string(const struct lttng_buffer_view *buf,
+               const char *str,
+               size_t len_with_null_terminator);
+
 #endif /* LTTNG_BUFFER_VIEW_H */