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