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