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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/* Copyright (c) 2013, Linaro Limited
* All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/**
* @file
*
* ODP queue
*/
#ifndef ODP_QUEUE_H_
#define ODP_QUEUE_H_
#ifdef __cplusplus
extern "C" {
#endif
#include <odp/std_types.h>
#include <odp/platform_types.h>
/** @defgroup odp_queue ODP QUEUE
* Macros and operation on a queue.
* @{
*/
/**
* ODP queue
*/
typedef uint32_t odp_queue_t;
/**
* Queue group instance type
*/
typedef uint32_t odp_queue_group_t;
/** Invalid queue */
#define ODP_QUEUE_INVALID 0
/** Maximum queue name lenght in chars */
#define ODP_QUEUE_NAME_LEN 32
/**
* ODP queue type
*/
typedef int odp_queue_type_t;
#define ODP_QUEUE_TYPE_SCHED 0 /**< Scheduled queue */
#define ODP_QUEUE_TYPE_POLL 1 /**< Not scheduled queue */
#define ODP_QUEUE_TYPE_PKTIN 2 /**< Packet input queue */
#define ODP_QUEUE_TYPE_PKTOUT 3 /**< Packet output queue */
/**
* ODP schedule priority
*/
typedef int odp_schedule_prio_t;
/** Highest scheduling priority */
#define ODP_SCHED_PRIO_HIGHEST 0
/** Normal scheduling priority */
#define ODP_SCHED_PRIO_NORMAL (ODP_CONFIG_SCHED_PRIOS / 2)
/** Lowest scheduling priority */
#define ODP_SCHED_PRIO_LOWEST (ODP_CONFIG_SCHED_PRIOS - 1)
/** Default scheduling priority */
#define ODP_SCHED_PRIO_DEFAULT ODP_SCHED_PRIO_NORMAL
/**
* ODP schedule synchronisation
*/
typedef int odp_schedule_sync_t;
#define ODP_SCHED_SYNC_NONE 0 /**< Queue not synchronised */
#define ODP_SCHED_SYNC_ATOMIC 1 /**< Atomic queue */
#define ODP_SCHED_SYNC_ORDERED 2 /**< Ordered queue */
/** Default queue synchronisation */
#define ODP_SCHED_SYNC_DEFAULT ODP_SCHED_SYNC_ATOMIC
/**
* ODP schedule CPU group
*/
typedef int odp_schedule_group_t;
/** Group of all CPUs */
#define ODP_SCHED_GROUP_ALL 0
/** Default CPU group */
#define ODP_SCHED_GROUP_DEFAULT ODP_SCHED_GROUP_ALL
/**
* ODP Queue parameters
*/
typedef struct odp_queue_param_t {
/** Scheduler parameters */
struct {
odp_schedule_prio_t prio;
odp_schedule_sync_t sync;
odp_schedule_group_t group;
} sched;
/** Queue context */
void *context;
} odp_queue_param_t;
/**
* Queue create
*
* @param name Queue name
* @param type Queue type
* @param param Queue parameters. Uses defaults if NULL.
*
* @return Queue handle or ODP_QUEUE_INVALID
*/
odp_queue_t odp_queue_create(const char *name, odp_queue_type_t type,
odp_queue_param_t *param);
/**
* Destroy ODP queue
*
* Destroys ODP queue. The queue must be empty and detached from other
* ODP API (crypto, pktio, etc). Application must ensure that no other
* operations on this queue are invoked in parallel. Otherwise behavior
* is undefined.
*
* @param queue Queue handle
*
* @return 0 if successful
*/
int odp_queue_destroy(odp_queue_t queue);
/**
* Find a queue by name
*
* @param name Queue name
*
* @return Queue handle or ODP_QUEUE_INVALID
*/
odp_queue_t odp_queue_lookup(const char *name);
/**
* Set queue context
*
* Its the responsability of the interface user to make sure
* queue context allocation is done in an area reachable for
* all EOs accessing the context
*
* @param queue Queue handle
* @param context Address to the queue context
*
* @return 0 if successful
*/
int odp_queue_set_context(odp_queue_t queue, void *context);
/**
* Get queue context
*
* @param queue Queue handle
*
* @return If successful, a pointer to the queue context,
* NULL for failure.
*/
void *odp_queue_get_context(odp_queue_t queue);
/**
* Queue enqueue
*
* @param queue Queue handle
* @param ev Event handle
*
* @return 0 if succesful
*/
int odp_queue_enq(odp_queue_t queue, odp_event_t ev);
/**
* Enqueue multiple events to a queue
*
* @param queue Queue handle
* @param ev Event handles
* @param num Number of event handles
*
* @return 0 if succesful
*/
int odp_queue_enq_multi(odp_queue_t queue, odp_event_t ev[], int num);
/**
* Queue dequeue
*
* Dequeues next event from head of the queue. Cannot be used for
* ODP_QUEUE_TYPE_SCHED type queues (use odp_schedule() instead).
*
* @param queue Queue handle
*
* @return Event handle, or ODP_EVENT_INVALID
*/
odp_event_t odp_queue_deq(odp_queue_t queue);
/**
* Dequeue multiple events from a queue
*
* Dequeues multiple events from head of the queue. Cannot be used for
* ODP_QUEUE_TYPE_SCHED type queues (use odp_schedule() instead).
*
* @param queue Queue handle
* @param events Event handle array for output
* @param num Maximum number of event handles
* @return Number of events written (0 ... num)
*/
int odp_queue_deq_multi(odp_queue_t queue, odp_event_t events[], int num);
/**
* Queue type
*
* @param queue Queue handle
*
* @return Queue type
*/
odp_queue_type_t odp_queue_type(odp_queue_t queue);
/**
* Queue schedule type
*
* @param queue Queue handle
*
* @return Queue schedule synchronisation type
*/
odp_schedule_sync_t odp_queue_sched_type(odp_queue_t queue);
/**
* Queue priority
*
* @note Passing an invalid queue_handle will result in UNDEFINED behavior
*
* @param queue Queue handle
*
* @return Queue schedule priority
*/
odp_schedule_prio_t odp_queue_sched_prio(odp_queue_t queue);
/**
* Queue group
*
* @note Passing an invalid queue_handle will result in UNDEFINED behavior
*
* @param queue Queue handle
*
* @return Queue schedule group
*/
odp_schedule_group_t odp_queue_sched_group(odp_queue_t queue);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif
|
