rte_eal_interrupts.h

Go to the documentation of this file.

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

#ifndef _RTE_INTERRUPTS_H_
#error "don't include this file directly, please include generic <rte_interrupts.h>"
#endif

#ifndef _RTE_EAL_INTERRUPTS_H_
#define _RTE_EAL_INTERRUPTS_H_

#define RTE_MAX_RXTX_INTR_VEC_ID      512
#define RTE_INTR_VEC_ZERO_OFFSET      0
#define RTE_INTR_VEC_RXTX_OFFSET      1

enum rte_intr_handle_type {
    RTE_INTR_HANDLE_UNKNOWN = 0,  
    RTE_INTR_HANDLE_UIO,          
    RTE_INTR_HANDLE_UIO_INTX,     
    RTE_INTR_HANDLE_VFIO_LEGACY,  
    RTE_INTR_HANDLE_VFIO_MSI,     
    RTE_INTR_HANDLE_VFIO_MSIX,    
    RTE_INTR_HANDLE_ALARM,        
    RTE_INTR_HANDLE_EXT,          
    RTE_INTR_HANDLE_VDEV,         
    RTE_INTR_HANDLE_DEV_EVENT,    
    RTE_INTR_HANDLE_VFIO_REQ,     
    RTE_INTR_HANDLE_MAX           
};

#define RTE_INTR_EVENT_ADD            1UL
#define RTE_INTR_EVENT_DEL            2UL

typedef void (*rte_intr_event_cb_t)(int fd, void *arg);

struct rte_epoll_data {
    uint32_t event;               
    void *data;                   
    rte_intr_event_cb_t cb_fun;   
    void *cb_arg;                 
};

enum {
    RTE_EPOLL_INVALID = 0,
    RTE_EPOLL_VALID,
    RTE_EPOLL_EXEC,
};

struct rte_epoll_event {
    uint32_t status;           
    int fd;                    
    int epfd;       
    struct rte_epoll_data epdata;
};

struct rte_intr_handle {
    RTE_STD_C11
    union {
        struct {
            RTE_STD_C11
            union {
                int vfio_dev_fd;
                int uio_cfg_fd;
            };
            int fd; 
        };
        void *handle; 
    };
    enum rte_intr_handle_type type;  
    uint32_t max_intr;             
    uint32_t nb_efd;               
    uint8_t efd_counter_size;      
    int efds[RTE_MAX_RXTX_INTR_VEC_ID];  
    struct rte_epoll_event elist[RTE_MAX_RXTX_INTR_VEC_ID];
    int *intr_vec;                 
};

#define RTE_EPOLL_PER_THREAD        -1  
int
rte_epoll_wait(int epfd, struct rte_epoll_event *events,
           int maxevents, int timeout);

__rte_experimental
int
rte_epoll_wait_interruptible(int epfd, struct rte_epoll_event *events,
           int maxevents, int timeout);

int
rte_epoll_ctl(int epfd, int op, int fd,
          struct rte_epoll_event *event);

int
rte_intr_tls_epfd(void);

int
rte_intr_rx_ctl(struct rte_intr_handle *intr_handle,
        int epfd, int op, unsigned int vec, void *data);

void
rte_intr_free_epoll_fd(struct rte_intr_handle *intr_handle);

int
rte_intr_efd_enable(struct rte_intr_handle *intr_handle, uint32_t nb_efd);

void
rte_intr_efd_disable(struct rte_intr_handle *intr_handle);

int
rte_intr_dp_is_en(struct rte_intr_handle *intr_handle);

int
rte_intr_allow_others(struct rte_intr_handle *intr_handle);

int
rte_intr_cap_multiple(struct rte_intr_handle *intr_handle);

__rte_experimental
int
rte_thread_is_intr(void);

#endif /* _RTE_EAL_INTERRUPTS_H_ */