lib/librte_eal/common/include/rte_lcore.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 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 #ifndef _RTE_LCORE_H_
  35 #define _RTE_LCORE_H_
  36
  37 /**
  38  * @file
  39  *
  40  * API for lcore and socket manipulation
  41  *
  42  */
  43 #include <rte_per_lcore.h>
  44 #include <rte_eal.h>
  45 #include <rte_launch.h>
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif
  50
  51 #define LCORE_ID_ANY -1    /**< Any lcore. */
  52
  53 /**
  54  * Structure storing internal configuration (per-lcore)
  55  */
  56 struct lcore_config {
  57         unsigned detected;         /**< true if lcore was detected */
  58         pthread_t thread_id;       /**< pthread identifier */
  59         int pipe_master2slave[2];  /**< communication pipe with master */
  60         int pipe_slave2master[2];  /**< communication pipe with master */
  61         lcore_function_t * volatile f;         /**< function to call */
  62         void * volatile arg;       /**< argument of function */
  63         volatile int ret;          /**< return value of function */
  64         volatile enum rte_lcore_state_t state; /**< lcore state */
  65         unsigned socket_id;        /**< physical socket id for this lcore */
  66         unsigned core_id;          /**< core number on socket for this lcore */
  67 };
  68
  69 /**
  70  * Internal configuration (per-lcore)
  71  */
  72 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
  73
  74 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per core "core id". */
  75
  76 /**
  77  * Return the ID of the execution unit we are running on.
  78  * @return
  79  *  Logical core ID
  80  */
  81 static inline unsigned
  82 rte_lcore_id(void)
  83 {
  84         return RTE_PER_LCORE(_lcore_id);
  85 }
  86
  87 /**
  88  * Get the id of the master lcore
  89  *
  90  * @return
  91  *   the id of the master lcore
  92  */
  93 static inline unsigned
  94 rte_get_master_lcore(void)
  95 {
  96         return rte_eal_get_configuration()->master_lcore;
  97 }
  98
  99 /**
 100  * Return the number of execution units (lcores) on the system.
 101  *
 102  * @return
 103  *   the number of execution units (lcores) on the system.
 104  */
 105 static inline unsigned
 106 rte_lcore_count(void)
 107 {
 108         const struct rte_config *cfg = rte_eal_get_configuration();
 109         return cfg->lcore_count;
 110 }
 111
 112 /**
 113  * Return the ID of the physical socket of the logical core we are
 114  * running on.
 115  * @return
 116  *   the ID of current lcoreid's physical socket
 117  */
 118 static inline unsigned
 119 rte_socket_id(void)
 120 {
 121         return lcore_config[rte_lcore_id()].socket_id;
 122 }
 123
 124 /**
 125  * Get the ID of the physical socket of the specified lcore
 126  *
 127  * @param lcore_id
 128  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
 129  * @return
 130  *   the ID of lcoreid's physical socket
 131  */
 132 static inline unsigned
 133 rte_lcore_to_socket_id(unsigned lcore_id)
 134 {
 135         return lcore_config[lcore_id].socket_id;
 136 }
 137
 138 /**
 139  * Test if an lcore is enabled.
 140  *
 141  * @param lcore_id
 142  *   The identifier of the lcore, which MUST be between 0 and
 143  *   RTE_MAX_LCORE-1.
 144  * @return
 145  *   True if the given lcore is enabled; false otherwise.
 146  */
 147 static inline int
 148 rte_lcore_is_enabled(unsigned lcore_id)
 149 {
 150         struct rte_config *cfg = rte_eal_get_configuration();
 151         if (lcore_id >= RTE_MAX_LCORE)
 152                 return 0;
 153         return (cfg->lcore_role[lcore_id] != ROLE_OFF);
 154 }
 155
 156 /**
 157  * Get the next enabled lcore ID.
 158  *
 159  * @param i
 160  *   The current lcore (reference).
 161  * @param skip_master
 162  *   If true, do not return the ID of the master lcore.
 163  * @param wrap
 164  *   If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
 165  *   return RTE_MAX_LCORE.
 166  * @return
 167  *   The next lcore_id or RTE_MAX_LCORE if not found.
 168  */
 169 static inline unsigned
 170 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
 171 {
 172         i++;
 173         if (wrap)
 174                 i %= RTE_MAX_LCORE;
 175
 176         while (i < RTE_MAX_LCORE) {
 177                 if (!rte_lcore_is_enabled(i) ||
 178                     (skip_master && (i == rte_get_master_lcore()))) {
 179                         i++;
 180                         if (wrap)
 181                                 i %= RTE_MAX_LCORE;
 182                         continue;
 183                 }
 184                 break;
 185         }
 186         return i;
 187 }
 188 /**
 189  * Macro to browse all running lcores.
 190  */
 191 #define RTE_LCORE_FOREACH(i)                                            \
 192         for (i = rte_get_next_lcore(-1, 0, 0);                          \
 193              i<RTE_MAX_LCORE;                                           \
 194              i = rte_get_next_lcore(i, 0, 0))
 195
 196 /**
 197  * Macro to browse all running lcores except the master lcore.
 198  */
 199 #define RTE_LCORE_FOREACH_SLAVE(i)                                      \
 200         for (i = rte_get_next_lcore(-1, 1, 0);                          \
 201              i<RTE_MAX_LCORE;                                           \
 202              i = rte_get_next_lcore(i, 1, 0))
 203
 204 #ifdef __cplusplus
 205 }
 206 #endif
 207
 208
 209 #endif /* _RTE_LCORE_H_ */