2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_BUFFER_VIEW_H
9 #define LTTNG_BUFFER_VIEW_H
11 #include <common/macros.h>
16 struct lttng_dynamic_buffer
;
18 struct lttng_buffer_view
{
24 * Return a buffer view referencing a subset of the memory referenced by a raw
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.
31 * Note that a buffer view never assumes the ownership of the memory it
35 struct lttng_buffer_view
lttng_buffer_view_init(
36 const char *src
, size_t offset
, ptrdiff_t len
);
39 * Checks if a buffer view is safe to access.
41 * After calling the buffer view creation functions, callers should verify
42 * if the resquested length (if any is explicitly provided) could be mapped
46 bool lttng_buffer_view_is_valid(const struct lttng_buffer_view
*view
);
49 * Return a buffer view referencing a subset of the memory referenced by another
52 * @src Source view to reference
53 * @offset Offset to apply to the source memory content
54 * @len Length of the memory contents to reference. Passing -1 will
55 * cause the view to reference the whole view from the offset
58 * Note that a buffer view never assumes the ownership of the memory it
62 struct lttng_buffer_view
lttng_buffer_view_from_view(
63 const struct lttng_buffer_view
*src
, size_t offset
,
67 * Return a buffer view referencing a subset of the memory referenced by a
70 * @src Source dynamic buffer to reference
71 * @offset Offset to apply to the source memory content
72 * @len Length of the memory contents to reference. Passing -1 will
73 * cause the view to reference the whole dynamic buffer from the
76 * Note that a buffer view never assumes the ownership of the memory it
80 struct lttng_buffer_view
lttng_buffer_view_from_dynamic_buffer(
81 const struct lttng_dynamic_buffer
*src
, size_t offset
,
85 * Verify that `buf` contains a string starting at `str` of length
86 * `len_with_null_terminator`.
88 * @buf The buffer view
89 * @str The start of the string
90 * @len_with_null_terminator Expected length of the string, including the
94 bool lttng_buffer_view_contains_string(const struct lttng_buffer_view
*buf
,
96 size_t len_with_null_terminator
);
98 #endif /* LTTNG_BUFFER_VIEW_H */
This page took 0.032887 seconds and 5 git commands to generate.