DPDK  20.05.0
rte_stack.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2019 Intel Corporation
3  */
4 
16 #ifndef _RTE_STACK_H_
17 #define _RTE_STACK_H_
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 #include <rte_atomic.h>
24 #include <rte_compat.h>
25 #include <rte_debug.h>
26 #include <rte_errno.h>
27 #include <rte_memzone.h>
28 #include <rte_spinlock.h>
29 
30 #define RTE_TAILQ_STACK_NAME "RTE_STACK"
31 #define RTE_STACK_MZ_PREFIX "STK_"
32 
33 #define RTE_STACK_NAMESIZE (RTE_MEMZONE_NAMESIZE - \
34  sizeof(RTE_STACK_MZ_PREFIX) + 1)
35 
36 struct rte_stack_lf_elem {
37  void *data;
38  struct rte_stack_lf_elem *next;
39 };
40 
41 struct rte_stack_lf_head {
42  struct rte_stack_lf_elem *top;
43  uint64_t cnt;
44 };
45 
46 struct rte_stack_lf_list {
48  struct rte_stack_lf_head head __rte_aligned(16);
50  uint64_t len;
51 };
52 
53 /* Structure containing two lock-free LIFO lists: the stack itself and a list
54  * of free linked-list elements.
55  */
56 struct rte_stack_lf {
58  struct rte_stack_lf_list used __rte_cache_aligned;
60  struct rte_stack_lf_list free __rte_cache_aligned;
62  struct rte_stack_lf_elem elems[] __rte_cache_aligned;
63 };
64 
65 /* Structure containing the LIFO, its current length, and a lock for mutual
66  * exclusion.
67  */
68 struct rte_stack_std {
69  rte_spinlock_t lock;
70  uint32_t len;
71  void *objs[];
72 };
73 
74 /* The RTE stack structure contains the LIFO structure itself, plus metadata
75  * such as its name and memzone pointer.
76  */
77 struct rte_stack {
81  const struct rte_memzone *memzone;
82  uint32_t capacity;
83  uint32_t flags;
85  union {
86  struct rte_stack_lf stack_lf;
87  struct rte_stack_std stack_std;
88  };
90 
95 #define RTE_STACK_F_LF 0x0001
96 
97 #include "rte_stack_std.h"
98 #include "rte_stack_lf.h"
99 
115 __rte_experimental
116 static __rte_always_inline unsigned int
117 rte_stack_push(struct rte_stack *s, void * const *obj_table, unsigned int n)
118 {
119  RTE_ASSERT(s != NULL);
120  RTE_ASSERT(obj_table != NULL);
121 
122  if (s->flags & RTE_STACK_F_LF)
123  return __rte_stack_lf_push(s, obj_table, n);
124  else
125  return __rte_stack_std_push(s, obj_table, n);
126 }
127 
143 __rte_experimental
144 static __rte_always_inline unsigned int
145 rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n)
146 {
147  RTE_ASSERT(s != NULL);
148  RTE_ASSERT(obj_table != NULL);
149 
150  if (s->flags & RTE_STACK_F_LF)
151  return __rte_stack_lf_pop(s, obj_table, n);
152  else
153  return __rte_stack_std_pop(s, obj_table, n);
154 }
155 
167 __rte_experimental
168 static __rte_always_inline unsigned int
169 rte_stack_count(struct rte_stack *s)
170 {
171  RTE_ASSERT(s != NULL);
172 
173  if (s->flags & RTE_STACK_F_LF)
174  return __rte_stack_lf_count(s);
175  else
176  return __rte_stack_std_count(s);
177 }
178 
190 __rte_experimental
191 static __rte_always_inline unsigned int
192 rte_stack_free_count(struct rte_stack *s)
193 {
194  RTE_ASSERT(s != NULL);
195 
196  return s->capacity - rte_stack_count(s);
197 }
198 
229 __rte_experimental
230 struct rte_stack *
231 rte_stack_create(const char *name, unsigned int count, int socket_id,
232  uint32_t flags);
233 
243 __rte_experimental
244 void
245 rte_stack_free(struct rte_stack *s);
246 
261 __rte_experimental
262 struct rte_stack *
263 rte_stack_lookup(const char *name);
264 
265 #ifdef __cplusplus
266 }
267 #endif
268 
269 #endif /* _RTE_STACK_H_ */
#define __rte_always_inline
Definition: rte_common.h:193
__rte_experimental struct rte_stack * rte_stack_lookup(const char *name)
uint32_t flags
Definition: rte_memzone.h:70
__rte_experimental void rte_stack_free(struct rte_stack *s)
#define RTE_STACK_F_LF
Definition: rte_stack.h:95
static __rte_experimental __rte_always_inline unsigned int rte_stack_free_count(struct rte_stack *s)
Definition: rte_stack.h:192
static __rte_experimental __rte_always_inline unsigned int rte_stack_count(struct rte_stack *s)
Definition: rte_stack.h:169
static __rte_experimental __rte_always_inline unsigned int rte_stack_pop(struct rte_stack *s, void **obj_table, unsigned int n)
Definition: rte_stack.h:145
__rte_experimental struct rte_stack * rte_stack_create(const char *name, unsigned int count, int socket_id, uint32_t flags)
#define RTE_STD_C11
Definition: rte_common.h:40
#define __rte_cache_aligned
Definition: rte_common.h:367
#define RTE_STACK_NAMESIZE
Definition: rte_stack.h:33
static __rte_experimental __rte_always_inline unsigned int rte_stack_push(struct rte_stack *s, void *const *obj_table, unsigned int n)
Definition: rte_stack.h:117