lib/librte_eal/common/include/rte_eal.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2013 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
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #define RTE_VERSION 1 /**< The version of the RTE configuration structure. */
  50 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
  51
  52 /**
  53  * The lcore role (used in RTE or not).
  54  */
  55 enum rte_lcore_role_t {
  56         ROLE_RTE,
  57         ROLE_OFF,
  58 };
  59
  60 /**
  61  * The type of process in a linuxapp, multi-process setup
  62  */
  63 enum rte_proc_type_t {
  64         RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
  65         RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
  66         RTE_PROC_SECONDARY,
  67
  68         RTE_PROC_INVALID
  69 };
  70
  71 /**
  72  * The global RTE configuration structure.
  73  */
  74 struct rte_config {
  75         uint32_t version; /**< Configuration [structure] version. */
  76         uint32_t magic;   /**< Magic number - Sanity check. */
  77
  78
  79         uint32_t master_lcore;       /**< Id of the master lcore */
  80         uint32_t lcore_count;        /**< Number of available logical cores. */
  81         enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
  82
  83         /** Primary or secondary configuration */
  84         enum rte_proc_type_t process_type;
  85
  86         /**
  87          * Pointer to memory configuration, which may be shared across multiple
  88          * Intel DPDK instances
  89          */
  90         struct rte_mem_config *mem_config;
  91 } __attribute__((__packed__));
  92
  93 /**
  94  * Get the global configuration structure.
  95  *
  96  * @return
  97  *   A pointer to the global configuration structure.
  98  */
  99 struct rte_config *rte_eal_get_configuration(void);
 100
 101 /**
 102  * Get a lcore's role.
 103  *
 104  * @param lcore_id
 105  *   The identifier of the lcore.
 106  * @return
 107  *   The role of the lcore.
 108  */
 109 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
 110
 111
 112 /**
 113  * Get the process type in a multi-process setup
 114  *
 115  * @return
 116  *   The process type
 117  */
 118 enum rte_proc_type_t rte_eal_process_type(void);
 119
 120 /**
 121  * Initialize the Environment Abstraction Layer (EAL).
 122  *
 123  * This function is to be executed on the MASTER lcore only, as soon
 124  * as possible in the application's main() function.
 125  *
 126  * The function finishes the initialization process that was started
 127  * during boot (in case of baremetal) or before main() is called (in
 128  * case of linuxapp). It puts the SLAVE lcores in the WAIT state.
 129  *
 130  * When the multi-partition feature is supported, depending on the
 131  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 132  * function waits to ensure that the magic number is set before
 133  * returning. See also the rte_eal_get_configuration() function. Note:
 134  * This behavior may change in the future.
 135  *
 136  * @param argc
 137  *   The argc argument that was given to the main() function.
 138  * @param argv
 139  *   The argv argument that was given to the main() function.
 140  * @return
 141  *   - On success, the number of parsed arguments, which is greater or
 142  *     equal to zero. After the call to rte_eal_init(),
 143  *     all arguments argv[x] with x < ret may be modified and should
 144  *     not be accessed by the application.
 145  *   - On failure, a negative error value.
 146  */
 147 int rte_eal_init(int argc, char **argv);
 148 /**
 149  * Usage function typedef used by the application usage function.
 150  *
 151  * Use this function typedef to define and call rte_set_applcation_usage_hook()
 152  * routine.
 153  */
 154 typedef void    (*rte_usage_hook_t)(const char * prgname);
 155
 156 /**
 157  * Add application usage routine callout from the eal_usage() routine.
 158  *
 159  * This function allows the application to include its usage message
 160  * in the EAL system usage message. The routine rte_set_application_usage_hook()
 161  * needs to be called before the rte_eal_init() routine in the application.
 162  *
 163  * This routine is optional for the application and will behave as if the set
 164  * routine was never called as the default behavior.
 165  *
 166  * @param func
 167  *   The func argument is a function pointer to the application usage routine.
 168  *   Called function is defined using rte_usage_hook_t typedef, which is of
 169  *   the form void rte_usage_func(const char * prgname).
 170  *
 171  *   Calling this routine with a NULL value will reset the usage hook routine and
 172  *   return the current value, which could be NULL.
 173  * @return
 174  *   - Returns the current value of the rte_application_usage pointer to allow
 175  *     the caller to daisy chain the usage routines if needing more then one.
 176  */
 177 rte_usage_hook_t
 178 rte_set_application_usage_hook( rte_usage_hook_t usage_func );
 179
 180 /**
 181  * macro to get the lock of tailq in mem_config
 182  */
 183 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 184
 185 /**
 186  * macro to get the multiple lock of mempool shared by mutiple-instance
 187  */
 188 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 189
 190
 191 /**
 192  * Utility macro to do a thread-safe tailq 'INSERT' of rte_mem_config
 193  *
 194  * @param idx
 195  *   a kind of tailq define in enum rte_tailq_t
 196  *
 197  * @param type
 198  *   type of list(tailq head)
 199  *
 200  * @param elm
 201  *   The element will be added into the list
 202  *
 203  */
 204 #define RTE_EAL_TAILQ_INSERT_TAIL(idx, type, elm) do {  \
 205         struct type *list;                                      \
 206         list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
 207         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
 208         TAILQ_INSERT_TAIL(list, elm, next);                     \
 209         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
 210 } while (0)
 211
 212 /**
 213  * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config
 214  *
 215  * @param idx
 216  *   a kind of tailq define in enum rte_tailq_t
 217  *
 218  * @param type
 219  *   type of list(tailq head)
 220  *
 221  * @param elm
 222  *   The element will be remove from the list
 223  *
 224  */
 225 #define RTE_EAL_TAILQ_REMOVE(idx, type, elm) do {       \
 226         struct type *list;                                      \
 227         list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
 228         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
 229         TAILQ_REMOVE(list, elm, next);                          \
 230         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
 231 } while (0)                                                     \
 232
 233
 234 /**
 235  *  macro to check TAILQ exist
 236  *
 237  *  @param idx
 238  *    a kind of tailq define in enum rte_tailq_t
 239  *
 240  */
 241 #define RTE_EAL_TAILQ_EXIST_CHECK(idx) do {   \
 242         if (RTE_TAILQ_LOOKUP_BY_IDX(idx, rte_tailq_head) == NULL){      \
 243                 rte_errno = E_RTE_NO_TAILQ;                             \
 244                 return NULL;                                            \
 245         }                                                               \
 246 } while(0)
 247
 248
 249 #ifdef __cplusplus
 250 }
 251 #endif
 252
 253 #endif /* _RTE_EAL_H_ */