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