rte_dev.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2014 6WIND S.A.
 */

#ifndef _RTE_DEV_H_
#define _RTE_DEV_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include <sys/queue.h>

#include <rte_config.h>
#include <rte_compat.h>
#include <rte_log.h>

enum rte_dev_event_type {
    RTE_DEV_EVENT_ADD,  
    RTE_DEV_EVENT_REMOVE,   
    RTE_DEV_EVENT_MAX   
};

struct rte_dev_event {
    enum rte_dev_event_type type;   
    int subsystem;          
    char *devname;          
};

typedef void (*rte_dev_event_cb_fn)(char *device_name,
                    enum rte_dev_event_type event,
                    void *cb_arg);

__attribute__((format(printf, 2, 0)))
static inline void
rte_pmd_debug_trace(const char *func_name, const char *fmt, ...)
{
    va_list ap;

    va_start(ap, fmt);

    {
        char buffer[vsnprintf(NULL, 0, fmt, ap) + 1];

        va_end(ap);

        va_start(ap, fmt);
        vsnprintf(buffer, sizeof(buffer), fmt, ap);
        va_end(ap);

        rte_log(RTE_LOG_ERR, RTE_LOGTYPE_PMD, "%s: %s",
            func_name, buffer);
    }
}

/*
 * Enable RTE_PMD_DEBUG_TRACE() when at least one component relying on the
 * RTE_*_RET() macros defined below is compiled in debug mode.
 */
#if defined(RTE_LIBRTE_EVENTDEV_DEBUG)
#define RTE_PMD_DEBUG_TRACE(...) \
    rte_pmd_debug_trace(__func__, __VA_ARGS__)
#else
#define RTE_PMD_DEBUG_TRACE(...) (void)0
#endif

/* Macros for checking for restricting functions to primary instance only */
#define RTE_PROC_PRIMARY_OR_ERR_RET(retval) do { \
    if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
        RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
        return retval; \
    } \
} while (0)

#define RTE_PROC_PRIMARY_OR_RET() do { \
    if (rte_eal_process_type() != RTE_PROC_PRIMARY) { \
        RTE_PMD_DEBUG_TRACE("Cannot run in secondary processes\n"); \
        return; \
    } \
} while (0)

/* Macros to check for invalid function pointers */
#define RTE_FUNC_PTR_OR_ERR_RET(func, retval) do { \
    if ((func) == NULL) { \
        RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
        return retval; \
    } \
} while (0)

#define RTE_FUNC_PTR_OR_RET(func) do { \
    if ((func) == NULL) { \
        RTE_PMD_DEBUG_TRACE("Function not supported\n"); \
        return; \
    } \
} while (0)

enum rte_kernel_driver {
    RTE_KDRV_UNKNOWN = 0,
    RTE_KDRV_IGB_UIO,
    RTE_KDRV_VFIO,
    RTE_KDRV_UIO_GENERIC,
    RTE_KDRV_NIC_UIO,
    RTE_KDRV_NONE,
};

enum rte_dev_policy {
    RTE_DEV_WHITELISTED,
    RTE_DEV_BLACKLISTED,
};

struct rte_mem_resource {
    uint64_t phys_addr; 
    uint64_t len;       
    void *addr;         
};

struct rte_driver {
    TAILQ_ENTRY(rte_driver) next;  
    const char *name;                   
    const char *alias;              
};

/*
 * Internal identifier length
 * Sufficiently large to allow for UUID or PCI address
 */
#define RTE_DEV_NAME_MAX_LEN 64

struct rte_device {
    TAILQ_ENTRY(rte_device) next; 
    const char *name;             
    const struct rte_driver *driver;
    int numa_node;                
    struct rte_devargs *devargs;  
};

__rte_deprecated
int rte_eal_dev_attach(const char *name, const char *devargs);

__rte_deprecated
int rte_eal_dev_detach(struct rte_device *dev);

int __rte_experimental rte_eal_hotplug_add(const char *busname, const char *devname,
            const char *devargs);

int __rte_experimental rte_eal_hotplug_remove(const char *busname,
                      const char *devname);

typedef int (*rte_dev_cmp_t)(const struct rte_device *dev, const void *data);

#define RTE_PMD_EXPORT_NAME_ARRAY(n, idx) n##idx[]

#define RTE_PMD_EXPORT_NAME(name, idx) \
static const char RTE_PMD_EXPORT_NAME_ARRAY(this_pmd_name, idx) \
__attribute__((used)) = RTE_STR(name)

#define DRV_EXP_TAG(name, tag) __##name##_##tag

#define RTE_PMD_REGISTER_PCI_TABLE(name, table) \
static const char DRV_EXP_TAG(name, pci_tbl_export)[] __attribute__((used)) = \
RTE_STR(table)

#define RTE_PMD_REGISTER_PARAM_STRING(name, str) \
static const char DRV_EXP_TAG(name, param_string_export)[] \
__attribute__((used)) = str

#define RTE_PMD_REGISTER_KMOD_DEP(name, str) \
static const char DRV_EXP_TAG(name, kmod_dep_export)[] \
__attribute__((used)) = str

struct rte_dev_iterator {
    const char *dev_str; 
    const char *bus_str; 
    const char *cls_str; 
    struct rte_bus *bus; 
    struct rte_class *cls; 
    struct rte_device *device; 
    void *class_device; 
};

typedef void *(*rte_dev_iterate_t)(const void *start,
                   const char *devstr,
                   const struct rte_dev_iterator *it);

__rte_experimental
int
rte_dev_iterator_init(struct rte_dev_iterator *it, const char *str);

__rte_experimental
struct rte_device *
rte_dev_iterator_next(struct rte_dev_iterator *it);

#define RTE_DEV_FOREACH(dev, devstr, it) \
    for (rte_dev_iterator_init(it, devstr), \
         dev = rte_dev_iterator_next(it); \
         dev != NULL; \
         dev = rte_dev_iterator_next(it))

#ifdef __cplusplus
}
#endif

int __rte_experimental
rte_dev_event_callback_register(const char *device_name,
                rte_dev_event_cb_fn cb_fn,
                void *cb_arg);

int __rte_experimental
rte_dev_event_callback_unregister(const char *device_name,
                  rte_dev_event_cb_fn cb_fn,
                  void *cb_arg);

int __rte_experimental
rte_dev_event_monitor_start(void);

int __rte_experimental
rte_dev_event_monitor_stop(void);

#endif /* _RTE_DEV_H_ */