1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
11 * EAL Configuration API
17 #include <rte_config.h>
18 #include <rte_compat.h>
19 #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 type of process in a linux, multi-process setup
37 enum rte_proc_type_t {
38 RTE_PROC_AUTO = -1, /* allow auto-detection of primary/secondary */
39 RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
46 * Get the process type in a multi-process setup
51 enum rte_proc_type_t rte_eal_process_type(void);
54 * Request iopl privilege for all RPL.
56 * This function should be called by pmds which need access to ioports.
59 * - On success, returns 0.
60 * - On failure, returns -1.
62 int rte_eal_iopl_init(void);
65 * Initialize the Environment Abstraction Layer (EAL).
67 * This function is to be executed on the MAIN lcore only, as soon
68 * as possible in the application's main() function.
69 * It puts the WORKER lcores in the WAIT state.
72 * A non-negative value. If it is greater than 0, the array members
73 * for argv[0] through argv[argc] (non-inclusive) shall contain pointers
76 * An array of strings. The contents of the array, as well as the strings
77 * which are pointed to by the array, may be modified by this function.
79 * - On success, the number of parsed arguments, which is greater or
80 * equal to zero. After the call to rte_eal_init(),
81 * all arguments argv[x] with x < ret may have been modified by this
82 * function call and should not be further interpreted by the
83 * application. The EAL does not take any ownership of the memory used
84 * for either the argv array, or its members.
85 * - On failure, -1 and rte_errno is set to a value indicating the cause
86 * for failure. In some instances, the application will need to be
87 * restarted as part of clearing the issue.
89 * Error codes returned via rte_errno:
90 * EACCES indicates a permissions issue.
92 * EAGAIN indicates either a bus or system resource was not available,
93 * setup may be attempted again.
95 * EALREADY indicates that the rte_eal_init function has already been
96 * called, and cannot be called again.
98 * EFAULT indicates the tailq configuration name was not found in
99 * memory configuration.
101 * EINVAL indicates invalid parameters were passed as argv/argc.
103 * ENOMEM indicates failure likely caused by an out-of-memory condition.
105 * ENODEV indicates memory setup issues.
107 * ENOTSUP indicates that the EAL cannot initialize on this system.
109 * EPROTO indicates that the PCI bus is either not present, or is not
110 * readable by the eal.
112 * ENOEXEC indicates that a service core failed to launch successfully.
114 int rte_eal_init(int argc, char **argv);
117 * Clean up the Environment Abstraction Layer (EAL)
119 * This function must be called to release any internal resources that EAL has
120 * allocated during rte_eal_init(). After this call, no DPDK function calls may
121 * be made. It is expected that common usage of this function is to call it
122 * just before terminating the process.
125 * - 0 Successfully released all internal EAL resources.
126 * - -EFAULT There was an error in releasing all resources.
128 int rte_eal_cleanup(void);
131 * Check if a primary process is currently alive
133 * This function returns true when a primary process is currently
136 * @param config_file_path
137 * The config_file_path argument provided should point at the location
138 * that the primary process will create its config file. If NULL, the default
139 * config file path is used.
142 * - If alive, returns 1.
143 * - If dead, returns 0.
145 int rte_eal_primary_proc_alive(const char *config_file_path);
148 * Disable multiprocess.
150 * This function can be called to indicate that multiprocess won't be used for
151 * the rest of the application life.
154 * - true if called from a primary process that had no secondary processes
156 * - false, otherwise.
158 bool rte_mp_disable(void);
160 #define RTE_MP_MAX_FD_NUM 8 /* The max amount of fds */
161 #define RTE_MP_MAX_NAME_LEN 64 /* The max length of action name */
162 #define RTE_MP_MAX_PARAM_LEN 256 /* The max length of param */
164 char name[RTE_MP_MAX_NAME_LEN];
167 uint8_t param[RTE_MP_MAX_PARAM_LEN];
168 int fds[RTE_MP_MAX_FD_NUM];
171 struct rte_mp_reply {
174 struct rte_mp_msg *msgs; /* caller to free */
178 * Action function typedef used by other components.
180 * As we create socket channel for primary/secondary communication, use
181 * this function typedef to register action for coming messages.
183 * @note When handling IPC request callbacks, the reply must be sent even in
184 * cases of error handling. Simply returning success or failure will *not*
185 * send a response to the requestor.
186 * Implementation of error signalling mechanism is up to the application.
188 * @note No memory allocations should take place inside the callback.
190 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
193 * Asynchronous reply function typedef used by other components.
195 * As we create socket channel for primary/secondary communication, use
196 * this function typedef to register action for coming responses to asynchronous
199 * @note When handling IPC request callbacks, the reply must be sent even in
200 * cases of error handling. Simply returning success or failure will *not*
201 * send a response to the requestor.
202 * Implementation of error signalling mechanism is up to the application.
204 * @note No memory allocations should take place inside the callback.
206 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
207 const struct rte_mp_reply *reply);
210 * Register an action function for primary/secondary communication.
212 * Call this function to register an action, if the calling component wants
213 * to response the messages from the corresponding component in its primary
214 * process or secondary processes.
216 * @note IPC may be unsupported in certain circumstances, so caller should check
220 * The name argument plays as the nonredundant key to find the action.
223 * The action argument is the function pointer to the action function.
230 rte_mp_action_register(const char *name, rte_mp_t action);
233 * Unregister an action function for primary/secondary communication.
235 * Call this function to unregister an action if the calling component does
236 * not want to response the messages from the corresponding component in its
237 * primary process or secondary processes.
239 * @note IPC may be unsupported in certain circumstances, so caller should check
243 * The name argument plays as the nonredundant key to find the action.
247 rte_mp_action_unregister(const char *name);
250 * Send a message to the peer process.
252 * This function will send a message which will be responded by the action
253 * identified by name in the peer process.
256 * The msg argument contains the customized message.
259 * - On success, return 0.
260 * - On failure, return -1, and the reason will be stored in rte_errno.
263 rte_mp_sendmsg(struct rte_mp_msg *msg);
266 * Send a request to the peer process and expect a reply.
268 * This function sends a request message to the peer process, and will
269 * block until receiving reply message from the peer process.
271 * @note The caller is responsible to free reply->replies.
273 * @note This API must not be used inside memory-related or IPC callbacks, and
274 * no memory allocations should take place inside such callback.
276 * @note IPC may be unsupported in certain circumstances, so caller should check
280 * The req argument contains the customized request message.
283 * The reply argument will be for storing all the replied messages;
284 * the caller is responsible for free reply->msgs.
287 * The ts argument specifies how long we can wait for the peer(s) to reply.
290 * - On success, return 0.
291 * - On failure, return -1, and the reason will be stored in rte_errno.
294 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
295 const struct timespec *ts);
298 * Send a request to the peer process and expect a reply in a separate callback.
300 * This function sends a request message to the peer process, and will not
301 * block. Instead, reply will be received in a separate callback.
303 * @note IPC may be unsupported in certain circumstances, so caller should check
307 * The req argument contains the customized request message.
310 * The ts argument specifies how long we can wait for the peer(s) to reply.
313 * The callback to trigger when all responses for this request have arrived.
316 * - On success, return 0.
317 * - On failure, return -1, and the reason will be stored in rte_errno.
320 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
321 rte_mp_async_reply_t clb);
324 * Send a reply to the peer process.
326 * This function will send a reply message in response to a request message
327 * received previously.
329 * @note When handling IPC request callbacks, the reply must be sent even in
330 * cases of error handling. Simply returning success or failure will *not*
331 * send a response to the requestor.
332 * Implementation of error signalling mechanism is up to the application.
335 * The msg argument contains the customized message.
338 * The peer argument is the pointer to the peer socket path.
341 * - On success, return 0.
342 * - On failure, return -1, and the reason will be stored in rte_errno.
345 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
348 * Usage function typedef used by the application usage function.
350 * Use this function typedef to define and call rte_set_application_usage_hook()
353 typedef void (*rte_usage_hook_t)(const char * prgname);
356 * Add application usage routine callout from the eal_usage() routine.
358 * This function allows the application to include its usage message
359 * in the EAL system usage message. The routine rte_set_application_usage_hook()
360 * needs to be called before the rte_eal_init() routine in the application.
362 * This routine is optional for the application and will behave as if the set
363 * routine was never called as the default behavior.
366 * The func argument is a function pointer to the application usage routine.
367 * Called function is defined using rte_usage_hook_t typedef, which is of
368 * the form void rte_usage_func(const char * prgname).
370 * Calling this routine with a NULL value will reset the usage hook routine and
371 * return the current value, which could be NULL.
373 * - Returns the current value of the rte_application_usage pointer to allow
374 * the caller to daisy chain the usage routines if needing more then one.
377 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
380 * Whether EAL is using huge pages (disabled by --no-huge option).
381 * The no-huge mode is not compatible with all drivers or features.
384 * Nonzero if hugepages are enabled.
386 int rte_eal_has_hugepages(void);
389 * Whether EAL is using PCI bus.
390 * Disabled by --no-pci option.
393 * Nonzero if the PCI bus is enabled.
395 int rte_eal_has_pci(void);
398 * Whether the EAL was asked to create UIO device.
403 int rte_eal_create_uio_dev(void);
406 * The user-configured vfio interrupt mode.
409 * Interrupt mode configured with the command line,
410 * RTE_INTR_MODE_NONE by default.
412 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
416 * @b EXPERIMENTAL: this API may change without prior notice
418 * Copy the user-configured vfio VF token.
421 * vfio VF token configured with the command line is copied
422 * into this parameter, zero uuid by default.
425 void rte_eal_vfio_get_vf_token(rte_uuid_t vf_token);
428 * A wrap API for syscall gettid.
431 * On success, returns the thread ID of calling process.
432 * It is always successful.
434 int rte_sys_gettid(void);
436 RTE_DECLARE_PER_LCORE(int, _thread_id);
439 * Get system unique thread id.
442 * On success, returns the thread ID of calling process.
443 * It is always successful.
445 static inline int rte_gettid(void)
447 if (RTE_PER_LCORE(_thread_id) == -1)
448 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
449 return RTE_PER_LCORE(_thread_id);
453 * Get the OS-specific EAL base address.
459 uint64_t rte_eal_get_baseaddr(void);
465 * enum rte_iova_mode value.
467 enum rte_iova_mode rte_eal_iova_mode(void);
470 * Get user provided pool ops name for mbuf
473 * returns user provided pool ops name.
476 rte_eal_mbuf_user_pool_ops(void);
479 * Get the runtime directory of DPDK
482 * The runtime directory path of DPDK
485 rte_eal_get_runtime_dir(void);
491 #endif /* _RTE_EAL_H_ */