@@ -11,7 +11,7 @@ include_HEADERS = \
$(top_srcdir)/platform/linux-generic/include/api/odp_atomic.h \
$(top_srcdir)/platform/linux-generic/include/api/odp_barrier.h \
$(top_srcdir)/platform/linux-generic/include/api/odp_buffer.h \
- $(top_srcdir)/platform/linux-generic/include/api/odp_buffer_pool.h \
+ $(top_srcdir)/platform/linux-generic/include/api/odp_pool.h \
$(top_srcdir)/platform/linux-generic/include/api/odp_byteorder.h \
$(top_srcdir)/platform/linux-generic/include/api/odp_classification.h \
$(top_srcdir)/platform/linux-generic/include/api/odp_compiler.h \
@@ -36,7 +36,7 @@ extern "C" {
#include <odp_thread.h>
#include <odp_shared_memory.h>
#include <odp_buffer.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_queue.h>
#include <odp_ticketlock.h>
#include <odp_time.h>
deleted file mode 100644
@@ -1,182 +0,0 @@
-/* Copyright (c) 2013, Linaro Limited
- * All rights reserved.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- */
-
-
-/**
- * @file
- *
- * ODP buffer pool
- */
-
-#ifndef ODP_BUFFER_POOL_H_
-#define ODP_BUFFER_POOL_H_
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-
-
-#include <odp_std_types.h>
-#include <odp_platform_types.h>
-#include <odp_buffer.h>
-#include <odp_event.h>
-
-/** @addtogroup odp_buffer
- * Operations on a buffer pool.
- * @{
- */
-
-/** Maximum queue name lenght in chars */
-#define ODP_BUFFER_POOL_NAME_LEN 32
-
-/**
- * Buffer pool parameters
- * Used to communicate buffer pool creation options.
- */
-typedef struct odp_buffer_pool_param_t {
- uint32_t buf_size; /**< Buffer size in bytes. The maximum
- number of bytes application will
- store in each buffer. For packets, this
- is the maximum packet data length, and
- configured headroom and tailroom will be
- added to this number */
- uint32_t buf_align; /**< Minimum buffer alignment in bytes.
- Valid values are powers of two. Use 0
- for default alignment. Default will
- always be a multiple of 8. */
- uint32_t num_bufs; /**< Number of buffers in the pool */
- int buf_type; /**< Buffer type */
-} odp_buffer_pool_param_t;
-
-#define ODP_BUFFER_TYPE_RAW ODP_EVENT_BUFFER
-#define ODP_BUFFER_TYPE_PACKET ODP_EVENT_PACKET
-#define ODP_BUFFER_TYPE_TIMEOUT ODP_EVENT_TIMEOUT
-
-/**
- * Create a buffer pool
- * This routine is used to create a buffer pool. It take three
- * arguments: the optional name of the pool to be created, an optional shared
- * memory handle, and a parameter struct that describes the pool to be
- * created. If a name is not specified the result is an anonymous pool that
- * cannot be referenced by odp_buffer_pool_lookup().
- *
- * @param name Name of the pool, max ODP_BUFFER_POOL_NAME_LEN-1 chars.
- * May be specified as NULL for anonymous pools.
- *
- * @param shm The shared memory object in which to create the pool.
- * Use ODP_SHM_NULL to reserve default memory type
- * for the buffer type.
- *
- * @param params Buffer pool parameters.
- *
- * @return Handle of the created buffer pool
- * @retval ODP_BUFFER_POOL_INVALID Buffer pool could not be created
- */
-
-odp_buffer_pool_t odp_buffer_pool_create(const char *name,
- odp_shm_t shm,
- odp_buffer_pool_param_t *params);
-
-/**
- * Destroy a buffer pool previously created by odp_buffer_pool_create()
- *
- * @param pool Handle of the buffer pool to be destroyed
- *
- * @retval 0 Success
- * @retval -1 Failure
- *
- * @note This routine destroys a previously created buffer pool. This call
- * does not destroy any shared memory object passed to
- * odp_buffer_pool_create() used to store the buffer pool contents. The caller
- * takes responsibility for that. If no shared memory object was passed as
- * part of the create call, then this routine will destroy any internal shared
- * memory objects associated with the buffer pool. Results are undefined if
- * an attempt is made to destroy a buffer pool that contains allocated or
- * otherwise active buffers.
- */
-int odp_buffer_pool_destroy(odp_buffer_pool_t pool);
-
-/**
- * Find a buffer pool by name
- *
- * @param name Name of the pool
- *
- * @return Handle of found buffer pool
- * @retval ODP_BUFFER_POOL_INVALID Buffer pool could not be found
- *
- * @note This routine cannot be used to look up an anonymous pool (one created
- * with no name).
- */
-odp_buffer_pool_t odp_buffer_pool_lookup(const char *name);
-
-/**
- * Buffer pool information struct
- * Used to get information about a buffer pool.
- */
-typedef struct odp_buffer_pool_info_t {
- const char *name; /**< pool name */
- odp_shm_t shm; /**< handle of shared memory area
- supplied by application to
- contain buffer pool, or
- ODP_SHM_INVALID if this pool is
- managed by ODP */
- odp_buffer_pool_param_t params; /**< pool parameters */
-} odp_buffer_pool_info_t;
-
-/**
- * Retrieve information about a buffer pool
- *
- * @param pool Buffer pool handle
- *
- * @param[out] info Receives an odp_buffer_pool_info_t object
- * that describes the pool.
- *
- * @retval 0 Success
- * @retval -1 Failure. Info could not be retrieved.
- */
-
-int odp_buffer_pool_info(odp_buffer_pool_t pool,
- odp_buffer_pool_info_t *info);
-
-/**
- * Print buffer pool info
- *
- * @param pool Pool handle
- *
- * @note This routine writes implementation-defined information about the
- * specified buffer pool to the ODP log. The intended use is for debugging.
- */
-void odp_buffer_pool_print(odp_buffer_pool_t pool);
-
-/**
- * Buffer alloc
- *
- * The validity of a buffer can be cheked at any time with odp_buffer_is_valid()
- * @param pool Pool handle
- *
- * @return Handle of allocated buffer
- * @retval ODP_BUFFER_INVALID Buffer could not be allocated
- */
-odp_buffer_t odp_buffer_alloc(odp_buffer_pool_t pool);
-
-/**
- * Buffer free
- *
- * @param buf Buffer handle
- *
- */
-void odp_buffer_free(odp_buffer_t buf);
-
-/**
- * @}
- */
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
@@ -20,7 +20,7 @@ extern "C" {
#include <odp_std_types.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_packet.h>
#include <odp_queue.h>
@@ -20,7 +20,7 @@ extern "C" {
#include <odp_std_types.h>
#include <odp_event.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_queue.h>
#include <odp_packet.h>
@@ -20,7 +20,7 @@ extern "C" {
#include <odp_std_types.h>
#include <odp_platform_types.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_packet.h>
#include <odp_queue.h>
new file mode 100644
@@ -0,0 +1,182 @@
+/* Copyright (c) 2015, Linaro Limited
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+
+/**
+ * @file
+ *
+ * ODP pool
+ */
+
+#ifndef ODP_POOL_H_
+#define ODP_POOL_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+
+#include <odp_std_types.h>
+#include <odp_platform_types.h>
+#include <odp_buffer.h>
+#include <odp_event.h>
+
+/** @addtogroup odp_buffer
+ * Operations on a buffer pool.
+ * @{
+ */
+
+/** Maximum queue name lenght in chars */
+#define ODP_BUFFER_POOL_NAME_LEN 32
+
+/**
+ * Buffer pool parameters
+ * Used to communicate buffer pool creation options.
+ */
+typedef struct odp_buffer_pool_param_t {
+ uint32_t buf_size; /**< Buffer size in bytes. The maximum
+ number of bytes application will
+ store in each buffer. For packets, this
+ is the maximum packet data length, and
+ configured headroom and tailroom will be
+ added to this number */
+ uint32_t buf_align; /**< Minimum buffer alignment in bytes.
+ Valid values are powers of two. Use 0
+ for default alignment. Default will
+ always be a multiple of 8. */
+ uint32_t num_bufs; /**< Number of buffers in the pool */
+ int buf_type; /**< Buffer type */
+} odp_buffer_pool_param_t;
+
+#define ODP_BUFFER_TYPE_RAW ODP_EVENT_BUFFER
+#define ODP_BUFFER_TYPE_PACKET ODP_EVENT_PACKET
+#define ODP_BUFFER_TYPE_TIMEOUT ODP_EVENT_TIMEOUT
+
+/**
+ * Create a buffer pool
+ * This routine is used to create a buffer pool. It take three
+ * arguments: the optional name of the pool to be created, an optional shared
+ * memory handle, and a parameter struct that describes the pool to be
+ * created. If a name is not specified the result is an anonymous pool that
+ * cannot be referenced by odp_buffer_pool_lookup().
+ *
+ * @param name Name of the pool, max ODP_BUFFER_POOL_NAME_LEN-1 chars.
+ * May be specified as NULL for anonymous pools.
+ *
+ * @param shm The shared memory object in which to create the pool.
+ * Use ODP_SHM_NULL to reserve default memory type
+ * for the buffer type.
+ *
+ * @param params Buffer pool parameters.
+ *
+ * @return Handle of the created buffer pool
+ * @retval ODP_BUFFER_POOL_INVALID Buffer pool could not be created
+ */
+
+odp_buffer_pool_t odp_buffer_pool_create(const char *name,
+ odp_shm_t shm,
+ odp_buffer_pool_param_t *params);
+
+/**
+ * Destroy a buffer pool previously created by odp_buffer_pool_create()
+ *
+ * @param pool Handle of the buffer pool to be destroyed
+ *
+ * @retval 0 Success
+ * @retval -1 Failure
+ *
+ * @note This routine destroys a previously created buffer pool. This call
+ * does not destroy any shared memory object passed to
+ * odp_buffer_pool_create() used to store the buffer pool contents. The caller
+ * takes responsibility for that. If no shared memory object was passed as
+ * part of the create call, then this routine will destroy any internal shared
+ * memory objects associated with the buffer pool. Results are undefined if
+ * an attempt is made to destroy a buffer pool that contains allocated or
+ * otherwise active buffers.
+ */
+int odp_buffer_pool_destroy(odp_buffer_pool_t pool);
+
+/**
+ * Find a buffer pool by name
+ *
+ * @param name Name of the pool
+ *
+ * @return Handle of found buffer pool
+ * @retval ODP_BUFFER_POOL_INVALID Buffer pool could not be found
+ *
+ * @note This routine cannot be used to look up an anonymous pool (one created
+ * with no name).
+ */
+odp_buffer_pool_t odp_buffer_pool_lookup(const char *name);
+
+/**
+ * Buffer pool information struct
+ * Used to get information about a buffer pool.
+ */
+typedef struct odp_buffer_pool_info_t {
+ const char *name; /**< pool name */
+ odp_shm_t shm; /**< handle of shared memory area
+ supplied by application to
+ contain buffer pool, or
+ ODP_SHM_INVALID if this pool is
+ managed by ODP */
+ odp_buffer_pool_param_t params; /**< pool parameters */
+} odp_buffer_pool_info_t;
+
+/**
+ * Retrieve information about a buffer pool
+ *
+ * @param pool Buffer pool handle
+ *
+ * @param[out] info Receives an odp_buffer_pool_info_t object
+ * that describes the pool.
+ *
+ * @retval 0 Success
+ * @retval -1 Failure. Info could not be retrieved.
+ */
+
+int odp_buffer_pool_info(odp_buffer_pool_t pool,
+ odp_buffer_pool_info_t *info);
+
+/**
+ * Print buffer pool info
+ *
+ * @param pool Pool handle
+ *
+ * @note This routine writes implementation-defined information about the
+ * specified buffer pool to the ODP log. The intended use is for debugging.
+ */
+void odp_buffer_pool_print(odp_buffer_pool_t pool);
+
+/**
+ * Buffer alloc
+ *
+ * The validity of a buffer can be cheked at any time with odp_buffer_is_valid()
+ * @param pool Pool handle
+ *
+ * @return Handle of allocated buffer
+ * @retval ODP_BUFFER_INVALID Buffer could not be allocated
+ */
+odp_buffer_t odp_buffer_alloc(odp_buffer_pool_t pool);
+
+/**
+ * Buffer free
+ *
+ * @param buf Buffer handle
+ *
+ */
+void odp_buffer_free(odp_buffer_t buf);
+
+/**
+ * @}
+ */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
@@ -20,7 +20,7 @@ extern "C" {
#include <odp_std_types.h>
#include <odp_atomic.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_buffer.h>
#include <odp_debug.h>
#include <odp_align.h>
@@ -21,7 +21,7 @@ extern "C" {
#include <odp_std_types.h>
#include <odp_align.h>
#include <odp_align_internal.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_buffer_internal.h>
#include <odp_hints.h>
#include <odp_config.h>
@@ -15,7 +15,7 @@
#include <odp_align.h>
#include <odp_buffer.h>
#include <odp_debug.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_packet.h>
#include <linux/version.h>
@@ -5,7 +5,7 @@
*/
#include <odp_std_types.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_buffer_internal.h>
#include <odp_buffer_pool_internal.h>
#include <odp_buffer_inlines.h>
@@ -6,7 +6,7 @@
#include <odp_event.h>
#include <odp_buffer.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_buffer_internal.h>
int odp_event_type(odp_event_t event)
@@ -10,7 +10,7 @@
#include <odp_queue.h>
#include <odp_shared_memory.h>
#include <odp_buffer.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_internal.h>
#include <odp_config.h>
#include <odp_debug_internal.h>
@@ -35,7 +35,7 @@
#include <odp_atomic_internal.h>
#include <odp_buffer.h>
#include <odp_buffer_inlines.h>
-#include <odp_buffer_pool.h>
+#include <odp_pool.h>
#include <odp_buffer_pool_internal.h>
#include <odp_debug.h>
#include <odp_debug_internal.h>
Renamed pool API header file. Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org> --- platform/linux-generic/Makefile.am | 2 +- platform/linux-generic/include/api/odp.h | 2 +- .../linux-generic/include/api/odp_buffer_pool.h | 182 --------------------- .../linux-generic/include/api/odp_classification.h | 2 +- platform/linux-generic/include/api/odp_crypto.h | 2 +- platform/linux-generic/include/api/odp_packet_io.h | 2 +- platform/linux-generic/include/api/odp_pool.h | 182 +++++++++++++++++++++ .../linux-generic/include/odp_buffer_internal.h | 2 +- .../include/odp_buffer_pool_internal.h | 2 +- platform/linux-generic/include/odp_packet_socket.h | 2 +- platform/linux-generic/odp_buffer_pool.c | 2 +- platform/linux-generic/odp_event.c | 2 +- platform/linux-generic/odp_schedule.c | 2 +- platform/linux-generic/odp_timer.c | 2 +- 14 files changed, 194 insertions(+), 194 deletions(-) delete mode 100644 platform/linux-generic/include/api/odp_buffer_pool.h create mode 100644 platform/linux-generic/include/api/odp_pool.h