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
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
  50
  51 /**
  52  * The lcore role (used in RTE or not).
  53  */
  54 enum rte_lcore_role_t {
  55         ROLE_RTE,
  56         ROLE_OFF,
  57 };
  58
  59 /**
  60  * The type of process in a linuxapp, multi-process setup
  61  */
  62 enum rte_proc_type_t {
  63         RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
  64         RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
  65         RTE_PROC_SECONDARY,
  66
  67         RTE_PROC_INVALID
  68 };
  69
  70 /**
  71  * The global RTE configuration structure.
  72  */
  73 struct rte_config {
  74         uint32_t master_lcore;       /**< Id of the master lcore */
  75         uint32_t lcore_count;        /**< Number of available logical cores. */
  76         enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
  77
  78         /** Primary or secondary configuration */
  79         enum rte_proc_type_t process_type;
  80
  81         /** A set of general status flags */
  82         unsigned flags;
  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 that was started
 136  * during boot (in case of baremetal) or before main() is called (in
 137  * case of linuxapp). It puts the SLAVE lcores in the WAIT state.
 138  *
 139  * When the multi-partition feature is supported, depending on the
 140  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 141  * function waits to ensure that the magic number is set before
 142  * returning. See also the rte_eal_get_configuration() function. Note:
 143  * This behavior may change in the future.
 144  *
 145  * @param argc
 146  *   The argc argument that was given to the main() function.
 147  * @param argv
 148  *   The argv argument that was given to the main() function.
 149  * @return
 150  *   - On success, the number of parsed arguments, which is greater or
 151  *     equal to zero. After the call to rte_eal_init(),
 152  *     all arguments argv[x] with x < ret may be modified and should
 153  *     not be accessed by the application.
 154  *   - On failure, a negative error value.
 155  */
 156 int rte_eal_init(int argc, char **argv);
 157 /**
 158  * Usage function typedef used by the application usage function.
 159  *
 160  * Use this function typedef to define and call rte_set_applcation_usage_hook()
 161  * routine.
 162  */
 163 typedef void    (*rte_usage_hook_t)(const char * prgname);
 164
 165 /**
 166  * Add application usage routine callout from the eal_usage() routine.
 167  *
 168  * This function allows the application to include its usage message
 169  * in the EAL system usage message. The routine rte_set_application_usage_hook()
 170  * needs to be called before the rte_eal_init() routine in the application.
 171  *
 172  * This routine is optional for the application and will behave as if the set
 173  * routine was never called as the default behavior.
 174  *
 175  * @param func
 176  *   The func argument is a function pointer to the application usage routine.
 177  *   Called function is defined using rte_usage_hook_t typedef, which is of
 178  *   the form void rte_usage_func(const char * prgname).
 179  *
 180  *   Calling this routine with a NULL value will reset the usage hook routine and
 181  *   return the current value, which could be NULL.
 182  * @return
 183  *   - Returns the current value of the rte_application_usage pointer to allow
 184  *     the caller to daisy chain the usage routines if needing more then one.
 185  */
 186 rte_usage_hook_t
 187 rte_set_application_usage_hook( rte_usage_hook_t usage_func );
 188
 189 /**
 190  * macro to get the lock of tailq in mem_config
 191  */
 192 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 193
 194 /**
 195  * macro to get the multiple lock of mempool shared by mutiple-instance
 196  */
 197 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 198
 199
 200 /**
 201  * Utility macro to do a thread-safe tailq 'INSERT' of rte_mem_config
 202  *
 203  * @param idx
 204  *   a kind of tailq define in enum rte_tailq_t
 205  *
 206  * @param type
 207  *   type of list(tailq head)
 208  *
 209  * @param elm
 210  *   The element will be added into the list
 211  *
 212  */
 213 #define RTE_EAL_TAILQ_INSERT_TAIL(idx, type, elm) do {  \
 214         struct type *list;                                      \
 215         list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
 216         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
 217         TAILQ_INSERT_TAIL(list, elm, next);                     \
 218         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
 219 } while (0)
 220
 221 /**
 222  * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config
 223  *
 224  * @param idx
 225  *   a kind of tailq define in enum rte_tailq_t
 226  *
 227  * @param type
 228  *   type of list(tailq head)
 229  *
 230  * @param elm
 231  *   The element will be remove from the list
 232  *
 233  */
 234 #define RTE_EAL_TAILQ_REMOVE(idx, type, elm) do {       \
 235         struct type *list;                                      \
 236         list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type);              \
 237         rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);            \
 238         TAILQ_REMOVE(list, elm, next);                          \
 239         rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);          \
 240 } while (0)                                                     \
 241
 242
 243 /**
 244  *  macro to check TAILQ exist
 245  *
 246  *  @param idx
 247  *    a kind of tailq define in enum rte_tailq_t
 248  *
 249  */
 250 #define RTE_EAL_TAILQ_EXIST_CHECK(idx) do {   \
 251         if (RTE_TAILQ_LOOKUP_BY_IDX(idx, rte_tailq_head) == NULL){      \
 252                 rte_errno = E_RTE_NO_TAILQ;                             \
 253                 return NULL;                                            \
 254         }                                                               \
 255 } while(0)
 256
 257 /**
 258  * Whether EAL is using huge pages (disabled by --no-huge option).
 259  * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
 260  * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
 261  * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
 262  * as 6WIND.
 263  *
 264  * @return
 265  *   Nonzero if hugepages are enabled.
 266  */
 267 int rte_eal_has_hugepages(void);
 268
 269 #ifdef __cplusplus
 270 }
 271 #endif
 272
 273 #endif /* _RTE_EAL_H_ */