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 #include <rte_config.h>
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
  54
  55 /* Maximum thread_name length. */
  56 #define RTE_MAX_THREAD_NAME_LEN 16
  57
  58 /**
  59  * The lcore role (used in RTE or not).
  60  */
  61 enum rte_lcore_role_t {
  62         ROLE_RTE,
  63         ROLE_OFF,
  64 };
  65
  66 /**
  67  * The type of process in a linuxapp, multi-process setup
  68  */
  69 enum rte_proc_type_t {
  70         RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
  71         RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
  72         RTE_PROC_SECONDARY,
  73
  74         RTE_PROC_INVALID
  75 };
  76
  77 /**
  78  * The global RTE configuration structure.
  79  */
  80 struct rte_config {
  81         uint32_t master_lcore;       /**< Id of the master lcore */
  82         uint32_t lcore_count;        /**< Number of available logical cores. */
  83         enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
  84
  85         /** Primary or secondary configuration */
  86         enum rte_proc_type_t process_type;
  87
  88         /**
  89          * Pointer to memory configuration, which may be shared across multiple
  90          * DPDK instances
  91          */
  92         struct rte_mem_config *mem_config;
  93 } __attribute__((__packed__));
  94
  95 /**
  96  * Get the global configuration structure.
  97  *
  98  * @return
  99  *   A pointer to the global configuration structure.
 100  */
 101 struct rte_config *rte_eal_get_configuration(void);
 102
 103 /**
 104  * Get a lcore's role.
 105  *
 106  * @param lcore_id
 107  *   The identifier of the lcore.
 108  * @return
 109  *   The role of the lcore.
 110  */
 111 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
 112
 113
 114 /**
 115  * Get the process type in a multi-process setup
 116  *
 117  * @return
 118  *   The process type
 119  */
 120 enum rte_proc_type_t rte_eal_process_type(void);
 121
 122 /**
 123  * Request iopl privilege for all RPL.
 124  *
 125  * This function should be called by pmds which need access to ioports.
 126
 127  * @return
 128  *   - On success, returns 0.
 129  *   - On failure, returns -1.
 130  */
 131 int rte_eal_iopl_init(void);
 132
 133 /**
 134  * Initialize the Environment Abstraction Layer (EAL).
 135  *
 136  * This function is to be executed on the MASTER lcore only, as soon
 137  * as possible in the application's main() function.
 138  *
 139  * The function finishes the initialization process before main() is called.
 140  * It puts the SLAVE lcores in the WAIT state.
 141  *
 142  * When the multi-partition feature is supported, depending on the
 143  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 144  * function waits to ensure that the magic number is set before
 145  * returning. See also the rte_eal_get_configuration() function. Note:
 146  * This behavior may change in the future.
 147  *
 148  * @param argc
 149  *   A non-negative value.  If it is greater than 0, the array members
 150  *   for argv[0] through argv[argc] (non-inclusive) shall contain pointers
 151  *   to strings.
 152  * @param argv
 153  *   An array of strings.  The contents of the array, as well as the strings
 154  *   which are pointed to by the array, may be modified by this function.
 155  * @return
 156  *   - On success, the number of parsed arguments, which is greater or
 157  *     equal to zero. After the call to rte_eal_init(),
 158  *     all arguments argv[x] with x < ret may have been modified by this
 159  *     function call and should not be further interpreted by the
 160  *     application.  The EAL does not take any ownership of the memory used
 161  *     for either the argv array, or its members.
 162  *   - On failure, -1 and rte_errno is set to a value indicating the cause
 163  *     for failure.  In some instances, the application will need to be
 164  *     restarted as part of clearing the issue.
 165  *
 166  *   Error codes returned via rte_errno:
 167  *     EACCES indicates a permissions issue.
 168  *
 169  *     EAGAIN indicates either a bus or system resource was not available,
 170  *            setup may be attempted again.
 171  *
 172  *     EALREADY indicates that the rte_eal_init function has already been
 173  *              called, and cannot be called again.
 174  *
 175  *     EFAULT indicates the tailq configuration name was not found in
 176  *            memory configuration.
 177  *
 178  *     EINVAL indicates invalid parameters were passed as argv/argc.
 179  *
 180  *     ENOMEM indicates failure likely caused by an out-of-memory condition.
 181  *
 182  *     ENODEV indicates memory setup issues.
 183  *
 184  *     ENOTSUP indicates that the EAL cannot initialize on this system.
 185  *
 186  *     EPROTO indicates that the PCI bus is either not present, or is not
 187  *            readable by the eal.
 188  */
 189 int rte_eal_init(int argc, char **argv);
 190
 191 /**
 192  * Check if a primary process is currently alive
 193  *
 194  * This function returns true when a primary process is currently
 195  * active.
 196  *
 197  * @param config_file_path
 198  *   The config_file_path argument provided should point at the location
 199  *   that the primary process will create its config file. If NULL, the default
 200  *   config file path is used.
 201  *
 202  * @return
 203  *  - If alive, returns 1.
 204  *  - If dead, returns 0.
 205  */
 206 int rte_eal_primary_proc_alive(const char *config_file_path);
 207
 208 /**
 209  * Usage function typedef used by the application usage function.
 210  *
 211  * Use this function typedef to define and call rte_set_applcation_usage_hook()
 212  * routine.
 213  */
 214 typedef void    (*rte_usage_hook_t)(const char * prgname);
 215
 216 /**
 217  * Add application usage routine callout from the eal_usage() routine.
 218  *
 219  * This function allows the application to include its usage message
 220  * in the EAL system usage message. The routine rte_set_application_usage_hook()
 221  * needs to be called before the rte_eal_init() routine in the application.
 222  *
 223  * This routine is optional for the application and will behave as if the set
 224  * routine was never called as the default behavior.
 225  *
 226  * @param usage_func
 227  *   The func argument is a function pointer to the application usage routine.
 228  *   Called function is defined using rte_usage_hook_t typedef, which is of
 229  *   the form void rte_usage_func(const char * prgname).
 230  *
 231  *   Calling this routine with a NULL value will reset the usage hook routine and
 232  *   return the current value, which could be NULL.
 233  * @return
 234  *   - Returns the current value of the rte_application_usage pointer to allow
 235  *     the caller to daisy chain the usage routines if needing more then one.
 236  */
 237 rte_usage_hook_t
 238 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
 239
 240 /**
 241  * macro to get the lock of tailq in mem_config
 242  */
 243 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 244
 245 /**
 246  * macro to get the multiple lock of mempool shared by mutiple-instance
 247  */
 248 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 249
 250 /**
 251  * Whether EAL is using huge pages (disabled by --no-huge option).
 252  * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
 253  * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
 254  * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
 255  * as 6WIND.
 256  *
 257  * @return
 258  *   Nonzero if hugepages are enabled.
 259  */
 260 int rte_eal_has_hugepages(void);
 261
 262 /**
 263  * A wrap API for syscall gettid.
 264  *
 265  * @return
 266  *   On success, returns the thread ID of calling process.
 267  *   It is always successful.
 268  */
 269 int rte_sys_gettid(void);
 270
 271 /**
 272  * Get system unique thread id.
 273  *
 274  * @return
 275  *   On success, returns the thread ID of calling process.
 276  *   It is always successful.
 277  */
 278 static inline int rte_gettid(void)
 279 {
 280         static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
 281         if (RTE_PER_LCORE(_thread_id) == -1)
 282                 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
 283         return RTE_PER_LCORE(_thread_id);
 284 }
 285
 286 #define RTE_INIT(func) \
 287 static void __attribute__((constructor, used)) func(void)
 288
 289 #ifdef __cplusplus
 290 }
 291 #endif
 292
 293 #endif /* _RTE_EAL_H_ */