8f6587225dadffc4c620a35a16275f98efc7ee5a
[dpdk.git] / 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_launch.h>
55 #include <rte_eal.h>
56 #include <rte_per_lcore.h>
57 #include <rte_lcore.h>
58 #include <rte_atomic.h>
59 #include <rte_branch_prediction.h>
60 #include <rte_debug.h>
61 #include <rte_log.h>
62 #include <rte_malloc.h>
63 #include <rte_errno.h>
64 #include <rte_spinlock.h>
65 #include <rte_pause.h>
66
67 #include "eal_private.h"
68 #include "eal_vfio.h"
69 #include "eal_thread.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(const 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(const 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_MASK;
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 masking 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(const 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(const 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(const 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         /* 0 < irq_set->count < RTE_MAX_RXTX_INTR_VEC_ID + 1 */
294         irq_set->count = intr_handle->max_intr ?
295                 (intr_handle->max_intr > RTE_MAX_RXTX_INTR_VEC_ID + 1 ?
296                 RTE_MAX_RXTX_INTR_VEC_ID + 1 : intr_handle->max_intr) : 1;
297         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
298         irq_set->index = VFIO_PCI_MSIX_IRQ_INDEX;
299         irq_set->start = 0;
300         fd_ptr = (int *) &irq_set->data;
301         /* INTR vector offset 0 reserve for non-efds mapping */
302         fd_ptr[RTE_INTR_VEC_ZERO_OFFSET] = intr_handle->fd;
303         memcpy(&fd_ptr[RTE_INTR_VEC_RXTX_OFFSET], intr_handle->efds,
304                 sizeof(*intr_handle->efds) * intr_handle->nb_efd);
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(const 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(const 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(const 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(const 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(const 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(const 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(const 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(const struct rte_intr_handle *intr_handle)
557 {
558         if (intr_handle && intr_handle->type == RTE_INTR_HANDLE_VDEV)
559                 return 0;
560
561         if (!intr_handle || intr_handle->fd < 0 || intr_handle->uio_cfg_fd < 0)
562                 return -1;
563
564         switch (intr_handle->type){
565         /* write to the uio fd to enable the interrupt */
566         case RTE_INTR_HANDLE_UIO:
567                 if (uio_intr_enable(intr_handle))
568                         return -1;
569                 break;
570         case RTE_INTR_HANDLE_UIO_INTX:
571                 if (uio_intx_intr_enable(intr_handle))
572                         return -1;
573                 break;
574         /* not used at this moment */
575         case RTE_INTR_HANDLE_ALARM:
576                 return -1;
577 #ifdef VFIO_PRESENT
578         case RTE_INTR_HANDLE_VFIO_MSIX:
579                 if (vfio_enable_msix(intr_handle))
580                         return -1;
581                 break;
582         case RTE_INTR_HANDLE_VFIO_MSI:
583                 if (vfio_enable_msi(intr_handle))
584                         return -1;
585                 break;
586         case RTE_INTR_HANDLE_VFIO_LEGACY:
587                 if (vfio_enable_intx(intr_handle))
588                         return -1;
589                 break;
590 #endif
591         /* unknown handle type */
592         default:
593                 RTE_LOG(ERR, EAL,
594                         "Unknown handle type of fd %d\n",
595                                         intr_handle->fd);
596                 return -1;
597         }
598
599         return 0;
600 }
601
602 int
603 rte_intr_disable(const struct rte_intr_handle *intr_handle)
604 {
605         if (intr_handle && intr_handle->type == RTE_INTR_HANDLE_VDEV)
606                 return 0;
607
608         if (!intr_handle || intr_handle->fd < 0 || intr_handle->uio_cfg_fd < 0)
609                 return -1;
610
611         switch (intr_handle->type){
612         /* write to the uio fd to disable the interrupt */
613         case RTE_INTR_HANDLE_UIO:
614                 if (uio_intr_disable(intr_handle))
615                         return -1;
616                 break;
617         case RTE_INTR_HANDLE_UIO_INTX:
618                 if (uio_intx_intr_disable(intr_handle))
619                         return -1;
620                 break;
621         /* not used at this moment */
622         case RTE_INTR_HANDLE_ALARM:
623                 return -1;
624 #ifdef VFIO_PRESENT
625         case RTE_INTR_HANDLE_VFIO_MSIX:
626                 if (vfio_disable_msix(intr_handle))
627                         return -1;
628                 break;
629         case RTE_INTR_HANDLE_VFIO_MSI:
630                 if (vfio_disable_msi(intr_handle))
631                         return -1;
632                 break;
633         case RTE_INTR_HANDLE_VFIO_LEGACY:
634                 if (vfio_disable_intx(intr_handle))
635                         return -1;
636                 break;
637 #endif
638         /* unknown handle type */
639         default:
640                 RTE_LOG(ERR, EAL,
641                         "Unknown handle type of fd %d\n",
642                                         intr_handle->fd);
643                 return -1;
644         }
645
646         return 0;
647 }
648
649 static int
650 eal_intr_process_interrupts(struct epoll_event *events, int nfds)
651 {
652         bool call = false;
653         int n, bytes_read;
654         struct rte_intr_source *src;
655         struct rte_intr_callback *cb;
656         union rte_intr_read_buffer buf;
657         struct rte_intr_callback active_cb;
658
659         for (n = 0; n < nfds; n++) {
660
661                 /**
662                  * if the pipe fd is ready to read, return out to
663                  * rebuild the wait list.
664                  */
665                 if (events[n].data.fd == intr_pipe.readfd){
666                         int r = read(intr_pipe.readfd, buf.charbuf,
667                                         sizeof(buf.charbuf));
668                         RTE_SET_USED(r);
669                         return -1;
670                 }
671                 rte_spinlock_lock(&intr_lock);
672                 TAILQ_FOREACH(src, &intr_sources, next)
673                         if (src->intr_handle.fd ==
674                                         events[n].data.fd)
675                                 break;
676                 if (src == NULL){
677                         rte_spinlock_unlock(&intr_lock);
678                         continue;
679                 }
680
681                 /* mark this interrupt source as active and release the lock. */
682                 src->active = 1;
683                 rte_spinlock_unlock(&intr_lock);
684
685                 /* set the length to be read dor different handle type */
686                 switch (src->intr_handle.type) {
687                 case RTE_INTR_HANDLE_UIO:
688                 case RTE_INTR_HANDLE_UIO_INTX:
689                         bytes_read = sizeof(buf.uio_intr_count);
690                         break;
691                 case RTE_INTR_HANDLE_ALARM:
692                         bytes_read = sizeof(buf.timerfd_num);
693                         break;
694 #ifdef VFIO_PRESENT
695                 case RTE_INTR_HANDLE_VFIO_MSIX:
696                 case RTE_INTR_HANDLE_VFIO_MSI:
697                 case RTE_INTR_HANDLE_VFIO_LEGACY:
698                         bytes_read = sizeof(buf.vfio_intr_count);
699                         break;
700 #endif
701                 case RTE_INTR_HANDLE_VDEV:
702                 case RTE_INTR_HANDLE_EXT:
703                         bytes_read = 0;
704                         call = true;
705                         break;
706
707                 default:
708                         bytes_read = 1;
709                         break;
710                 }
711
712                 if (bytes_read > 0) {
713                         /**
714                          * read out to clear the ready-to-be-read flag
715                          * for epoll_wait.
716                          */
717                         bytes_read = read(events[n].data.fd, &buf, bytes_read);
718                         if (bytes_read < 0) {
719                                 if (errno == EINTR || errno == EWOULDBLOCK)
720                                         continue;
721
722                                 RTE_LOG(ERR, EAL, "Error reading from file "
723                                         "descriptor %d: %s\n",
724                                         events[n].data.fd,
725                                         strerror(errno));
726                         } else if (bytes_read == 0)
727                                 RTE_LOG(ERR, EAL, "Read nothing from file "
728                                         "descriptor %d\n", events[n].data.fd);
729                         else
730                                 call = true;
731                 }
732
733                 /* grab a lock, again to call callbacks and update status. */
734                 rte_spinlock_lock(&intr_lock);
735
736                 if (call) {
737
738                         /* Finally, call all callbacks. */
739                         TAILQ_FOREACH(cb, &src->callbacks, next) {
740
741                                 /* make a copy and unlock. */
742                                 active_cb = *cb;
743                                 rte_spinlock_unlock(&intr_lock);
744
745                                 /* call the actual callback */
746                                 active_cb.cb_fn(active_cb.cb_arg);
747
748                                 /*get the lock back. */
749                                 rte_spinlock_lock(&intr_lock);
750                         }
751                 }
752
753                 /* we done with that interrupt source, release it. */
754                 src->active = 0;
755                 rte_spinlock_unlock(&intr_lock);
756         }
757
758         return 0;
759 }
760
761 /**
762  * It handles all the interrupts.
763  *
764  * @param pfd
765  *  epoll file descriptor.
766  * @param totalfds
767  *  The number of file descriptors added in epoll.
768  *
769  * @return
770  *  void
771  */
772 static void
773 eal_intr_handle_interrupts(int pfd, unsigned totalfds)
774 {
775         struct epoll_event events[totalfds];
776         int nfds = 0;
777
778         for(;;) {
779                 nfds = epoll_wait(pfd, events, totalfds,
780                         EAL_INTR_EPOLL_WAIT_FOREVER);
781                 /* epoll_wait fail */
782                 if (nfds < 0) {
783                         if (errno == EINTR)
784                                 continue;
785                         RTE_LOG(ERR, EAL,
786                                 "epoll_wait returns with fail\n");
787                         return;
788                 }
789                 /* epoll_wait timeout, will never happens here */
790                 else if (nfds == 0)
791                         continue;
792                 /* epoll_wait has at least one fd ready to read */
793                 if (eal_intr_process_interrupts(events, nfds) < 0)
794                         return;
795         }
796 }
797
798 /**
799  * It builds/rebuilds up the epoll file descriptor with all the
800  * file descriptors being waited on. Then handles the interrupts.
801  *
802  * @param arg
803  *  pointer. (unused)
804  *
805  * @return
806  *  never return;
807  */
808 static __attribute__((noreturn)) void *
809 eal_intr_thread_main(__rte_unused void *arg)
810 {
811         struct epoll_event ev;
812
813         /* host thread, never break out */
814         for (;;) {
815                 /* build up the epoll fd with all descriptors we are to
816                  * wait on then pass it to the handle_interrupts function
817                  */
818                 static struct epoll_event pipe_event = {
819                         .events = EPOLLIN | EPOLLPRI,
820                 };
821                 struct rte_intr_source *src;
822                 unsigned numfds = 0;
823
824                 /* create epoll fd */
825                 int pfd = epoll_create(1);
826                 if (pfd < 0)
827                         rte_panic("Cannot create epoll instance\n");
828
829                 pipe_event.data.fd = intr_pipe.readfd;
830                 /**
831                  * add pipe fd into wait list, this pipe is used to
832                  * rebuild the wait list.
833                  */
834                 if (epoll_ctl(pfd, EPOLL_CTL_ADD, intr_pipe.readfd,
835                                                 &pipe_event) < 0) {
836                         rte_panic("Error adding fd to %d epoll_ctl, %s\n",
837                                         intr_pipe.readfd, strerror(errno));
838                 }
839                 numfds++;
840
841                 rte_spinlock_lock(&intr_lock);
842
843                 TAILQ_FOREACH(src, &intr_sources, next) {
844                         if (src->callbacks.tqh_first == NULL)
845                                 continue; /* skip those with no callbacks */
846                         ev.events = EPOLLIN | EPOLLPRI | EPOLLRDHUP | EPOLLHUP;
847                         ev.data.fd = src->intr_handle.fd;
848
849                         /**
850                          * add all the uio device file descriptor
851                          * into wait list.
852                          */
853                         if (epoll_ctl(pfd, EPOLL_CTL_ADD,
854                                         src->intr_handle.fd, &ev) < 0){
855                                 rte_panic("Error adding fd %d epoll_ctl, %s\n",
856                                         src->intr_handle.fd, strerror(errno));
857                         }
858                         else
859                                 numfds++;
860                 }
861                 rte_spinlock_unlock(&intr_lock);
862                 /* serve the interrupt */
863                 eal_intr_handle_interrupts(pfd, numfds);
864
865                 /**
866                  * when we return, we need to rebuild the
867                  * list of fds to monitor.
868                  */
869                 close(pfd);
870         }
871 }
872
873 int
874 rte_eal_intr_init(void)
875 {
876         int ret = 0, ret_1 = 0;
877         char thread_name[RTE_MAX_THREAD_NAME_LEN];
878
879         /* init the global interrupt source head */
880         TAILQ_INIT(&intr_sources);
881
882         /**
883          * create a pipe which will be waited by epoll and notified to
884          * rebuild the wait list of epoll.
885          */
886         if (pipe(intr_pipe.pipefd) < 0) {
887                 rte_errno = errno;
888                 return -1;
889         }
890
891         /* create the host thread to wait/handle the interrupt */
892         ret = pthread_create(&intr_thread, NULL,
893                         eal_intr_thread_main, NULL);
894         if (ret != 0) {
895                 rte_errno = ret;
896                 RTE_LOG(ERR, EAL,
897                         "Failed to create thread for interrupt handling\n");
898         } else {
899                 /* Set thread_name for aid in debugging. */
900                 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN,
901                         "eal-intr-thread");
902                 ret_1 = rte_thread_setname(intr_thread, thread_name);
903                 if (ret_1 != 0)
904                         RTE_LOG(DEBUG, EAL,
905                         "Failed to set thread name for interrupt handling\n");
906         }
907
908         return -ret;
909 }
910
911 static void
912 eal_intr_proc_rxtx_intr(int fd, const struct rte_intr_handle *intr_handle)
913 {
914         union rte_intr_read_buffer buf;
915         int bytes_read = 1;
916         int nbytes;
917
918         switch (intr_handle->type) {
919         case RTE_INTR_HANDLE_UIO:
920         case RTE_INTR_HANDLE_UIO_INTX:
921                 bytes_read = sizeof(buf.uio_intr_count);
922                 break;
923 #ifdef VFIO_PRESENT
924         case RTE_INTR_HANDLE_VFIO_MSIX:
925         case RTE_INTR_HANDLE_VFIO_MSI:
926         case RTE_INTR_HANDLE_VFIO_LEGACY:
927                 bytes_read = sizeof(buf.vfio_intr_count);
928                 break;
929 #endif
930         case RTE_INTR_HANDLE_VDEV:
931                 /* for vdev, fd points to:
932                  * a. eventfd which does not need to read out;
933                  * b. datapath fd which needs PMD to read out.
934                  */
935                 return;
936         case RTE_INTR_HANDLE_EXT:
937                 return;
938         default:
939                 bytes_read = 1;
940                 RTE_LOG(INFO, EAL, "unexpected intr type\n");
941                 break;
942         }
943
944         /**
945          * read out to clear the ready-to-be-read flag
946          * for epoll_wait.
947          */
948         do {
949                 nbytes = read(fd, &buf, bytes_read);
950                 if (nbytes < 0) {
951                         if (errno == EINTR || errno == EWOULDBLOCK ||
952                             errno == EAGAIN)
953                                 continue;
954                         RTE_LOG(ERR, EAL,
955                                 "Error reading from fd %d: %s\n",
956                                 fd, strerror(errno));
957                 } else if (nbytes == 0)
958                         RTE_LOG(ERR, EAL, "Read nothing from fd %d\n", fd);
959                 return;
960         } while (1);
961 }
962
963 static int
964 eal_epoll_process_event(struct epoll_event *evs, unsigned int n,
965                         struct rte_epoll_event *events)
966 {
967         unsigned int i, count = 0;
968         struct rte_epoll_event *rev;
969
970         for (i = 0; i < n; i++) {
971                 rev = evs[i].data.ptr;
972                 if (!rev || !rte_atomic32_cmpset(&rev->status, RTE_EPOLL_VALID,
973                                                  RTE_EPOLL_EXEC))
974                         continue;
975
976                 events[count].status        = RTE_EPOLL_VALID;
977                 events[count].fd            = rev->fd;
978                 events[count].epfd          = rev->epfd;
979                 events[count].epdata.event  = rev->epdata.event;
980                 events[count].epdata.data   = rev->epdata.data;
981                 if (rev->epdata.cb_fun)
982                         rev->epdata.cb_fun(rev->fd,
983                                            rev->epdata.cb_arg);
984
985                 rte_compiler_barrier();
986                 rev->status = RTE_EPOLL_VALID;
987                 count++;
988         }
989         return count;
990 }
991
992 static inline int
993 eal_init_tls_epfd(void)
994 {
995         int pfd = epoll_create(255);
996
997         if (pfd < 0) {
998                 RTE_LOG(ERR, EAL,
999                         "Cannot create epoll instance\n");
1000                 return -1;
1001         }
1002         return pfd;
1003 }
1004
1005 int
1006 rte_intr_tls_epfd(void)
1007 {
1008         if (RTE_PER_LCORE(_epfd) == -1)
1009                 RTE_PER_LCORE(_epfd) = eal_init_tls_epfd();
1010
1011         return RTE_PER_LCORE(_epfd);
1012 }
1013
1014 int
1015 rte_epoll_wait(int epfd, struct rte_epoll_event *events,
1016                int maxevents, int timeout)
1017 {
1018         struct epoll_event evs[maxevents];
1019         int rc;
1020
1021         if (!events) {
1022                 RTE_LOG(ERR, EAL, "rte_epoll_event can't be NULL\n");
1023                 return -1;
1024         }
1025
1026         /* using per thread epoll fd */
1027         if (epfd == RTE_EPOLL_PER_THREAD)
1028                 epfd = rte_intr_tls_epfd();
1029
1030         while (1) {
1031                 rc = epoll_wait(epfd, evs, maxevents, timeout);
1032                 if (likely(rc > 0)) {
1033                         /* epoll_wait has at least one fd ready to read */
1034                         rc = eal_epoll_process_event(evs, rc, events);
1035                         break;
1036                 } else if (rc < 0) {
1037                         if (errno == EINTR)
1038                                 continue;
1039                         /* epoll_wait fail */
1040                         RTE_LOG(ERR, EAL, "epoll_wait returns with fail %s\n",
1041                                 strerror(errno));
1042                         rc = -1;
1043                         break;
1044                 } else {
1045                         /* rc == 0, epoll_wait timed out */
1046                         break;
1047                 }
1048         }
1049
1050         return rc;
1051 }
1052
1053 static inline void
1054 eal_epoll_data_safe_free(struct rte_epoll_event *ev)
1055 {
1056         while (!rte_atomic32_cmpset(&ev->status, RTE_EPOLL_VALID,
1057                                     RTE_EPOLL_INVALID))
1058                 while (ev->status != RTE_EPOLL_VALID)
1059                         rte_pause();
1060         memset(&ev->epdata, 0, sizeof(ev->epdata));
1061         ev->fd = -1;
1062         ev->epfd = -1;
1063 }
1064
1065 int
1066 rte_epoll_ctl(int epfd, int op, int fd,
1067               struct rte_epoll_event *event)
1068 {
1069         struct epoll_event ev;
1070
1071         if (!event) {
1072                 RTE_LOG(ERR, EAL, "rte_epoll_event can't be NULL\n");
1073                 return -1;
1074         }
1075
1076         /* using per thread epoll fd */
1077         if (epfd == RTE_EPOLL_PER_THREAD)
1078                 epfd = rte_intr_tls_epfd();
1079
1080         if (op == EPOLL_CTL_ADD) {
1081                 event->status = RTE_EPOLL_VALID;
1082                 event->fd = fd;  /* ignore fd in event */
1083                 event->epfd = epfd;
1084                 ev.data.ptr = (void *)event;
1085         }
1086
1087         ev.events = event->epdata.event;
1088         if (epoll_ctl(epfd, op, fd, &ev) < 0) {
1089                 RTE_LOG(ERR, EAL, "Error op %d fd %d epoll_ctl, %s\n",
1090                         op, fd, strerror(errno));
1091                 if (op == EPOLL_CTL_ADD)
1092                         /* rollback status when CTL_ADD fail */
1093                         event->status = RTE_EPOLL_INVALID;
1094                 return -1;
1095         }
1096
1097         if (op == EPOLL_CTL_DEL && event->status != RTE_EPOLL_INVALID)
1098                 eal_epoll_data_safe_free(event);
1099
1100         return 0;
1101 }
1102
1103 int
1104 rte_intr_rx_ctl(struct rte_intr_handle *intr_handle, int epfd,
1105                 int op, unsigned int vec, void *data)
1106 {
1107         struct rte_epoll_event *rev;
1108         struct rte_epoll_data *epdata;
1109         int epfd_op;
1110         unsigned int efd_idx;
1111         int rc = 0;
1112
1113         efd_idx = (vec >= RTE_INTR_VEC_RXTX_OFFSET) ?
1114                 (vec - RTE_INTR_VEC_RXTX_OFFSET) : vec;
1115
1116         if (!intr_handle || intr_handle->nb_efd == 0 ||
1117             efd_idx >= intr_handle->nb_efd) {
1118                 RTE_LOG(ERR, EAL, "Wrong intr vector number.\n");
1119                 return -EPERM;
1120         }
1121
1122         switch (op) {
1123         case RTE_INTR_EVENT_ADD:
1124                 epfd_op = EPOLL_CTL_ADD;
1125                 rev = &intr_handle->elist[efd_idx];
1126                 if (rev->status != RTE_EPOLL_INVALID) {
1127                         RTE_LOG(INFO, EAL, "Event already been added.\n");
1128                         return -EEXIST;
1129                 }
1130
1131                 /* attach to intr vector fd */
1132                 epdata = &rev->epdata;
1133                 epdata->event  = EPOLLIN | EPOLLPRI | EPOLLET;
1134                 epdata->data   = data;
1135                 epdata->cb_fun = (rte_intr_event_cb_t)eal_intr_proc_rxtx_intr;
1136                 epdata->cb_arg = (void *)intr_handle;
1137                 rc = rte_epoll_ctl(epfd, epfd_op,
1138                                    intr_handle->efds[efd_idx], rev);
1139                 if (!rc)
1140                         RTE_LOG(DEBUG, EAL,
1141                                 "efd %d associated with vec %d added on epfd %d"
1142                                 "\n", rev->fd, vec, epfd);
1143                 else
1144                         rc = -EPERM;
1145                 break;
1146         case RTE_INTR_EVENT_DEL:
1147                 epfd_op = EPOLL_CTL_DEL;
1148                 rev = &intr_handle->elist[efd_idx];
1149                 if (rev->status == RTE_EPOLL_INVALID) {
1150                         RTE_LOG(INFO, EAL, "Event does not exist.\n");
1151                         return -EPERM;
1152                 }
1153
1154                 rc = rte_epoll_ctl(rev->epfd, epfd_op, rev->fd, rev);
1155                 if (rc)
1156                         rc = -EPERM;
1157                 break;
1158         default:
1159                 RTE_LOG(ERR, EAL, "event op type mismatch\n");
1160                 rc = -EPERM;
1161         }
1162
1163         return rc;
1164 }
1165
1166 void
1167 rte_intr_free_epoll_fd(struct rte_intr_handle *intr_handle)
1168 {
1169         uint32_t i;
1170         struct rte_epoll_event *rev;
1171
1172         for (i = 0; i < intr_handle->nb_efd; i++) {
1173                 rev = &intr_handle->elist[i];
1174                 if (rev->status == RTE_EPOLL_INVALID)
1175                         continue;
1176                 if (rte_epoll_ctl(rev->epfd, EPOLL_CTL_DEL, rev->fd, rev)) {
1177                         /* force free if the entry valid */
1178                         eal_epoll_data_safe_free(rev);
1179                         rev->status = RTE_EPOLL_INVALID;
1180                 }
1181         }
1182 }
1183
1184 int
1185 rte_intr_efd_enable(struct rte_intr_handle *intr_handle, uint32_t nb_efd)
1186 {
1187         uint32_t i;
1188         int fd;
1189         uint32_t n = RTE_MIN(nb_efd, (uint32_t)RTE_MAX_RXTX_INTR_VEC_ID);
1190
1191         assert(nb_efd != 0);
1192
1193         if (intr_handle->type == RTE_INTR_HANDLE_VFIO_MSIX) {
1194                 for (i = 0; i < n; i++) {
1195                         fd = eventfd(0, EFD_NONBLOCK | EFD_CLOEXEC);
1196                         if (fd < 0) {
1197                                 RTE_LOG(ERR, EAL,
1198                                         "can't setup eventfd, error %i (%s)\n",
1199                                         errno, strerror(errno));
1200                                 return -errno;
1201                         }
1202                         intr_handle->efds[i] = fd;
1203                 }
1204                 intr_handle->nb_efd   = n;
1205                 intr_handle->max_intr = NB_OTHER_INTR + n;
1206         } else if (intr_handle->type == RTE_INTR_HANDLE_VDEV) {
1207                 /* do nothing, and let vdev driver to initialize this struct */
1208         } else {
1209                 intr_handle->efds[0]  = intr_handle->fd;
1210                 intr_handle->nb_efd   = RTE_MIN(nb_efd, 1U);
1211                 intr_handle->max_intr = NB_OTHER_INTR;
1212         }
1213
1214         return 0;
1215 }
1216
1217 void
1218 rte_intr_efd_disable(struct rte_intr_handle *intr_handle)
1219 {
1220         uint32_t i;
1221
1222         rte_intr_free_epoll_fd(intr_handle);
1223         if (intr_handle->max_intr > intr_handle->nb_efd) {
1224                 for (i = 0; i < intr_handle->nb_efd; i++)
1225                         close(intr_handle->efds[i]);
1226         }
1227         intr_handle->nb_efd = 0;
1228         intr_handle->max_intr = 0;
1229 }
1230
1231 int
1232 rte_intr_dp_is_en(struct rte_intr_handle *intr_handle)
1233 {
1234         return !(!intr_handle->nb_efd);
1235 }
1236
1237 int
1238 rte_intr_allow_others(struct rte_intr_handle *intr_handle)
1239 {
1240         if (!rte_intr_dp_is_en(intr_handle))
1241                 return 1;
1242         else
1243                 return !!(intr_handle->max_intr - intr_handle->nb_efd);
1244 }
1245
1246 int
1247 rte_intr_cap_multiple(struct rte_intr_handle *intr_handle)
1248 {
1249         if (intr_handle->type == RTE_INTR_HANDLE_VFIO_MSIX)
1250                 return 1;
1251
1252         if (intr_handle->type == RTE_INTR_HANDLE_VDEV)
1253                 return 1;
1254
1255         return 0;
1256 }