4 * Copyright(c) 2010-2014 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.
39 * Here defines rte_tailq APIs for only internal use
47 #include <sys/queue.h>
49 /** dummy structure type used by the rte_tailq APIs */
51 TAILQ_ENTRY(rte_dummy) next; /**< Pointer entries for a tailq list */
54 TAILQ_HEAD(rte_dummy_head, rte_dummy);
56 #define RTE_TAILQ_NAMESIZE 32
59 * The structure defining a tailq header entry for storing
60 * in the rte_config structure in shared memory. Each tailq
61 * is identified by name.
62 * Any library storing a set of objects e.g. rings, mempools, hash-tables,
63 * is recommended to use an entry here, so as to make it easy for
64 * a multi-process app to find already-created elements in shared memory.
66 struct rte_tailq_head {
67 struct rte_dummy_head tailq_head; /**< NOTE: must be first element */
71 * Utility macro to make reserving a tailqueue for a particular struct easier.
74 * The name to be given to the tailq - used by lookup to find it later
77 * The name of the list type we are using. (Generally this is the same as the
78 * first parameter passed to TAILQ_HEAD macro)
81 * The return value from rte_eal_tailq_reserve, typecast to the appropriate
82 * structure pointer type.
83 * NULL on error, since the tailq_head is the first
84 * element in the rte_tailq_head structure.
86 #define RTE_TAILQ_RESERVE(name, struct_name) \
87 (struct struct_name *)(&rte_eal_tailq_reserve(name)->tailq_head)
90 * Utility macro to make reserving a tailqueue for a particular struct easier.
93 * The tailq idx defined in rte_tail_t to be given to the tail queue.
94 * - used by lookup to find it later
97 * The name of the list type we are using. (Generally this is the same as the
98 * first parameter passed to TAILQ_HEAD macro)
101 * The return value from rte_eal_tailq_reserve, typecast to the appropriate
102 * structure pointer type.
103 * NULL on error, since the tailq_head is the first
104 * element in the rte_tailq_head structure.
106 #define RTE_TAILQ_RESERVE_BY_IDX(idx, struct_name) \
107 (struct struct_name *)(&rte_eal_tailq_reserve_by_idx(idx)->tailq_head)
110 * Utility macro to make looking up a tailqueue for a particular struct easier.
116 * The name of the list type we are using. (Generally this is the same as the
117 * first parameter passed to TAILQ_HEAD macro)
120 * The return value from rte_eal_tailq_lookup, typecast to the appropriate
121 * structure pointer type.
122 * NULL on error, since the tailq_head is the first
123 * element in the rte_tailq_head structure.
125 #define RTE_TAILQ_LOOKUP(name, struct_name) \
126 (struct struct_name *)(&rte_eal_tailq_lookup(name)->tailq_head)
129 * Utility macro to make looking up a tailqueue for a particular struct easier.
132 * The tailq idx defined in rte_tail_t to be given to the tail queue.
135 * The name of the list type we are using. (Generally this is the same as the
136 * first parameter passed to TAILQ_HEAD macro)
139 * The return value from rte_eal_tailq_lookup, typecast to the appropriate
140 * structure pointer type.
141 * NULL on error, since the tailq_head is the first
142 * element in the rte_tailq_head structure.
144 #define RTE_TAILQ_LOOKUP_BY_IDX(idx, struct_name) \
145 (struct struct_name *)(&rte_eal_tailq_lookup_by_idx(idx)->tailq_head)
148 * Reserve a slot in the tailq list for a particular tailq header
149 * Note: this function, along with rte_tailq_lookup, is not multi-thread safe,
150 * and both these functions should only be called from a single thread at a time
153 * The name to be given to the tail queue.
155 * A pointer to the newly reserved tailq entry
157 struct rte_tailq_head *rte_eal_tailq_reserve(const char *name);
160 * Reserve a slot in the tailq list for a particular tailq header
161 * Note: this function, along with rte_tailq_lookup, is not multi-thread safe,
162 * and both these functions should only be called from a single thread at a time
165 * The tailq idx defined in rte_tail_t to be given to the tail queue.
167 * A pointer to the newly reserved tailq entry
169 struct rte_tailq_head *rte_eal_tailq_reserve_by_idx(const unsigned idx);
172 * Dump tail queues to the console.
175 * A pointer to a file for output
177 void rte_dump_tailq(FILE *f);
180 * Lookup for a tail queue.
182 * Get a pointer to a tail queue header of an already reserved tail
183 * queue identified by the name given as an argument.
184 * Note: this function, along with rte_tailq_reserve, is not multi-thread safe,
185 * and both these functions should only be called from a single thread at a time
188 * The name of the queue.
190 * A pointer to the tail queue head structure.
192 struct rte_tailq_head *rte_eal_tailq_lookup(const char *name);
195 * Lookup for a tail queue.
197 * Get a pointer to a tail queue header of an already reserved tail
198 * queue identified by the name given as an argument.
199 * Note: this function, along with rte_tailq_reserve, is not multi-thread safe,
200 * and both these functions should only be called from a single thread at a time
203 * The tailq idx defined in rte_tail_t to be given to the tail queue.
205 * A pointer to the tail queue head structure.
207 struct rte_tailq_head *rte_eal_tailq_lookup_by_idx(const unsigned idx);
213 #endif /* _RTE_TAILQ_H_ */