lib/librte_eal/common/include/rte_eal.h

   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 <sched.h>
  16 #include <time.h>
  17
  18 #include <rte_config.h>
  19 #include <rte_compat.h>
  20 #include <rte_per_lcore.h>
  21 #include <rte_bus.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 lcore role (used in RTE or not).
  36  */
  37 enum rte_lcore_role_t {
  38         ROLE_RTE,
  39         ROLE_OFF,
  40         ROLE_SERVICE,
  41 };
  42
  43 /**
  44  * The type of process in a linux, multi-process setup
  45  */
  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 */
  49         RTE_PROC_SECONDARY,
  50
  51         RTE_PROC_INVALID
  52 };
  53
  54 /**
  55  * The global RTE configuration structure.
  56  */
  57 struct rte_config {
  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. */
  64
  65         /** Primary or secondary configuration */
  66         enum rte_proc_type_t process_type;
  67
  68         /** PA or VA mapping mode */
  69         enum rte_iova_mode iova_mode;
  70
  71         /**
  72          * Pointer to memory configuration, which may be shared across multiple
  73          * DPDK instances
  74          */
  75         struct rte_mem_config *mem_config;
  76 } __attribute__((__packed__));
  77
  78 /**
  79  * Get the global configuration structure.
  80  *
  81  * @return
  82  *   A pointer to the global configuration structure.
  83  */
  84 struct rte_config *rte_eal_get_configuration(void);
  85
  86 /**
  87  * Get a lcore's role.
  88  *
  89  * @param lcore_id
  90  *   The identifier of the lcore.
  91  * @return
  92  *   The role of the lcore.
  93  */
  94 enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);
  95
  96
  97 /**
  98  * Get the process type in a multi-process setup
  99  *
 100  * @return
 101  *   The process type
 102  */
 103 enum rte_proc_type_t rte_eal_process_type(void);
 104
 105 /**
 106  * Request iopl privilege for all RPL.
 107  *
 108  * This function should be called by pmds which need access to ioports.
 109
 110  * @return
 111  *   - On success, returns 0.
 112  *   - On failure, returns -1.
 113  */
 114 int rte_eal_iopl_init(void);
 115
 116 /**
 117  * Initialize the Environment Abstraction Layer (EAL).
 118  *
 119  * This function is to be executed on the MASTER lcore only, as soon
 120  * as possible in the application's main() function.
 121  *
 122  * The function finishes the initialization process before main() is called.
 123  * It puts the SLAVE lcores in the WAIT state.
 124  *
 125  * When the multi-partition feature is supported, depending on the
 126  * configuration (if CONFIG_RTE_EAL_MAIN_PARTITION is disabled), this
 127  * function waits to ensure that the magic number is set before
 128  * returning. See also the rte_eal_get_configuration() function. Note:
 129  * This behavior may change in the future.
 130  *
 131  * @param argc
 132  *   A non-negative value.  If it is greater than 0, the array members
 133  *   for argv[0] through argv[argc] (non-inclusive) shall contain pointers
 134  *   to strings.
 135  * @param argv
 136  *   An array of strings.  The contents of the array, as well as the strings
 137  *   which are pointed to by the array, may be modified by this function.
 138  * @return
 139  *   - On success, the number of parsed arguments, which is greater or
 140  *     equal to zero. After the call to rte_eal_init(),
 141  *     all arguments argv[x] with x < ret may have been modified by this
 142  *     function call and should not be further interpreted by the
 143  *     application.  The EAL does not take any ownership of the memory used
 144  *     for either the argv array, or its members.
 145  *   - On failure, -1 and rte_errno is set to a value indicating the cause
 146  *     for failure.  In some instances, the application will need to be
 147  *     restarted as part of clearing the issue.
 148  *
 149  *   Error codes returned via rte_errno:
 150  *     EACCES indicates a permissions issue.
 151  *
 152  *     EAGAIN indicates either a bus or system resource was not available,
 153  *            setup may be attempted again.
 154  *
 155  *     EALREADY indicates that the rte_eal_init function has already been
 156  *              called, and cannot be called again.
 157  *
 158  *     EFAULT indicates the tailq configuration name was not found in
 159  *            memory configuration.
 160  *
 161  *     EINVAL indicates invalid parameters were passed as argv/argc.
 162  *
 163  *     ENOMEM indicates failure likely caused by an out-of-memory condition.
 164  *
 165  *     ENODEV indicates memory setup issues.
 166  *
 167  *     ENOTSUP indicates that the EAL cannot initialize on this system.
 168  *
 169  *     EPROTO indicates that the PCI bus is either not present, or is not
 170  *            readable by the eal.
 171  *
 172  *     ENOEXEC indicates that a service core failed to launch successfully.
 173  */
 174 int rte_eal_init(int argc, char **argv);
 175
 176 /**
 177  * Clean up the Environment Abstraction Layer (EAL)
 178  *
 179  * This function must be called to release any internal resources that EAL has
 180  * allocated during rte_eal_init(). After this call, no DPDK function calls may
 181  * be made. It is expected that common usage of this function is to call it
 182  * just before terminating the process.
 183  *
 184  * @return 0 Successfully released all internal EAL resources
 185  * @return -EFAULT There was an error in releasing all resources.
 186  */
 187 int rte_eal_cleanup(void);
 188
 189 /**
 190  * Check if a primary process is currently alive
 191  *
 192  * This function returns true when a primary process is currently
 193  * active.
 194  *
 195  * @param config_file_path
 196  *   The config_file_path argument provided should point at the location
 197  *   that the primary process will create its config file. If NULL, the default
 198  *   config file path is used.
 199  *
 200  * @return
 201  *  - If alive, returns 1.
 202  *  - If dead, returns 0.
 203  */
 204 int rte_eal_primary_proc_alive(const char *config_file_path);
 205
 206 #define RTE_MP_MAX_FD_NUM       8    /* The max amount of fds */
 207 #define RTE_MP_MAX_NAME_LEN     64   /* The max length of action name */
 208 #define RTE_MP_MAX_PARAM_LEN    256  /* The max length of param */
 209 struct rte_mp_msg {
 210         char name[RTE_MP_MAX_NAME_LEN];
 211         int len_param;
 212         int num_fds;
 213         uint8_t param[RTE_MP_MAX_PARAM_LEN];
 214         int fds[RTE_MP_MAX_FD_NUM];
 215 };
 216
 217 struct rte_mp_reply {
 218         int nb_sent;
 219         int nb_received;
 220         struct rte_mp_msg *msgs; /* caller to free */
 221 };
 222
 223 /**
 224  * Action function typedef used by other components.
 225  *
 226  * As we create  socket channel for primary/secondary communication, use
 227  * this function typedef to register action for coming messages.
 228  *
 229  * @note When handling IPC request callbacks, the reply must be sent even in
 230  *   cases of error handling. Simply returning success or failure will *not*
 231  *   send a response to the requestor.
 232  *   Implementation of error signalling mechanism is up to the application.
 233  *
 234  * @note No memory allocations should take place inside the callback.
 235  */
 236 typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);
 237
 238 /**
 239  * Asynchronous reply function typedef used by other components.
 240  *
 241  * As we create socket channel for primary/secondary communication, use
 242  * this function typedef to register action for coming responses to asynchronous
 243  * requests.
 244  *
 245  * @note When handling IPC request callbacks, the reply must be sent even in
 246  *   cases of error handling. Simply returning success or failure will *not*
 247  *   send a response to the requestor.
 248  *   Implementation of error signalling mechanism is up to the application.
 249  *
 250  * @note No memory allocations should take place inside the callback.
 251  */
 252 typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
 253                 const struct rte_mp_reply *reply);
 254
 255 /**
 256  * @warning
 257  * @b EXPERIMENTAL: this API may change without prior notice
 258  *
 259  * Register an action function for primary/secondary communication.
 260  *
 261  * Call this function to register an action, if the calling component wants
 262  * to response the messages from the corresponding component in its primary
 263  * process or secondary processes.
 264  *
 265  * @note IPC may be unsupported in certain circumstances, so caller should check
 266  *    for ENOTSUP error.
 267  *
 268  * @param name
 269  *   The name argument plays as the nonredundant key to find the action.
 270  *
 271  * @param action
 272  *   The action argument is the function pointer to the action function.
 273  *
 274  * @return
 275  *  - 0 on success.
 276  *  - (<0) on failure.
 277  */
 278 __rte_experimental
 279 int
 280 rte_mp_action_register(const char *name, rte_mp_t action);
 281
 282 /**
 283  * @warning
 284  * @b EXPERIMENTAL: this API may change without prior notice
 285  *
 286  * Unregister an action function for primary/secondary communication.
 287  *
 288  * Call this function to unregister an action  if the calling component does
 289  * not want to response the messages from the corresponding component in its
 290  * primary process or secondary processes.
 291  *
 292  * @note IPC may be unsupported in certain circumstances, so caller should check
 293  *    for ENOTSUP error.
 294  *
 295  * @param name
 296  *   The name argument plays as the nonredundant key to find the action.
 297  *
 298  */
 299 __rte_experimental
 300 void
 301 rte_mp_action_unregister(const char *name);
 302
 303 /**
 304  * @warning
 305  * @b EXPERIMENTAL: this API may change without prior notice
 306  *
 307  * Send a message to the peer process.
 308  *
 309  * This function will send a message which will be responded by the action
 310  * identified by name in the peer process.
 311  *
 312  * @param msg
 313  *   The msg argument contains the customized message.
 314  *
 315  * @return
 316  *  - On success, return 0.
 317  *  - On failure, return -1, and the reason will be stored in rte_errno.
 318  */
 319 __rte_experimental
 320 int
 321 rte_mp_sendmsg(struct rte_mp_msg *msg);
 322
 323 /**
 324  * @warning
 325  * @b EXPERIMENTAL: this API may change without prior notice
 326  *
 327  * Send a request to the peer process and expect a reply.
 328  *
 329  * This function sends a request message to the peer process, and will
 330  * block until receiving reply message from the peer process.
 331  *
 332  * @note The caller is responsible to free reply->replies.
 333  *
 334  * @note This API must not be used inside memory-related or IPC callbacks, and
 335  *   no memory allocations should take place inside such callback.
 336  *
 337  * @note IPC may be unsupported in certain circumstances, so caller should check
 338  *    for ENOTSUP error.
 339  *
 340  * @param req
 341  *   The req argument contains the customized request message.
 342  *
 343  * @param reply
 344  *   The reply argument will be for storing all the replied messages;
 345  *   the caller is responsible for free reply->msgs.
 346  *
 347  * @param ts
 348  *   The ts argument specifies how long we can wait for the peer(s) to reply.
 349  *
 350  * @return
 351  *  - On success, return 0.
 352  *  - On failure, return -1, and the reason will be stored in rte_errno.
 353  */
 354 __rte_experimental
 355 int
 356 rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
 357                const struct timespec *ts);
 358
 359 /**
 360  * @warning
 361  * @b EXPERIMENTAL: this API may change without prior notice
 362  *
 363  * Send a request to the peer process and expect a reply in a separate callback.
 364  *
 365  * This function sends a request message to the peer process, and will not
 366  * block. Instead, reply will be received in a separate callback.
 367  *
 368  * @note IPC may be unsupported in certain circumstances, so caller should check
 369  *    for ENOTSUP error.
 370  *
 371  * @param req
 372  *   The req argument contains the customized request message.
 373  *
 374  * @param ts
 375  *   The ts argument specifies how long we can wait for the peer(s) to reply.
 376  *
 377  * @param clb
 378  *   The callback to trigger when all responses for this request have arrived.
 379  *
 380  * @return
 381  *  - On success, return 0.
 382  *  - On failure, return -1, and the reason will be stored in rte_errno.
 383  */
 384 __rte_experimental
 385 int
 386 rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
 387                 rte_mp_async_reply_t clb);
 388
 389 /**
 390  * @warning
 391  * @b EXPERIMENTAL: this API may change without prior notice
 392  *
 393  * Send a reply to the peer process.
 394  *
 395  * This function will send a reply message in response to a request message
 396  * received previously.
 397  *
 398  * @note When handling IPC request callbacks, the reply must be sent even in
 399  *   cases of error handling. Simply returning success or failure will *not*
 400  *   send a response to the requestor.
 401  *   Implementation of error signalling mechanism is up to the application.
 402  *
 403  * @param msg
 404  *   The msg argument contains the customized message.
 405  *
 406  * @param peer
 407  *   The peer argument is the pointer to the peer socket path.
 408  *
 409  * @return
 410  *  - On success, return 0.
 411  *  - On failure, return -1, and the reason will be stored in rte_errno.
 412  */
 413 __rte_experimental
 414 int
 415 rte_mp_reply(struct rte_mp_msg *msg, const char *peer);
 416
 417 /**
 418  * Usage function typedef used by the application usage function.
 419  *
 420  * Use this function typedef to define and call rte_set_application_usage_hook()
 421  * routine.
 422  */
 423 typedef void    (*rte_usage_hook_t)(const char * prgname);
 424
 425 /**
 426  * Add application usage routine callout from the eal_usage() routine.
 427  *
 428  * This function allows the application to include its usage message
 429  * in the EAL system usage message. The routine rte_set_application_usage_hook()
 430  * needs to be called before the rte_eal_init() routine in the application.
 431  *
 432  * This routine is optional for the application and will behave as if the set
 433  * routine was never called as the default behavior.
 434  *
 435  * @param usage_func
 436  *   The func argument is a function pointer to the application usage routine.
 437  *   Called function is defined using rte_usage_hook_t typedef, which is of
 438  *   the form void rte_usage_func(const char * prgname).
 439  *
 440  *   Calling this routine with a NULL value will reset the usage hook routine and
 441  *   return the current value, which could be NULL.
 442  * @return
 443  *   - Returns the current value of the rte_application_usage pointer to allow
 444  *     the caller to daisy chain the usage routines if needing more then one.
 445  */
 446 rte_usage_hook_t
 447 rte_set_application_usage_hook(rte_usage_hook_t usage_func);
 448
 449 /**
 450  * macro to get the lock of tailq in mem_config
 451  */
 452 #define RTE_EAL_TAILQ_RWLOCK         (&rte_eal_get_configuration()->mem_config->qlock)
 453
 454 /**
 455  * macro to get the multiple lock of mempool shared by multiple-instance
 456  */
 457 #define RTE_EAL_MEMPOOL_RWLOCK            (&rte_eal_get_configuration()->mem_config->mplock)
 458
 459 /**
 460  * Whether EAL is using huge pages (disabled by --no-huge option).
 461  * The no-huge mode cannot be used with UIO poll-mode drivers like igb/ixgbe.
 462  * It is useful for NIC drivers (e.g. librte_pmd_mlx4, librte_pmd_vmxnet3) or
 463  * crypto drivers (e.g. librte_crypto_nitrox) provided by third-parties such
 464  * as 6WIND.
 465  *
 466  * @return
 467  *   Nonzero if hugepages are enabled.
 468  */
 469 int rte_eal_has_hugepages(void);
 470
 471 /**
 472  * Whether EAL is using PCI bus.
 473  * Disabled by --no-pci option.
 474  *
 475  * @return
 476  *   Nonzero if the PCI bus is enabled.
 477  */
 478 int rte_eal_has_pci(void);
 479
 480 /**
 481  * Whether the EAL was asked to create UIO device.
 482  *
 483  * @return
 484  *   Nonzero if true.
 485  */
 486 int rte_eal_create_uio_dev(void);
 487
 488 /**
 489  * The user-configured vfio interrupt mode.
 490  *
 491  * @return
 492  *   Interrupt mode configured with the command line,
 493  *   RTE_INTR_MODE_NONE by default.
 494  */
 495 enum rte_intr_mode rte_eal_vfio_intr_mode(void);
 496
 497 /**
 498  * A wrap API for syscall gettid.
 499  *
 500  * @return
 501  *   On success, returns the thread ID of calling process.
 502  *   It is always successful.
 503  */
 504 int rte_sys_gettid(void);
 505
 506 /**
 507  * Get system unique thread id.
 508  *
 509  * @return
 510  *   On success, returns the thread ID of calling process.
 511  *   It is always successful.
 512  */
 513 static inline int rte_gettid(void)
 514 {
 515         static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
 516         if (RTE_PER_LCORE(_thread_id) == -1)
 517                 RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
 518         return RTE_PER_LCORE(_thread_id);
 519 }
 520
 521 /**
 522  * Get the iova mode
 523  *
 524  * @return
 525  *   enum rte_iova_mode value.
 526  */
 527 enum rte_iova_mode rte_eal_iova_mode(void);
 528
 529 /**
 530  * Get user provided pool ops name for mbuf
 531  *
 532  * @return
 533  *   returns user provided pool ops name.
 534  */
 535 const char *
 536 rte_eal_mbuf_user_pool_ops(void);
 537
 538 /**
 539  * Get the runtime directory of DPDK
 540  *
 541  * @return
 542  *  The runtime directory path of DPDK
 543  */
 544 const char *
 545 rte_eal_get_runtime_dir(void);
 546
 547 #ifdef __cplusplus
 548 }
 549 #endif
 550
 551 #endif /* _RTE_EAL_H_ */