SoW-2019-0002: Dynamic Snapshot
[lttng-tools.git] / src / common / dynamic-array.h
CommitLineData
2c5ff4e4 1/*
ab5be9fa 2 * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>
2c5ff4e4 3 *
ab5be9fa 4 * SPDX-License-Identifier: LGPL-2.1-only
2c5ff4e4 5 *
2c5ff4e4
JG
6 */
7
8#ifndef LTTNG_DYNAMIC_ARRAY_H
9#define LTTNG_DYNAMIC_ARRAY_H
10
11#include <common/dynamic-buffer.h>
12#include <assert.h>
13
93bed9fe
JG
14typedef void (*lttng_dynamic_array_element_destructor)(void *element);
15typedef void (*lttng_dynamic_pointer_array_destructor)(void *ptr);
16
2c5ff4e4
JG
17struct lttng_dynamic_array {
18 struct lttng_dynamic_buffer buffer;
19 size_t element_size;
20 size_t size;
93bed9fe 21 lttng_dynamic_array_element_destructor destructor;
2c5ff4e4
JG
22};
23
24struct lttng_dynamic_pointer_array {
25 struct lttng_dynamic_array array;
26};
27
2c5ff4e4
JG
28/*
29 * Initialize a resizable array of fixed-size elements. This performs no
30 * allocation and can't fail.
31 */
32LTTNG_HIDDEN
33void lttng_dynamic_array_init(struct lttng_dynamic_array *array,
93bed9fe
JG
34 size_t element_size,
35 lttng_dynamic_array_element_destructor destructor);
2c5ff4e4
JG
36
37/*
38 * Returns the number of elements in the dynamic array.
39 */
40static inline
41size_t lttng_dynamic_array_get_count(
42 const struct lttng_dynamic_array *array)
43{
44 return array->size;
45}
46
47/*
48 * Returns a pointer to the element. Mutating operations on the array invalidate
49 * the returned pointer.
50 */
51static inline
52void *lttng_dynamic_array_get_element(const struct lttng_dynamic_array *array,
53 size_t element_index)
54{
55 assert(element_index < array->size);
56 return array->buffer.data + (element_index * array->element_size);
57}
58
59/*
60 * Add an element to the end of a dynamic array. The array's element count is
61 * increased by one and its underlying capacity is adjusted automatically.
62 *
63 * element is a pointer to the element to add (copy) to the array.
64 */
65LTTNG_HIDDEN
66int lttng_dynamic_array_add_element(struct lttng_dynamic_array *array,
67 const void *element);
68
93bed9fe
JG
69/*
70 * Remove an element from the dynamic array. The array's element count is
71 * decreased by one and the following elements are shifted to take its place
72 * (when applicable).
73 */
74LTTNG_HIDDEN
75int lttng_dynamic_array_remove_element(struct lttng_dynamic_array *array,
76 size_t element_index);
77
2c5ff4e4
JG
78/* Release any memory used by the dynamic array. */
79LTTNG_HIDDEN
93bed9fe 80void lttng_dynamic_array_reset(struct lttng_dynamic_array *array);
2c5ff4e4 81
74465ffb
MD
82/* Remove all elements from the dynamic array. */
83LTTNG_HIDDEN
84void lttng_dynamic_array_clear(struct lttng_dynamic_array *array);
2c5ff4e4
JG
85
86/*
87 * Specialization of lttng_dynamic_array for pointers. This utility
88 * is built under the assumption that pointer sizes are equal
89 * for all data types on supported architectures. Revisit this in the event
90 * of a port to an Harvard architecture.
91 */
92
93/*
94 * Initialize a resizable array of fixed-size elements. This performs no
95 * allocation and can't fail.
96 */
97LTTNG_HIDDEN
98void lttng_dynamic_pointer_array_init(
93bed9fe
JG
99 struct lttng_dynamic_pointer_array *array,
100 lttng_dynamic_pointer_array_destructor destructor);
2c5ff4e4
JG
101
102/*
103 * Returns the number of pointers in the dynamic pointer array.
104 */
105static inline
106size_t lttng_dynamic_pointer_array_get_count(
107 const struct lttng_dynamic_pointer_array *array)
108{
109 return lttng_dynamic_array_get_count(&array->array);
110}
111
112/*
14c4262b 113 * Returns the pointer at index `index`.
2c5ff4e4
JG
114 */
115static inline
116void *lttng_dynamic_pointer_array_get_pointer(
117 const struct lttng_dynamic_pointer_array *array, size_t index)
118{
119 void **element = lttng_dynamic_array_get_element(&array->array, index);
120
121 return *element;
122}
123
1831ae68
FD
124/*
125 * Returns the pointer at index `index`, sets the array slot to NULL. Does not
126 * run the destructor.
127 */
128
129static inline
130void *lttng_dynamic_pointer_array_steal_pointer(
131 struct lttng_dynamic_pointer_array *array, size_t index)
132{
133 void **p_element = lttng_dynamic_array_get_element(&array->array, index);
134 void *element = *p_element;
135
136 *p_element = NULL;
137
138 return element;
139}
140
2c5ff4e4
JG
141/*
142 * Add a pointer to the end of a dynamic pointer array. The array's element
143 * count is increased by one and its underlying capacity is adjusted
144 * automatically.
145 */
146static inline
147int lttng_dynamic_pointer_array_add_pointer(
148 struct lttng_dynamic_pointer_array *array, void *pointer)
149{
150 return lttng_dynamic_array_add_element(&array->array, &pointer);
151}
152
93bed9fe
JG
153/*
154 * Remove a pointer from a dynamic pointer array. The array's element
155 * count is decreased by one and the following pointers are shifted to
156 * take the place of the removed pointer (if applicable).
157 */
0186592a 158LTTNG_HIDDEN
93bed9fe 159int lttng_dynamic_pointer_array_remove_pointer(
0186592a 160 struct lttng_dynamic_pointer_array *array, size_t index);
93bed9fe 161
2c5ff4e4
JG
162/* Release any memory used by the dynamic array. */
163LTTNG_HIDDEN
164void lttng_dynamic_pointer_array_reset(
93bed9fe 165 struct lttng_dynamic_pointer_array *array);
2c5ff4e4 166
74465ffb
MD
167/* Remove all elements from the dynamic pointer array. */
168LTTNG_HIDDEN
169void lttng_dynamic_pointer_array_clear(
170 struct lttng_dynamic_pointer_array *array);
171
2c5ff4e4 172#endif /* LTTNG_DYNAMIC_ARRAY_H */
This page took 0.059844 seconds and 5 git commands to generate.