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