4 * Copyright(c) 2010-2016 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
46 #include <rte_per_lcore.h>
49 #include <rte_pci_dev_feature_defs.h>
55 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
57 /* Maximum thread_name length. */
58 #define RTE_MAX_THREAD_NAME_LEN 16
61 * The lcore role (used in RTE or not).
63 enum rte_lcore_role_t {
70 * The type of process in a linuxapp, multi-process setup
72 enum rte_proc_type_t {
73 RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
74 RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
81 * The global RTE configuration structure.
84 uint32_t master_lcore; /**< Id of the master lcore */
85 uint32_t lcore_count; /**< Number of available logical cores. */
86 uint32_t service_lcore_count;/**< Number of available service cores. */
87 enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
89 /** Primary or secondary configuration */
90 enum rte_proc_type_t process_type;
92 /** PA or VA mapping mode */
93 enum rte_iova_mode iova_mode;
96 * Pointer to memory configuration, which may be shared across multiple
99 struct rte_mem_config *mem_config;
100 } __attribute__((__packed__));
103 * Get the global configuration structure.
106 * A pointer to the global configuration structure.
108 struct rte_config *rte_eal_get_configuration(void);
111 * Get a lcore's role.
114 * The identifier of the lcore.
116 * The role of the lcore.
118 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
122 * Get the process type in a multi-process setup
127 enum rte_proc_type_t rte_eal_process_type(void);
130 * Request iopl privilege for all RPL.
132 * This function should be called by pmds which need access to ioports.
135 * - On success, returns 0.
136 * - On failure, returns -1.
138 int rte_eal_iopl_init(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 before main() is called.
147 * It puts the SLAVE lcores in the WAIT state.
149 * When the multi-partition feature is supported, depending on the
150 * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
151 * function waits to ensure that the magic number is set before
152 * returning. See also the rte_eal_get_configuration() function. Note:
153 * This behavior may change in the future.
156 * A non-negative value. If it is greater than 0, the array members
157 * for argv[0] through argv[argc] (non-inclusive) shall contain pointers
160 * An array of strings. The contents of the array, as well as the strings
161 * which are pointed to by the array, may be modified by this function.
163 * - On success, the number of parsed arguments, which is greater or
164 * equal to zero. After the call to rte_eal_init(),
165 * all arguments argv[x] with x < ret may have been modified by this
166 * function call and should not be further interpreted by the
167 * application. The EAL does not take any ownership of the memory used
168 * for either the argv array, or its members.
169 * - On failure, -1 and rte_errno is set to a value indicating the cause
170 * for failure. In some instances, the application will need to be
171 * restarted as part of clearing the issue.
173 * Error codes returned via rte_errno:
174 * EACCES indicates a permissions issue.
176 * EAGAIN indicates either a bus or system resource was not available,
177 * setup may be attempted again.
179 * EALREADY indicates that the rte_eal_init function has already been
180 * called, and cannot be called again.
182 * EFAULT indicates the tailq configuration name was not found in
183 * memory configuration.
185 * EINVAL indicates invalid parameters were passed as argv/argc.
187 * ENOMEM indicates failure likely caused by an out-of-memory condition.
189 * ENODEV indicates memory setup issues.
191 * ENOTSUP indicates that the EAL cannot initialize on this system.
193 * EPROTO indicates that the PCI bus is either not present, or is not
194 * readable by the eal.
196 * ENOEXEC indicates that a service core failed to launch successfully.
198 int rte_eal_init(int argc, char **argv);
201 * Check if a primary process is currently alive
203 * This function returns true when a primary process is currently
206 * @param config_file_path
207 * The config_file_path argument provided should point at the location
208 * that the primary process will create its config file. If NULL, the default
209 * config file path is used.
212 * - If alive, returns 1.
213 * - If dead, returns 0.
215 int rte_eal_primary_proc_alive(const char *config_file_path);
218 * Usage function typedef used by the application usage function.
220 * Use this function typedef to define and call rte_set_application_usage_hook()
223 typedef void (*rte_usage_hook_t)(const char * prgname);
226 * Add application usage routine callout from the eal_usage() routine.
228 * This function allows the application to include its usage message
229 * in the EAL system usage message. The routine rte_set_application_usage_hook()
230 * needs to be called before the rte_eal_init() routine in the application.
232 * This routine is optional for the application and will behave as if the set
233 * routine was never called as the default behavior.
236 * The func argument is a function pointer to the application usage routine.
237 * Called function is defined using rte_usage_hook_t typedef, which is of
238 * the form void rte_usage_func(const char * prgname).
240 * Calling this routine with a NULL value will reset the usage hook routine and
241 * return the current value, which could be NULL.
243 * - Returns the current value of the rte_application_usage pointer to allow
244 * the caller to daisy chain the usage routines if needing more then one.
247 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
250 * macro to get the lock of tailq in mem_config
252 #define RTE_EAL_TAILQ_RWLOCK (&rte_eal_get_configuration()->mem_config->qlock)
255 * macro to get the multiple lock of mempool shared by mutiple-instance
257 #define RTE_EAL_MEMPOOL_RWLOCK (&rte_eal_get_configuration()->mem_config->mplock)
260 * Whether EAL is using huge pages (disabled by --no-huge option).
261 * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
262 * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
263 * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
267 * Nonzero if hugepages are enabled.
269 int rte_eal_has_hugepages(void);
272 * Whether EAL is using PCI bus.
273 * Disabled by --no-pci option.
276 * Nonzero if the PCI bus is enabled.
278 int rte_eal_has_pci(void);
281 * Whether the EAL was asked to create UIO device.
286 int rte_eal_create_uio_dev(void);
289 * The user-configured vfio interrupt mode.
292 * Interrupt mode configured with the command line,
293 * RTE_INTR_MODE_NONE by default.
295 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
298 * A wrap API for syscall gettid.
301 * On success, returns the thread ID of calling process.
302 * It is always successful.
304 int rte_sys_gettid(void);
307 * Get system unique thread id.
310 * On success, returns the thread ID of calling process.
311 * It is always successful.
313 static inline int rte_gettid(void)
315 static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
316 if (RTE_PER_LCORE(_thread_id) == -1)
317 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
318 return RTE_PER_LCORE(_thread_id);
325 * enum rte_iova_mode value.
327 enum rte_iova_mode rte_eal_iova_mode(void);
330 * Get default pool ops name for mbuf
333 * returns default pool ops name.
336 rte_eal_mbuf_default_mempool_ops(void);
342 #endif /* _RTE_EAL_H_ */