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>
24 #include <rte_pci_dev_feature_defs.h>
30 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
32 /* Maximum thread_name length. */
33 #define RTE_MAX_THREAD_NAME_LEN 16
36 * The lcore role (used in RTE or not).
38 enum rte_lcore_role_t {
45 * The type of process in a linux, multi-process setup
47 enum rte_proc_type_t {
48 RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
49 RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
56 * Get the process type in a multi-process setup
61 enum rte_proc_type_t rte_eal_process_type(void);
64 * Request iopl privilege for all RPL.
66 * This function should be called by pmds which need access to ioports.
69 * - On success, returns 0.
70 * - On failure, returns -1.
72 int rte_eal_iopl_init(void);
75 * Initialize the Environment Abstraction Layer (EAL).
77 * This function is to be executed on the MASTER lcore only, as soon
78 * as possible in the application's main() function.
80 * The function finishes the initialization process before main() is called.
81 * It puts the SLAVE lcores in the WAIT state.
83 * When the multi-partition feature is supported, depending on the
84 * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
85 * function waits to ensure that the magic number is set before
86 * returning. See also the rte_eal_get_configuration() function. Note:
87 * This behavior may change in the future.
90 * A non-negative value. If it is greater than 0, the array members
91 * for argv[0] through argv[argc] (non-inclusive) shall contain pointers
94 * An array of strings. The contents of the array, as well as the strings
95 * which are pointed to by the array, may be modified by this function.
97 * - On success, the number of parsed arguments, which is greater or
98 * equal to zero. After the call to rte_eal_init(),
99 * all arguments argv[x] with x < ret may have been modified by this
100 * function call and should not be further interpreted by the
101 * application. The EAL does not take any ownership of the memory used
102 * for either the argv array, or its members.
103 * - On failure, -1 and rte_errno is set to a value indicating the cause
104 * for failure. In some instances, the application will need to be
105 * restarted as part of clearing the issue.
107 * Error codes returned via rte_errno:
108 * EACCES indicates a permissions issue.
110 * EAGAIN indicates either a bus or system resource was not available,
111 * setup may be attempted again.
113 * EALREADY indicates that the rte_eal_init function has already been
114 * called, and cannot be called again.
116 * EFAULT indicates the tailq configuration name was not found in
117 * memory configuration.
119 * EINVAL indicates invalid parameters were passed as argv/argc.
121 * ENOMEM indicates failure likely caused by an out-of-memory condition.
123 * ENODEV indicates memory setup issues.
125 * ENOTSUP indicates that the EAL cannot initialize on this system.
127 * EPROTO indicates that the PCI bus is either not present, or is not
128 * readable by the eal.
130 * ENOEXEC indicates that a service core failed to launch successfully.
132 int rte_eal_init(int argc, char **argv);
135 * Clean up the Environment Abstraction Layer (EAL)
137 * This function must be called to release any internal resources that EAL has
138 * allocated during rte_eal_init(). After this call, no DPDK function calls may
139 * be made. It is expected that common usage of this function is to call it
140 * just before terminating the process.
142 * @return 0 Successfully released all internal EAL resources
143 * @return -EFAULT There was an error in releasing all resources.
145 int rte_eal_cleanup(void);
148 * Check if a primary process is currently alive
150 * This function returns true when a primary process is currently
153 * @param config_file_path
154 * The config_file_path argument provided should point at the location
155 * that the primary process will create its config file. If NULL, the default
156 * config file path is used.
159 * - If alive, returns 1.
160 * - If dead, returns 0.
162 int rte_eal_primary_proc_alive(const char *config_file_path);
164 #define RTE_MP_MAX_FD_NUM 8 /* The max amount of fds */
165 #define RTE_MP_MAX_NAME_LEN 64 /* The max length of action name */
166 #define RTE_MP_MAX_PARAM_LEN 256 /* The max length of param */
168 char name[RTE_MP_MAX_NAME_LEN];
171 uint8_t param[RTE_MP_MAX_PARAM_LEN];
172 int fds[RTE_MP_MAX_FD_NUM];
175 struct rte_mp_reply {
178 struct rte_mp_msg *msgs; /* caller to free */
182 * Action function typedef used by other components.
184 * As we create socket channel for primary/secondary communication, use
185 * this function typedef to register action for coming messages.
187 * @note When handling IPC request callbacks, the reply must be sent even in
188 * cases of error handling. Simply returning success or failure will *not*
189 * send a response to the requestor.
190 * Implementation of error signalling mechanism is up to the application.
192 * @note No memory allocations should take place inside the callback.
194 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
197 * Asynchronous reply function typedef used by other components.
199 * As we create socket channel for primary/secondary communication, use
200 * this function typedef to register action for coming responses to asynchronous
203 * @note When handling IPC request callbacks, the reply must be sent even in
204 * cases of error handling. Simply returning success or failure will *not*
205 * send a response to the requestor.
206 * Implementation of error signalling mechanism is up to the application.
208 * @note No memory allocations should take place inside the callback.
210 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
211 const struct rte_mp_reply *reply);
215 * @b EXPERIMENTAL: this API may change without prior notice
217 * Register an action function for primary/secondary communication.
219 * Call this function to register an action, if the calling component wants
220 * to response the messages from the corresponding component in its primary
221 * process or secondary processes.
223 * @note IPC may be unsupported in certain circumstances, so caller should check
227 * The name argument plays as the nonredundant key to find the action.
230 * The action argument is the function pointer to the action function.
238 rte_mp_action_register(const char *name, rte_mp_t action);
242 * @b EXPERIMENTAL: this API may change without prior notice
244 * Unregister an action function for primary/secondary communication.
246 * Call this function to unregister an action if the calling component does
247 * not want to response the messages from the corresponding component in its
248 * primary process or secondary processes.
250 * @note IPC may be unsupported in certain circumstances, so caller should check
254 * The name argument plays as the nonredundant key to find the action.
259 rte_mp_action_unregister(const char *name);
263 * @b EXPERIMENTAL: this API may change without prior notice
265 * Send a message to the peer process.
267 * This function will send a message which will be responded by the action
268 * identified by name in the peer process.
271 * The msg argument contains the customized message.
274 * - On success, return 0.
275 * - On failure, return -1, and the reason will be stored in rte_errno.
279 rte_mp_sendmsg(struct rte_mp_msg *msg);
283 * @b EXPERIMENTAL: this API may change without prior notice
285 * Send a request to the peer process and expect a reply.
287 * This function sends a request message to the peer process, and will
288 * block until receiving reply message from the peer process.
290 * @note The caller is responsible to free reply->replies.
292 * @note This API must not be used inside memory-related or IPC callbacks, and
293 * no memory allocations should take place inside such callback.
295 * @note IPC may be unsupported in certain circumstances, so caller should check
299 * The req argument contains the customized request message.
302 * The reply argument will be for storing all the replied messages;
303 * the caller is responsible for free reply->msgs.
306 * The ts argument specifies how long we can wait for the peer(s) to reply.
309 * - On success, return 0.
310 * - On failure, return -1, and the reason will be stored in rte_errno.
314 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
315 const struct timespec *ts);
319 * @b EXPERIMENTAL: this API may change without prior notice
321 * Send a request to the peer process and expect a reply in a separate callback.
323 * This function sends a request message to the peer process, and will not
324 * block. Instead, reply will be received in a separate 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 ts argument specifies how long we can wait for the peer(s) to reply.
336 * The callback to trigger when all responses for this request have arrived.
339 * - On success, return 0.
340 * - On failure, return -1, and the reason will be stored in rte_errno.
344 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
345 rte_mp_async_reply_t clb);
349 * @b EXPERIMENTAL: this API may change without prior notice
351 * Send a reply to the peer process.
353 * This function will send a reply message in response to a request message
354 * received previously.
356 * @note When handling IPC request callbacks, the reply must be sent even in
357 * cases of error handling. Simply returning success or failure will *not*
358 * send a response to the requestor.
359 * Implementation of error signalling mechanism is up to the application.
362 * The msg argument contains the customized message.
365 * The peer argument is the pointer to the peer socket path.
368 * - On success, return 0.
369 * - On failure, return -1, and the reason will be stored in rte_errno.
373 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
376 * Usage function typedef used by the application usage function.
378 * Use this function typedef to define and call rte_set_application_usage_hook()
381 typedef void (*rte_usage_hook_t)(const char * prgname);
384 * Add application usage routine callout from the eal_usage() routine.
386 * This function allows the application to include its usage message
387 * in the EAL system usage message. The routine rte_set_application_usage_hook()
388 * needs to be called before the rte_eal_init() routine in the application.
390 * This routine is optional for the application and will behave as if the set
391 * routine was never called as the default behavior.
394 * The func argument is a function pointer to the application usage routine.
395 * Called function is defined using rte_usage_hook_t typedef, which is of
396 * the form void rte_usage_func(const char * prgname).
398 * Calling this routine with a NULL value will reset the usage hook routine and
399 * return the current value, which could be NULL.
401 * - Returns the current value of the rte_application_usage pointer to allow
402 * the caller to daisy chain the usage routines if needing more then one.
405 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
408 * Whether EAL is using huge pages (disabled by --no-huge option).
409 * The no-huge mode is not compatible with all drivers or features.
412 * Nonzero if hugepages are enabled.
414 int rte_eal_has_hugepages(void);
417 * Whether EAL is using PCI bus.
418 * Disabled by --no-pci option.
421 * Nonzero if the PCI bus is enabled.
423 int rte_eal_has_pci(void);
426 * Whether the EAL was asked to create UIO device.
431 int rte_eal_create_uio_dev(void);
434 * The user-configured vfio interrupt mode.
437 * Interrupt mode configured with the command line,
438 * RTE_INTR_MODE_NONE by default.
440 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
444 * @b EXPERIMENTAL: this API may change without prior notice
446 * Copy the user-configured vfio VF token.
449 * vfio VF token configured with the command line is copied
450 * into this parameter, zero uuid by default.
453 void rte_eal_vfio_get_vf_token(rte_uuid_t vf_token);
456 * A wrap API for syscall gettid.
459 * On success, returns the thread ID of calling process.
460 * It is always successful.
462 int rte_sys_gettid(void);
464 RTE_DECLARE_PER_LCORE(int, _thread_id);
467 * Get system unique thread id.
470 * On success, returns the thread ID of calling process.
471 * It is always successful.
473 static inline int rte_gettid(void)
475 if (RTE_PER_LCORE(_thread_id) == -1)
476 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
477 return RTE_PER_LCORE(_thread_id);
484 * enum rte_iova_mode value.
486 enum rte_iova_mode rte_eal_iova_mode(void);
489 * Get user provided pool ops name for mbuf
492 * returns user provided pool ops name.
495 rte_eal_mbuf_user_pool_ops(void);
498 * Get the runtime directory of DPDK
501 * The runtime directory path of DPDK
504 rte_eal_get_runtime_dir(void);
510 #endif /* _RTE_EAL_H_ */