lib/librte_eal/common/include/rte_eal.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 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 /* Maximum thread_name length. */
  55 #define RTE_MAX_THREAD_NAME_LEN 16
  56
  57 /**
  58  * The lcore role (used in RTE or not).
  59  */
  60 enum rte_lcore_role_t {
  61         ROLE_RTE,
  62         ROLE_OFF,
  63 };
  64
  65 /**
  66  * The type of process in a linuxapp, multi-process setup
  67  */
  68 enum rte_proc_type_t {
  69         RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
  70         RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
  71         RTE_PROC_SECONDARY,
  72
  73         RTE_PROC_INVALID
  74 };
  75
  76 /**
  77  * The global RTE configuration structure.
  78  */
  79 struct rte_config {
  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          * 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  * Request iopl privilege for all RPL.
 123  *
 124  * This function should be called by pmds which need access to ioports.
 125
 126  * @return
 127  *   - On success, returns 0.
 128  *   - On failure, returns -1.
 129  */
 130 int rte_eal_iopl_init(void);
 131
 132 /**
 133  * Initialize the Environment Abstraction Layer (EAL).
 134  *
 135  * This function is to be executed on the MASTER lcore only, as soon
 136  * as possible in the application's main() function.
 137  *
 138  * The function finishes the initialization process before main() is called.
 139  * It puts the SLAVE lcores in the WAIT state.
 140  *
 141  * When the multi-partition feature is supported, depending on the
 142  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 143  * function waits to ensure that the magic number is set before
 144  * returning. See also the rte_eal_get_configuration() function. Note:
 145  * This behavior may change in the future.
 146  *
 147  * @param argc
 148  *   The argc argument that was given to the main() function.
 149  * @param argv
 150  *   The argv argument that was given to the main() function.
 151  * @return
 152  *   - On success, the number of parsed arguments, which is greater or
 153  *     equal to zero. After the call to rte_eal_init(),
 154  *     all arguments argv[x] with x < ret may be modified and should
 155  *     not be accessed by the application.
 156  *   - On failure, a negative error value.
 157  */
 158 int rte_eal_init(int argc, char **argv);
 159
 160 /**
 161  * Check if a primary process is currently alive
 162  *
 163  * This function returns true when a primary process is currently
 164  * active.
 165  *
 166  * @param config_file_path
 167  *   The config_file_path argument provided should point at the location
 168  *   that the primary process will create its config file. If NULL, the default
 169  *   config file path is used.
 170  *
 171  * @return
 172  *  - If alive, returns 1.
 173  *  - If dead, returns 0.
 174  */
 175 int rte_eal_primary_proc_alive(const char *config_file_path);
 176
 177 /**
 178  * Usage function typedef used by the application usage function.
 179  *
 180  * Use this function typedef to define and call rte_set_applcation_usage_hook()
 181  * routine.
 182  */
 183 typedef void    (*rte_usage_hook_t)(const char * prgname);
 184
 185 /**
 186  * Add application usage routine callout from the eal_usage() routine.
 187  *
 188  * This function allows the application to include its usage message
 189  * in the EAL system usage message. The routine rte_set_application_usage_hook()
 190  * needs to be called before the rte_eal_init() routine in the application.
 191  *
 192  * This routine is optional for the application and will behave as if the set
 193  * routine was never called as the default behavior.
 194  *
 195  * @param usage_func
 196  *   The func argument is a function pointer to the application usage routine.
 197  *   Called function is defined using rte_usage_hook_t typedef, which is of
 198  *   the form void rte_usage_func(const char * prgname).
 199  *
 200  *   Calling this routine with a NULL value will reset the usage hook routine and
 201  *   return the current value, which could be NULL.
 202  * @return
 203  *   - Returns the current value of the rte_application_usage pointer to allow
 204  *     the caller to daisy chain the usage routines if needing more then one.
 205  */
 206 rte_usage_hook_t
 207 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
 208
 209 /**
 210  * macro to get the lock of tailq in mem_config
 211  */
 212 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 213
 214 /**
 215  * macro to get the multiple lock of mempool shared by mutiple-instance
 216  */
 217 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 218
 219 /**
 220  * Whether EAL is using huge pages (disabled by --no-huge option).
 221  * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
 222  * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
 223  * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
 224  * as 6WIND.
 225  *
 226  * @return
 227  *   Nonzero if hugepages are enabled.
 228  */
 229 int rte_eal_has_hugepages(void);
 230
 231 /**
 232  * A wrap API for syscall gettid.
 233  *
 234  * @return
 235  *   On success, returns the thread ID of calling process.
 236  *   It is always successful.
 237  */
 238 int rte_sys_gettid(void);
 239
 240 /**
 241  * Get system unique thread id.
 242  *
 243  * @return
 244  *   On success, returns the thread ID of calling process.
 245  *   It is always successful.
 246  */
 247 static inline int rte_gettid(void)
 248 {
 249         static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
 250         if (RTE_PER_LCORE(_thread_id) == -1)
 251                 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
 252         return RTE_PER_LCORE(_thread_id);
 253 }
 254
 255 #ifdef __cplusplus
 256 }
 257 #endif
 258
 259 #endif /* _RTE_EAL_H_ */