lib/librte_eal/linuxapp/eal/eal_interrupts.c

   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 #include <stdio.h>
  35 #include <stdint.h>
  36 #include <stdlib.h>
  37 #include <pthread.h>
  38 #include <sys/queue.h>
  39 #include <stdarg.h>
  40 #include <unistd.h>
  41 #include <string.h>
  42 #include <errno.h>
  43 #include <inttypes.h>
  44 #include <sys/epoll.h>
  45 #include <sys/signalfd.h>
  46 #include <sys/ioctl.h>
  47 #include <sys/eventfd.h>
  48 #include <assert.h>
  49 #include <stdbool.h>
  50
  51 #include <rte_common.h>
  52 #include <rte_interrupts.h>
  53 #include <rte_memory.h>
  54 #include <rte_memzone.h>
  55 #include <rte_launch.h>
  56 #include <rte_eal.h>
  57 #include <rte_per_lcore.h>
  58 #include <rte_lcore.h>
  59 #include <rte_atomic.h>
  60 #include <rte_branch_prediction.h>
  61 #include <rte_debug.h>
  62 #include <rte_log.h>
  63 #include <rte_pci.h>
  64 #include <rte_malloc.h>
  65 #include <rte_errno.h>
  66 #include <rte_spinlock.h>
  67
  68 #include "eal_private.h"
  69 #include "eal_vfio.h"
  70 #include "eal_thread.h"
  71
  72 #define EAL_INTR_EPOLL_WAIT_FOREVER (-1)
  73 #define NB_OTHER_INTR               1
  74
  75 static RTE_DEFINE_PER_LCORE(int, _epfd) = -1; /**< epoll fd per thread */
  76
  77 /**
  78  * union for pipe fds.
  79  */
  80 union intr_pipefds{
  81         struct {
  82                 int pipefd[2];
  83         };
  84         struct {
  85                 int readfd;
  86                 int writefd;
  87         };
  88 };
  89
  90 /**
  91  * union buffer for reading on different devices
  92  */
  93 union rte_intr_read_buffer {
  94         int uio_intr_count;              /* for uio device */
  95 #ifdef VFIO_PRESENT
  96         uint64_t vfio_intr_count;        /* for vfio device */
  97 #endif
  98         uint64_t timerfd_num;            /* for timerfd */
  99         char charbuf[16];                /* for others */
 100 };
 101
 102 TAILQ_HEAD(rte_intr_cb_list, rte_intr_callback);
 103 TAILQ_HEAD(rte_intr_source_list, rte_intr_source);
 104
 105 struct rte_intr_callback {
 106         TAILQ_ENTRY(rte_intr_callback) next;
 107         rte_intr_callback_fn cb_fn;  /**< callback address */
 108         void *cb_arg;                /**< parameter for callback */
 109 };
 110
 111 struct rte_intr_source {
 112         TAILQ_ENTRY(rte_intr_source) next;
 113         struct rte_intr_handle intr_handle; /**< interrupt handle */
 114         struct rte_intr_cb_list callbacks;  /**< user callbacks */
 115         uint32_t active;
 116 };
 117
 118 /* global spinlock for interrupt data operation */
 119 static rte_spinlock_t intr_lock = RTE_SPINLOCK_INITIALIZER;
 120
 121 /* union buffer for pipe read/write */
 122 static union intr_pipefds intr_pipe;
 123
 124 /* interrupt sources list */
 125 static struct rte_intr_source_list intr_sources;
 126
 127 /* interrupt handling thread */
 128 static pthread_t intr_thread;
 129
 130 /* VFIO interrupts */
 131 #ifdef VFIO_PRESENT
 132
 133 #define IRQ_SET_BUF_LEN  (sizeof(struct vfio_irq_set) + sizeof(int))
 134 /* irq set buffer length for queue interrupts and LSC interrupt */
 135 #define MSIX_IRQ_SET_BUF_LEN (sizeof(struct vfio_irq_set) + \
 136                               sizeof(int) * (RTE_MAX_RXTX_INTR_VEC_ID + 1))
 137
 138 /* enable legacy (INTx) interrupts */
 139 static int
 140 vfio_enable_intx(const struct rte_intr_handle *intr_handle) {
 141         struct vfio_irq_set *irq_set;
 142         char irq_set_buf[IRQ_SET_BUF_LEN];
 143         int len, ret;
 144         int *fd_ptr;
 145
 146         len = sizeof(irq_set_buf);
 147
 148         /* enable INTx */
 149         irq_set = (struct vfio_irq_set *) irq_set_buf;
 150         irq_set->argsz = len;
 151         irq_set->count = 1;
 152         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
 153         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
 154         irq_set->start = 0;
 155         fd_ptr = (int *) &irq_set->data;
 156         *fd_ptr = intr_handle->fd;
 157
 158         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 159
 160         if (ret) {
 161                 RTE_LOG(ERR, EAL, "Error enabling INTx interrupts for fd %d\n",
 162                                                 intr_handle->fd);
 163                 return -1;
 164         }
 165
 166         /* unmask INTx after enabling */
 167         memset(irq_set, 0, len);
 168         len = sizeof(struct vfio_irq_set);
 169         irq_set->argsz = len;
 170         irq_set->count = 1;
 171         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_UNMASK;
 172         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
 173         irq_set->start = 0;
 174
 175         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 176
 177         if (ret) {
 178                 RTE_LOG(ERR, EAL, "Error unmasking INTx interrupts for fd %d\n",
 179                                                 intr_handle->fd);
 180                 return -1;
 181         }
 182         return 0;
 183 }
 184
 185 /* disable legacy (INTx) interrupts */
 186 static int
 187 vfio_disable_intx(const struct rte_intr_handle *intr_handle) {
 188         struct vfio_irq_set *irq_set;
 189         char irq_set_buf[IRQ_SET_BUF_LEN];
 190         int len, ret;
 191
 192         len = sizeof(struct vfio_irq_set);
 193
 194         /* mask interrupts before disabling */
 195         irq_set = (struct vfio_irq_set *) irq_set_buf;
 196         irq_set->argsz = len;
 197         irq_set->count = 1;
 198         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_MASK;
 199         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
 200         irq_set->start = 0;
 201
 202         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 203
 204         if (ret) {
 205                 RTE_LOG(ERR, EAL, "Error masking INTx interrupts for fd %d\n",
 206                                                 intr_handle->fd);
 207                 return -1;
 208         }
 209
 210         /* disable INTx*/
 211         memset(irq_set, 0, len);
 212         irq_set->argsz = len;
 213         irq_set->count = 0;
 214         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_TRIGGER;
 215         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
 216         irq_set->start = 0;
 217
 218         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 219
 220         if (ret) {
 221                 RTE_LOG(ERR, EAL,
 222                         "Error disabling INTx interrupts for fd %d\n", intr_handle->fd);
 223                 return -1;
 224         }
 225         return 0;
 226 }
 227
 228 /* enable MSI interrupts */
 229 static int
 230 vfio_enable_msi(const struct rte_intr_handle *intr_handle) {
 231         int len, ret;
 232         char irq_set_buf[IRQ_SET_BUF_LEN];
 233         struct vfio_irq_set *irq_set;
 234         int *fd_ptr;
 235
 236         len = sizeof(irq_set_buf);
 237
 238         irq_set = (struct vfio_irq_set *) irq_set_buf;
 239         irq_set->argsz = len;
 240         irq_set->count = 1;
 241         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
 242         irq_set->index = VFIO_PCI_MSI_IRQ_INDEX;
 243         irq_set->start = 0;
 244         fd_ptr = (int *) &irq_set->data;
 245         *fd_ptr = intr_handle->fd;
 246
 247         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 248
 249         if (ret) {
 250                 RTE_LOG(ERR, EAL, "Error enabling MSI interrupts for fd %d\n",
 251                                                 intr_handle->fd);
 252                 return -1;
 253         }
 254         return 0;
 255 }
 256
 257 /* disable MSI interrupts */
 258 static int
 259 vfio_disable_msi(const struct rte_intr_handle *intr_handle) {
 260         struct vfio_irq_set *irq_set;
 261         char irq_set_buf[IRQ_SET_BUF_LEN];
 262         int len, ret;
 263
 264         len = sizeof(struct vfio_irq_set);
 265
 266         irq_set = (struct vfio_irq_set *) irq_set_buf;
 267         irq_set->argsz = len;
 268         irq_set->count = 0;
 269         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_TRIGGER;
 270         irq_set->index = VFIO_PCI_MSI_IRQ_INDEX;
 271         irq_set->start = 0;
 272
 273         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 274
 275         if (ret)
 276                 RTE_LOG(ERR, EAL,
 277                         "Error disabling MSI interrupts for fd %d\n", intr_handle->fd);
 278
 279         return ret;
 280 }
 281
 282 /* enable MSI-X interrupts */
 283 static int
 284 vfio_enable_msix(const struct rte_intr_handle *intr_handle) {
 285         int len, ret;
 286         char irq_set_buf[MSIX_IRQ_SET_BUF_LEN];
 287         struct vfio_irq_set *irq_set;
 288         int *fd_ptr;
 289
 290         len = sizeof(irq_set_buf);
 291
 292         irq_set = (struct vfio_irq_set *) irq_set_buf;
 293         irq_set->argsz = len;
 294         /* 0 < irq_set->count < RTE_MAX_RXTX_INTR_VEC_ID + 1 */
 295         irq_set->count = intr_handle->max_intr ?
 296                 (intr_handle->max_intr > RTE_MAX_RXTX_INTR_VEC_ID + 1 ?
 297                 RTE_MAX_RXTX_INTR_VEC_ID + 1 : intr_handle->max_intr) : 1;
 298         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
 299         irq_set->index = VFIO_PCI_MSIX_IRQ_INDEX;
 300         irq_set->start = 0;
 301         fd_ptr = (int *) &irq_set->data;
 302         /* INTR vector offset 0 reserve for non-efds mapping */
 303         fd_ptr[RTE_INTR_VEC_ZERO_OFFSET] = intr_handle->fd;
 304         memcpy(&fd_ptr[RTE_INTR_VEC_RXTX_OFFSET], intr_handle->efds,
 305                 sizeof(*intr_handle->efds) * intr_handle->nb_efd);
 306
 307         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 308
 309         if (ret) {
 310                 RTE_LOG(ERR, EAL, "Error enabling MSI-X interrupts for fd %d\n",
 311                                                 intr_handle->fd);
 312                 return -1;
 313         }
 314
 315         return 0;
 316 }
 317
 318 /* disable MSI-X interrupts */
 319 static int
 320 vfio_disable_msix(const struct rte_intr_handle *intr_handle) {
 321         struct vfio_irq_set *irq_set;
 322         char irq_set_buf[MSIX_IRQ_SET_BUF_LEN];
 323         int len, ret;
 324
 325         len = sizeof(struct vfio_irq_set);
 326
 327         irq_set = (struct vfio_irq_set *) irq_set_buf;
 328         irq_set->argsz = len;
 329         irq_set->count = 0;
 330         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_TRIGGER;
 331         irq_set->index = VFIO_PCI_MSIX_IRQ_INDEX;
 332         irq_set->start = 0;
 333
 334         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
 335
 336         if (ret)
 337                 RTE_LOG(ERR, EAL,
 338                         "Error disabling MSI-X interrupts for fd %d\n", intr_handle->fd);
 339
 340         return ret;
 341 }
 342 #endif
 343
 344 static int
 345 uio_intx_intr_disable(const struct rte_intr_handle *intr_handle)
 346 {
 347         unsigned char command_high;
 348
 349         /* use UIO config file descriptor for uio_pci_generic */
 350         if (pread(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
 351                 RTE_LOG(ERR, EAL,
 352                         "Error reading interrupts status for fd %d\n",
 353                         intr_handle->uio_cfg_fd);
 354                 return -1;
 355         }
 356         /* disable interrupts */
 357         command_high |= 0x4;
 358         if (pwrite(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
 359                 RTE_LOG(ERR, EAL,
 360                         "Error disabling interrupts for fd %d\n",
 361                         intr_handle->uio_cfg_fd);
 362                 return -1;
 363         }
 364
 365         return 0;
 366 }
 367
 368 static int
 369 uio_intx_intr_enable(const struct rte_intr_handle *intr_handle)
 370 {
 371         unsigned char command_high;
 372
 373         /* use UIO config file descriptor for uio_pci_generic */
 374         if (pread(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
 375                 RTE_LOG(ERR, EAL,
 376                         "Error reading interrupts status for fd %d\n",
 377                         intr_handle->uio_cfg_fd);
 378                 return -1;
 379         }
 380         /* enable interrupts */
 381         command_high &= ~0x4;
 382         if (pwrite(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
 383                 RTE_LOG(ERR, EAL,
 384                         "Error enabling interrupts for fd %d\n",
 385                         intr_handle->uio_cfg_fd);
 386                 return -1;
 387         }
 388
 389         return 0;
 390 }
 391
 392 static int
 393 uio_intr_disable(const struct rte_intr_handle *intr_handle)
 394 {
 395         const int value = 0;
 396
 397         if (write(intr_handle->fd, &value, sizeof(value)) < 0) {
 398                 RTE_LOG(ERR, EAL,
 399                         "Error disabling interrupts for fd %d (%s)\n",
 400                         intr_handle->fd, strerror(errno));
 401                 return -1;
 402         }
 403         return 0;
 404 }
 405
 406 static int
 407 uio_intr_enable(const struct rte_intr_handle *intr_handle)
 408 {
 409         const int value = 1;
 410
 411         if (write(intr_handle->fd, &value, sizeof(value)) < 0) {
 412                 RTE_LOG(ERR, EAL,
 413                         "Error enabling interrupts for fd %d (%s)\n",
 414                         intr_handle->fd, strerror(errno));
 415                 return -1;
 416         }
 417         return 0;
 418 }
 419
 420 int
 421 rte_intr_callback_register(const struct rte_intr_handle *intr_handle,
 422                         rte_intr_callback_fn cb, void *cb_arg)
 423 {
 424         int ret, wake_thread;
 425         struct rte_intr_source *src;
 426         struct rte_intr_callback *callback;
 427
 428         wake_thread = 0;
 429
 430         /* first do parameter checking */
 431         if (intr_handle == NULL || intr_handle->fd < 0 || cb == NULL) {
 432                 RTE_LOG(ERR, EAL,
 433                         "Registering with invalid input parameter\n");
 434                 return -EINVAL;
 435         }
 436
 437         /* allocate a new interrupt callback entity */
 438         callback = rte_zmalloc("interrupt callback list",
 439                                 sizeof(*callback), 0);
 440         if (callback == NULL) {
 441                 RTE_LOG(ERR, EAL, "Can not allocate memory\n");
 442                 return -ENOMEM;
 443         }
 444         callback->cb_fn = cb;
 445         callback->cb_arg = cb_arg;
 446
 447         rte_spinlock_lock(&intr_lock);
 448
 449         /* check if there is at least one callback registered for the fd */
 450         TAILQ_FOREACH(src, &intr_sources, next) {
 451                 if (src->intr_handle.fd == intr_handle->fd) {
 452                         /* we had no interrupts for this */
 453                         if TAILQ_EMPTY(&src->callbacks)
 454                                 wake_thread = 1;
 455
 456                         TAILQ_INSERT_TAIL(&(src->callbacks), callback, next);
 457                         ret = 0;
 458                         break;
 459                 }
 460         }
 461
 462         /* no existing callbacks for this - add new source */
 463         if (src == NULL) {
 464                 if ((src = rte_zmalloc("interrupt source list",
 465                                 sizeof(*src), 0)) == NULL) {
 466                         RTE_LOG(ERR, EAL, "Can not allocate memory\n");
 467                         rte_free(callback);
 468                         ret = -ENOMEM;
 469                 } else {
 470                         src->intr_handle = *intr_handle;
 471                         TAILQ_INIT(&src->callbacks);
 472                         TAILQ_INSERT_TAIL(&(src->callbacks), callback, next);
 473                         TAILQ_INSERT_TAIL(&intr_sources, src, next);
 474                         wake_thread = 1;
 475                         ret = 0;
 476                 }
 477         }
 478
 479         rte_spinlock_unlock(&intr_lock);
 480
 481         /**
 482          * check if need to notify the pipe fd waited by epoll_wait to
 483          * rebuild the wait list.
 484          */
 485         if (wake_thread)
 486                 if (write(intr_pipe.writefd, "1", 1) < 0)
 487                         return -EPIPE;
 488
 489         return ret;
 490 }
 491
 492 int
 493 rte_intr_callback_unregister(const struct rte_intr_handle *intr_handle,
 494                         rte_intr_callback_fn cb_fn, void *cb_arg)
 495 {
 496         int ret;
 497         struct rte_intr_source *src;
 498         struct rte_intr_callback *cb, *next;
 499
 500         /* do parameter checking first */
 501         if (intr_handle == NULL || intr_handle->fd < 0) {
 502                 RTE_LOG(ERR, EAL,
 503                 "Unregistering with invalid input parameter\n");
 504                 return -EINVAL;
 505         }
 506
 507         rte_spinlock_lock(&intr_lock);
 508
 509         /* check if the insterrupt source for the fd is existent */
 510         TAILQ_FOREACH(src, &intr_sources, next)
 511                 if (src->intr_handle.fd == intr_handle->fd)
 512                         break;
 513
 514         /* No interrupt source registered for the fd */
 515         if (src == NULL) {
 516                 ret = -ENOENT;
 517
 518         /* interrupt source has some active callbacks right now. */
 519         } else if (src->active != 0) {
 520                 ret = -EAGAIN;
 521
 522         /* ok to remove. */
 523         } else {
 524                 ret = 0;
 525
 526                 /*walk through the callbacks and remove all that match. */
 527                 for (cb = TAILQ_FIRST(&src->callbacks); cb != NULL; cb = next) {
 528
 529                         next = TAILQ_NEXT(cb, next);
 530
 531                         if (cb->cb_fn == cb_fn && (cb_arg == (void *)-1 ||
 532                                         cb->cb_arg == cb_arg)) {
 533                                 TAILQ_REMOVE(&src->callbacks, cb, next);
 534                                 rte_free(cb);
 535                                 ret++;
 536                         }
 537                 }
 538
 539                 /* all callbacks for that source are removed. */
 540                 if (TAILQ_EMPTY(&src->callbacks)) {
 541                         TAILQ_REMOVE(&intr_sources, src, next);
 542                         rte_free(src);
 543                 }
 544         }
 545
 546         rte_spinlock_unlock(&intr_lock);
 547
 548         /* notify the pipe fd waited by epoll_wait to rebuild the wait list */
 549         if (ret >= 0 && write(intr_pipe.writefd, "1", 1) < 0) {
 550                 ret = -EPIPE;
 551         }
 552
 553         return ret;
 554 }
 555
 556 int
 557 rte_intr_enable(const struct rte_intr_handle *intr_handle)
 558 {
 559         if (intr_handle && intr_handle->type == RTE_INTR_HANDLE_VDEV)
 560                 return 0;
 561
 562         if (!intr_handle || intr_handle->fd < 0 || intr_handle->uio_cfg_fd < 0)
 563                 return -1;
 564
 565         switch (intr_handle->type){
 566         /* write to the uio fd to enable the interrupt */
 567         case RTE_INTR_HANDLE_UIO:
 568                 if (uio_intr_enable(intr_handle))
 569                         return -1;
 570                 break;
 571         case RTE_INTR_HANDLE_UIO_INTX:
 572                 if (uio_intx_intr_enable(intr_handle))
 573                         return -1;
 574                 break;
 575         /* not used at this moment */
 576         case RTE_INTR_HANDLE_ALARM:
 577                 return -1;
 578 #ifdef VFIO_PRESENT
 579         case RTE_INTR_HANDLE_VFIO_MSIX:
 580                 if (vfio_enable_msix(intr_handle))
 581                         return -1;
 582                 break;
 583         case RTE_INTR_HANDLE_VFIO_MSI:
 584                 if (vfio_enable_msi(intr_handle))
 585                         return -1;
 586                 break;
 587         case RTE_INTR_HANDLE_VFIO_LEGACY:
 588                 if (vfio_enable_intx(intr_handle))
 589                         return -1;
 590                 break;
 591 #endif
 592         /* unknown handle type */
 593         default:
 594                 RTE_LOG(ERR, EAL,
 595                         "Unknown handle type of fd %d\n",
 596                                         intr_handle->fd);
 597                 return -1;
 598         }
 599
 600         return 0;
 601 }
 602
 603 int
 604 rte_intr_disable(const struct rte_intr_handle *intr_handle)
 605 {
 606         if (intr_handle && intr_handle->type == RTE_INTR_HANDLE_VDEV)
 607                 return 0;
 608
 609         if (!intr_handle || intr_handle->fd < 0 || intr_handle->uio_cfg_fd < 0)
 610                 return -1;
 611
 612         switch (intr_handle->type){
 613         /* write to the uio fd to disable the interrupt */
 614         case RTE_INTR_HANDLE_UIO:
 615                 if (uio_intr_disable(intr_handle))
 616                         return -1;
 617                 break;
 618         case RTE_INTR_HANDLE_UIO_INTX:
 619                 if (uio_intx_intr_disable(intr_handle))
 620                         return -1;
 621                 break;
 622         /* not used at this moment */
 623         case RTE_INTR_HANDLE_ALARM:
 624                 return -1;
 625 #ifdef VFIO_PRESENT
 626         case RTE_INTR_HANDLE_VFIO_MSIX:
 627                 if (vfio_disable_msix(intr_handle))
 628                         return -1;
 629                 break;
 630         case RTE_INTR_HANDLE_VFIO_MSI:
 631                 if (vfio_disable_msi(intr_handle))
 632                         return -1;
 633                 break;
 634         case RTE_INTR_HANDLE_VFIO_LEGACY:
 635                 if (vfio_disable_intx(intr_handle))
 636                         return -1;
 637                 break;
 638 #endif
 639         /* unknown handle type */
 640         default:
 641                 RTE_LOG(ERR, EAL,
 642                         "Unknown handle type of fd %d\n",
 643                                         intr_handle->fd);
 644                 return -1;
 645         }
 646
 647         return 0;
 648 }
 649
 650 static int
 651 eal_intr_process_interrupts(struct epoll_event *events, int nfds)
 652 {
 653         bool call = false;
 654         int n, bytes_read;
 655         struct rte_intr_source *src;
 656         struct rte_intr_callback *cb;
 657         union rte_intr_read_buffer buf;
 658         struct rte_intr_callback active_cb;
 659
 660         for (n = 0; n < nfds; n++) {
 661
 662                 /**
 663                  * if the pipe fd is ready to read, return out to
 664                  * rebuild the wait list.
 665                  */
 666                 if (events[n].data.fd == intr_pipe.readfd){
 667                         int r = read(intr_pipe.readfd, buf.charbuf,
 668                                         sizeof(buf.charbuf));
 669                         RTE_SET_USED(r);
 670                         return -1;
 671                 }
 672                 rte_spinlock_lock(&intr_lock);
 673                 TAILQ_FOREACH(src, &intr_sources, next)
 674                         if (src->intr_handle.fd ==
 675                                         events[n].data.fd)
 676                                 break;
 677                 if (src == NULL){
 678                         rte_spinlock_unlock(&intr_lock);
 679                         continue;
 680                 }
 681
 682                 /* mark this interrupt source as active and release the lock. */
 683                 src->active = 1;
 684                 rte_spinlock_unlock(&intr_lock);
 685
 686                 /* set the length to be read dor different handle type */
 687                 switch (src->intr_handle.type) {
 688                 case RTE_INTR_HANDLE_UIO:
 689                 case RTE_INTR_HANDLE_UIO_INTX:
 690                         bytes_read = sizeof(buf.uio_intr_count);
 691                         break;
 692                 case RTE_INTR_HANDLE_ALARM:
 693                         bytes_read = sizeof(buf.timerfd_num);
 694                         break;
 695 #ifdef VFIO_PRESENT
 696                 case RTE_INTR_HANDLE_VFIO_MSIX:
 697                 case RTE_INTR_HANDLE_VFIO_MSI:
 698                 case RTE_INTR_HANDLE_VFIO_LEGACY:
 699                         bytes_read = sizeof(buf.vfio_intr_count);
 700                         break;
 701 #endif
 702                 case RTE_INTR_HANDLE_VDEV:
 703                 case RTE_INTR_HANDLE_EXT:
 704                         bytes_read = 0;
 705                         call = true;
 706                         break;
 707
 708                 default:
 709                         bytes_read = 1;
 710                         break;
 711                 }
 712
 713                 if (bytes_read > 0) {
 714                         /**
 715                          * read out to clear the ready-to-be-read flag
 716                          * for epoll_wait.
 717                          */
 718                         bytes_read = read(events[n].data.fd, &buf, bytes_read);
 719                         if (bytes_read < 0) {
 720                                 if (errno == EINTR || errno == EWOULDBLOCK)
 721                                         continue;
 722
 723                                 RTE_LOG(ERR, EAL, "Error reading from file "
 724                                         "descriptor %d: %s\n",
 725                                         events[n].data.fd,
 726                                         strerror(errno));
 727                         } else if (bytes_read == 0)
 728                                 RTE_LOG(ERR, EAL, "Read nothing from file "
 729                                         "descriptor %d\n", events[n].data.fd);
 730                         else
 731                                 call = true;
 732                 }
 733
 734                 /* grab a lock, again to call callbacks and update status. */
 735                 rte_spinlock_lock(&intr_lock);
 736
 737                 if (call) {
 738
 739                         /* Finally, call all callbacks. */
 740                         TAILQ_FOREACH(cb, &src->callbacks, next) {
 741
 742                                 /* make a copy and unlock. */
 743                                 active_cb = *cb;
 744                                 rte_spinlock_unlock(&intr_lock);
 745
 746                                 /* call the actual callback */
 747                                 active_cb.cb_fn(&src->intr_handle,
 748                                         active_cb.cb_arg);
 749
 750                                 /*get the lock back. */
 751                                 rte_spinlock_lock(&intr_lock);
 752                         }
 753                 }
 754
 755                 /* we done with that interrupt source, release it. */
 756                 src->active = 0;
 757                 rte_spinlock_unlock(&intr_lock);
 758         }
 759
 760         return 0;
 761 }
 762
 763 /**
 764  * It handles all the interrupts.
 765  *
 766  * @param pfd
 767  *  epoll file descriptor.
 768  * @param totalfds
 769  *  The number of file descriptors added in epoll.
 770  *
 771  * @return
 772  *  void
 773  */
 774 static void
 775 eal_intr_handle_interrupts(int pfd, unsigned totalfds)
 776 {
 777         struct epoll_event events[totalfds];
 778         int nfds = 0;
 779
 780         for(;;) {
 781                 nfds = epoll_wait(pfd, events, totalfds,
 782                         EAL_INTR_EPOLL_WAIT_FOREVER);
 783                 /* epoll_wait fail */
 784                 if (nfds < 0) {
 785                         if (errno == EINTR)
 786                                 continue;
 787                         RTE_LOG(ERR, EAL,
 788                                 "epoll_wait returns with fail\n");
 789                         return;
 790                 }
 791                 /* epoll_wait timeout, will never happens here */
 792                 else if (nfds == 0)
 793                         continue;
 794                 /* epoll_wait has at least one fd ready to read */
 795                 if (eal_intr_process_interrupts(events, nfds) < 0)
 796                         return;
 797         }
 798 }
 799
 800 /**
 801  * It builds/rebuilds up the epoll file descriptor with all the
 802  * file descriptors being waited on. Then handles the interrupts.
 803  *
 804  * @param arg
 805  *  pointer. (unused)
 806  *
 807  * @return
 808  *  never return;
 809  */
 810 static __attribute__((noreturn)) void *
 811 eal_intr_thread_main(__rte_unused void *arg)
 812 {
 813         struct epoll_event ev;
 814
 815         /* host thread, never break out */
 816         for (;;) {
 817                 /* build up the epoll fd with all descriptors we are to
 818                  * wait on then pass it to the handle_interrupts function
 819                  */
 820                 static struct epoll_event pipe_event = {
 821                         .events = EPOLLIN | EPOLLPRI,
 822                 };
 823                 struct rte_intr_source *src;
 824                 unsigned numfds = 0;
 825
 826                 /* create epoll fd */
 827                 int pfd = epoll_create(1);
 828                 if (pfd < 0)
 829                         rte_panic("Cannot create epoll instance\n");
 830
 831                 pipe_event.data.fd = intr_pipe.readfd;
 832                 /**
 833                  * add pipe fd into wait list, this pipe is used to
 834                  * rebuild the wait list.
 835                  */
 836                 if (epoll_ctl(pfd, EPOLL_CTL_ADD, intr_pipe.readfd,
 837                                                 &pipe_event) < 0) {
 838                         rte_panic("Error adding fd to %d epoll_ctl, %s\n",
 839                                         intr_pipe.readfd, strerror(errno));
 840                 }
 841                 numfds++;
 842
 843                 rte_spinlock_lock(&intr_lock);
 844
 845                 TAILQ_FOREACH(src, &intr_sources, next) {
 846                         if (src->callbacks.tqh_first == NULL)
 847                                 continue; /* skip those with no callbacks */
 848                         ev.events = EPOLLIN | EPOLLPRI | EPOLLRDHUP | EPOLLHUP;
 849                         ev.data.fd = src->intr_handle.fd;
 850
 851                         /**
 852                          * add all the uio device file descriptor
 853                          * into wait list.
 854                          */
 855                         if (epoll_ctl(pfd, EPOLL_CTL_ADD,
 856                                         src->intr_handle.fd, &ev) < 0){
 857                                 rte_panic("Error adding fd %d epoll_ctl, %s\n",
 858                                         src->intr_handle.fd, strerror(errno));
 859                         }
 860                         else
 861                                 numfds++;
 862                 }
 863                 rte_spinlock_unlock(&intr_lock);
 864                 /* serve the interrupt */
 865                 eal_intr_handle_interrupts(pfd, numfds);
 866
 867                 /**
 868                  * when we return, we need to rebuild the
 869                  * list of fds to monitor.
 870                  */
 871                 close(pfd);
 872         }
 873 }
 874
 875 int
 876 rte_eal_intr_init(void)
 877 {
 878         int ret = 0, ret_1 = 0;
 879         char thread_name[RTE_MAX_THREAD_NAME_LEN];
 880
 881         /* init the global interrupt source head */
 882         TAILQ_INIT(&intr_sources);
 883
 884         /**
 885          * create a pipe which will be waited by epoll and notified to
 886          * rebuild the wait list of epoll.
 887          */
 888         if (pipe(intr_pipe.pipefd) < 0) {
 889                 rte_errno = errno;
 890                 return -1;
 891         }
 892
 893         /* create the host thread to wait/handle the interrupt */
 894         ret = pthread_create(&intr_thread, NULL,
 895                         eal_intr_thread_main, NULL);
 896         if (ret != 0) {
 897                 rte_errno = ret;
 898                 RTE_LOG(ERR, EAL,
 899                         "Failed to create thread for interrupt handling\n");
 900         } else {
 901                 /* Set thread_name for aid in debugging. */
 902                 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN,
 903                         "eal-intr-thread");
 904                 ret_1 = rte_thread_setname(intr_thread, thread_name);
 905                 if (ret_1 != 0)
 906                         RTE_LOG(DEBUG, EAL,
 907                         "Failed to set thread name for interrupt handling\n");
 908         }
 909
 910         return -ret;
 911 }
 912
 913 static void
 914 eal_intr_proc_rxtx_intr(int fd, const struct rte_intr_handle *intr_handle)
 915 {
 916         union rte_intr_read_buffer buf;
 917         int bytes_read = 1;
 918         int nbytes;
 919
 920         switch (intr_handle->type) {
 921         case RTE_INTR_HANDLE_UIO:
 922         case RTE_INTR_HANDLE_UIO_INTX:
 923                 bytes_read = sizeof(buf.uio_intr_count);
 924                 break;
 925 #ifdef VFIO_PRESENT
 926         case RTE_INTR_HANDLE_VFIO_MSIX:
 927         case RTE_INTR_HANDLE_VFIO_MSI:
 928         case RTE_INTR_HANDLE_VFIO_LEGACY:
 929                 bytes_read = sizeof(buf.vfio_intr_count);
 930                 break;
 931 #endif
 932         case RTE_INTR_HANDLE_VDEV:
 933                 /* for vdev, fd points to:
 934                  * a. eventfd which does not need to read out;
 935                  * b. datapath fd which needs PMD to read out.
 936                  */
 937                 return;
 938         case RTE_INTR_HANDLE_EXT:
 939                 return;
 940         default:
 941                 bytes_read = 1;
 942                 RTE_LOG(INFO, EAL, "unexpected intr type\n");
 943                 break;
 944         }
 945
 946         /**
 947          * read out to clear the ready-to-be-read flag
 948          * for epoll_wait.
 949          */
 950         do {
 951                 nbytes = read(fd, &buf, bytes_read);
 952                 if (nbytes < 0) {
 953                         if (errno == EINTR || errno == EWOULDBLOCK ||
 954                             errno == EAGAIN)
 955                                 continue;
 956                         RTE_LOG(ERR, EAL,
 957                                 "Error reading from fd %d: %s\n",
 958                                 fd, strerror(errno));
 959                 } else if (nbytes == 0)
 960                         RTE_LOG(ERR, EAL, "Read nothing from fd %d\n", fd);
 961                 return;
 962         } while (1);
 963 }
 964
 965 static int
 966 eal_epoll_process_event(struct epoll_event *evs, unsigned int n,
 967                         struct rte_epoll_event *events)
 968 {
 969         unsigned int i, count = 0;
 970         struct rte_epoll_event *rev;
 971
 972         for (i = 0; i < n; i++) {
 973                 rev = evs[i].data.ptr;
 974                 if (!rev || !rte_atomic32_cmpset(&rev->status, RTE_EPOLL_VALID,
 975                                                  RTE_EPOLL_EXEC))
 976                         continue;
 977
 978                 events[count].status        = RTE_EPOLL_VALID;
 979                 events[count].fd            = rev->fd;
 980                 events[count].epfd          = rev->epfd;
 981                 events[count].epdata.event  = rev->epdata.event;
 982                 events[count].epdata.data   = rev->epdata.data;
 983                 if (rev->epdata.cb_fun)
 984                         rev->epdata.cb_fun(rev->fd,
 985                                            rev->epdata.cb_arg);
 986
 987                 rte_compiler_barrier();
 988                 rev->status = RTE_EPOLL_VALID;
 989                 count++;
 990         }
 991         return count;
 992 }
 993
 994 static inline int
 995 eal_init_tls_epfd(void)
 996 {
 997         int pfd = epoll_create(255);
 998
 999         if (pfd < 0) {
1000                 RTE_LOG(ERR, EAL,
1001                         "Cannot create epoll instance\n");
1002                 return -1;
1003         }
1004         return pfd;
1005 }
1006
1007 int
1008 rte_intr_tls_epfd(void)
1009 {
1010         if (RTE_PER_LCORE(_epfd) == -1)
1011                 RTE_PER_LCORE(_epfd) = eal_init_tls_epfd();
1012
1013         return RTE_PER_LCORE(_epfd);
1014 }
1015
1016 int
1017 rte_epoll_wait(int epfd, struct rte_epoll_event *events,
1018                int maxevents, int timeout)
1019 {
1020         struct epoll_event evs[maxevents];
1021         int rc;
1022
1023         if (!events) {
1024                 RTE_LOG(ERR, EAL, "rte_epoll_event can't be NULL\n");
1025                 return -1;
1026         }
1027
1028         /* using per thread epoll fd */
1029         if (epfd == RTE_EPOLL_PER_THREAD)
1030                 epfd = rte_intr_tls_epfd();
1031
1032         while (1) {
1033                 rc = epoll_wait(epfd, evs, maxevents, timeout);
1034                 if (likely(rc > 0)) {
1035                         /* epoll_wait has at least one fd ready to read */
1036                         rc = eal_epoll_process_event(evs, rc, events);
1037                         break;
1038                 } else if (rc < 0) {
1039                         if (errno == EINTR)
1040                                 continue;
1041                         /* epoll_wait fail */
1042                         RTE_LOG(ERR, EAL, "epoll_wait returns with fail %s\n",
1043                                 strerror(errno));
1044                         rc = -1;
1045                         break;
1046                 } else {
1047                         /* rc == 0, epoll_wait timed out */
1048                         break;
1049                 }
1050         }
1051
1052         return rc;
1053 }
1054
1055 static inline void
1056 eal_epoll_data_safe_free(struct rte_epoll_event *ev)
1057 {
1058         while (!rte_atomic32_cmpset(&ev->status, RTE_EPOLL_VALID,
1059                                     RTE_EPOLL_INVALID))
1060                 while (ev->status != RTE_EPOLL_VALID)
1061                         rte_pause();
1062         memset(&ev->epdata, 0, sizeof(ev->epdata));
1063         ev->fd = -1;
1064         ev->epfd = -1;
1065 }
1066
1067 int
1068 rte_epoll_ctl(int epfd, int op, int fd,
1069               struct rte_epoll_event *event)
1070 {
1071         struct epoll_event ev;
1072
1073         if (!event) {
1074                 RTE_LOG(ERR, EAL, "rte_epoll_event can't be NULL\n");
1075                 return -1;
1076         }
1077
1078         /* using per thread epoll fd */
1079         if (epfd == RTE_EPOLL_PER_THREAD)
1080                 epfd = rte_intr_tls_epfd();
1081
1082         if (op == EPOLL_CTL_ADD) {
1083                 event->status = RTE_EPOLL_VALID;
1084                 event->fd = fd;  /* ignore fd in event */
1085                 event->epfd = epfd;
1086                 ev.data.ptr = (void *)event;
1087         }
1088
1089         ev.events = event->epdata.event;
1090         if (epoll_ctl(epfd, op, fd, &ev) < 0) {
1091                 RTE_LOG(ERR, EAL, "Error op %d fd %d epoll_ctl, %s\n",
1092                         op, fd, strerror(errno));
1093                 if (op == EPOLL_CTL_ADD)
1094                         /* rollback status when CTL_ADD fail */
1095                         event->status = RTE_EPOLL_INVALID;
1096                 return -1;
1097         }
1098
1099         if (op == EPOLL_CTL_DEL && event->status != RTE_EPOLL_INVALID)
1100                 eal_epoll_data_safe_free(event);
1101
1102         return 0;
1103 }
1104
1105 int
1106 rte_intr_rx_ctl(struct rte_intr_handle *intr_handle, int epfd,
1107                 int op, unsigned int vec, void *data)
1108 {
1109         struct rte_epoll_event *rev;
1110         struct rte_epoll_data *epdata;
1111         int epfd_op;
1112         unsigned int efd_idx;
1113         int rc = 0;
1114
1115         efd_idx = (vec >= RTE_INTR_VEC_RXTX_OFFSET) ?
1116                 (vec - RTE_INTR_VEC_RXTX_OFFSET) : vec;
1117
1118         if (!intr_handle || intr_handle->nb_efd == 0 ||
1119             efd_idx >= intr_handle->nb_efd) {
1120                 RTE_LOG(ERR, EAL, "Wrong intr vector number.\n");
1121                 return -EPERM;
1122         }
1123
1124         switch (op) {
1125         case RTE_INTR_EVENT_ADD:
1126                 epfd_op = EPOLL_CTL_ADD;
1127                 rev = &intr_handle->elist[efd_idx];
1128                 if (rev->status != RTE_EPOLL_INVALID) {
1129                         RTE_LOG(INFO, EAL, "Event already been added.\n");
1130                         return -EEXIST;
1131                 }
1132
1133                 /* attach to intr vector fd */
1134                 epdata = &rev->epdata;
1135                 epdata->event  = EPOLLIN | EPOLLPRI | EPOLLET;
1136                 epdata->data   = data;
1137                 epdata->cb_fun = (rte_intr_event_cb_t)eal_intr_proc_rxtx_intr;
1138                 epdata->cb_arg = (void *)intr_handle;
1139                 rc = rte_epoll_ctl(epfd, epfd_op,
1140                                    intr_handle->efds[efd_idx], rev);
1141                 if (!rc)
1142                         RTE_LOG(DEBUG, EAL,
1143                                 "efd %d associated with vec %d added on epfd %d"
1144                                 "\n", rev->fd, vec, epfd);
1145                 else
1146                         rc = -EPERM;
1147                 break;
1148         case RTE_INTR_EVENT_DEL:
1149                 epfd_op = EPOLL_CTL_DEL;
1150                 rev = &intr_handle->elist[efd_idx];
1151                 if (rev->status == RTE_EPOLL_INVALID) {
1152                         RTE_LOG(INFO, EAL, "Event does not exist.\n");
1153                         return -EPERM;
1154                 }
1155
1156                 rc = rte_epoll_ctl(rev->epfd, epfd_op, rev->fd, rev);
1157                 if (rc)
1158                         rc = -EPERM;
1159                 break;
1160         default:
1161                 RTE_LOG(ERR, EAL, "event op type mismatch\n");
1162                 rc = -EPERM;
1163         }
1164
1165         return rc;
1166 }
1167
1168 void
1169 rte_intr_free_epoll_fd(struct rte_intr_handle *intr_handle)
1170 {
1171         uint32_t i;
1172         struct rte_epoll_event *rev;
1173
1174         for (i = 0; i < intr_handle->nb_efd; i++) {
1175                 rev = &intr_handle->elist[i];
1176                 if (rev->status == RTE_EPOLL_INVALID)
1177                         continue;
1178                 if (rte_epoll_ctl(rev->epfd, EPOLL_CTL_DEL, rev->fd, rev)) {
1179                         /* force free if the entry valid */
1180                         eal_epoll_data_safe_free(rev);
1181                         rev->status = RTE_EPOLL_INVALID;
1182                 }
1183         }
1184 }
1185
1186 int
1187 rte_intr_efd_enable(struct rte_intr_handle *intr_handle, uint32_t nb_efd)
1188 {
1189         uint32_t i;
1190         int fd;
1191         uint32_t n = RTE_MIN(nb_efd, (uint32_t)RTE_MAX_RXTX_INTR_VEC_ID);
1192
1193         assert(nb_efd != 0);
1194
1195         if (intr_handle->type == RTE_INTR_HANDLE_VFIO_MSIX) {
1196                 for (i = 0; i < n; i++) {
1197                         fd = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
1198                         if (fd < 0) {
1199                                 RTE_LOG(ERR, EAL,
1200                                         "can't setup eventfd, error %i (%s)\n",
1201                                         errno, strerror(errno));
1202                                 return -errno;
1203                         }
1204                         intr_handle->efds[i] = fd;
1205                 }
1206                 intr_handle->nb_efd   = n;
1207                 intr_handle->max_intr = NB_OTHER_INTR + n;
1208         } else if (intr_handle->type == RTE_INTR_HANDLE_VDEV) {
1209                 /* do nothing, and let vdev driver to initialize this struct */
1210         } else {
1211                 intr_handle->efds[0]  = intr_handle->fd;
1212                 intr_handle->nb_efd   = RTE_MIN(nb_efd, 1U);
1213                 intr_handle->max_intr = NB_OTHER_INTR;
1214         }
1215
1216         return 0;
1217 }
1218
1219 void
1220 rte_intr_efd_disable(struct rte_intr_handle *intr_handle)
1221 {
1222         uint32_t i;
1223
1224         rte_intr_free_epoll_fd(intr_handle);
1225         if (intr_handle->max_intr > intr_handle->nb_efd) {
1226                 for (i = 0; i < intr_handle->nb_efd; i++)
1227                         close(intr_handle->efds[i]);
1228         }
1229         intr_handle->nb_efd = 0;
1230         intr_handle->max_intr = 0;
1231 }
1232
1233 int
1234 rte_intr_dp_is_en(struct rte_intr_handle *intr_handle)
1235 {
1236         return !(!intr_handle->nb_efd);
1237 }
1238
1239 int
1240 rte_intr_allow_others(struct rte_intr_handle *intr_handle)
1241 {
1242         if (!rte_intr_dp_is_en(intr_handle))
1243                 return 1;
1244         else
1245                 return !!(intr_handle->max_intr - intr_handle->nb_efd);
1246 }
1247
1248 int
1249 rte_intr_cap_multiple(struct rte_intr_handle *intr_handle)
1250 {
1251         if (intr_handle->type == RTE_INTR_HANDLE_VFIO_MSIX)
1252                 return 1;
1253
1254         if (intr_handle->type == RTE_INTR_HANDLE_VDEV)
1255                 return 1;
1256
1257         return 0;
1258 }