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