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 #if defined(__linux__)
  54         typedef cpu_set_t rte_cpuset_t;
  55 #elif defined(__FreeBSD__)
  56 #include <pthread_np.h>
  57         typedef cpuset_t rte_cpuset_t;
  58 #endif
  59
  60 /**
  61  * Structure storing internal configuration (per-lcore)
  62  */
  63 struct lcore_config {
  64         unsigned detected;         /**< true if lcore was detected */
  65         pthread_t thread_id;       /**< pthread identifier */
  66         int pipe_master2slave[2];  /**< communication pipe with master */
  67         int pipe_slave2master[2];  /**< communication pipe with master */
  68         lcore_function_t * volatile f;         /**< function to call */
  69         void * volatile arg;       /**< argument of function */
  70         volatile int ret;          /**< return value of function */
  71         volatile enum rte_lcore_state_t state; /**< lcore state */
  72         unsigned socket_id;        /**< physical socket id for this lcore */
  73         unsigned core_id;          /**< core number on socket for this lcore */
  74         int core_index;            /**< relative index, starting from 0 */
  75         rte_cpuset_t cpuset;       /**< cpu set which the lcore affinity to */
  76 };
  77
  78 /**
  79  * Internal configuration (per-lcore)
  80  */
  81 extern struct lcore_config lcore_config[RTE_MAX_LCORE];
  82
  83 RTE_DECLARE_PER_LCORE(unsigned, _lcore_id); /**< Per core "core id". */
  84
  85 /**
  86  * Return the ID of the execution unit we are running on.
  87  * @return
  88  *  Logical core ID
  89  */
  90 static inline unsigned
  91 rte_lcore_id(void)
  92 {
  93         return RTE_PER_LCORE(_lcore_id);
  94 }
  95
  96 /**
  97  * Get the id of the master lcore
  98  *
  99  * @return
 100  *   the id of the master lcore
 101  */
 102 static inline unsigned
 103 rte_get_master_lcore(void)
 104 {
 105         return rte_eal_get_configuration()->master_lcore;
 106 }
 107
 108 /**
 109  * Return the number of execution units (lcores) on the system.
 110  *
 111  * @return
 112  *   the number of execution units (lcores) on the system.
 113  */
 114 static inline unsigned
 115 rte_lcore_count(void)
 116 {
 117         const struct rte_config *cfg = rte_eal_get_configuration();
 118         return cfg->lcore_count;
 119 }
 120
 121 /**
 122  * Return the index of the lcore starting from zero.
 123  * The order is physical or given by command line (-l option).
 124  *
 125  * @param lcore_id
 126  *   The targeted lcore, or -1 for the current one.
 127  * @return
 128  *   The relative index, or -1 if not enabled.
 129  */
 130 static inline int
 131 rte_lcore_index(int lcore_id)
 132 {
 133         if (lcore_id >= RTE_MAX_LCORE)
 134                 return -1;
 135         if (lcore_id < 0)
 136                 lcore_id = rte_lcore_id();
 137         return lcore_config[lcore_id].core_index;
 138 }
 139
 140 /**
 141  * Return the ID of the physical socket of the logical core we are
 142  * running on.
 143  * @return
 144  *   the ID of current lcoreid's physical socket
 145  */
 146 static inline unsigned
 147 rte_socket_id(void)
 148 {
 149         return lcore_config[rte_lcore_id()].socket_id;
 150 }
 151
 152 /**
 153  * Get the ID of the physical socket of the specified lcore
 154  *
 155  * @param lcore_id
 156  *   the targeted lcore, which MUST be between 0 and RTE_MAX_LCORE-1.
 157  * @return
 158  *   the ID of lcoreid's physical socket
 159  */
 160 static inline unsigned
 161 rte_lcore_to_socket_id(unsigned lcore_id)
 162 {
 163         return lcore_config[lcore_id].socket_id;
 164 }
 165
 166 /**
 167  * Test if an lcore is enabled.
 168  *
 169  * @param lcore_id
 170  *   The identifier of the lcore, which MUST be between 0 and
 171  *   RTE_MAX_LCORE-1.
 172  * @return
 173  *   True if the given lcore is enabled; false otherwise.
 174  */
 175 static inline int
 176 rte_lcore_is_enabled(unsigned lcore_id)
 177 {
 178         struct rte_config *cfg = rte_eal_get_configuration();
 179         if (lcore_id >= RTE_MAX_LCORE)
 180                 return 0;
 181         return (cfg->lcore_role[lcore_id] != ROLE_OFF);
 182 }
 183
 184 /**
 185  * Get the next enabled lcore ID.
 186  *
 187  * @param i
 188  *   The current lcore (reference).
 189  * @param skip_master
 190  *   If true, do not return the ID of the master lcore.
 191  * @param wrap
 192  *   If true, go back to 0 when RTE_MAX_LCORE is reached; otherwise,
 193  *   return RTE_MAX_LCORE.
 194  * @return
 195  *   The next lcore_id or RTE_MAX_LCORE if not found.
 196  */
 197 static inline unsigned
 198 rte_get_next_lcore(unsigned i, int skip_master, int wrap)
 199 {
 200         i++;
 201         if (wrap)
 202                 i %= RTE_MAX_LCORE;
 203
 204         while (i < RTE_MAX_LCORE) {
 205                 if (!rte_lcore_is_enabled(i) ||
 206                     (skip_master && (i == rte_get_master_lcore()))) {
 207                         i++;
 208                         if (wrap)
 209                                 i %= RTE_MAX_LCORE;
 210                         continue;
 211                 }
 212                 break;
 213         }
 214         return i;
 215 }
 216 /**
 217  * Macro to browse all running lcores.
 218  */
 219 #define RTE_LCORE_FOREACH(i)                                            \
 220         for (i = rte_get_next_lcore(-1, 0, 0);                          \
 221              i<RTE_MAX_LCORE;                                           \
 222              i = rte_get_next_lcore(i, 0, 0))
 223
 224 /**
 225  * Macro to browse all running lcores except the master lcore.
 226  */
 227 #define RTE_LCORE_FOREACH_SLAVE(i)                                      \
 228         for (i = rte_get_next_lcore(-1, 1, 0);                          \
 229              i<RTE_MAX_LCORE;                                           \
 230              i = rte_get_next_lcore(i, 1, 0))
 231
 232 #ifdef __cplusplus
 233 }
 234 #endif
 235
 236
 237 #endif /* _RTE_LCORE_H_ */