lib/librte_eal/common/include/rte_eal.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2012 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  *  version: DPDK.L.1.2.3-3
  34  */
  35
  36 #ifndef _RTE_EAL_H_
  37 #define _RTE_EAL_H_
  38
  39 /**
  40  * @file
  41  *
  42  * EAL Configuration API
  43  */
  44
  45 #include <rte_tailq.h>
  46 #include <rte_memory.h>
  47 #include <rte_memzone.h>
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #define RTE_VERSION 1 /**< The version of the RTE configuration structure. */
  54 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
  55
  56 /**
  57  * The lcore role (used in RTE or not).
  58  */
  59 enum rte_lcore_role_t {
  60         ROLE_RTE,
  61         ROLE_OFF,
  62 };
  63
  64 /**
  65  * The type of process in a linuxapp, multi-process setup
  66  */
  67 enum rte_proc_type_t {
  68         RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
  69         RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
  70         RTE_PROC_SECONDARY,
  71
  72         RTE_PROC_INVALID
  73 };
  74
  75 /**
  76  * the structure for the memory configuration for the RTE.
  77  * Used by the rte_config structure. It is separated out, as for multi-process
  78  * support, the memory details should be shared across instances
  79  */
  80 struct rte_mem_config {
  81         /* memory topology */
  82         uint32_t nchannel;    /**< Number of channels (0 if unknown). */
  83         uint32_t nrank;       /**< Number of ranks (0 if unknown). */
  84
  85         /* memory segments and zones */
  86         struct rte_memseg memseg[RTE_MAX_MEMSEG];    /**< Physmem descriptors. */
  87         struct rte_memzone memzone[RTE_MAX_MEMZONE]; /**< Memzone descriptors. */
  88
  89         struct rte_tailq_head tailq_head[RTE_MAX_TAILQ]; /**< Tailqs for objects */
  90 } __attribute__((__packed__));
  91
  92 /**
  93  * The global RTE configuration structure.
  94  */
  95 struct rte_config {
  96         uint32_t version; /**< Configuration [structure] version. */
  97         uint32_t magic;   /**< Magic number - Sanity check. */
  98
  99
 100         uint32_t master_lcore;       /**< Id of the master lcore */
 101         uint32_t lcore_count;        /**< Number of available logical cores. */
 102         enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
 103
 104         /** Primary or secondary configuration */
 105         enum rte_proc_type_t process_type;
 106
 107         /**
 108          * Pointer to memory configuration, which may be shared across multiple
 109          * Intel DPDK instances
 110          */
 111         struct rte_mem_config *mem_config;
 112 } __attribute__((__packed__));
 113
 114 /**
 115  * Get the global configuration structure.
 116  *
 117  * @return
 118  *   A pointer to the global configuration structure.
 119  */
 120 struct rte_config *rte_eal_get_configuration(void);
 121
 122 /**
 123  * Get a lcore's role.
 124  *
 125  * @param lcore_id
 126  *   The identifier of the lcore.
 127  * @return
 128  *   The role of the lcore.
 129  */
 130 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
 131
 132
 133 /**
 134  * Get the process type in a multi-process setup
 135  *
 136  * @return
 137  *   The process type
 138  */
 139 enum rte_proc_type_t rte_eal_process_type(void);
 140
 141 /**
 142  * Initialize the Environment Abstraction Layer (EAL).
 143  *
 144  * This function is to be executed on the MASTER lcore only, as soon
 145  * as possible in the application's main() function.
 146  *
 147  * The function finishes the initialization process that was started
 148  * during boot (in case of baremetal) or before main() is called (in
 149  * case of linuxapp). It puts the SLAVE lcores in the WAIT state.
 150  *
 151  * When the multi-partition feature is supported, depending on the
 152  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 153  * function waits to ensure that the magic number is set before
 154  * returning. See also the rte_eal_get_configuration() function. Note:
 155  * This behavior may change in the future.
 156  *
 157  * @param argc
 158  *   The argc argument that was given to the main() function.
 159  * @param argv
 160  *   The argv argument that was given to the main() function.
 161  * @return
 162  *   - On success, the number of parsed arguments, which is greater or
 163  *     equal to zero. After the call to rte_eal_init(),
 164  *     all arguments argv[x] with x < ret may be modified and should
 165  *     not be accessed by the application.
 166  *   - On failure, a negative error value.
 167  */
 168 int rte_eal_init(int argc, char **argv);
 169
 170 #ifdef __cplusplus
 171 }
 172 #endif
 173
 174 #endif /* _RTE_EAL_H_ */