4 * Copyright(c) 2010-2012 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.
33 * version: DPDK.L.1.2.3-3
49 #include <sys/queue.h>
52 /** dummy structure type used by the rte_tailq APIs */
54 TAILQ_ENTRY(rte_dummy) next; /**< Pointer entries for a tailq list */
57 TAILQ_HEAD(rte_dummy_head, rte_dummy);
59 #define RTE_TAILQ_NAMESIZE 32
62 * The structure defining a tailq header entry for storing
63 * in the rte_config structure in shared memory. Each tailq
64 * is identified by name.
65 * Any library storing a set of objects e.g. rings, mempools, hash-tables,
66 * is recommended to use an entry here, so as to make it easy for
67 * a multi-process app to find already-created elements in shared memory.
69 struct rte_tailq_head {
70 struct rte_dummy_head tailq_head; /**< NOTE: must be first element */
71 char qname[RTE_TAILQ_NAMESIZE]; /**< Queue name */
74 struct rte_tailq_head {};
78 * Utility macro to make reserving a tailqueue for a particular struct easier.
81 * The name to be given to the tailq - used by lookup to find it later
84 * The name of the list type we are using. (Generally this is the same as the
85 * first parameter passed to TAILQ_HEAD macro)
88 * The return value from rte_eal_tailq_reserve, typecast to the appropriate
89 * structure pointer type.
90 * NULL on error, since the tailq_head is the first
91 * element in the rte_tailq_head structure.
93 #define RTE_TAILQ_RESERVE(name, struct_name) \
94 (struct struct_name *)(&rte_eal_tailq_reserve(name)->tailq_head)
97 * Utility macro to make looking up a tailqueue for a particular struct easier.
100 * The name of the tailq
103 * The name of the list type we are using. (Generally this is the same as the
104 * first parameter passed to TAILQ_HEAD macro)
107 * The return value from rte_eal_tailq_lookup, typecast to the appropriate
108 * structure pointer type.
109 * NULL on error, since the tailq_head is the first
110 * element in the rte_tailq_head structure.
112 #define RTE_TAILQ_LOOKUP(name, struct_name) \
113 (struct struct_name *)(&rte_eal_tailq_lookup(name)->tailq_head)
116 * Reserve a slot in the tailq list for a particular tailq header
117 * Note: this function, along with rte_tailq_lookup, is not multi-thread safe,
118 * and both these functions should only be called from a single thread at a time
121 * The name to be given to the tail queue.
123 * A pointer to the newly reserved tailq entry
125 struct rte_tailq_head *rte_eal_tailq_reserve(const char *name);
128 * Lookup for a tail queue.
130 * Get a pointer to a tail queue header of an already reserved tail
131 * queue identified by the name given as an argument.
132 * Note: this function, along with rte_tailq_reserve, is not multi-thread safe,
133 * and both these functions should only be called from a single thread at a time
136 * The name of the queue.
138 * A pointer to the tail queue head structure.
140 struct rte_tailq_head *rte_eal_tailq_lookup(const char *name);
146 #endif /* _RTE_TAILQ_H_ */