SoW-2019-0002: Dynamic Snapshot

[lttng-tools.git] / src / common / dynamic-array.h

diff --git a/src/common/dynamic-array.h b/src/common/dynamic-array.h
index a5e4f7fb530806a9f0fc61eb93c95bc805c2d713..2b3ea62731cb3c54a5cc17d2bbe8fd9b068744a5 100644 (file)
--- a/src/common/dynamic-array.h
+++ b/src/common/dynamic-array.h
@@ -1,18 +1,8 @@
 /*
 /*

- * Copyright (C) 2019 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2019 Jérémie Galarneau <jeremie.galarneau@efficios.com>

  *
  *

- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only

  *
  *

- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

  */
 
 #ifndef LTTNG_DYNAMIC_ARRAY_H
  */
 
 #ifndef LTTNG_DYNAMIC_ARRAY_H


@@ -21,26 +11,28 @@
 #include <common/dynamic-buffer.h>
 #include <assert.h>
 
 #include <common/dynamic-buffer.h>
 #include <assert.h>
 

+typedef void (*lttng_dynamic_array_element_destructor)(void *element);
+typedef void (*lttng_dynamic_pointer_array_destructor)(void *ptr);
+

 struct lttng_dynamic_array {
        struct lttng_dynamic_buffer buffer;
        size_t element_size;
        size_t size;
 struct lttng_dynamic_array {
        struct lttng_dynamic_buffer buffer;
        size_t element_size;
        size_t size;

+       lttng_dynamic_array_element_destructor destructor;

 };
 
 struct lttng_dynamic_pointer_array {
        struct lttng_dynamic_array array;
 };
 
 };
 
 struct lttng_dynamic_pointer_array {
        struct lttng_dynamic_array array;
 };
 

-typedef void (*lttng_dynamic_array_element_destructor)(void *element);
-typedef void (*lttng_dynamic_pointer_array_destructor)(void *ptr);
-

 /*
  * Initialize a resizable array of fixed-size elements. This performs no
  * allocation and can't fail.
  */
 LTTNG_HIDDEN
 void lttng_dynamic_array_init(struct lttng_dynamic_array *array,
 /*
  * Initialize a resizable array of fixed-size elements. This performs no
  * allocation and can't fail.
  */
 LTTNG_HIDDEN
 void lttng_dynamic_array_init(struct lttng_dynamic_array *array,

-               size_t element_size);
+               size_t element_size,
+               lttng_dynamic_array_element_destructor destructor);

 
 /*
  * Returns the number of elements in the dynamic array.
 
 /*
  * Returns the number of elements in the dynamic array.


@@ -74,11 +66,22 @@ LTTNG_HIDDEN
 int lttng_dynamic_array_add_element(struct lttng_dynamic_array *array,
                const void *element);
 
 int lttng_dynamic_array_add_element(struct lttng_dynamic_array *array,
                const void *element);
 

+/*
+ * Remove an element from the dynamic array. The array's element count is
+ * decreased by one and the following elements are shifted to take its place
+ * (when applicable).
+ */
+LTTNG_HIDDEN
+int lttng_dynamic_array_remove_element(struct lttng_dynamic_array *array,
+               size_t element_index);
+

 /* Release any memory used by the dynamic array. */
 LTTNG_HIDDEN
 /* Release any memory used by the dynamic array. */
 LTTNG_HIDDEN

-void lttng_dynamic_array_reset(struct lttng_dynamic_array *array,
-               lttng_dynamic_array_element_destructor destructor);
+void lttng_dynamic_array_reset(struct lttng_dynamic_array *array);

 
 

+/* Remove all elements from the dynamic array. */
+LTTNG_HIDDEN
+void lttng_dynamic_array_clear(struct lttng_dynamic_array *array);

 
 /*
  * Specialization of lttng_dynamic_array for pointers. This utility
 
 /*
  * Specialization of lttng_dynamic_array for pointers. This utility


@@ -93,7 +96,8 @@ void lttng_dynamic_array_reset(struct lttng_dynamic_array *array,
  */
 LTTNG_HIDDEN
 void lttng_dynamic_pointer_array_init(
  */
 LTTNG_HIDDEN
 void lttng_dynamic_pointer_array_init(

-               struct lttng_dynamic_pointer_array *array);
+               struct lttng_dynamic_pointer_array *array,
+               lttng_dynamic_pointer_array_destructor destructor);

 
 /*
  * Returns the number of pointers in the dynamic pointer array.
 
 /*
  * Returns the number of pointers in the dynamic pointer array.


@@ -106,8 +110,7 @@ size_t lttng_dynamic_pointer_array_get_count(
 }
 
 /*
 }
 
 /*

- * Returns a pointer to the element. Mutating operations on the array invalidate
- * the returned pointer.
+ * Returns the pointer at index `index`.

  */
 static inline
 void *lttng_dynamic_pointer_array_get_pointer(
  */
 static inline
 void *lttng_dynamic_pointer_array_get_pointer(


@@ -118,6 +121,23 @@ void *lttng_dynamic_pointer_array_get_pointer(
        return *element;
 }
 
        return *element;
 }
 

+/*
+ * Returns the pointer at index `index`, sets the array slot to NULL. Does not
+ * run the destructor.
+ */
+
+static inline
+void *lttng_dynamic_pointer_array_steal_pointer(
+               struct lttng_dynamic_pointer_array *array, size_t index)
+{
+       void **p_element = lttng_dynamic_array_get_element(&array->array, index);
+       void *element = *p_element;
+
+       *p_element = NULL;
+
+       return element;
+}
+

 /*
  * Add a pointer to the end of a dynamic pointer array. The array's element
  * count is increased by one and its underlying capacity is adjusted
 /*
  * Add a pointer to the end of a dynamic pointer array. The array's element
  * count is increased by one and its underlying capacity is adjusted


@@ -130,10 +150,23 @@ int lttng_dynamic_pointer_array_add_pointer(
        return lttng_dynamic_array_add_element(&array->array, &pointer);
 }
 
        return lttng_dynamic_array_add_element(&array->array, &pointer);
 }
 

+/*
+ * Remove a pointer from a dynamic pointer array. The array's element
+ * count is decreased by one and the following pointers are shifted to
+ * take the place of the removed pointer (if applicable).
+ */
+LTTNG_HIDDEN
+int lttng_dynamic_pointer_array_remove_pointer(
+               struct lttng_dynamic_pointer_array *array, size_t index);
+

 /* Release any memory used by the dynamic array. */
 LTTNG_HIDDEN
 void lttng_dynamic_pointer_array_reset(
 /* Release any memory used by the dynamic array. */
 LTTNG_HIDDEN
 void lttng_dynamic_pointer_array_reset(

-               struct lttng_dynamic_pointer_array *array,
-               lttng_dynamic_pointer_array_destructor destructor);
+               struct lttng_dynamic_pointer_array *array);
+
+/* Remove all elements from the dynamic pointer array. */
+LTTNG_HIDDEN
+void lttng_dynamic_pointer_array_clear(
+               struct lttng_dynamic_pointer_array *array);

 
 #endif /* LTTNG_DYNAMIC_ARRAY_H */
 
 #endif /* LTTNG_DYNAMIC_ARRAY_H */