cdd74ee101a469d446dfb000425f8dbf8662ae18
[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_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_malloc.h>
64 #include <rte_errno.h>
65 #include <rte_spinlock.h>
66 #include <rte_pause.h>
67 #include <rte_vfio.h>
68
69 #include "eal_private.h"
70 #include "eal_vfio.h"
71 #include "eal_thread.h"
72
73 #define EAL_INTR_EPOLL_WAIT_FOREVER (-1)
74 #define NB_OTHER_INTR               1
75
76 static RTE_DEFINE_PER_LCORE(int, _epfd) = -1; /**< epoll fd per thread */
77
78 /**
79  * union for pipe fds.
80  */
81 union intr_pipefds{
82         struct {
83                 int pipefd[2];
84         };
85         struct {
86                 int readfd;
87                 int writefd;
88         };
89 };
90
91 /**
92  * union buffer for reading on different devices
93  */
94 union rte_intr_read_buffer {
95         int uio_intr_count;              /* for uio device */
96 #ifdef VFIO_PRESENT
97         uint64_t vfio_intr_count;        /* for vfio device */
98 #endif
99         uint64_t timerfd_num;            /* for timerfd */
100         char charbuf[16];                /* for others */
101 };
102
103 TAILQ_HEAD(rte_intr_cb_list, rte_intr_callback);
104 TAILQ_HEAD(rte_intr_source_list, rte_intr_source);
105
106 struct rte_intr_callback {
107         TAILQ_ENTRY(rte_intr_callback) next;
108         rte_intr_callback_fn cb_fn;  /**< callback address */
109         void *cb_arg;                /**< parameter for callback */
110 };
111
112 struct rte_intr_source {
113         TAILQ_ENTRY(rte_intr_source) next;
114         struct rte_intr_handle intr_handle; /**< interrupt handle */
115         struct rte_intr_cb_list callbacks;  /**< user callbacks */
116         uint32_t active;
117 };
118
119 /* global spinlock for interrupt data operation */
120 static rte_spinlock_t intr_lock = RTE_SPINLOCK_INITIALIZER;
121
122 /* union buffer for pipe read/write */
123 static union intr_pipefds intr_pipe;
124
125 /* interrupt sources list */
126 static struct rte_intr_source_list intr_sources;
127
128 /* interrupt handling thread */
129 static pthread_t intr_thread;
130
131 /* VFIO interrupts */
132 #ifdef VFIO_PRESENT
133
134 #define IRQ_SET_BUF_LEN  (sizeof(struct vfio_irq_set) + sizeof(int))
135 /* irq set buffer length for queue interrupts and LSC interrupt */
136 #define MSIX_IRQ_SET_BUF_LEN (sizeof(struct vfio_irq_set) + \
137                               sizeof(int) * (RTE_MAX_RXTX_INTR_VEC_ID + 1))
138
139 /* enable legacy (INTx) interrupts */
140 static int
141 vfio_enable_intx(const struct rte_intr_handle *intr_handle) {
142         struct vfio_irq_set *irq_set;
143         char irq_set_buf[IRQ_SET_BUF_LEN];
144         int len, ret;
145         int *fd_ptr;
146
147         len = sizeof(irq_set_buf);
148
149         /* enable INTx */
150         irq_set = (struct vfio_irq_set *) irq_set_buf;
151         irq_set->argsz = len;
152         irq_set->count = 1;
153         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
154         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
155         irq_set->start = 0;
156         fd_ptr = (int *) &irq_set->data;
157         *fd_ptr = intr_handle->fd;
158
159         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
160
161         if (ret) {
162                 RTE_LOG(ERR, EAL, "Error enabling INTx interrupts for fd %d\n",
163                                                 intr_handle->fd);
164                 return -1;
165         }
166
167         /* unmask INTx after enabling */
168         memset(irq_set, 0, len);
169         len = sizeof(struct vfio_irq_set);
170         irq_set->argsz = len;
171         irq_set->count = 1;
172         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_UNMASK;
173         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
174         irq_set->start = 0;
175
176         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
177
178         if (ret) {
179                 RTE_LOG(ERR, EAL, "Error unmasking INTx interrupts for fd %d\n",
180                                                 intr_handle->fd);
181                 return -1;
182         }
183         return 0;
184 }
185
186 /* disable legacy (INTx) interrupts */
187 static int
188 vfio_disable_intx(const struct rte_intr_handle *intr_handle) {
189         struct vfio_irq_set *irq_set;
190         char irq_set_buf[IRQ_SET_BUF_LEN];
191         int len, ret;
192
193         len = sizeof(struct vfio_irq_set);
194
195         /* mask interrupts before disabling */
196         irq_set = (struct vfio_irq_set *) irq_set_buf;
197         irq_set->argsz = len;
198         irq_set->count = 1;
199         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_MASK;
200         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
201         irq_set->start = 0;
202
203         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
204
205         if (ret) {
206                 RTE_LOG(ERR, EAL, "Error masking INTx interrupts for fd %d\n",
207                                                 intr_handle->fd);
208                 return -1;
209         }
210
211         /* disable INTx*/
212         memset(irq_set, 0, len);
213         irq_set->argsz = len;
214         irq_set->count = 0;
215         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_TRIGGER;
216         irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
217         irq_set->start = 0;
218
219         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
220
221         if (ret) {
222                 RTE_LOG(ERR, EAL,
223                         "Error disabling INTx interrupts for fd %d\n", intr_handle->fd);
224                 return -1;
225         }
226         return 0;
227 }
228
229 /* enable MSI interrupts */
230 static int
231 vfio_enable_msi(const struct rte_intr_handle *intr_handle) {
232         int len, ret;
233         char irq_set_buf[IRQ_SET_BUF_LEN];
234         struct vfio_irq_set *irq_set;
235         int *fd_ptr;
236
237         len = sizeof(irq_set_buf);
238
239         irq_set = (struct vfio_irq_set *) irq_set_buf;
240         irq_set->argsz = len;
241         irq_set->count = 1;
242         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
243         irq_set->index = VFIO_PCI_MSI_IRQ_INDEX;
244         irq_set->start = 0;
245         fd_ptr = (int *) &irq_set->data;
246         *fd_ptr = intr_handle->fd;
247
248         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
249
250         if (ret) {
251                 RTE_LOG(ERR, EAL, "Error enabling MSI interrupts for fd %d\n",
252                                                 intr_handle->fd);
253                 return -1;
254         }
255         return 0;
256 }
257
258 /* disable MSI interrupts */
259 static int
260 vfio_disable_msi(const struct rte_intr_handle *intr_handle) {
261         struct vfio_irq_set *irq_set;
262         char irq_set_buf[IRQ_SET_BUF_LEN];
263         int len, ret;
264
265         len = sizeof(struct vfio_irq_set);
266
267         irq_set = (struct vfio_irq_set *) irq_set_buf;
268         irq_set->argsz = len;
269         irq_set->count = 0;
270         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_TRIGGER;
271         irq_set->index = VFIO_PCI_MSI_IRQ_INDEX;
272         irq_set->start = 0;
273
274         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
275
276         if (ret)
277                 RTE_LOG(ERR, EAL,
278                         "Error disabling MSI interrupts for fd %d\n", intr_handle->fd);
279
280         return ret;
281 }
282
283 /* enable MSI-X interrupts */
284 static int
285 vfio_enable_msix(const struct rte_intr_handle *intr_handle) {
286         int len, ret;
287         char irq_set_buf[MSIX_IRQ_SET_BUF_LEN];
288         struct vfio_irq_set *irq_set;
289         int *fd_ptr;
290
291         len = sizeof(irq_set_buf);
292
293         irq_set = (struct vfio_irq_set *) irq_set_buf;
294         irq_set->argsz = len;
295         /* 0 < irq_set->count < RTE_MAX_RXTX_INTR_VEC_ID + 1 */
296         irq_set->count = intr_handle->max_intr ?
297                 (intr_handle->max_intr > RTE_MAX_RXTX_INTR_VEC_ID + 1 ?
298                 RTE_MAX_RXTX_INTR_VEC_ID + 1 : intr_handle->max_intr) : 1;
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         /* INTR vector offset 0 reserve for non-efds mapping */
304         fd_ptr[RTE_INTR_VEC_ZERO_OFFSET] = intr_handle->fd;
305         memcpy(&fd_ptr[RTE_INTR_VEC_RXTX_OFFSET], intr_handle->efds,
306                 sizeof(*intr_handle->efds) * intr_handle->nb_efd);
307
308         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
309
310         if (ret) {
311                 RTE_LOG(ERR, EAL, "Error enabling MSI-X interrupts for fd %d\n",
312                                                 intr_handle->fd);
313                 return -1;
314         }
315
316         return 0;
317 }
318
319 /* disable MSI-X interrupts */
320 static int
321 vfio_disable_msix(const struct rte_intr_handle *intr_handle) {
322         struct vfio_irq_set *irq_set;
323         char irq_set_buf[MSIX_IRQ_SET_BUF_LEN];
324         int len, ret;
325
326         len = sizeof(struct vfio_irq_set);
327
328         irq_set = (struct vfio_irq_set *) irq_set_buf;
329         irq_set->argsz = len;
330         irq_set->count = 0;
331         irq_set->flags = VFIO_IRQ_SET_DATA_NONE | VFIO_IRQ_SET_ACTION_TRIGGER;
332         irq_set->index = VFIO_PCI_MSIX_IRQ_INDEX;
333         irq_set->start = 0;
334
335         ret = ioctl(intr_handle->vfio_dev_fd, VFIO_DEVICE_SET_IRQS, irq_set);
336
337         if (ret)
338                 RTE_LOG(ERR, EAL,
339                         "Error disabling MSI-X interrupts for fd %d\n", intr_handle->fd);
340
341         return ret;
342 }
343 #endif
344
345 static int
346 uio_intx_intr_disable(const struct rte_intr_handle *intr_handle)
347 {
348         unsigned char command_high;
349
350         /* use UIO config file descriptor for uio_pci_generic */
351         if (pread(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
352                 RTE_LOG(ERR, EAL,
353                         "Error reading interrupts status for fd %d\n",
354                         intr_handle->uio_cfg_fd);
355                 return -1;
356         }
357         /* disable interrupts */
358         command_high |= 0x4;
359         if (pwrite(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
360                 RTE_LOG(ERR, EAL,
361                         "Error disabling interrupts for fd %d\n",
362                         intr_handle->uio_cfg_fd);
363                 return -1;
364         }
365
366         return 0;
367 }
368
369 static int
370 uio_intx_intr_enable(const struct rte_intr_handle *intr_handle)
371 {
372         unsigned char command_high;
373
374         /* use UIO config file descriptor for uio_pci_generic */
375         if (pread(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
376                 RTE_LOG(ERR, EAL,
377                         "Error reading interrupts status for fd %d\n",
378                         intr_handle->uio_cfg_fd);
379                 return -1;
380         }
381         /* enable interrupts */
382         command_high &= ~0x4;
383         if (pwrite(intr_handle->uio_cfg_fd, &command_high, 1, 5) != 1) {
384                 RTE_LOG(ERR, EAL,
385                         "Error enabling interrupts for fd %d\n",
386                         intr_handle->uio_cfg_fd);
387                 return -1;
388         }
389
390         return 0;
391 }
392
393 static int
394 uio_intr_disable(const struct rte_intr_handle *intr_handle)
395 {
396         const int value = 0;
397
398         if (write(intr_handle->fd, &value, sizeof(value)) < 0) {
399                 RTE_LOG(ERR, EAL,
400                         "Error disabling interrupts for fd %d (%s)\n",
401                         intr_handle->fd, strerror(errno));
402                 return -1;
403         }
404         return 0;
405 }
406
407 static int
408 uio_intr_enable(const struct rte_intr_handle *intr_handle)
409 {
410         const int value = 1;
411
412         if (write(intr_handle->fd, &value, sizeof(value)) < 0) {
413                 RTE_LOG(ERR, EAL,
414                         "Error enabling interrupts for fd %d (%s)\n",
415                         intr_handle->fd, strerror(errno));
416                 return -1;
417         }
418         return 0;
419 }
420
421 int
422 rte_intr_callback_register(const struct rte_intr_handle *intr_handle,
423                         rte_intr_callback_fn cb, void *cb_arg)
424 {
425         int ret, wake_thread;
426         struct rte_intr_source *src;
427         struct rte_intr_callback *callback;
428
429         wake_thread = 0;
430
431         /* first do parameter checking */
432         if (intr_handle == NULL || intr_handle->fd < 0 || cb == NULL) {
433                 RTE_LOG(ERR, EAL,
434                         "Registering with invalid input parameter\n");
435                 return -EINVAL;
436         }
437
438         /* allocate a new interrupt callback entity */
439         callback = rte_zmalloc("interrupt callback list",
440                                 sizeof(*callback), 0);
441         if (callback == NULL) {
442                 RTE_LOG(ERR, EAL, "Can not allocate memory\n");
443                 return -ENOMEM;
444         }
445         callback->cb_fn = cb;
446         callback->cb_arg = cb_arg;
447
448         rte_spinlock_lock(&intr_lock);
449
450         /* check if there is at least one callback registered for the fd */
451         TAILQ_FOREACH(src, &intr_sources, next) {
452                 if (src->intr_handle.fd == intr_handle->fd) {
453                         /* we had no interrupts for this */
454                         if TAILQ_EMPTY(&src->callbacks)
455                                 wake_thread = 1;
456
457                         TAILQ_INSERT_TAIL(&(src->callbacks), callback, next);
458                         ret = 0;
459                         break;
460                 }
461         }
462
463         /* no existing callbacks for this - add new source */
464         if (src == NULL) {
465                 if ((src = rte_zmalloc("interrupt source list",
466                                 sizeof(*src), 0)) == NULL) {
467                         RTE_LOG(ERR, EAL, "Can not allocate memory\n");
468                         rte_free(callback);
469                         ret = -ENOMEM;
470                 } else {
471                         src->intr_handle = *intr_handle;
472                         TAILQ_INIT(&src->callbacks);
473                         TAILQ_INSERT_TAIL(&(src->callbacks), callback, next);
474                         TAILQ_INSERT_TAIL(&intr_sources, src, next);
475                         wake_thread = 1;
476                         ret = 0;
477                 }
478         }
479
480         rte_spinlock_unlock(&intr_lock);
481
482         /**
483          * check if need to notify the pipe fd waited by epoll_wait to
484          * rebuild the wait list.
485          */
486         if (wake_thread)
487                 if (write(intr_pipe.writefd, "1", 1) < 0)
488                         return -EPIPE;
489
490         return ret;
491 }
492
493 int
494 rte_intr_callback_unregister(const struct rte_intr_handle *intr_handle,
495                         rte_intr_callback_fn cb_fn, void *cb_arg)
496 {
497         int ret;
498         struct rte_intr_source *src;
499         struct rte_intr_callback *cb, *next;
500
501         /* do parameter checking first */
502         if (intr_handle == NULL || intr_handle->fd < 0) {
503                 RTE_LOG(ERR, EAL,
504                 "Unregistering with invalid input parameter\n");
505                 return -EINVAL;
506         }
507
508         rte_spinlock_lock(&intr_lock);
509
510         /* check if the insterrupt source for the fd is existent */
511         TAILQ_FOREACH(src, &intr_sources, next)
512                 if (src->intr_handle.fd == intr_handle->fd)
513                         break;
514
515         /* No interrupt source registered for the fd */
516         if (src == NULL) {
517                 ret = -ENOENT;
518
519         /* interrupt source has some active callbacks right now. */
520         } else if (src->active != 0) {
521                 ret = -EAGAIN;
522
523         /* ok to remove. */
524         } else {
525                 ret = 0;
526
527                 /*walk through the callbacks and remove all that match. */
528                 for (cb = TAILQ_FIRST(&src->callbacks); cb != NULL; cb = next) {
529
530                         next = TAILQ_NEXT(cb, next);
531
532                         if (cb->cb_fn == cb_fn && (cb_arg == (void *)-1 ||
533                                         cb->cb_arg == cb_arg)) {
534                                 TAILQ_REMOVE(&src->callbacks, cb, next);
535                                 rte_free(cb);
536                                 ret++;
537                         }
538                 }
539
540                 /* all callbacks for that source are removed. */
541                 if (TAILQ_EMPTY(&src->callbacks)) {
542                         TAILQ_REMOVE(&intr_sources, src, next);
543                         rte_free(src);
544                 }
545         }
546
547         rte_spinlock_unlock(&intr_lock);
548
549         /* notify the pipe fd waited by epoll_wait to rebuild the wait list */
550         if (ret >= 0 && write(intr_pipe.writefd, "1", 1) < 0) {
551                 ret = -EPIPE;
552         }
553
554         return ret;
555 }
556
557 int
558 rte_intr_enable(const struct rte_intr_handle *intr_handle)
559 {
560         if (intr_handle && intr_handle->type == RTE_INTR_HANDLE_VDEV)
561                 return 0;
562
563         if (!intr_handle || intr_handle->fd < 0 || intr_handle->uio_cfg_fd < 0)
564                 return -1;
565
566         switch (intr_handle->type){
567         /* write to the uio fd to enable the interrupt */
568         case RTE_INTR_HANDLE_UIO:
569                 if (uio_intr_enable(intr_handle))
570                         return -1;
571                 break;
572         case RTE_INTR_HANDLE_UIO_INTX:
573                 if (uio_intx_intr_enable(intr_handle))
574                         return -1;
575                 break;
576         /* not used at this moment */
577         case RTE_INTR_HANDLE_ALARM:
578                 return -1;
579 #ifdef VFIO_PRESENT
580         case RTE_INTR_HANDLE_VFIO_MSIX:
581                 if (vfio_enable_msix(intr_handle))
582                         return -1;
583                 break;
584         case RTE_INTR_HANDLE_VFIO_MSI:
585                 if (vfio_enable_msi(intr_handle))
586                         return -1;
587                 break;
588         case RTE_INTR_HANDLE_VFIO_LEGACY:
589                 if (vfio_enable_intx(intr_handle))
590                         return -1;
591                 break;
592 #endif
593         /* unknown handle type */
594         default:
595                 RTE_LOG(ERR, EAL,
596                         "Unknown handle type of fd %d\n",
597                                         intr_handle->fd);
598                 return -1;
599         }
600
601         return 0;
602 }
603
604 int
605 rte_intr_disable(const struct rte_intr_handle *intr_handle)
606 {
607         if (intr_handle && intr_handle->type == RTE_INTR_HANDLE_VDEV)
608                 return 0;
609
610         if (!intr_handle || intr_handle->fd < 0 || intr_handle->uio_cfg_fd < 0)
611                 return -1;
612
613         switch (intr_handle->type){
614         /* write to the uio fd to disable the interrupt */
615         case RTE_INTR_HANDLE_UIO:
616                 if (uio_intr_disable(intr_handle))
617                         return -1;
618                 break;
619         case RTE_INTR_HANDLE_UIO_INTX:
620                 if (uio_intx_intr_disable(intr_handle))
621                         return -1;
622                 break;
623         /* not used at this moment */
624         case RTE_INTR_HANDLE_ALARM:
625                 return -1;
626 #ifdef VFIO_PRESENT
627         case RTE_INTR_HANDLE_VFIO_MSIX:
628                 if (vfio_disable_msix(intr_handle))
629                         return -1;
630                 break;
631         case RTE_INTR_HANDLE_VFIO_MSI:
632                 if (vfio_disable_msi(intr_handle))
633                         return -1;
634                 break;
635         case RTE_INTR_HANDLE_VFIO_LEGACY:
636                 if (vfio_disable_intx(intr_handle))
637                         return -1;
638                 break;
639 #endif
640         /* unknown handle type */
641         default:
642                 RTE_LOG(ERR, EAL,
643                         "Unknown handle type of fd %d\n",
644                                         intr_handle->fd);
645                 return -1;
646         }
647
648         return 0;
649 }
650
651 static int
652 eal_intr_process_interrupts(struct epoll_event *events, int nfds)
653 {
654         bool call = false;
655         int n, bytes_read;
656         struct rte_intr_source *src;
657         struct rte_intr_callback *cb;
658         union rte_intr_read_buffer buf;
659         struct rte_intr_callback active_cb;
660
661         for (n = 0; n < nfds; n++) {
662
663                 /**
664                  * if the pipe fd is ready to read, return out to
665                  * rebuild the wait list.
666                  */
667                 if (events[n].data.fd == intr_pipe.readfd){
668                         int r = read(intr_pipe.readfd, buf.charbuf,
669                                         sizeof(buf.charbuf));
670                         RTE_SET_USED(r);
671                         return -1;
672                 }
673                 rte_spinlock_lock(&intr_lock);
674                 TAILQ_FOREACH(src, &intr_sources, next)
675                         if (src->intr_handle.fd ==
676                                         events[n].data.fd)
677                                 break;
678                 if (src == NULL){
679                         rte_spinlock_unlock(&intr_lock);
680                         continue;
681                 }
682
683                 /* mark this interrupt source as active and release the lock. */
684                 src->active = 1;
685                 rte_spinlock_unlock(&intr_lock);
686
687                 /* set the length to be read dor different handle type */
688                 switch (src->intr_handle.type) {
689                 case RTE_INTR_HANDLE_UIO:
690                 case RTE_INTR_HANDLE_UIO_INTX:
691                         bytes_read = sizeof(buf.uio_intr_count);
692                         break;
693                 case RTE_INTR_HANDLE_ALARM:
694                         bytes_read = sizeof(buf.timerfd_num);
695                         break;
696 #ifdef VFIO_PRESENT
697                 case RTE_INTR_HANDLE_VFIO_MSIX:
698                 case RTE_INTR_HANDLE_VFIO_MSI:
699                 case RTE_INTR_HANDLE_VFIO_LEGACY:
700                         bytes_read = sizeof(buf.vfio_intr_count);
701                         break;
702 #endif
703                 case RTE_INTR_HANDLE_VDEV:
704                 case RTE_INTR_HANDLE_EXT:
705                         bytes_read = 0;
706                         call = true;
707                         break;
708
709                 default:
710                         bytes_read = 1;
711                         break;
712                 }
713
714                 if (bytes_read > 0) {
715                         /**
716                          * read out to clear the ready-to-be-read flag
717                          * for epoll_wait.
718                          */
719                         bytes_read = read(events[n].data.fd, &buf, bytes_read);
720                         if (bytes_read < 0) {
721                                 if (errno == EINTR || errno == EWOULDBLOCK)
722                                         continue;
723
724                                 RTE_LOG(ERR, EAL, "Error reading from file "
725                                         "descriptor %d: %s\n",
726                                         events[n].data.fd,
727                                         strerror(errno));
728                         } else if (bytes_read == 0)
729                                 RTE_LOG(ERR, EAL, "Read nothing from file "
730                                         "descriptor %d\n", events[n].data.fd);
731                         else
732                                 call = true;
733                 }
734
735                 /* grab a lock, again to call callbacks and update status. */
736                 rte_spinlock_lock(&intr_lock);
737
738                 if (call) {
739
740                         /* Finally, call all callbacks. */
741                         TAILQ_FOREACH(cb, &src->callbacks, next) {
742
743                                 /* make a copy and unlock. */
744                                 active_cb = *cb;
745                                 rte_spinlock_unlock(&intr_lock);
746
747                                 /* call the actual callback */
748                                 active_cb.cb_fn(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 }