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