lib/librte_eal/common/include/rte_tailq.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  *
  33  */
  34
  35 #ifndef _RTE_TAILQ_H_
  36 #define _RTE_TAILQ_H_
  37
  38 /**
  39  * @file
  40  *
  41  */
  42
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 #include <sys/queue.h>
  49
  50 #ifndef __KERNEL__
  51 /** dummy structure type used by the rte_tailq APIs */
  52 struct rte_dummy {
  53         TAILQ_ENTRY(rte_dummy) next; /**< Pointer entries for a tailq list */
  54 };
  55 /** dummy */
  56 TAILQ_HEAD(rte_dummy_head, rte_dummy);
  57
  58 #define RTE_TAILQ_NAMESIZE 32
  59
  60 /**
  61  * The structure defining a tailq header entry for storing
  62  * in the rte_config structure in shared memory. Each tailq
  63  * is identified by name.
  64  * Any library storing a set of objects e.g. rings, mempools, hash-tables,
  65  * is recommended to use an entry here, so as to make it easy for
  66  * a multi-process app to find already-created elements in shared memory.
  67  */
  68 struct rte_tailq_head {
  69         struct rte_dummy_head tailq_head; /**< NOTE: must be first element */
  70         char qname[RTE_TAILQ_NAMESIZE]; /**< Queue name */
  71 };
  72 #else
  73 struct rte_tailq_head {};
  74 #endif
  75
  76 /**
  77  * Utility macro to make reserving a tailqueue for a particular struct easier.
  78  *
  79  * @param name
  80  *   The name to be given to the tailq - used by lookup to find it later
  81  *
  82  * @param struct_name
  83  *   The name of the list type we are using. (Generally this is the same as the
  84  *   first parameter passed to TAILQ_HEAD macro)
  85  *
  86  * @return
  87  *   The return value from rte_eal_tailq_reserve, typecast to the appropriate
  88  *   structure pointer type.
  89  *   NULL on error, since the tailq_head is the first
  90  *   element in the rte_tailq_head structure.
  91  */
  92 #define RTE_TAILQ_RESERVE(name, struct_name) \
  93         (struct struct_name *)(&rte_eal_tailq_reserve(name)->tailq_head)
  94
  95 /**
  96  * Utility macro to make looking up a tailqueue for a particular struct easier.
  97  *
  98  * @param name
  99  *   The name of the tailq
 100  *
 101  * @param struct_name
 102  *   The name of the list type we are using. (Generally this is the same as the
 103  *   first parameter passed to TAILQ_HEAD macro)
 104  *
 105  * @return
 106  *   The return value from rte_eal_tailq_lookup, typecast to the appropriate
 107  *   structure pointer type.
 108  *   NULL on error, since the tailq_head is the first
 109  *   element in the rte_tailq_head structure.
 110  */
 111 #define RTE_TAILQ_LOOKUP(name, struct_name) \
 112         (struct struct_name *)(&rte_eal_tailq_lookup(name)->tailq_head)
 113
 114 /**
 115  * Reserve a slot in the tailq list for a particular tailq header
 116  * Note: this function, along with rte_tailq_lookup, is not multi-thread safe,
 117  * and both these functions should only be called from a single thread at a time
 118  *
 119  * @param name
 120  *   The name to be given to the tail queue.
 121  * @return
 122  *   A pointer to the newly reserved tailq entry
 123  */
 124 struct rte_tailq_head *rte_eal_tailq_reserve(const char *name);
 125
 126 /**
 127  * Lookup for a tail queue.
 128  *
 129  * Get a pointer to a tail queue header of an already reserved tail
 130  * queue identified by the name given as an argument.
 131  * Note: this function, along with rte_tailq_reserve, is not multi-thread safe,
 132  * and both these functions should only be called from a single thread at a time
 133  *
 134  * @param name
 135  *   The name of the queue.
 136  * @return
 137  *   A pointer to the tail queue head structure.
 138  */
 139 struct rte_tailq_head *rte_eal_tailq_lookup(const char *name);
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif
 144
 145 #endif /* _RTE_TAILQ_H_ */