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