lib/librte_eal/common/include/rte_eal.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_EAL_H_
  35 #define _RTE_EAL_H_
  36
  37 /**
  38  * @file
  39  *
  40  * EAL Configuration API
  41  */
  42
  43 #include <stdint.h>
  44 #include <sched.h>
  45
  46 #include <rte_per_lcore.h>
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
  53
  54 /**
  55  * The lcore role (used in RTE or not).
  56  */
  57 enum rte_lcore_role_t {
  58         ROLE_RTE,
  59         ROLE_OFF,
  60 };
  61
  62 /**
  63  * The type of process in a linuxapp, multi-process setup
  64  */
  65 enum rte_proc_type_t {
  66         RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
  67         RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
  68         RTE_PROC_SECONDARY,
  69
  70         RTE_PROC_INVALID
  71 };
  72
  73 /**
  74  * The global RTE configuration structure.
  75  */
  76 struct rte_config {
  77         uint32_t master_lcore;       /**< Id of the master lcore */
  78         uint32_t lcore_count;        /**< Number of available logical cores. */
  79         enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
  80
  81         /** Primary or secondary configuration */
  82         enum rte_proc_type_t process_type;
  83
  84         /**
  85          * Pointer to memory configuration, which may be shared across multiple
  86          * Intel DPDK instances
  87          */
  88         struct rte_mem_config *mem_config;
  89 } __attribute__((__packed__));
  90
  91 /**
  92  * Get the global configuration structure.
  93  *
  94  * @return
  95  *   A pointer to the global configuration structure.
  96  */
  97 struct rte_config *rte_eal_get_configuration(void);
  98
  99 /**
 100  * Get a lcore's role.
 101  *
 102  * @param lcore_id
 103  *   The identifier of the lcore.
 104  * @return
 105  *   The role of the lcore.
 106  */
 107 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
 108
 109
 110 /**
 111  * Get the process type in a multi-process setup
 112  *
 113  * @return
 114  *   The process type
 115  */
 116 enum rte_proc_type_t rte_eal_process_type(void);
 117
 118 /**
 119  * Request iopl privilege for all RPL.
 120  *
 121  * This function should be called by pmds which need access to ioports.
 122
 123  * @return
 124  *   - On success, returns 0.
 125  *   - On failure, returns -1.
 126  */
 127 int rte_eal_iopl_init(void);
 128
 129 /**
 130  * Initialize the Environment Abstraction Layer (EAL).
 131  *
 132  * This function is to be executed on the MASTER lcore only, as soon
 133  * as possible in the application's main() function.
 134  *
 135  * The function finishes the initialization process before main() is called.
 136  * It puts the SLAVE lcores in the WAIT state.
 137  *
 138  * When the multi-partition feature is supported, depending on the
 139  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 140  * function waits to ensure that the magic number is set before
 141  * returning. See also the rte_eal_get_configuration() function. Note:
 142  * This behavior may change in the future.
 143  *
 144  * @param argc
 145  *   The argc argument that was given to the main() function.
 146  * @param argv
 147  *   The argv argument that was given to the main() function.
 148  * @return
 149  *   - On success, the number of parsed arguments, which is greater or
 150  *     equal to zero. After the call to rte_eal_init(),
 151  *     all arguments argv[x] with x < ret may be modified and should
 152  *     not be accessed by the application.
 153  *   - On failure, a negative error value.
 154  */
 155 int rte_eal_init(int argc, char **argv);
 156 /**
 157  * Usage function typedef used by the application usage function.
 158  *
 159  * Use this function typedef to define and call rte_set_applcation_usage_hook()
 160  * routine.
 161  */
 162 typedef void    (*rte_usage_hook_t)(const char * prgname);
 163
 164 /**
 165  * Add application usage routine callout from the eal_usage() routine.
 166  *
 167  * This function allows the application to include its usage message
 168  * in the EAL system usage message. The routine rte_set_application_usage_hook()
 169  * needs to be called before the rte_eal_init() routine in the application.
 170  *
 171  * This routine is optional for the application and will behave as if the set
 172  * routine was never called as the default behavior.
 173  *
 174  * @param func
 175  *   The func argument is a function pointer to the application usage routine.
 176  *   Called function is defined using rte_usage_hook_t typedef, which is of
 177  *   the form void rte_usage_func(const char * prgname).
 178  *
 179  *   Calling this routine with a NULL value will reset the usage hook routine and
 180  *   return the current value, which could be NULL.
 181  * @return
 182  *   - Returns the current value of the rte_application_usage pointer to allow
 183  *     the caller to daisy chain the usage routines if needing more then one.
 184  */
 185 rte_usage_hook_t
 186 rte_set_application_usage_hook( rte_usage_hook_t usage_func );
 187
 188 /**
 189  * macro to get the lock of tailq in mem_config
 190  */
 191 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 192
 193 /**
 194  * macro to get the multiple lock of mempool shared by mutiple-instance
 195  */
 196 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 197
 198
 199 /**
 200  * Utility macro to do a thread-safe tailq 'INSERT' of rte_mem_config
 201  *
 202  * @param idx
 203  *   a kind of tailq define in enum rte_tailq_t
 204  *
 205  * @param type
 206  *   type of list(tailq head)
 207  *
 208  * @param elm
 209  *   The element will be added into the list
 210  *
 211  */
 212 #define RTE_EAL_TAILQ_INSERT_TAIL(idx, type, elm) do {  \
 213         struct type *list;                                      \
 214         list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
 215         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
 216         TAILQ_INSERT_TAIL(list, elm, next);                     \
 217         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
 218 } while (0)
 219
 220 /**
 221  * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config
 222  *
 223  * @param idx
 224  *   a kind of tailq define in enum rte_tailq_t
 225  *
 226  * @param type
 227  *   type of list(tailq head)
 228  *
 229  * @param elm
 230  *   The element will be remove from the list
 231  *
 232  */
 233 #define RTE_EAL_TAILQ_REMOVE(idx, type, elm) do {       \
 234         struct type *list;                                      \
 235         list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
 236         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
 237         TAILQ_REMOVE(list, elm, next);                          \
 238         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
 239 } while (0)                                                     \
 240
 241
 242 /**
 243  *  macro to check TAILQ exist
 244  *
 245  *  @param idx
 246  *    a kind of tailq define in enum rte_tailq_t
 247  *
 248  */
 249 #define RTE_EAL_TAILQ_EXIST_CHECK(idx) do {   \
 250         if (RTE_TAILQ_LOOKUP_BY_IDX(idx, rte_tailq_head) == NULL){      \
 251                 rte_errno = E_RTE_NO_TAILQ;                             \
 252                 return NULL;                                            \
 253         }                                                               \
 254 } while(0)
 255
 256 /**
 257  * Whether EAL is using huge pages (disabled by --no-huge option).
 258  * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
 259  * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
 260  * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
 261  * as 6WIND.
 262  *
 263  * @return
 264  *   Nonzero if hugepages are enabled.
 265  */
 266 int rte_eal_has_hugepages(void);
 267
 268 /**
 269  * A wrap API for syscall gettid.
 270  *
 271  * @return
 272  *   On success, returns the thread ID of calling process.
 273  *   It is always successful.
 274  */
 275 int rte_sys_gettid(void);
 276
 277 /**
 278  * Get system unique thread id.
 279  *
 280  * @return
 281  *   On success, returns the thread ID of calling process.
 282  *   It is always successful.
 283  */
 284 static inline int rte_gettid(void)
 285 {
 286         static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
 287         if (RTE_PER_LCORE(_thread_id) == -1)
 288                 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
 289         return RTE_PER_LCORE(_thread_id);
 290 }
 291
 292 #ifdef __cplusplus
 293 }
 294 #endif
 295
 296 #endif /* _RTE_EAL_H_ */