lib/librte_eal/common/include/rte_eal_interrupts.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_INTERRUPTS_H_
  35 #error "don't include this file directly, please include generic <rte_interrupts.h>"
  36 #endif
  37
  38 /**
  39  * @file rte_eal_interrupts.h
  40  * @internal
  41  *
  42  * Contains function prototypes exposed by the EAL for interrupt handling by
  43  * drivers and other DPDK internal consumers.
  44  */
  45
  46 #ifndef _RTE_EAL_INTERRUPTS_H_
  47 #define _RTE_EAL_INTERRUPTS_H_
  48
  49 #define RTE_MAX_RXTX_INTR_VEC_ID     32
  50 #define RTE_INTR_VEC_ZERO_OFFSET      0
  51 #define RTE_INTR_VEC_RXTX_OFFSET      1
  52
  53 /**
  54  * The interrupt source type, e.g. UIO, VFIO, ALARM etc.
  55  */
  56 enum rte_intr_handle_type {
  57         RTE_INTR_HANDLE_UNKNOWN = 0,  /**< generic unknown handle */
  58         RTE_INTR_HANDLE_UIO,          /**< uio device handle */
  59         RTE_INTR_HANDLE_UIO_INTX,     /**< uio generic handle */
  60         RTE_INTR_HANDLE_VFIO_LEGACY,  /**< vfio device handle (legacy) */
  61         RTE_INTR_HANDLE_VFIO_MSI,     /**< vfio device handle (MSI) */
  62         RTE_INTR_HANDLE_VFIO_MSIX,    /**< vfio device handle (MSIX) */
  63         RTE_INTR_HANDLE_ALARM,        /**< alarm handle */
  64         RTE_INTR_HANDLE_EXT,          /**< external handler */
  65         RTE_INTR_HANDLE_VDEV,         /**< virtual device */
  66         RTE_INTR_HANDLE_MAX           /**< count of elements */
  67 };
  68
  69 #define RTE_INTR_EVENT_ADD            1UL
  70 #define RTE_INTR_EVENT_DEL            2UL
  71
  72 typedef void (*rte_intr_event_cb_t)(int fd, void *arg);
  73
  74 struct rte_epoll_data {
  75         uint32_t event;               /**< event type */
  76         void *data;                   /**< User data */
  77         rte_intr_event_cb_t cb_fun;   /**< IN: callback fun */
  78         void *cb_arg;                 /**< IN: callback arg */
  79 };
  80
  81 enum {
  82         RTE_EPOLL_INVALID = 0,
  83         RTE_EPOLL_VALID,
  84         RTE_EPOLL_EXEC,
  85 };
  86
  87 /** interrupt epoll event obj, taken by epoll_event.ptr */
  88 struct rte_epoll_event {
  89         volatile uint32_t status;  /**< OUT: event status */
  90         int fd;                    /**< OUT: event fd */
  91         int epfd;       /**< OUT: epoll instance the ev associated with */
  92         struct rte_epoll_data epdata;
  93 };
  94
  95 /** Handle for interrupts. */
  96 struct rte_intr_handle {
  97         RTE_STD_C11
  98         union {
  99                 int vfio_dev_fd;  /**< VFIO device file descriptor */
 100                 int uio_cfg_fd;  /**< UIO cfg file desc for uio_pci_generic */
 101         };
 102         int fd;  /**< interrupt event file descriptor */
 103         enum rte_intr_handle_type type;  /**< handle type */
 104         uint32_t max_intr;             /**< max interrupt requested */
 105         uint32_t nb_efd;               /**< number of available efd(event fd) */
 106         int efds[RTE_MAX_RXTX_INTR_VEC_ID];  /**< intr vectors/efds mapping */
 107         struct rte_epoll_event elist[RTE_MAX_RXTX_INTR_VEC_ID];
 108                                        /**< intr vector epoll event */
 109         int *intr_vec;                 /**< intr vector number array */
 110 };
 111
 112 #define RTE_EPOLL_PER_THREAD        -1  /**< to hint using per thread epfd */
 113
 114 /**
 115  * It waits for events on the epoll instance.
 116  *
 117  * @param epfd
 118  *   Epoll instance fd on which the caller wait for events.
 119  * @param events
 120  *   Memory area contains the events that will be available for the caller.
 121  * @param maxevents
 122  *   Up to maxevents are returned, must greater than zero.
 123  * @param timeout
 124  *   Specifying a timeout of -1 causes a block indefinitely.
 125  *   Specifying a timeout equal to zero cause to return immediately.
 126  * @return
 127  *   - On success, returns the number of available event.
 128  *   - On failure, a negative value.
 129  */
 130 int
 131 rte_epoll_wait(int epfd, struct rte_epoll_event *events,
 132                int maxevents, int timeout);
 133
 134 /**
 135  * It performs control operations on epoll instance referred by the epfd.
 136  * It requests that the operation op be performed for the target fd.
 137  *
 138  * @param epfd
 139  *   Epoll instance fd on which the caller perform control operations.
 140  * @param op
 141  *   The operation be performed for the target fd.
 142  * @param fd
 143  *   The target fd on which the control ops perform.
 144  * @param event
 145  *   Describes the object linked to the fd.
 146  *   Note: The caller must take care the object deletion after CTL_DEL.
 147  * @return
 148  *   - On success, zero.
 149  *   - On failure, a negative value.
 150  */
 151 int
 152 rte_epoll_ctl(int epfd, int op, int fd,
 153               struct rte_epoll_event *event);
 154
 155 /**
 156  * The function returns the per thread epoll instance.
 157  *
 158  * @return
 159  *   epfd the epoll instance referred to.
 160  */
 161 int
 162 rte_intr_tls_epfd(void);
 163
 164 /**
 165  * @param intr_handle
 166  *   Pointer to the interrupt handle.
 167  * @param epfd
 168  *   Epoll instance fd which the intr vector associated to.
 169  * @param op
 170  *   The operation be performed for the vector.
 171  *   Operation type of {ADD, DEL}.
 172  * @param vec
 173  *   RX intr vector number added to the epoll instance wait list.
 174  * @param data
 175  *   User raw data.
 176  * @return
 177  *   - On success, zero.
 178  *   - On failure, a negative value.
 179  */
 180 int
 181 rte_intr_rx_ctl(struct rte_intr_handle *intr_handle,
 182                 int epfd, int op, unsigned int vec, void *data);
 183
 184 /**
 185  * It deletes registered eventfds.
 186  *
 187  * @param intr_handle
 188  *   Pointer to the interrupt handle.
 189  */
 190 void
 191 rte_intr_free_epoll_fd(struct rte_intr_handle *intr_handle);
 192
 193 /**
 194  * It enables the packet I/O interrupt event if it's necessary.
 195  * It creates event fd for each interrupt vector when MSIX is used,
 196  * otherwise it multiplexes a single event fd.
 197  *
 198  * @param intr_handle
 199  *   Pointer to the interrupt handle.
 200  * @param nb_efd
 201  *   Number of interrupt vector trying to enable.
 202  *   The value 0 is not allowed.
 203  * @return
 204  *   - On success, zero.
 205  *   - On failure, a negative value.
 206  */
 207 int
 208 rte_intr_efd_enable(struct rte_intr_handle *intr_handle, uint32_t nb_efd);
 209
 210 /**
 211  * It disables the packet I/O interrupt event.
 212  * It deletes registered eventfds and closes the open fds.
 213  *
 214  * @param intr_handle
 215  *   Pointer to the interrupt handle.
 216  */
 217 void
 218 rte_intr_efd_disable(struct rte_intr_handle *intr_handle);
 219
 220 /**
 221  * The packet I/O interrupt on datapath is enabled or not.
 222  *
 223  * @param intr_handle
 224  *   Pointer to the interrupt handle.
 225  */
 226 int
 227 rte_intr_dp_is_en(struct rte_intr_handle *intr_handle);
 228
 229 /**
 230  * The interrupt handle instance allows other causes or not.
 231  * Other causes stand for any none packet I/O interrupts.
 232  *
 233  * @param intr_handle
 234  *   Pointer to the interrupt handle.
 235  */
 236 int
 237 rte_intr_allow_others(struct rte_intr_handle *intr_handle);
 238
 239 /**
 240  * The multiple interrupt vector capability of interrupt handle instance.
 241  * It returns zero if no multiple interrupt vector support.
 242  *
 243  * @param intr_handle
 244  *   Pointer to the interrupt handle.
 245  */
 246 int
 247 rte_intr_cap_multiple(struct rte_intr_handle *intr_handle);
 248
 249 #endif /* _RTE_EAL_INTERRUPTS_H_ */