1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2018 Intel Corporation
3 */
4
5 #ifndef _RTE_EAL_H_
6 #define _RTE_EAL_H_
7
8 /**
9 * @file
10 *
11 * EAL Configuration API
12 */
13
14 #include <stdint.h>
15 #include <time.h>
16
17 #include <rte_config.h>
18 #include <rte_compat.h>
19 #include <rte_per_lcore.h>
20 #include <rte_bus.h>
21 #include <rte_uuid.h>
22
23 #include <rte_pci_dev_feature_defs.h>
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 #define RTE_MAGIC 19820526 /**< Magic number written by the main partition when ready. */
30
31 /* Maximum thread_name length. */
32 #define RTE_MAX_THREAD_NAME_LEN 16
33
34 /**
35 * The type of process in a linux, multi-process setup
36 */
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 */
40 RTE_PROC_SECONDARY,
41
42 RTE_PROC_INVALID
43 };
44
45 /**
46 * Get the process type in a multi-process setup
47 *
48 * @return
49 * The process type
50 */
51 enum rte_proc_type_t rte_eal_process_type(void);
52
53 /**
54 * Request iopl privilege for all RPL.
55 *
56 * This function should be called by pmds which need access to ioports.
57
58 * @return
59 * - On success, returns 0.
60 * - On failure, returns -1.
61 */
62 int rte_eal_iopl_init(void);
63
64 /**
65 * Initialize the Environment Abstraction Layer (EAL).
66 *
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.
70 *
71 * @param argc
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
74 * to strings.
75 * @param argv
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.
78 * @return
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.
88 *
89 * Error codes returned via rte_errno:
90 * EACCES indicates a permissions issue.
91 *
92 * EAGAIN indicates either a bus or system resource was not available,
93 * setup may be attempted again.
94 *
95 * EALREADY indicates that the rte_eal_init function has already been
96 * called, and cannot be called again.
97 *
98 * EFAULT indicates the tailq configuration name was not found in
99 * memory configuration.
100 *
101 * EINVAL indicates invalid parameters were passed as argv/argc.
102 *
103 * ENOMEM indicates failure likely caused by an out-of-memory condition.
104 *
105 * ENODEV indicates memory setup issues.
106 *
107 * ENOTSUP indicates that the EAL cannot initialize on this system.
108 *
109 * EPROTO indicates that the PCI bus is either not present, or is not
110 * readable by the eal.
111 *
112 * ENOEXEC indicates that a service core failed to launch successfully.
113 */
114 int rte_eal_init(int argc, char **argv);
115
116 /**
117 * Clean up the Environment Abstraction Layer (EAL)
118 *
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.
123 *
124 * @return
125 * - 0 Successfully released all internal EAL resources.
126 * - -EFAULT There was an error in releasing all resources.
127 */
128 int rte_eal_cleanup(void);
129
130 /**
131 * Check if a primary process is currently alive
132 *
133 * This function returns true when a primary process is currently
134 * active.
135 *
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.
140 *
141 * @return
142 * - If alive, returns 1.
143 * - If dead, returns 0.
144 */
145 int rte_eal_primary_proc_alive(const char *config_file_path);
146
147 /**
148 * Disable multiprocess.
149 *
150 * This function can be called to indicate that multiprocess won't be used for
151 * the rest of the application life.
152 *
153 * @return
154 * - true if called from a primary process that had no secondary processes
155 * attached,
156 * - false, otherwise.
157 */
158 bool rte_mp_disable(void);
159
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 */
163 struct rte_mp_msg {
164 char name[RTE_MP_MAX_NAME_LEN];
165 int len_param;
166 int num_fds;
167 uint8_t param[RTE_MP_MAX_PARAM_LEN];
168 int fds[RTE_MP_MAX_FD_NUM];
169 };
170
171 struct rte_mp_reply {
172 int nb_sent;
173 int nb_received;
174 struct rte_mp_msg *msgs; /* caller to free */
175 };
176
177 /**
178 * Action function typedef used by other components.
179 *
180 * As we create socket channel for primary/secondary communication, use
181 * this function typedef to register action for coming messages.
182 *
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.
187 *
188 * @note No memory allocations should take place inside the callback.
189 */
190 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
191
192 /**
193 * Asynchronous reply function typedef used by other components.
194 *
195 * As we create socket channel for primary/secondary communication, use
196 * this function typedef to register action for coming responses to asynchronous
197 * requests.
198 *
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.
203 *
204 * @note No memory allocations should take place inside the callback.
205 */
206 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
207 const struct rte_mp_reply *reply);
208
209 /**
210 * Register an action function for primary/secondary communication.
211 *
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.
215 *
216 * @note IPC may be unsupported in certain circumstances, so caller should check
217 * for ENOTSUP error.
218 *
219 * @param name
220 * The name argument plays as the nonredundant key to find the action.
221 *
222 * @param action
223 * The action argument is the function pointer to the action function.
224 *
225 * @return
226 * - 0 on success.
227 * - (<0) on failure.
228 */
229 int
230 rte_mp_action_register(const char *name, rte_mp_t action);
231
232 /**
233 * Unregister an action function for primary/secondary communication.
234 *
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.
238 *
239 * @note IPC may be unsupported in certain circumstances, so caller should check
240 * for ENOTSUP error.
241 *
242 * @param name
243 * The name argument plays as the nonredundant key to find the action.
244 *
245 */
246 void
247 rte_mp_action_unregister(const char *name);
248
249 /**
250 * Send a message to the peer process.
251 *
252 * This function will send a message which will be responded by the action
253 * identified by name in the peer process.
254 *
255 * @param msg
256 * The msg argument contains the customized message.
257 *
258 * @return
259 * - On success, return 0.
260 * - On failure, return -1, and the reason will be stored in rte_errno.
261 */
262 int
263 rte_mp_sendmsg(struct rte_mp_msg *msg);
264
265 /**
266 * Send a request to the peer process and expect a reply.
267 *
268 * This function sends a request message to the peer process, and will
269 * block until receiving reply message from the peer process.
270 *
271 * @note The caller is responsible to free reply->replies.
272 *
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.
275 *
276 * @note IPC may be unsupported in certain circumstances, so caller should check
277 * for ENOTSUP error.
278 *
279 * @param req
280 * The req argument contains the customized request message.
281 *
282 * @param reply
283 * The reply argument will be for storing all the replied messages;
284 * the caller is responsible for free reply->msgs.
285 *
286 * @param ts
287 * The ts argument specifies how long we can wait for the peer(s) to reply.
288 *
289 * @return
290 * - On success, return 0.
291 * - On failure, return -1, and the reason will be stored in rte_errno.
292 */
293 int
294 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
295 const struct timespec *ts);
296
297 /**
298 * Send a request to the peer process and expect a reply in a separate callback.
299 *
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.
302 *
303 * @note IPC may be unsupported in certain circumstances, so caller should check
304 * for ENOTSUP error.
305 *
306 * @param req
307 * The req argument contains the customized request message.
308 *
309 * @param ts
310 * The ts argument specifies how long we can wait for the peer(s) to reply.
311 *
312 * @param clb
313 * The callback to trigger when all responses for this request have arrived.
314 *
315 * @return
316 * - On success, return 0.
317 * - On failure, return -1, and the reason will be stored in rte_errno.
318 */
319 int
320 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
321 rte_mp_async_reply_t clb);
322
323 /**
324 * Send a reply to the peer process.
325 *
326 * This function will send a reply message in response to a request message
327 * received previously.
328 *
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.
333 *
334 * @param msg
335 * The msg argument contains the customized message.
336 *
337 * @param peer
338 * The peer argument is the pointer to the peer socket path.
339 *
340 * @return
341 * - On success, return 0.
342 * - On failure, return -1, and the reason will be stored in rte_errno.
343 */
344 int
345 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
346
347 /**
348 * Usage function typedef used by the application usage function.
349 *
350 * Use this function typedef to define and call rte_set_application_usage_hook()
351 * routine.
352 */
353 typedef void (*rte_usage_hook_t)(const char * prgname);
354
355 /**
356 * Add application usage routine callout from the eal_usage() routine.
357 *
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.
361 *
362 * This routine is optional for the application and will behave as if the set
363 * routine was never called as the default behavior.
364 *
365 * @param usage_func
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).
369 *
370 * Calling this routine with a NULL value will reset the usage hook routine and
371 * return the current value, which could be NULL.
372 * @return
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.
375 */
376 rte_usage_hook_t
377 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
378
379 /**
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.
382 *
383 * @return
384 * Nonzero if hugepages are enabled.
385 */
386 int rte_eal_has_hugepages(void);
387
388 /**
389 * Whether EAL is using PCI bus.
390 * Disabled by --no-pci option.
391 *
392 * @return
393 * Nonzero if the PCI bus is enabled.
394 */
395 int rte_eal_has_pci(void);
396
397 /**
398 * Whether the EAL was asked to create UIO device.
399 *
400 * @return
401 * Nonzero if true.
402 */
403 int rte_eal_create_uio_dev(void);
404
405 /**
406 * The user-configured vfio interrupt mode.
407 *
408 * @return
409 * Interrupt mode configured with the command line,
410 * RTE_INTR_MODE_NONE by default.
411 */
412 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
413
414 /**
415 * @warning
416 * @b EXPERIMENTAL: this API may change without prior notice
417 *
418 * Copy the user-configured vfio VF token.
419 *
420 * @param vf_token
421 * vfio VF token configured with the command line is copied
422 * into this parameter, zero uuid by default.
423 */
424 __rte_experimental
425 void rte_eal_vfio_get_vf_token(rte_uuid_t vf_token);
426
427 /**
428 * A wrap API for syscall gettid.
429 *
430 * @return
431 * On success, returns the thread ID of calling process.
432 * It is always successful.
433 */
434 int rte_sys_gettid(void);
435
436 RTE_DECLARE_PER_LCORE(int, _thread_id);
437
438 /**
439 * Get system unique thread id.
440 *
441 * @return
442 * On success, returns the thread ID of calling process.
443 * It is always successful.
444 */
rte_gettid(void)445 static inline int rte_gettid(void)
446 {
447 if (RTE_PER_LCORE(_thread_id) == -1)
448 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
449 return RTE_PER_LCORE(_thread_id);
450 }
451
452 /**
453 * Get the OS-specific EAL base address.
454 *
455 * @return
456 * The base address.
457 */
458 __rte_internal
459 uint64_t rte_eal_get_baseaddr(void);
460
461 /**
462 * Get the iova mode
463 *
464 * @return
465 * enum rte_iova_mode value.
466 */
467 enum rte_iova_mode rte_eal_iova_mode(void);
468
469 /**
470 * Get user provided pool ops name for mbuf
471 *
472 * @return
473 * returns user provided pool ops name.
474 */
475 const char *
476 rte_eal_mbuf_user_pool_ops(void);
477
478 /**
479 * Get the runtime directory of DPDK
480 *
481 * @return
482 * The runtime directory path of DPDK
483 */
484 const char *
485 rte_eal_get_runtime_dir(void);
486
487 #ifdef __cplusplus
488 }
489 #endif
490
491 #endif /* _RTE_EAL_H_ */
492