blob: 87a194ce9b353ae0b96cdd65d5b5df31d9fdfa39 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/* Copyright (c) 2015, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP pool
*/
#ifndef ODP_API_POOL_H_
#define ODP_API_POOL_H_
#include <odp/api/visibility_begin.h>
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/api/std_types.h>
/** @defgroup odp_pool ODP POOL
* Operations on a pool.
* @{
*/
/**
* @typedef odp_pool_t
* ODP pool
*/
/**
* @def ODP_POOL_INVALID
* Invalid pool
*/
/** Maximum queue name length in chars */
#define ODP_POOL_NAME_LEN 32
/**
* Pool parameters
* Used to communicate pool creation options.
* @note A single thread may not be able to allocate all 'num' elements
* from the pool at any particular time, as other threads or hardware
* blocks are allowed to keep some for caching purposes.
*/
typedef struct odp_pool_param_t {
/** Pool type */
int type;
union {
struct {
/** Number of buffers in the pool */
uint32_t num;
/** Buffer size in bytes. The maximum number of bytes
application will store in each buffer. */
uint32_t size;
/** 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 align;
} buf;
struct {
/** The number of packets that the pool must provide
that are packet length 'len' bytes or smaller. */
uint32_t num;
/** Minimum packet length that the pool must provide
'num' packets. The number of packets may be less
than 'num' when packets are larger than 'len'.
Use 0 for default. */
uint32_t len;
/** Minimum number of packet data bytes that are stored
in the first segment of a packet. The maximum value
is defined by ODP_CONFIG_PACKET_SEG_LEN_MAX.
Use 0 for default. */
uint32_t seg_len;
/** User area size in bytes. Specify as 0 if no user
area is needed. */
uint32_t uarea_size;
} pkt;
struct {
/** Number of timeouts in the pool */
uint32_t num;
} tmo;
};
} odp_pool_param_t;
/** Packet pool*/
#define ODP_POOL_PACKET ODP_EVENT_PACKET
/** Buffer pool */
#define ODP_POOL_BUFFER ODP_EVENT_BUFFER
/** Timeout pool */
#define ODP_POOL_TIMEOUT ODP_EVENT_TIMEOUT
/**
* Create a pool
*
* This routine is used to create a pool. It take two arguments: the optional
* name of the pool to be created 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_pool_lookup().
*
* @param name Name of the pool, max ODP_POOL_NAME_LEN-1 chars.
* May be specified as NULL for anonymous pools.
*
* @param params Pool parameters.
*
* @return Handle of the created pool
* @retval ODP_POOL_INVALID Pool could not be created
*/
odp_pool_t odp_pool_create(const char *name, odp_pool_param_t *params);
/**
* Destroy a pool previously created by odp_pool_create()
*
* @param pool Handle of the pool to be destroyed
*
* @retval 0 Success
* @retval -1 Failure
*
* @note This routine destroys a previously created pool, and will destroy any
* internal shared memory objects associated with the pool. Results are
* undefined if an attempt is made to destroy a pool that contains allocated
* or otherwise active buffers.
*/
int odp_pool_destroy(odp_pool_t pool);
/**
* Find a pool by name
*
* @param name Name of the pool
*
* @return Handle of found pool
* @retval ODP_POOL_INVALID Pool could not be found
*
* @note This routine cannot be used to look up an anonymous pool (one created
* with no name).
*/
odp_pool_t odp_pool_lookup(const char *name);
/**
* Pool information struct
* Used to get information about a pool.
*/
typedef struct odp_pool_info_t {
const char *name; /**< pool name */
odp_pool_param_t params; /**< pool parameters */
} odp_pool_info_t;
/**
* Retrieve information about a pool
*
* @param pool Pool handle
*
* @param[out] info Receives an odp_pool_info_t object
* that describes the pool.
*
* @retval 0 Success
* @retval -1 Failure. Info could not be retrieved.
*/
int odp_pool_info(odp_pool_t pool, odp_pool_info_t *info);
/**
* Print pool info
*
* @param pool Pool handle
*
* @note This routine writes implementation-defined information about the
* specified pool to the ODP log. The intended use is for debugging.
*/
void odp_pool_print(odp_pool_t pool);
/**
* Get printable value for an odp_pool_t
*
* @param hdl odp_pool_t handle to be printed
* @return uint64_t value that can be used to print/display this
* handle
*
* @note This routine is intended to be used for diagnostic purposes
* to enable applications to generate a printable value that represents
* an odp_pool_t handle.
*/
uint64_t odp_pool_to_u64(odp_pool_t hdl);
/**
* Initialize pool params
*
* Initialize an odp_pool_param_t to its default values for all fields
*
* @param param Address of the odp_pool_param_t to be initialized
*/
void odp_pool_param_init(odp_pool_param_t *param);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#include <odp/api/visibility_end.h>
#endif
|
