lib/librte_eal/include/rte_eal_interrupts.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_INTERRUPTS_H_
   6 #error "don't include this file directly, please include generic <rte_interrupts.h>"
   7 #endif
   8
   9 /**
  10  * @file rte_eal_interrupts.h
  11  * @internal
  12  *
  13  * Contains function prototypes exposed by the EAL for interrupt handling by
  14  * drivers and other DPDK internal consumers.
  15  */
  16
  17 #ifndef _RTE_EAL_INTERRUPTS_H_
  18 #define _RTE_EAL_INTERRUPTS_H_
  19
  20 #define RTE_MAX_RXTX_INTR_VEC_ID      512
  21 #define RTE_INTR_VEC_ZERO_OFFSET      0
  22 #define RTE_INTR_VEC_RXTX_OFFSET      1
  23
  24 /**
  25  * The interrupt source type, e.g. UIO, VFIO, ALARM etc.
  26  */
  27 enum rte_intr_handle_type {
  28         RTE_INTR_HANDLE_UNKNOWN = 0,  /**< generic unknown handle */
  29         RTE_INTR_HANDLE_UIO,          /**< uio device handle */
  30         RTE_INTR_HANDLE_UIO_INTX,     /**< uio generic handle */
  31         RTE_INTR_HANDLE_VFIO_LEGACY,  /**< vfio device handle (legacy) */
  32         RTE_INTR_HANDLE_VFIO_MSI,     /**< vfio device handle (MSI) */
  33         RTE_INTR_HANDLE_VFIO_MSIX,    /**< vfio device handle (MSIX) */
  34         RTE_INTR_HANDLE_ALARM,        /**< alarm handle */
  35         RTE_INTR_HANDLE_EXT,          /**< external handler */
  36         RTE_INTR_HANDLE_VDEV,         /**< virtual device */
  37         RTE_INTR_HANDLE_DEV_EVENT,    /**< device event handle */
  38         RTE_INTR_HANDLE_VFIO_REQ,     /**< VFIO request handle */
  39         RTE_INTR_HANDLE_MAX           /**< count of elements */
  40 };
  41
  42 #define RTE_INTR_EVENT_ADD            1UL
  43 #define RTE_INTR_EVENT_DEL            2UL
  44
  45 typedef void (*rte_intr_event_cb_t)(int fd, void *arg);
  46
  47 struct rte_epoll_data {
  48         uint32_t event;               /**< event type */
  49         void *data;                   /**< User data */
  50         rte_intr_event_cb_t cb_fun;   /**< IN: callback fun */
  51         void *cb_arg;                 /**< IN: callback arg */
  52 };
  53
  54 enum {
  55         RTE_EPOLL_INVALID = 0,
  56         RTE_EPOLL_VALID,
  57         RTE_EPOLL_EXEC,
  58 };
  59
  60 /** interrupt epoll event obj, taken by epoll_event.ptr */
  61 struct rte_epoll_event {
  62         uint32_t status;           /**< OUT: event status */
  63         int fd;                    /**< OUT: event fd */
  64         int epfd;       /**< OUT: epoll instance the ev associated with */
  65         struct rte_epoll_data epdata;
  66 };
  67
  68 /** Handle for interrupts. */
  69 struct rte_intr_handle {
  70         RTE_STD_C11
  71         union {
  72                 struct {
  73                         RTE_STD_C11
  74                         union {
  75                                 /** VFIO device file descriptor */
  76                                 int vfio_dev_fd;
  77                                 /** UIO cfg file desc for uio_pci_generic */
  78                                 int uio_cfg_fd;
  79                         };
  80                         int fd; /**< interrupt event file descriptor */
  81                 };
  82                 void *handle; /**< device driver handle (Windows) */
  83         };
  84         enum rte_intr_handle_type type;  /**< handle type */
  85         uint32_t max_intr;             /**< max interrupt requested */
  86         uint32_t nb_efd;               /**< number of available efd(event fd) */
  87         uint8_t efd_counter_size;      /**< size of efd counter, used for vdev */
  88         int efds[RTE_MAX_RXTX_INTR_VEC_ID];  /**< intr vectors/efds mapping */
  89         struct rte_epoll_event elist[RTE_MAX_RXTX_INTR_VEC_ID];
  90                                        /**< intr vector epoll event */
  91         int *intr_vec;                 /**< intr vector number array */
  92 };
  93
  94 #define RTE_EPOLL_PER_THREAD        -1  /**< to hint using per thread epfd */
  95
  96 /**
  97  * It waits for events on the epoll instance.
  98  *
  99  * @param epfd
 100  *   Epoll instance fd on which the caller wait for events.
 101  * @param events
 102  *   Memory area contains the events that will be available for the caller.
 103  * @param maxevents
 104  *   Up to maxevents are returned, must greater than zero.
 105  * @param timeout
 106  *   Specifying a timeout of -1 causes a block indefinitely.
 107  *   Specifying a timeout equal to zero cause to return immediately.
 108  * @return
 109  *   - On success, returns the number of available event.
 110  *   - On failure, a negative value.
 111  */
 112 int
 113 rte_epoll_wait(int epfd, struct rte_epoll_event *events,
 114                int maxevents, int timeout);
 115
 116 /**
 117  * It performs control operations on epoll instance referred by the epfd.
 118  * It requests that the operation op be performed for the target fd.
 119  *
 120  * @param epfd
 121  *   Epoll instance fd on which the caller perform control operations.
 122  * @param op
 123  *   The operation be performed for the target fd.
 124  * @param fd
 125  *   The target fd on which the control ops perform.
 126  * @param event
 127  *   Describes the object linked to the fd.
 128  *   Note: The caller must take care the object deletion after CTL_DEL.
 129  * @return
 130  *   - On success, zero.
 131  *   - On failure, a negative value.
 132  */
 133 int
 134 rte_epoll_ctl(int epfd, int op, int fd,
 135               struct rte_epoll_event *event);
 136
 137 /**
 138  * The function returns the per thread epoll instance.
 139  *
 140  * @return
 141  *   epfd the epoll instance referred to.
 142  */
 143 int
 144 rte_intr_tls_epfd(void);
 145
 146 /**
 147  * @param intr_handle
 148  *   Pointer to the interrupt handle.
 149  * @param epfd
 150  *   Epoll instance fd which the intr vector associated to.
 151  * @param op
 152  *   The operation be performed for the vector.
 153  *   Operation type of {ADD, DEL}.
 154  * @param vec
 155  *   RX intr vector number added to the epoll instance wait list.
 156  * @param data
 157  *   User raw data.
 158  * @return
 159  *   - On success, zero.
 160  *   - On failure, a negative value.
 161  */
 162 int
 163 rte_intr_rx_ctl(struct rte_intr_handle *intr_handle,
 164                 int epfd, int op, unsigned int vec, void *data);
 165
 166 /**
 167  * It deletes registered eventfds.
 168  *
 169  * @param intr_handle
 170  *   Pointer to the interrupt handle.
 171  */
 172 void
 173 rte_intr_free_epoll_fd(struct rte_intr_handle *intr_handle);
 174
 175 /**
 176  * It enables the packet I/O interrupt event if it's necessary.
 177  * It creates event fd for each interrupt vector when MSIX is used,
 178  * otherwise it multiplexes a single event fd.
 179  *
 180  * @param intr_handle
 181  *   Pointer to the interrupt handle.
 182  * @param nb_efd
 183  *   Number of interrupt vector trying to enable.
 184  *   The value 0 is not allowed.
 185  * @return
 186  *   - On success, zero.
 187  *   - On failure, a negative value.
 188  */
 189 int
 190 rte_intr_efd_enable(struct rte_intr_handle *intr_handle, uint32_t nb_efd);
 191
 192 /**
 193  * It disables the packet I/O interrupt event.
 194  * It deletes registered eventfds and closes the open fds.
 195  *
 196  * @param intr_handle
 197  *   Pointer to the interrupt handle.
 198  */
 199 void
 200 rte_intr_efd_disable(struct rte_intr_handle *intr_handle);
 201
 202 /**
 203  * The packet I/O interrupt on datapath is enabled or not.
 204  *
 205  * @param intr_handle
 206  *   Pointer to the interrupt handle.
 207  */
 208 int
 209 rte_intr_dp_is_en(struct rte_intr_handle *intr_handle);
 210
 211 /**
 212  * The interrupt handle instance allows other causes or not.
 213  * Other causes stand for any none packet I/O interrupts.
 214  *
 215  * @param intr_handle
 216  *   Pointer to the interrupt handle.
 217  */
 218 int
 219 rte_intr_allow_others(struct rte_intr_handle *intr_handle);
 220
 221 /**
 222  * The multiple interrupt vector capability of interrupt handle instance.
 223  * It returns zero if no multiple interrupt vector support.
 224  *
 225  * @param intr_handle
 226  *   Pointer to the interrupt handle.
 227  */
 228 int
 229 rte_intr_cap_multiple(struct rte_intr_handle *intr_handle);
 230
 231 /**
 232  * @warning
 233  * @b EXPERIMENTAL: this API may change without prior notice
 234  *
 235  * @internal
 236  * Check if currently executing in interrupt context
 237  *
 238  * @return
 239  *  - non zero in case of interrupt context
 240  *  - zero in case of process context
 241  */
 242 __rte_experimental
 243 int
 244 rte_thread_is_intr(void);
 245
 246 #endif /* _RTE_EAL_INTERRUPTS_H_ */