rte_eal_interrupts.h

Go to the documentation of this file.

/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in
 *       the documentation and/or other materials provided with the
 *       distribution.
 *     * Neither the name of Intel Corporation nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#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     32
#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_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 {
    volatile uint32_t status;  
    int fd;                    
    int epfd;       
    struct rte_epoll_data epdata;
};

struct rte_intr_handle {
    RTE_STD_C11
    union {
        int vfio_dev_fd;  
        int uio_cfg_fd;  
    };
    int fd;  
    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);

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);

#endif /* _RTE_EAL_INTERRUPTS_H_ */