4 * Copyright(c) 2010-2014 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.
40 * EAL Configuration API
49 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
52 * The lcore role (used in RTE or not).
54 enum rte_lcore_role_t {
60 * The type of process in a linuxapp, multi-process setup
62 enum rte_proc_type_t {
63 RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
64 RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
71 * The global RTE configuration structure.
74 uint32_t master_lcore; /**< Id of the master lcore */
75 uint32_t lcore_count; /**< Number of available logical cores. */
76 enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
78 /** Primary or secondary configuration */
79 enum rte_proc_type_t process_type;
82 * Pointer to memory configuration, which may be shared across multiple
83 * Intel DPDK instances
85 struct rte_mem_config *mem_config;
86 } __attribute__((__packed__));
89 * Get the global configuration structure.
92 * A pointer to the global configuration structure.
94 struct rte_config *rte_eal_get_configuration(void);
100 * The identifier of the lcore.
102 * The role of the lcore.
104 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
108 * Get the process type in a multi-process setup
113 enum rte_proc_type_t rte_eal_process_type(void);
116 * Request iopl privilege for all RPL.
118 * This function should be called by pmds which need access to ioports.
121 * - On success, returns 0.
122 * - On failure, returns -1.
124 int rte_eal_iopl_init(void);
127 * Initialize the Environment Abstraction Layer (EAL).
129 * This function is to be executed on the MASTER lcore only, as soon
130 * as possible in the application's main() function.
132 * The function finishes the initialization process before main() is called.
133 * It puts the SLAVE lcores in the WAIT state.
135 * When the multi-partition feature is supported, depending on the
136 * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
137 * function waits to ensure that the magic number is set before
138 * returning. See also the rte_eal_get_configuration() function. Note:
139 * This behavior may change in the future.
142 * The argc argument that was given to the main() function.
144 * The argv argument that was given to the main() function.
146 * - On success, the number of parsed arguments, which is greater or
147 * equal to zero. After the call to rte_eal_init(),
148 * all arguments argv[x] with x < ret may be modified and should
149 * not be accessed by the application.
150 * - On failure, a negative error value.
152 int rte_eal_init(int argc, char **argv);
154 * Usage function typedef used by the application usage function.
156 * Use this function typedef to define and call rte_set_applcation_usage_hook()
159 typedef void (*rte_usage_hook_t)(const char * prgname);
162 * Add application usage routine callout from the eal_usage() routine.
164 * This function allows the application to include its usage message
165 * in the EAL system usage message. The routine rte_set_application_usage_hook()
166 * needs to be called before the rte_eal_init() routine in the application.
168 * This routine is optional for the application and will behave as if the set
169 * routine was never called as the default behavior.
172 * The func argument is a function pointer to the application usage routine.
173 * Called function is defined using rte_usage_hook_t typedef, which is of
174 * the form void rte_usage_func(const char * prgname).
176 * Calling this routine with a NULL value will reset the usage hook routine and
177 * return the current value, which could be NULL.
179 * - Returns the current value of the rte_application_usage pointer to allow
180 * the caller to daisy chain the usage routines if needing more then one.
183 rte_set_application_usage_hook( rte_usage_hook_t usage_func );
186 * macro to get the lock of tailq in mem_config
188 #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock)
191 * macro to get the multiple lock of mempool shared by mutiple-instance
193 #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock)
197 * Utility macro to do a thread-safe tailq 'INSERT' of rte_mem_config
200 * a kind of tailq define in enum rte_tailq_t
203 * type of list(tailq head)
206 * The element will be added into the list
209 #define RTE_EAL_TAILQ_INSERT_TAIL(idx, type, elm) do { \
211 list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type); \
212 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK); \
213 TAILQ_INSERT_TAIL(list, elm, next); \
214 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK); \
218 * Utility macro to do a thread-safe tailq 'REMOVE' of rte_mem_config
221 * a kind of tailq define in enum rte_tailq_t
224 * type of list(tailq head)
227 * The element will be remove from the list
230 #define RTE_EAL_TAILQ_REMOVE(idx, type, elm) do { \
232 list = RTE_TAILQ_LOOKUP_BY_IDX(idx, type); \
233 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK); \
234 TAILQ_REMOVE(list, elm, next); \
235 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK); \
240 * macro to check TAILQ exist
243 * a kind of tailq define in enum rte_tailq_t
246 #define RTE_EAL_TAILQ_EXIST_CHECK(idx) do { \
247 if (RTE_TAILQ_LOOKUP_BY_IDX(idx, rte_tailq_head) == NULL){ \
248 rte_errno = E_RTE_NO_TAILQ; \
254 * Whether EAL is using huge pages (disabled by --no-huge option).
255 * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
256 * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
257 * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
261 * Nonzero if hugepages are enabled.
263 int rte_eal_has_hugepages(void);
269 #endif /* _RTE_EAL_H_ */