4 * Copyright(c) 2010-2012 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
41 * EAL Configuration API
44 #include <rte_tailq.h>
45 #include <rte_memory.h>
46 #include <rte_memzone.h>
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. */
56 * The lcore role (used in RTE or not).
58 enum rte_lcore_role_t {
64 * The type of process in a linuxapp, multi-process setup
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 */
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
79 struct rte_mem_config {
81 uint32_t nchannel; /**< Number of channels (0 if unknown). */
82 uint32_t nrank; /**< Number of ranks (0 if unknown). */
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. */
88 struct rte_tailq_head tailq_head[RTE_MAX_TAILQ]; /**< Tailqs for objects */
89 } __attribute__((__packed__));
92 * The global RTE configuration structure.
95 uint32_t version; /**< Configuration [structure] version. */
96 uint32_t magic; /**< Magic number - Sanity check. */
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. */
103 /** Primary or secondary configuration */
104 enum rte_proc_type_t process_type;
107 * Pointer to memory configuration, which may be shared across multiple
108 * Intel DPDK instances
110 struct rte_mem_config *mem_config;
111 } __attribute__((__packed__));
114 * Get the global configuration structure.
117 * A pointer to the global configuration structure.
119 struct rte_config *rte_eal_get_configuration(void);
122 * Get a lcore's role.
125 * The identifier of the lcore.
127 * The role of the lcore.
129 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
133 * Get the process type in a multi-process setup
138 enum rte_proc_type_t rte_eal_process_type(void);
141 * Initialize the Environment Abstraction Layer (EAL).
143 * This function is to be executed on the MASTER lcore only, as soon
144 * as possible in the application's main() function.
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.
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.
157 * The argc argument that was given to the main() function.
159 * The argv argument that was given to the main() function.
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.
167 int rte_eal_init(int argc, char **argv);
173 #endif /* _RTE_EAL_H_ */