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
13 #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
45 * @view Buffer view to validate
47 bool lttng_buffer_view_is_valid(const struct lttng_buffer_view
*view
);
50 * Return a buffer view referencing a subset of the memory referenced by another
53 * @src Source view to reference
54 * @offset Offset to apply to the source memory content
55 * @len Length of the memory contents to reference. Passing -1 will
56 * cause the view to reference the whole view from the offset
59 * Note that a buffer view never assumes the ownership of the memory it
63 struct lttng_buffer_view
lttng_buffer_view_from_view(
64 const struct lttng_buffer_view
*src
, size_t offset
,
68 * Return a buffer view referencing a subset of the memory referenced by a
71 * @src Source dynamic buffer to reference
72 * @offset Offset to apply to the source memory content
73 * @len Length of the memory contents to reference. Passing -1 will
74 * cause the view to reference the whole dynamic buffer from the
77 * Note that a buffer view never assumes the ownership of the memory it
81 struct lttng_buffer_view
lttng_buffer_view_from_dynamic_buffer(
82 const struct lttng_dynamic_buffer
*src
, size_t offset
,
86 * Verify that `buf` contains a string starting at `str` of length
87 * `len_with_null_terminator`.
89 * @buf The buffer view
90 * @str The start of the string
91 * @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.037983 seconds and 4 git commands to generate.