1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
11 * EAL Configuration API
18 #include <rte_config.h>
19 #include <rte_compat.h>
20 #include <rte_per_lcore.h>
23 #include <rte_pci_dev_feature_defs.h>
29 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
31 /* Maximum thread_name length. */
32 #define RTE_MAX_THREAD_NAME_LEN 16
35 * The lcore role (used in RTE or not).
37 enum rte_lcore_role_t {
44 * The type of process in a linux, multi-process setup
46 enum rte_proc_type_t {
47 RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
48 RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
55 * The global RTE configuration structure.
58 uint32_t master_lcore; /**< Id of the master lcore */
59 uint32_t lcore_count; /**< Number of available logical cores. */
60 uint32_t numa_node_count; /**< Number of detected NUMA nodes. */
61 uint32_t numa_nodes[RTE_MAX_NUMA_NODES]; /**< List of detected NUMA nodes. */
62 uint32_t service_lcore_count;/**< Number of available service cores. */
63 enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; /**< State of cores. */
65 /** Primary or secondary configuration */
66 enum rte_proc_type_t process_type;
68 /** PA or VA mapping mode */
69 enum rte_iova_mode iova_mode;
72 * Pointer to memory configuration, which may be shared across multiple
75 struct rte_mem_config *mem_config;
76 } __attribute__((__packed__));
79 * Get the global configuration structure.
82 * A pointer to the global configuration structure.
84 struct rte_config *rte_eal_get_configuration(void);
87 * Get the process type in a multi-process setup
92 enum rte_proc_type_t rte_eal_process_type(void);
95 * Request iopl privilege for all RPL.
97 * This function should be called by pmds which need access to ioports.
100 * - On success, returns 0.
101 * - On failure, returns -1.
103 int rte_eal_iopl_init(void);
106 * Initialize the Environment Abstraction Layer (EAL).
108 * This function is to be executed on the MASTER lcore only, as soon
109 * as possible in the application's main() function.
111 * The function finishes the initialization process before main() is called.
112 * It puts the SLAVE lcores in the WAIT state.
114 * When the multi-partition feature is supported, depending on the
115 * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
116 * function waits to ensure that the magic number is set before
117 * returning. See also the rte_eal_get_configuration() function. Note:
118 * This behavior may change in the future.
121 * A non-negative value. If it is greater than 0, the array members
122 * for argv[0] through argv[argc] (non-inclusive) shall contain pointers
125 * An array of strings. The contents of the array, as well as the strings
126 * which are pointed to by the array, may be modified by this function.
128 * - On success, the number of parsed arguments, which is greater or
129 * equal to zero. After the call to rte_eal_init(),
130 * all arguments argv[x] with x < ret may have been modified by this
131 * function call and should not be further interpreted by the
132 * application. The EAL does not take any ownership of the memory used
133 * for either the argv array, or its members.
134 * - On failure, -1 and rte_errno is set to a value indicating the cause
135 * for failure. In some instances, the application will need to be
136 * restarted as part of clearing the issue.
138 * Error codes returned via rte_errno:
139 * EACCES indicates a permissions issue.
141 * EAGAIN indicates either a bus or system resource was not available,
142 * setup may be attempted again.
144 * EALREADY indicates that the rte_eal_init function has already been
145 * called, and cannot be called again.
147 * EFAULT indicates the tailq configuration name was not found in
148 * memory configuration.
150 * EINVAL indicates invalid parameters were passed as argv/argc.
152 * ENOMEM indicates failure likely caused by an out-of-memory condition.
154 * ENODEV indicates memory setup issues.
156 * ENOTSUP indicates that the EAL cannot initialize on this system.
158 * EPROTO indicates that the PCI bus is either not present, or is not
159 * readable by the eal.
161 * ENOEXEC indicates that a service core failed to launch successfully.
163 int rte_eal_init(int argc, char **argv);
166 * Clean up the Environment Abstraction Layer (EAL)
168 * This function must be called to release any internal resources that EAL has
169 * allocated during rte_eal_init(). After this call, no DPDK function calls may
170 * be made. It is expected that common usage of this function is to call it
171 * just before terminating the process.
173 * @return 0 Successfully released all internal EAL resources
174 * @return -EFAULT There was an error in releasing all resources.
176 int rte_eal_cleanup(void);
179 * Check if a primary process is currently alive
181 * This function returns true when a primary process is currently
184 * @param config_file_path
185 * The config_file_path argument provided should point at the location
186 * that the primary process will create its config file. If NULL, the default
187 * config file path is used.
190 * - If alive, returns 1.
191 * - If dead, returns 0.
193 int rte_eal_primary_proc_alive(const char *config_file_path);
195 #define RTE_MP_MAX_FD_NUM 8 /* The max amount of fds */
196 #define RTE_MP_MAX_NAME_LEN 64 /* The max length of action name */
197 #define RTE_MP_MAX_PARAM_LEN 256 /* The max length of param */
199 char name[RTE_MP_MAX_NAME_LEN];
202 uint8_t param[RTE_MP_MAX_PARAM_LEN];
203 int fds[RTE_MP_MAX_FD_NUM];
206 struct rte_mp_reply {
209 struct rte_mp_msg *msgs; /* caller to free */
213 * Action function typedef used by other components.
215 * As we create socket channel for primary/secondary communication, use
216 * this function typedef to register action for coming messages.
218 * @note When handling IPC request callbacks, the reply must be sent even in
219 * cases of error handling. Simply returning success or failure will *not*
220 * send a response to the requestor.
221 * Implementation of error signalling mechanism is up to the application.
223 * @note No memory allocations should take place inside the callback.
225 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
228 * Asynchronous reply function typedef used by other components.
230 * As we create socket channel for primary/secondary communication, use
231 * this function typedef to register action for coming responses to asynchronous
234 * @note When handling IPC request callbacks, the reply must be sent even in
235 * cases of error handling. Simply returning success or failure will *not*
236 * send a response to the requestor.
237 * Implementation of error signalling mechanism is up to the application.
239 * @note No memory allocations should take place inside the callback.
241 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
242 const struct rte_mp_reply *reply);
246 * @b EXPERIMENTAL: this API may change without prior notice
248 * Register an action function for primary/secondary communication.
250 * Call this function to register an action, if the calling component wants
251 * to response the messages from the corresponding component in its primary
252 * process or secondary processes.
254 * @note IPC may be unsupported in certain circumstances, so caller should check
258 * The name argument plays as the nonredundant key to find the action.
261 * The action argument is the function pointer to the action function.
269 rte_mp_action_register(const char *name, rte_mp_t action);
273 * @b EXPERIMENTAL: this API may change without prior notice
275 * Unregister an action function for primary/secondary communication.
277 * Call this function to unregister an action if the calling component does
278 * not want to response the messages from the corresponding component in its
279 * primary process or secondary processes.
281 * @note IPC may be unsupported in certain circumstances, so caller should check
285 * The name argument plays as the nonredundant key to find the action.
290 rte_mp_action_unregister(const char *name);
294 * @b EXPERIMENTAL: this API may change without prior notice
296 * Send a message to the peer process.
298 * This function will send a message which will be responded by the action
299 * identified by name in the peer process.
302 * The msg argument contains the customized message.
305 * - On success, return 0.
306 * - On failure, return -1, and the reason will be stored in rte_errno.
310 rte_mp_sendmsg(struct rte_mp_msg *msg);
314 * @b EXPERIMENTAL: this API may change without prior notice
316 * Send a request to the peer process and expect a reply.
318 * This function sends a request message to the peer process, and will
319 * block until receiving reply message from the peer process.
321 * @note The caller is responsible to free reply->replies.
323 * @note This API must not be used inside memory-related or IPC callbacks, and
324 * no memory allocations should take place inside such callback.
326 * @note IPC may be unsupported in certain circumstances, so caller should check
330 * The req argument contains the customized request message.
333 * The reply argument will be for storing all the replied messages;
334 * the caller is responsible for free reply->msgs.
337 * The ts argument specifies how long we can wait for the peer(s) to reply.
340 * - On success, return 0.
341 * - On failure, return -1, and the reason will be stored in rte_errno.
345 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
346 const struct timespec *ts);
350 * @b EXPERIMENTAL: this API may change without prior notice
352 * Send a request to the peer process and expect a reply in a separate callback.
354 * This function sends a request message to the peer process, and will not
355 * block. Instead, reply will be received in a separate callback.
357 * @note IPC may be unsupported in certain circumstances, so caller should check
361 * The req argument contains the customized request message.
364 * The ts argument specifies how long we can wait for the peer(s) to reply.
367 * The callback to trigger when all responses for this request have arrived.
370 * - On success, return 0.
371 * - On failure, return -1, and the reason will be stored in rte_errno.
375 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
376 rte_mp_async_reply_t clb);
380 * @b EXPERIMENTAL: this API may change without prior notice
382 * Send a reply to the peer process.
384 * This function will send a reply message in response to a request message
385 * received previously.
387 * @note When handling IPC request callbacks, the reply must be sent even in
388 * cases of error handling. Simply returning success or failure will *not*
389 * send a response to the requestor.
390 * Implementation of error signalling mechanism is up to the application.
393 * The msg argument contains the customized message.
396 * The peer argument is the pointer to the peer socket path.
399 * - On success, return 0.
400 * - On failure, return -1, and the reason will be stored in rte_errno.
404 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
407 * Usage function typedef used by the application usage function.
409 * Use this function typedef to define and call rte_set_application_usage_hook()
412 typedef void (*rte_usage_hook_t)(const char * prgname);
415 * Add application usage routine callout from the eal_usage() routine.
417 * This function allows the application to include its usage message
418 * in the EAL system usage message. The routine rte_set_application_usage_hook()
419 * needs to be called before the rte_eal_init() routine in the application.
421 * This routine is optional for the application and will behave as if the set
422 * routine was never called as the default behavior.
425 * The func argument is a function pointer to the application usage routine.
426 * Called function is defined using rte_usage_hook_t typedef, which is of
427 * the form void rte_usage_func(const char * prgname).
429 * Calling this routine with a NULL value will reset the usage hook routine and
430 * return the current value, which could be NULL.
432 * - Returns the current value of the rte_application_usage pointer to allow
433 * the caller to daisy chain the usage routines if needing more then one.
436 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
439 * Whether EAL is using huge pages (disabled by --no-huge option).
440 * The no-huge mode is not compatible with all drivers or features.
443 * Nonzero if hugepages are enabled.
445 int rte_eal_has_hugepages(void);
448 * Whether EAL is using PCI bus.
449 * Disabled by --no-pci option.
452 * Nonzero if the PCI bus is enabled.
454 int rte_eal_has_pci(void);
457 * Whether the EAL was asked to create UIO device.
462 int rte_eal_create_uio_dev(void);
465 * The user-configured vfio interrupt mode.
468 * Interrupt mode configured with the command line,
469 * RTE_INTR_MODE_NONE by default.
471 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
474 * A wrap API for syscall gettid.
477 * On success, returns the thread ID of calling process.
478 * It is always successful.
480 int rte_sys_gettid(void);
483 * Get system unique thread id.
486 * On success, returns the thread ID of calling process.
487 * It is always successful.
489 static inline int rte_gettid(void)
491 static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
492 if (RTE_PER_LCORE(_thread_id) == -1)
493 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
494 return RTE_PER_LCORE(_thread_id);
501 * enum rte_iova_mode value.
503 enum rte_iova_mode rte_eal_iova_mode(void);
506 * Get user provided pool ops name for mbuf
509 * returns user provided pool ops name.
512 rte_eal_mbuf_user_pool_ops(void);
515 * Get the runtime directory of DPDK
518 * The runtime directory path of DPDK
521 rte_eal_get_runtime_dir(void);
527 #endif /* _RTE_EAL_H_ */