4 * Copyright(c) 2010-2013 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Here defines rte_tailq APIs for only internal use
48 #include <sys/queue.h>
50 /** dummy structure type used by the rte_tailq APIs */
52 TAILQ_ENTRY(rte_dummy) next; /**< Pointer entries for a tailq list */
55 TAILQ_HEAD(rte_dummy_head, rte_dummy);
57 #define RTE_TAILQ_NAMESIZE 32
60 * The structure defining a tailq header entry for storing
61 * in the rte_config structure in shared memory. Each tailq
62 * is identified by name.
63 * Any library storing a set of objects e.g. rings, mempools, hash-tables,
64 * is recommended to use an entry here, so as to make it easy for
65 * a multi-process app to find already-created elements in shared memory.
67 struct rte_tailq_head {
68 struct rte_dummy_head tailq_head; /**< NOTE: must be first element */
72 * Utility macro to make reserving a tailqueue for a particular struct easier.
75 * The name to be given to the tailq - used by lookup to find it later
78 * The name of the list type we are using. (Generally this is the same as the
79 * first parameter passed to TAILQ_HEAD macro)
82 * The return value from rte_eal_tailq_reserve, typecast to the appropriate
83 * structure pointer type.
84 * NULL on error, since the tailq_head is the first
85 * element in the rte_tailq_head structure.
87 #define RTE_TAILQ_RESERVE(name, struct_name) \
88 (struct struct_name *)(&rte_eal_tailq_reserve(name)->tailq_head)
91 * Utility macro to make reserving a tailqueue for a particular struct easier.
94 * The tailq idx defined in rte_tail_t to be given to the tail queue.
95 * - used by lookup to find it later
98 * The name of the list type we are using. (Generally this is the same as the
99 * first parameter passed to TAILQ_HEAD macro)
102 * The return value from rte_eal_tailq_reserve, typecast to the appropriate
103 * structure pointer type.
104 * NULL on error, since the tailq_head is the first
105 * element in the rte_tailq_head structure.
107 #define RTE_TAILQ_RESERVE_BY_IDX(idx, struct_name) \
108 (struct struct_name *)(&rte_eal_tailq_reserve_by_idx(idx)->tailq_head)
111 * Utility macro to make looking up a tailqueue for a particular struct easier.
117 * The name of the list type we are using. (Generally this is the same as the
118 * first parameter passed to TAILQ_HEAD macro)
121 * The return value from rte_eal_tailq_lookup, typecast to the appropriate
122 * structure pointer type.
123 * NULL on error, since the tailq_head is the first
124 * element in the rte_tailq_head structure.
126 #define RTE_TAILQ_LOOKUP(name, struct_name) \
127 (struct struct_name *)(&rte_eal_tailq_lookup(name)->tailq_head)
130 * Utility macro to make looking up a tailqueue for a particular struct easier.
133 * The tailq idx defined in rte_tail_t to be given to the tail queue.
136 * The name of the list type we are using. (Generally this is the same as the
137 * first parameter passed to TAILQ_HEAD macro)
140 * The return value from rte_eal_tailq_lookup, typecast to the appropriate
141 * structure pointer type.
142 * NULL on error, since the tailq_head is the first
143 * element in the rte_tailq_head structure.
145 #define RTE_TAILQ_LOOKUP_BY_IDX(idx, struct_name) \
146 (struct struct_name *)(&rte_eal_tailq_lookup_by_idx(idx)->tailq_head)
149 * Reserve a slot in the tailq list for a particular tailq header
150 * Note: this function, along with rte_tailq_lookup, is not multi-thread safe,
151 * and both these functions should only be called from a single thread at a time
154 * The name to be given to the tail queue.
156 * A pointer to the newly reserved tailq entry
158 struct rte_tailq_head *rte_eal_tailq_reserve(const char *name);
161 * Reserve a slot in the tailq list for a particular tailq header
162 * Note: this function, along with rte_tailq_lookup, is not multi-thread safe,
163 * and both these functions should only be called from a single thread at a time
166 * The tailq idx defined in rte_tail_t to be given to the tail queue.
168 * A pointer to the newly reserved tailq entry
170 struct rte_tailq_head *rte_eal_tailq_reserve_by_idx(const unsigned idx);
173 * Dump tail queues to the console.
175 void rte_dump_tailq(void);
178 * Lookup for a tail queue.
180 * Get a pointer to a tail queue header of an already reserved tail
181 * queue identified by the name given as an argument.
182 * Note: this function, along with rte_tailq_reserve, is not multi-thread safe,
183 * and both these functions should only be called from a single thread at a time
186 * The name of the queue.
188 * A pointer to the tail queue head structure.
190 struct rte_tailq_head *rte_eal_tailq_lookup(const char *name);
193 * Lookup for a tail queue.
195 * Get a pointer to a tail queue header of an already reserved tail
196 * queue identified by the name given as an argument.
197 * Note: this function, along with rte_tailq_reserve, is not multi-thread safe,
198 * and both these functions should only be called from a single thread at a time
201 * The tailq idx defined in rte_tail_t to be given to the tail queue.
203 * A pointer to the tail queue head structure.
205 struct rte_tailq_head *rte_eal_tailq_lookup_by_idx(const unsigned idx);
211 #endif /* _RTE_TAILQ_H_ */