GNU Linux-libre 4.19.286-gnu1
[releases.git] / arch / um / kernel / irq.c
1 /*
2  * Copyright (C) 2017 - Cambridge Greys Ltd
3  * Copyright (C) 2011 - 2014 Cisco Systems Inc
4  * Copyright (C) 2000 - 2007 Jeff Dike (jdike@{addtoit,linux.intel}.com)
5  * Licensed under the GPL
6  * Derived (i.e. mostly copied) from arch/i386/kernel/irq.c:
7  *      Copyright (C) 1992, 1998 Linus Torvalds, Ingo Molnar
8  */
9
10 #include <linux/cpumask.h>
11 #include <linux/hardirq.h>
12 #include <linux/interrupt.h>
13 #include <linux/kernel_stat.h>
14 #include <linux/module.h>
15 #include <linux/sched.h>
16 #include <linux/seq_file.h>
17 #include <linux/slab.h>
18 #include <as-layout.h>
19 #include <kern_util.h>
20 #include <os.h>
21 #include <irq_user.h>
22
23
24 extern void free_irqs(void);
25
26 /* When epoll triggers we do not know why it did so
27  * we can also have different IRQs for read and write.
28  * This is why we keep a small irq_fd array for each fd -
29  * one entry per IRQ type
30  */
31
32 struct irq_entry {
33         struct irq_entry *next;
34         int fd;
35         struct irq_fd *irq_array[MAX_IRQ_TYPE + 1];
36 };
37
38 static struct irq_entry *active_fds;
39
40 static DEFINE_SPINLOCK(irq_lock);
41
42 static void irq_io_loop(struct irq_fd *irq, struct uml_pt_regs *regs)
43 {
44 /*
45  * irq->active guards against reentry
46  * irq->pending accumulates pending requests
47  * if pending is raised the irq_handler is re-run
48  * until pending is cleared
49  */
50         if (irq->active) {
51                 irq->active = false;
52                 do {
53                         irq->pending = false;
54                         do_IRQ(irq->irq, regs);
55                 } while (irq->pending && (!irq->purge));
56                 if (!irq->purge)
57                         irq->active = true;
58         } else {
59                 irq->pending = true;
60         }
61 }
62
63 void sigio_handler(int sig, struct siginfo *unused_si, struct uml_pt_regs *regs)
64 {
65         struct irq_entry *irq_entry;
66         struct irq_fd *irq;
67
68         int n, i, j;
69
70         while (1) {
71                 /* This is now lockless - epoll keeps back-referencesto the irqs
72                  * which have trigger it so there is no need to walk the irq
73                  * list and lock it every time. We avoid locking by turning off
74                  * IO for a specific fd by executing os_del_epoll_fd(fd) before
75                  * we do any changes to the actual data structures
76                  */
77                 n = os_waiting_for_events_epoll();
78
79                 if (n <= 0) {
80                         if (n == -EINTR)
81                                 continue;
82                         else
83                                 break;
84                 }
85
86                 for (i = 0; i < n ; i++) {
87                         /* Epoll back reference is the entry with 3 irq_fd
88                          * leaves - one for each irq type.
89                          */
90                         irq_entry = (struct irq_entry *)
91                                 os_epoll_get_data_pointer(i);
92                         for (j = 0; j < MAX_IRQ_TYPE ; j++) {
93                                 irq = irq_entry->irq_array[j];
94                                 if (irq == NULL)
95                                         continue;
96                                 if (os_epoll_triggered(i, irq->events) > 0)
97                                         irq_io_loop(irq, regs);
98                                 if (irq->purge) {
99                                         irq_entry->irq_array[j] = NULL;
100                                         kfree(irq);
101                                 }
102                         }
103                 }
104         }
105
106         free_irqs();
107 }
108
109 static int assign_epoll_events_to_irq(struct irq_entry *irq_entry)
110 {
111         int i;
112         int events = 0;
113         struct irq_fd *irq;
114
115         for (i = 0; i < MAX_IRQ_TYPE ; i++) {
116                 irq = irq_entry->irq_array[i];
117                 if (irq != NULL)
118                         events = irq->events | events;
119         }
120         if (events > 0) {
121         /* os_add_epoll will call os_mod_epoll if this already exists */
122                 return os_add_epoll_fd(events, irq_entry->fd, irq_entry);
123         }
124         /* No events - delete */
125         return os_del_epoll_fd(irq_entry->fd);
126 }
127
128
129
130 static int activate_fd(int irq, int fd, int type, void *dev_id)
131 {
132         struct irq_fd *new_fd;
133         struct irq_entry *irq_entry;
134         int i, err, events;
135         unsigned long flags;
136
137         err = os_set_fd_async(fd);
138         if (err < 0)
139                 goto out;
140
141         spin_lock_irqsave(&irq_lock, flags);
142
143         /* Check if we have an entry for this fd */
144
145         err = -EBUSY;
146         for (irq_entry = active_fds;
147                 irq_entry != NULL; irq_entry = irq_entry->next) {
148                 if (irq_entry->fd == fd)
149                         break;
150         }
151
152         if (irq_entry == NULL) {
153                 /* This needs to be atomic as it may be called from an
154                  * IRQ context.
155                  */
156                 irq_entry = kmalloc(sizeof(struct irq_entry), GFP_ATOMIC);
157                 if (irq_entry == NULL) {
158                         printk(KERN_ERR
159                                 "Failed to allocate new IRQ entry\n");
160                         goto out_unlock;
161                 }
162                 irq_entry->fd = fd;
163                 for (i = 0; i < MAX_IRQ_TYPE; i++)
164                         irq_entry->irq_array[i] = NULL;
165                 irq_entry->next = active_fds;
166                 active_fds = irq_entry;
167         }
168
169         /* Check if we are trying to re-register an interrupt for a
170          * particular fd
171          */
172
173         if (irq_entry->irq_array[type] != NULL) {
174                 printk(KERN_ERR
175                         "Trying to reregister IRQ %d FD %d TYPE %d ID %p\n",
176                         irq, fd, type, dev_id
177                 );
178                 goto out_unlock;
179         } else {
180                 /* New entry for this fd */
181
182                 err = -ENOMEM;
183                 new_fd = kmalloc(sizeof(struct irq_fd), GFP_ATOMIC);
184                 if (new_fd == NULL)
185                         goto out_unlock;
186
187                 events = os_event_mask(type);
188
189                 *new_fd = ((struct irq_fd) {
190                         .id             = dev_id,
191                         .irq            = irq,
192                         .type           = type,
193                         .events         = events,
194                         .active         = true,
195                         .pending        = false,
196                         .purge          = false
197                 });
198                 /* Turn off any IO on this fd - allows us to
199                  * avoid locking the IRQ loop
200                  */
201                 os_del_epoll_fd(irq_entry->fd);
202                 irq_entry->irq_array[type] = new_fd;
203         }
204
205         /* Turn back IO on with the correct (new) IO event mask */
206         assign_epoll_events_to_irq(irq_entry);
207         spin_unlock_irqrestore(&irq_lock, flags);
208         maybe_sigio_broken(fd, (type != IRQ_NONE));
209
210         return 0;
211 out_unlock:
212         spin_unlock_irqrestore(&irq_lock, flags);
213 out:
214         return err;
215 }
216
217 /*
218  * Walk the IRQ list and dispose of any unused entries.
219  * Should be done under irq_lock.
220  */
221
222 static void garbage_collect_irq_entries(void)
223 {
224         int i;
225         bool reap;
226         struct irq_entry *walk;
227         struct irq_entry *previous = NULL;
228         struct irq_entry *to_free;
229
230         if (active_fds == NULL)
231                 return;
232         walk = active_fds;
233         while (walk != NULL) {
234                 reap = true;
235                 for (i = 0; i < MAX_IRQ_TYPE ; i++) {
236                         if (walk->irq_array[i] != NULL) {
237                                 reap = false;
238                                 break;
239                         }
240                 }
241                 if (reap) {
242                         if (previous == NULL)
243                                 active_fds = walk->next;
244                         else
245                                 previous->next = walk->next;
246                         to_free = walk;
247                 } else {
248                         to_free = NULL;
249                 }
250                 walk = walk->next;
251                 if (to_free != NULL)
252                         kfree(to_free);
253         }
254 }
255
256 /*
257  * Walk the IRQ list and get the descriptor for our FD
258  */
259
260 static struct irq_entry *get_irq_entry_by_fd(int fd)
261 {
262         struct irq_entry *walk = active_fds;
263
264         while (walk != NULL) {
265                 if (walk->fd == fd)
266                         return walk;
267                 walk = walk->next;
268         }
269         return NULL;
270 }
271
272
273 /*
274  * Walk the IRQ list and dispose of an entry for a specific
275  * device, fd and number. Note - if sharing an IRQ for read
276  * and writefor the same FD it will be disposed in either case.
277  * If this behaviour is undesirable use different IRQ ids.
278  */
279
280 #define IGNORE_IRQ 1
281 #define IGNORE_DEV (1<<1)
282
283 static void do_free_by_irq_and_dev(
284         struct irq_entry *irq_entry,
285         unsigned int irq,
286         void *dev,
287         int flags
288 )
289 {
290         int i;
291         struct irq_fd *to_free;
292
293         for (i = 0; i < MAX_IRQ_TYPE ; i++) {
294                 if (irq_entry->irq_array[i] != NULL) {
295                         if (
296                         ((flags & IGNORE_IRQ) ||
297                                 (irq_entry->irq_array[i]->irq == irq)) &&
298                         ((flags & IGNORE_DEV) ||
299                                 (irq_entry->irq_array[i]->id == dev))
300                         ) {
301                                 /* Turn off any IO on this fd - allows us to
302                                  * avoid locking the IRQ loop
303                                  */
304                                 os_del_epoll_fd(irq_entry->fd);
305                                 to_free = irq_entry->irq_array[i];
306                                 irq_entry->irq_array[i] = NULL;
307                                 assign_epoll_events_to_irq(irq_entry);
308                                 if (to_free->active)
309                                         to_free->purge = true;
310                                 else
311                                         kfree(to_free);
312                         }
313                 }
314         }
315 }
316
317 void free_irq_by_fd(int fd)
318 {
319         struct irq_entry *to_free;
320         unsigned long flags;
321
322         spin_lock_irqsave(&irq_lock, flags);
323         to_free = get_irq_entry_by_fd(fd);
324         if (to_free != NULL) {
325                 do_free_by_irq_and_dev(
326                         to_free,
327                         -1,
328                         NULL,
329                         IGNORE_IRQ | IGNORE_DEV
330                 );
331         }
332         garbage_collect_irq_entries();
333         spin_unlock_irqrestore(&irq_lock, flags);
334 }
335 EXPORT_SYMBOL(free_irq_by_fd);
336
337 static void free_irq_by_irq_and_dev(unsigned int irq, void *dev)
338 {
339         struct irq_entry *to_free;
340         unsigned long flags;
341
342         spin_lock_irqsave(&irq_lock, flags);
343         to_free = active_fds;
344         while (to_free != NULL) {
345                 do_free_by_irq_and_dev(
346                         to_free,
347                         irq,
348                         dev,
349                         0
350                 );
351                 to_free = to_free->next;
352         }
353         garbage_collect_irq_entries();
354         spin_unlock_irqrestore(&irq_lock, flags);
355 }
356
357
358 void reactivate_fd(int fd, int irqnum)
359 {
360         /** NOP - we do auto-EOI now **/
361 }
362
363 void deactivate_fd(int fd, int irqnum)
364 {
365         struct irq_entry *to_free;
366         unsigned long flags;
367
368         os_del_epoll_fd(fd);
369         spin_lock_irqsave(&irq_lock, flags);
370         to_free = get_irq_entry_by_fd(fd);
371         if (to_free != NULL) {
372                 do_free_by_irq_and_dev(
373                         to_free,
374                         irqnum,
375                         NULL,
376                         IGNORE_DEV
377                 );
378         }
379         garbage_collect_irq_entries();
380         spin_unlock_irqrestore(&irq_lock, flags);
381         ignore_sigio_fd(fd);
382 }
383 EXPORT_SYMBOL(deactivate_fd);
384
385 /*
386  * Called just before shutdown in order to provide a clean exec
387  * environment in case the system is rebooting.  No locking because
388  * that would cause a pointless shutdown hang if something hadn't
389  * released the lock.
390  */
391 int deactivate_all_fds(void)
392 {
393         unsigned long flags;
394         struct irq_entry *to_free;
395
396         spin_lock_irqsave(&irq_lock, flags);
397         /* Stop IO. The IRQ loop has no lock so this is our
398          * only way of making sure we are safe to dispose
399          * of all IRQ handlers
400          */
401         os_set_ioignore();
402         to_free = active_fds;
403         while (to_free != NULL) {
404                 do_free_by_irq_and_dev(
405                         to_free,
406                         -1,
407                         NULL,
408                         IGNORE_IRQ | IGNORE_DEV
409                 );
410                 to_free = to_free->next;
411         }
412         garbage_collect_irq_entries();
413         spin_unlock_irqrestore(&irq_lock, flags);
414         os_close_epoll_fd();
415         return 0;
416 }
417
418 /*
419  * do_IRQ handles all normal device IRQs (the special
420  * SMP cross-CPU interrupts have their own specific
421  * handlers).
422  */
423 unsigned int do_IRQ(int irq, struct uml_pt_regs *regs)
424 {
425         struct pt_regs *old_regs = set_irq_regs((struct pt_regs *)regs);
426         irq_enter();
427         generic_handle_irq(irq);
428         irq_exit();
429         set_irq_regs(old_regs);
430         return 1;
431 }
432
433 void um_free_irq(unsigned int irq, void *dev)
434 {
435         free_irq_by_irq_and_dev(irq, dev);
436         free_irq(irq, dev);
437 }
438 EXPORT_SYMBOL(um_free_irq);
439
440 int um_request_irq(unsigned int irq, int fd, int type,
441                    irq_handler_t handler,
442                    unsigned long irqflags, const char * devname,
443                    void *dev_id)
444 {
445         int err;
446
447         if (fd != -1) {
448                 err = activate_fd(irq, fd, type, dev_id);
449                 if (err)
450                         return err;
451         }
452
453         return request_irq(irq, handler, irqflags, devname, dev_id);
454 }
455
456 EXPORT_SYMBOL(um_request_irq);
457 EXPORT_SYMBOL(reactivate_fd);
458
459 /*
460  * irq_chip must define at least enable/disable and ack when
461  * the edge handler is used.
462  */
463 static void dummy(struct irq_data *d)
464 {
465 }
466
467 /* This is used for everything else than the timer. */
468 static struct irq_chip normal_irq_type = {
469         .name = "SIGIO",
470         .irq_disable = dummy,
471         .irq_enable = dummy,
472         .irq_ack = dummy,
473         .irq_mask = dummy,
474         .irq_unmask = dummy,
475 };
476
477 static struct irq_chip SIGVTALRM_irq_type = {
478         .name = "SIGVTALRM",
479         .irq_disable = dummy,
480         .irq_enable = dummy,
481         .irq_ack = dummy,
482         .irq_mask = dummy,
483         .irq_unmask = dummy,
484 };
485
486 void __init init_IRQ(void)
487 {
488         int i;
489
490         irq_set_chip_and_handler(TIMER_IRQ, &SIGVTALRM_irq_type, handle_edge_irq);
491
492
493         for (i = 1; i < NR_IRQS; i++)
494                 irq_set_chip_and_handler(i, &normal_irq_type, handle_edge_irq);
495         /* Initialize EPOLL Loop */
496         os_setup_epoll();
497 }
498
499 /*
500  * IRQ stack entry and exit:
501  *
502  * Unlike i386, UML doesn't receive IRQs on the normal kernel stack
503  * and switch over to the IRQ stack after some preparation.  We use
504  * sigaltstack to receive signals on a separate stack from the start.
505  * These two functions make sure the rest of the kernel won't be too
506  * upset by being on a different stack.  The IRQ stack has a
507  * thread_info structure at the bottom so that current et al continue
508  * to work.
509  *
510  * to_irq_stack copies the current task's thread_info to the IRQ stack
511  * thread_info and sets the tasks's stack to point to the IRQ stack.
512  *
513  * from_irq_stack copies the thread_info struct back (flags may have
514  * been modified) and resets the task's stack pointer.
515  *
516  * Tricky bits -
517  *
518  * What happens when two signals race each other?  UML doesn't block
519  * signals with sigprocmask, SA_DEFER, or sa_mask, so a second signal
520  * could arrive while a previous one is still setting up the
521  * thread_info.
522  *
523  * There are three cases -
524  *     The first interrupt on the stack - sets up the thread_info and
525  * handles the interrupt
526  *     A nested interrupt interrupting the copying of the thread_info -
527  * can't handle the interrupt, as the stack is in an unknown state
528  *     A nested interrupt not interrupting the copying of the
529  * thread_info - doesn't do any setup, just handles the interrupt
530  *
531  * The first job is to figure out whether we interrupted stack setup.
532  * This is done by xchging the signal mask with thread_info->pending.
533  * If the value that comes back is zero, then there is no setup in
534  * progress, and the interrupt can be handled.  If the value is
535  * non-zero, then there is stack setup in progress.  In order to have
536  * the interrupt handled, we leave our signal in the mask, and it will
537  * be handled by the upper handler after it has set up the stack.
538  *
539  * Next is to figure out whether we are the outer handler or a nested
540  * one.  As part of setting up the stack, thread_info->real_thread is
541  * set to non-NULL (and is reset to NULL on exit).  This is the
542  * nesting indicator.  If it is non-NULL, then the stack is already
543  * set up and the handler can run.
544  */
545
546 static unsigned long pending_mask;
547
548 unsigned long to_irq_stack(unsigned long *mask_out)
549 {
550         struct thread_info *ti;
551         unsigned long mask, old;
552         int nested;
553
554         mask = xchg(&pending_mask, *mask_out);
555         if (mask != 0) {
556                 /*
557                  * If any interrupts come in at this point, we want to
558                  * make sure that their bits aren't lost by our
559                  * putting our bit in.  So, this loop accumulates bits
560                  * until xchg returns the same value that we put in.
561                  * When that happens, there were no new interrupts,
562                  * and pending_mask contains a bit for each interrupt
563                  * that came in.
564                  */
565                 old = *mask_out;
566                 do {
567                         old |= mask;
568                         mask = xchg(&pending_mask, old);
569                 } while (mask != old);
570                 return 1;
571         }
572
573         ti = current_thread_info();
574         nested = (ti->real_thread != NULL);
575         if (!nested) {
576                 struct task_struct *task;
577                 struct thread_info *tti;
578
579                 task = cpu_tasks[ti->cpu].task;
580                 tti = task_thread_info(task);
581
582                 *ti = *tti;
583                 ti->real_thread = tti;
584                 task->stack = ti;
585         }
586
587         mask = xchg(&pending_mask, 0);
588         *mask_out |= mask | nested;
589         return 0;
590 }
591
592 unsigned long from_irq_stack(int nested)
593 {
594         struct thread_info *ti, *to;
595         unsigned long mask;
596
597         ti = current_thread_info();
598
599         pending_mask = 1;
600
601         to = ti->real_thread;
602         current->stack = to;
603         ti->real_thread = NULL;
604         *to = *ti;
605
606         mask = xchg(&pending_mask, 0);
607         return mask & ~1;
608 }
609