rte_eal.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2018 Intel Corporation
 */

#ifndef _RTE_EAL_H_
#define _RTE_EAL_H_

#include <stdint.h>
#include <sched.h>
#include <time.h>

#include <rte_config.h>
#include <rte_compat.h>
#include <rte_per_lcore.h>
#include <rte_bus.h>

#include <rte_pci_dev_feature_defs.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_MAGIC 19820526 
/* Maximum thread_name length. */
#define RTE_MAX_THREAD_NAME_LEN 16

enum rte_lcore_role_t {
    ROLE_RTE,
    ROLE_OFF,
    ROLE_SERVICE,
};

enum rte_proc_type_t {
    RTE_PROC_AUTO = -1,   /* allow auto-detection of primary/secondary */
    RTE_PROC_PRIMARY = 0, /* set to zero, so primary is the default */
    RTE_PROC_SECONDARY,

    RTE_PROC_INVALID
};

struct rte_config {
    uint32_t master_lcore;       
    uint32_t lcore_count;        
    uint32_t numa_node_count;    
    uint32_t numa_nodes[RTE_MAX_NUMA_NODES]; 
    uint32_t service_lcore_count;
    enum rte_lcore_role_t lcore_role[RTE_MAX_LCORE]; 
    enum rte_proc_type_t process_type;

    enum rte_iova_mode iova_mode;

    struct rte_mem_config *mem_config;
} __attribute__((__packed__));

struct rte_config *rte_eal_get_configuration(void);

enum rte_lcore_role_t rte_eal_lcore_role(unsigned lcore_id);


enum rte_proc_type_t rte_eal_process_type(void);

int rte_eal_iopl_init(void);

int rte_eal_init(int argc, char **argv);

int rte_eal_cleanup(void);

int rte_eal_primary_proc_alive(const char *config_file_path);

#define RTE_MP_MAX_FD_NUM   8    /* The max amount of fds */
#define RTE_MP_MAX_NAME_LEN 64   /* The max length of action name */
#define RTE_MP_MAX_PARAM_LEN    256  /* The max length of param */
struct rte_mp_msg {
    char name[RTE_MP_MAX_NAME_LEN];
    int len_param;
    int num_fds;
    uint8_t param[RTE_MP_MAX_PARAM_LEN];
    int fds[RTE_MP_MAX_FD_NUM];
};

struct rte_mp_reply {
    int nb_sent;
    int nb_received;
    struct rte_mp_msg *msgs; /* caller to free */
};

typedef int (*rte_mp_t)(const struct rte_mp_msg *msg, const void *peer);

typedef int (*rte_mp_async_reply_t)(const struct rte_mp_msg *request,
        const struct rte_mp_reply *reply);

__rte_experimental
int
rte_mp_action_register(const char *name, rte_mp_t action);

__rte_experimental
void
rte_mp_action_unregister(const char *name);

__rte_experimental
int
rte_mp_sendmsg(struct rte_mp_msg *msg);

__rte_experimental
int
rte_mp_request_sync(struct rte_mp_msg *req, struct rte_mp_reply *reply,
           const struct timespec *ts);

__rte_experimental
int
rte_mp_request_async(struct rte_mp_msg *req, const struct timespec *ts,
        rte_mp_async_reply_t clb);

__rte_experimental
int
rte_mp_reply(struct rte_mp_msg *msg, const char *peer);

typedef void    (*rte_usage_hook_t)(const char * prgname);

rte_usage_hook_t
rte_set_application_usage_hook(rte_usage_hook_t usage_func);

int rte_eal_has_hugepages(void);

int rte_eal_has_pci(void);

int rte_eal_create_uio_dev(void);

enum rte_intr_mode rte_eal_vfio_intr_mode(void);

int rte_sys_gettid(void);

static inline int rte_gettid(void)
{
    static RTE_DEFINE_PER_LCORE(int, _thread_id) = -1;
    if (RTE_PER_LCORE(_thread_id) == -1)
        RTE_PER_LCORE(_thread_id) = rte_sys_gettid();
    return RTE_PER_LCORE(_thread_id);
}

enum rte_iova_mode rte_eal_iova_mode(void);

const char *
rte_eal_mbuf_user_pool_ops(void);

const char *
rte_eal_get_runtime_dir(void);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_EAL_H_ */