src/common/buffer-view.h

   1 /*
   2  * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-only
   5  *
   6  */
   7
   8 #ifndef LTTNG_BUFFER_VIEW_H
   9 #define LTTNG_BUFFER_VIEW_H
  10
  11 #include <common/macros.h>
  12 #include <stdbool.h>
  13 #include <stddef.h>
  14 #include <stdint.h>
  15
  16 struct lttng_dynamic_buffer;
  17
  18 struct lttng_buffer_view {
  19         const char *data;
  20         size_t size;
  21 };
  22
  23 /**
  24  * Return a buffer view referencing a subset of the memory referenced by a raw
  25  * pointer.
  26  *
  27  * @src         Source buffer to reference
  28  * @offset      Offset to apply to the source memory buffer
  29  * @len         Length of the memory contents to reference.
  30  *
  31  * Note that a buffer view never assumes the ownership of the memory it
  32  * references.
  33  */
  34 LTTNG_HIDDEN
  35 struct lttng_buffer_view lttng_buffer_view_init(
  36                 const char *src, size_t offset, ptrdiff_t len);
  37
  38 /**
  39  * Checks if a buffer view is safe to access.
  40  *
  41  * After calling the buffer view creation functions, callers should verify
  42  * if the resquested length (if any is explicitly provided) could be mapped
  43  * to a new view.
  44  *
  45  * @view        Buffer view to validate
  46  */
  47 LTTNG_HIDDEN
  48 bool lttng_buffer_view_is_valid(const struct lttng_buffer_view *view);
  49
  50 /**
  51  * Return a buffer view referencing a subset of the memory referenced by another
  52  * view.
  53  *
  54  * @src         Source view to reference
  55  * @offset      Offset to apply to the source memory content
  56  * @len         Length of the memory contents to reference. Passing -1 will
  57  *              cause the view to reference the whole view from the offset
  58  *              provided.
  59  *
  60  * Note that a buffer view never assumes the ownership of the memory it
  61  * references.
  62  */
  63 LTTNG_HIDDEN
  64 struct lttng_buffer_view lttng_buffer_view_from_view(
  65                 const struct lttng_buffer_view *src, size_t offset,
  66                 ptrdiff_t len);
  67
  68 /**
  69  * Return a buffer view referencing a subset of the memory referenced by a
  70  * dynamic buffer.
  71  *
  72  * @src         Source dynamic buffer to reference
  73  * @offset      Offset to apply to the source memory content
  74  * @len         Length of the memory contents to reference. Passing -1 will
  75  *              cause the view to reference the whole dynamic buffer from the
  76  *              offset provided.
  77  *
  78  * Note that a buffer view never assumes the ownership of the memory it
  79  * references.
  80  */
  81 LTTNG_HIDDEN
  82 struct lttng_buffer_view lttng_buffer_view_from_dynamic_buffer(
  83                 const struct lttng_dynamic_buffer *src, size_t offset,
  84                 ptrdiff_t len);
  85
  86 /**
  87  * Verify that `buf` contains a string starting at `str` of length
  88  * `len_with_null_terminator`.
  89  *
  90  * @buf                         The buffer view
  91  * @str                         The start of the string
  92  * @len_with_null_terminator    Expected length of the string, including the
  93  *                              NULL terminator.
  94  */
  95 LTTNG_HIDDEN
  96 bool lttng_buffer_view_contains_string(const struct lttng_buffer_view *buf,
  97                 const char *str,
  98                 size_t len_with_null_terminator);
  99
 100 #endif /* LTTNG_BUFFER_VIEW_H */