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