2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_DYNAMIC_BUFFER_H
9 #define LTTNG_DYNAMIC_BUFFER_H
13 #include <common/macros.h>
15 struct lttng_buffer_view
;
17 struct lttng_dynamic_buffer
{
19 /* size is the buffer's currently used capacity. */
22 * capacity shall not be accessed by users directly, it is meant for
29 * Initialize a dynamic buffer. This performs no allocation and is meant
30 * to be used instead of memset or explicit initialization of the buffer.
33 void lttng_dynamic_buffer_init(struct lttng_dynamic_buffer
*buffer
);
36 * Append the content of a raw memory buffer to the end of a dynamic buffer
37 * (after its current "size"). The dynamic buffer's size is increased by
38 * "len", and its capacity is adjusted automatically.
41 int lttng_dynamic_buffer_append(struct lttng_dynamic_buffer
*buffer
,
42 const void *buf
, size_t len
);
45 * Performs the same action as lttng_dynamic_buffer_append(), but using another
46 * dynamic buffer as the source buffer. The source buffer's size is used in lieu
50 int lttng_dynamic_buffer_append_buffer(struct lttng_dynamic_buffer
*dst_buffer
,
51 const struct lttng_dynamic_buffer
*src_buffer
);
54 * Performs the same action as lttng_dynamic_buffer_append(), but using a
55 * buffer view as the source buffer. The source buffer's size is used in lieu
59 int lttng_dynamic_buffer_append_view(struct lttng_dynamic_buffer
*buffer
,
60 const struct lttng_buffer_view
*view
);
63 * Set the buffer's size to new_size. The capacity of the buffer will
64 * be expanded (if necessary) to accommodates new_size. Areas acquired by
65 * a size increase will be zeroed.
67 * Be careful to expand the buffer's size _before_ calling out external
68 * APIs (e.g. read(3)) which may populate the buffer as setting the size
69 * after will zero-out the result of the operation.
71 * Shrinking a buffer does not zero the old content. If the buffer may contain
72 * sensititve information, it must be cleared manually _before_ changing the
75 * NOTE: It is striclty _invalid_ to access memory after _size_, regardless
76 * of prior calls to set_capacity().
79 int lttng_dynamic_buffer_set_size(struct lttng_dynamic_buffer
*buffer
,
83 * Set the buffer's capacity to accommodates the new_capacity, allocating memory
84 * as necessary. The buffer's content is preserved. Setting a buffer's capacity
85 * is meant as a _hint_ to the underlying buffer and is only optimization; no
86 * guarantee is offered that subsequent calls to append or set_size will succeed.
88 * If the current size > new_capacity, the operation will fail.
91 int lttng_dynamic_buffer_set_capacity(struct lttng_dynamic_buffer
*buffer
,
94 /* Release any memory used by the dynamic buffer. */
96 void lttng_dynamic_buffer_reset(struct lttng_dynamic_buffer
*buffer
);
98 /* Get the space left in the buffer before a new resize is needed. */
100 size_t lttng_dynamic_buffer_get_capacity_left(
101 struct lttng_dynamic_buffer
*buffer
);
103 #endif /* LTTNG_DYNAMIC_BUFFER_H */
This page took 0.031644 seconds and 4 git commands to generate.