sys/kern/kern_intr.c

   1 /*
   2  * Copyright (c) 2003 Matthew Dillon <dillon@backplane.com> All rights reserved.
   3  * Copyright (c) 1997, Stefan Esser <se@freebsd.org> All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/kern/kern_intr.c,v 1.24.2.1 2001/10/14 20:05:50 luigi Exp $
  27  * $DragonFly: src/sys/kern/kern_intr.c,v 1.55 2008/09/01 12:49:00 sephe Exp $
  28  *
  29  */
  30
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/malloc.h>
  34 #include <sys/kernel.h>
  35 #include <sys/sysctl.h>
  36 #include <sys/thread.h>
  37 #include <sys/proc.h>
  38 #include <sys/random.h>
  39 #include <sys/serialize.h>
  40 #include <sys/interrupt.h>
  41 #include <sys/bus.h>
  42 #include <sys/machintr.h>
  43
  44 #include <machine/frame.h>
  45
  46 #include <sys/interrupt.h>
  47
  48 #include <sys/thread2.h>
  49 #include <sys/mplock2.h>
  50
  51 struct info_info;
  52
  53 typedef struct intrec {
  54     struct intrec *next;
  55     struct intr_info *info;
  56     inthand2_t  *handler;
  57     void        *argument;
  58     char        *name;
  59     int         intr;
  60     int         intr_flags;
  61     struct lwkt_serialize *serializer;
  62 } *intrec_t;
  63
  64 struct intr_info {
  65         intrec_t        i_reclist;
  66         struct thread   i_thread;
  67         struct random_softc i_random;
  68         int             i_running;
  69         long            i_count;        /* interrupts dispatched */
  70         int             i_mplock_required;
  71         int             i_fast;
  72         int             i_slow;
  73         int             i_state;
  74         int             i_errorticks;
  75         unsigned long   i_straycount;
  76 } intr_info_ary[MAX_INTS];
  77
  78 int max_installed_hard_intr;
  79 int max_installed_soft_intr;
  80
  81 #define EMERGENCY_INTR_POLLING_FREQ_MAX 20000
  82
  83 /*
  84  * Assert that callers into interrupt handlers don't return with
  85  * dangling tokens, spinlocks, or mp locks.
  86  */
  87 #ifdef INVARIANTS
  88 # ifdef SMP
  89 /* INVARIANTS & SMP */
  90 #  define SMP_INVARIANTS_DECLARE                                \
  91         int mpcount;
  92
  93 #  define SMP_INVARIANTS_GET(td)                                \
  94         mpcount = (td)->td_mpcount
  95
  96 #  define SMP_INVARIANTS_TEST(td, name)                         \
  97         KASSERT(mpcount == (td)->td_mpcount,                    \
  98                 ("mpcount mismatch after interrupt handler %s", \
  99                  name))
 100
 101 #  define SMP_INVARIANTS_ADJMP(count)                           \
 102         mpcount += (count)
 103
 104 # else
 105 /* INVARIANTS & !SMP */
 106 #  define SMP_INVARIANTS_DECLARE
 107 #  define SMP_INVARIANTS_GET(td)
 108 #  define SMP_INVARIANTS_TEST(td, name)
 109
 110 # endif /* ndef SMP */
 111
 112 #define TD_INVARIANTS_DECLARE   \
 113         SMP_INVARIANTS_DECLARE  \
 114         int spincount;          \
 115         lwkt_tokref_t curstop
 116
 117 #define TD_INVARIANTS_GET(td)                                   \
 118         do {                                                    \
 119                 SMP_INVARIANTS_GET(td);                         \
 120                 spincount = (td)->td_gd->gd_spinlocks_wr;       \
 121                 curstop = (td)->td_toks_stop;                   \
 122         } while(0)
 123
 124 #define TD_INVARIANTS_TEST(td, name)                                    \
 125         do {                                                            \
 126                 KASSERT(spincount == (td)->td_gd->gd_spinlocks_wr,      \
 127                         ("spincount mismatch after interrupt handler %s", \
 128                         name));                                         \
 129                 KASSERT(curstop == (td)->td_toks_stop,                  \
 130                         ("token count mismatch after interrupt handler %s", \
 131                         name));                                         \
 132                 SMP_INVARIANTS_TEST(td, name);                          \
 133         } while(0)
 134
 135 #else
 136 /* !INVARIANTS */
 137 # ifdef SMP
 138 /* !INVARIANTS & SMP */
 139 # define SMP_INVARIANTS_ADJMP(count)
 140
 141 # endif
 142
 143 #define TD_INVARIANTS_DECLARE
 144 #define TD_INVARIANTS_GET(td)
 145 #define TD_INVARIANTS_TEST(td, name)
 146
 147 #endif /* ndef INVARIANTS */
 148
 149 static int sysctl_emergency_freq(SYSCTL_HANDLER_ARGS);
 150 static int sysctl_emergency_enable(SYSCTL_HANDLER_ARGS);
 151 static void emergency_intr_timer_callback(systimer_t, struct intrframe *);
 152 static void ithread_handler(void *arg);
 153 static void ithread_emergency(void *arg);
 154 static void report_stray_interrupt(int intr, struct intr_info *info);
 155 static void int_moveto_destcpu(int *, int *, int);
 156 static void int_moveto_origcpu(int, int);
 157
 158 int intr_info_size = sizeof(intr_info_ary) / sizeof(intr_info_ary[0]);
 159
 160 static struct systimer emergency_intr_timer;
 161 static struct thread emergency_intr_thread;
 162
 163 #define ISTATE_NOTHREAD         0
 164 #define ISTATE_NORMAL           1
 165 #define ISTATE_LIVELOCKED       2
 166
 167 static int livelock_limit = 40000;
 168 static int livelock_lowater = 20000;
 169 static int livelock_debug = -1;
 170 SYSCTL_INT(_kern, OID_AUTO, livelock_limit,
 171         CTLFLAG_RW, &livelock_limit, 0, "Livelock interrupt rate limit");
 172 SYSCTL_INT(_kern, OID_AUTO, livelock_lowater,
 173         CTLFLAG_RW, &livelock_lowater, 0, "Livelock low-water mark restore");
 174 SYSCTL_INT(_kern, OID_AUTO, livelock_debug,
 175         CTLFLAG_RW, &livelock_debug, 0, "Livelock debug intr#");
 176
 177 static int emergency_intr_enable = 0;   /* emergency interrupt polling */
 178 TUNABLE_INT("kern.emergency_intr_enable", &emergency_intr_enable);
 179 SYSCTL_PROC(_kern, OID_AUTO, emergency_intr_enable, CTLTYPE_INT | CTLFLAG_RW,
 180         0, 0, sysctl_emergency_enable, "I", "Emergency Interrupt Poll Enable");
 181
 182 static int emergency_intr_freq = 10;    /* emergency polling frequency */
 183 TUNABLE_INT("kern.emergency_intr_freq", &emergency_intr_freq);
 184 SYSCTL_PROC(_kern, OID_AUTO, emergency_intr_freq, CTLTYPE_INT | CTLFLAG_RW,
 185         0, 0, sysctl_emergency_freq, "I", "Emergency Interrupt Poll Frequency");
 186
 187 /*
 188  * Sysctl support routines
 189  */
 190 static int
 191 sysctl_emergency_enable(SYSCTL_HANDLER_ARGS)
 192 {
 193         int error, enabled;
 194
 195         enabled = emergency_intr_enable;
 196         error = sysctl_handle_int(oidp, &enabled, 0, req);
 197         if (error || req->newptr == NULL)
 198                 return error;
 199         emergency_intr_enable = enabled;
 200         if (emergency_intr_enable) {
 201                 systimer_adjust_periodic(&emergency_intr_timer,
 202                                          emergency_intr_freq);
 203         } else {
 204                 systimer_adjust_periodic(&emergency_intr_timer, 1);
 205         }
 206         return 0;
 207 }
 208
 209 static int
 210 sysctl_emergency_freq(SYSCTL_HANDLER_ARGS)
 211 {
 212         int error, phz;
 213
 214         phz = emergency_intr_freq;
 215         error = sysctl_handle_int(oidp, &phz, 0, req);
 216         if (error || req->newptr == NULL)
 217                 return error;
 218         if (phz <= 0)
 219                 return EINVAL;
 220         else if (phz > EMERGENCY_INTR_POLLING_FREQ_MAX)
 221                 phz = EMERGENCY_INTR_POLLING_FREQ_MAX;
 222
 223         emergency_intr_freq = phz;
 224         if (emergency_intr_enable) {
 225                 systimer_adjust_periodic(&emergency_intr_timer,
 226                                          emergency_intr_freq);
 227         } else {
 228                 systimer_adjust_periodic(&emergency_intr_timer, 1);
 229         }
 230         return 0;
 231 }
 232
 233 /*
 234  * Register an SWI or INTerrupt handler.
 235  */
 236 void *
 237 register_swi(int intr, inthand2_t *handler, void *arg, const char *name,
 238                 struct lwkt_serialize *serializer)
 239 {
 240     if (intr < FIRST_SOFTINT || intr >= MAX_INTS)
 241         panic("register_swi: bad intr %d", intr);
 242     return(register_int(intr, handler, arg, name, serializer, 0));
 243 }
 244
 245 void *
 246 register_swi_mp(int intr, inthand2_t *handler, void *arg, const char *name,
 247                 struct lwkt_serialize *serializer)
 248 {
 249     if (intr < FIRST_SOFTINT || intr >= MAX_INTS)
 250         panic("register_swi: bad intr %d", intr);
 251     return(register_int(intr, handler, arg, name, serializer, INTR_MPSAFE));
 252 }
 253
 254 void *
 255 register_int(int intr, inthand2_t *handler, void *arg, const char *name,
 256                 struct lwkt_serialize *serializer, int intr_flags)
 257 {
 258     struct intr_info *info;
 259     struct intrec **list;
 260     intrec_t rec;
 261     int orig_cpuid, cpuid;
 262
 263     if (intr < 0 || intr >= MAX_INTS)
 264         panic("register_int: bad intr %d", intr);
 265     if (name == NULL)
 266         name = "???";
 267     info = &intr_info_ary[intr];
 268
 269     /*
 270      * Construct an interrupt handler record
 271      */
 272     rec = kmalloc(sizeof(struct intrec), M_DEVBUF, M_INTWAIT);
 273     rec->name = kmalloc(strlen(name) + 1, M_DEVBUF, M_INTWAIT);
 274     strcpy(rec->name, name);
 275
 276     rec->info = info;
 277     rec->handler = handler;
 278     rec->argument = arg;
 279     rec->intr = intr;
 280     rec->intr_flags = intr_flags;
 281     rec->next = NULL;
 282     rec->serializer = serializer;
 283
 284     /*
 285      * Create an emergency polling thread and set up a systimer to wake
 286      * it up.
 287      */
 288     if (emergency_intr_thread.td_kstack == NULL) {
 289         lwkt_create(ithread_emergency, NULL, NULL, &emergency_intr_thread,
 290                     TDF_STOPREQ | TDF_INTTHREAD, -1, "ithread emerg");
 291         systimer_init_periodic_nq(&emergency_intr_timer,
 292                     emergency_intr_timer_callback, &emergency_intr_thread,
 293                     (emergency_intr_enable ? emergency_intr_freq : 1));
 294     }
 295
 296     int_moveto_destcpu(&orig_cpuid, &cpuid, intr);
 297
 298     /*
 299      * Create an interrupt thread if necessary, leave it in an unscheduled
 300      * state.
 301      */
 302     if (info->i_state == ISTATE_NOTHREAD) {
 303         info->i_state = ISTATE_NORMAL;
 304         lwkt_create(ithread_handler, (void *)(intptr_t)intr, NULL,
 305                     &info->i_thread, TDF_STOPREQ | TDF_INTTHREAD, -1,
 306                     "ithread %d", intr);
 307         if (intr >= FIRST_SOFTINT)
 308             lwkt_setpri(&info->i_thread, TDPRI_SOFT_NORM);
 309         else
 310             lwkt_setpri(&info->i_thread, TDPRI_INT_MED);
 311         info->i_thread.td_preemptable = lwkt_preempt;
 312     }
 313
 314     list = &info->i_reclist;
 315
 316     /*
 317      * Keep track of how many fast and slow interrupts we have.
 318      * Set i_mplock_required if any handler in the chain requires
 319      * the MP lock to operate.
 320      */
 321     if ((intr_flags & INTR_MPSAFE) == 0)
 322         info->i_mplock_required = 1;
 323     if (intr_flags & INTR_CLOCK)
 324         ++info->i_fast;
 325     else
 326         ++info->i_slow;
 327
 328     /*
 329      * Enable random number generation keying off of this interrupt.
 330      */
 331     if ((intr_flags & INTR_NOENTROPY) == 0 && info->i_random.sc_enabled == 0) {
 332         info->i_random.sc_enabled = 1;
 333         info->i_random.sc_intr = intr;
 334     }
 335
 336     /*
 337      * Add the record to the interrupt list.
 338      */
 339     crit_enter();
 340     while (*list != NULL)
 341         list = &(*list)->next;
 342     *list = rec;
 343     crit_exit();
 344
 345     /*
 346      * Update max_installed_hard_intr to make the emergency intr poll
 347      * a bit more efficient.
 348      */
 349     if (intr < FIRST_SOFTINT) {
 350         if (max_installed_hard_intr <= intr)
 351             max_installed_hard_intr = intr + 1;
 352     } else {
 353         if (max_installed_soft_intr <= intr)
 354             max_installed_soft_intr = intr + 1;
 355     }
 356
 357     /*
 358      * Setup the machine level interrupt vector
 359      *
 360      * XXX temporary workaround for some ACPI brokedness.  ACPI installs
 361      * its interrupt too early, before the IOAPICs have been configured,
 362      * which means the IOAPIC is not enabled by the registration of the
 363      * ACPI interrupt.  Anything else sharing that IRQ will wind up not
 364      * being enabled.  Temporarily work around the problem by always
 365      * installing and enabling on every new interrupt handler, even
 366      * if one has already been setup on that irq.
 367      */
 368     if (intr < FIRST_SOFTINT /* && info->i_slow + info->i_fast == 1*/) {
 369         if (machintr_vector_setup(intr, intr_flags))
 370             kprintf("machintr_vector_setup: failed on irq %d\n", intr);
 371     }
 372
 373     int_moveto_origcpu(orig_cpuid, cpuid);
 374
 375     return(rec);
 376 }
 377
 378 void
 379 unregister_swi(void *id)
 380 {
 381     unregister_int(id);
 382 }
 383
 384 void
 385 unregister_int(void *id)
 386 {
 387     struct intr_info *info;
 388     struct intrec **list;
 389     intrec_t rec;
 390     int intr, orig_cpuid, cpuid;
 391
 392     intr = ((intrec_t)id)->intr;
 393
 394     if (intr < 0 || intr >= MAX_INTS)
 395         panic("register_int: bad intr %d", intr);
 396
 397     info = &intr_info_ary[intr];
 398
 399     int_moveto_destcpu(&orig_cpuid, &cpuid, intr);
 400
 401     /*
 402      * Remove the interrupt descriptor, adjust the descriptor count,
 403      * and teardown the machine level vector if this was the last interrupt.
 404      */
 405     crit_enter();
 406     list = &info->i_reclist;
 407     while ((rec = *list) != NULL) {
 408         if (rec == id)
 409             break;
 410         list = &rec->next;
 411     }
 412     if (rec) {
 413         intrec_t rec0;
 414
 415         *list = rec->next;
 416         if (rec->intr_flags & INTR_CLOCK)
 417             --info->i_fast;
 418         else
 419             --info->i_slow;
 420         if (intr < FIRST_SOFTINT && info->i_fast + info->i_slow == 0)
 421             machintr_vector_teardown(intr);
 422
 423         /*
 424          * Clear i_mplock_required if no handlers in the chain require the
 425          * MP lock.
 426          */
 427         for (rec0 = info->i_reclist; rec0; rec0 = rec0->next) {
 428             if ((rec0->intr_flags & INTR_MPSAFE) == 0)
 429                 break;
 430         }
 431         if (rec0 == NULL)
 432             info->i_mplock_required = 0;
 433     }
 434
 435     crit_exit();
 436
 437     int_moveto_origcpu(orig_cpuid, cpuid);
 438
 439     /*
 440      * Free the record.
 441      */
 442     if (rec != NULL) {
 443         kfree(rec->name, M_DEVBUF);
 444         kfree(rec, M_DEVBUF);
 445     } else {
 446         kprintf("warning: unregister_int: int %d handler for %s not found\n",
 447                 intr, ((intrec_t)id)->name);
 448     }
 449 }
 450
 451 const char *
 452 get_registered_name(int intr)
 453 {
 454     intrec_t rec;
 455
 456     if (intr < 0 || intr >= MAX_INTS)
 457         panic("register_int: bad intr %d", intr);
 458
 459     if ((rec = intr_info_ary[intr].i_reclist) == NULL)
 460         return(NULL);
 461     else if (rec->next)
 462         return("mux");
 463     else
 464         return(rec->name);
 465 }
 466
 467 int
 468 count_registered_ints(int intr)
 469 {
 470     struct intr_info *info;
 471
 472     if (intr < 0 || intr >= MAX_INTS)
 473         panic("register_int: bad intr %d", intr);
 474     info = &intr_info_ary[intr];
 475     return(info->i_fast + info->i_slow);
 476 }
 477
 478 long
 479 get_interrupt_counter(int intr)
 480 {
 481     struct intr_info *info;
 482
 483     if (intr < 0 || intr >= MAX_INTS)
 484         panic("register_int: bad intr %d", intr);
 485     info = &intr_info_ary[intr];
 486     return(info->i_count);
 487 }
 488
 489
 490 void
 491 swi_setpriority(int intr, int pri)
 492 {
 493     struct intr_info *info;
 494
 495     if (intr < FIRST_SOFTINT || intr >= MAX_INTS)
 496         panic("register_swi: bad intr %d", intr);
 497     info = &intr_info_ary[intr];
 498     if (info->i_state != ISTATE_NOTHREAD)
 499         lwkt_setpri(&info->i_thread, pri);
 500 }
 501
 502 void
 503 register_randintr(int intr)
 504 {
 505     struct intr_info *info;
 506
 507     if (intr < 0 || intr >= MAX_INTS)
 508         panic("register_randintr: bad intr %d", intr);
 509     info = &intr_info_ary[intr];
 510     info->i_random.sc_intr = intr;
 511     info->i_random.sc_enabled = 1;
 512 }
 513
 514 void
 515 unregister_randintr(int intr)
 516 {
 517     struct intr_info *info;
 518
 519     if (intr < 0 || intr >= MAX_INTS)
 520         panic("register_swi: bad intr %d", intr);
 521     info = &intr_info_ary[intr];
 522     info->i_random.sc_enabled = -1;
 523 }
 524
 525 int
 526 next_registered_randintr(int intr)
 527 {
 528     struct intr_info *info;
 529
 530     if (intr < 0 || intr >= MAX_INTS)
 531         panic("register_swi: bad intr %d", intr);
 532     while (intr < MAX_INTS) {
 533         info = &intr_info_ary[intr];
 534         if (info->i_random.sc_enabled > 0)
 535             break;
 536         ++intr;
 537     }
 538     return(intr);
 539 }
 540
 541 /*
 542  * Dispatch an interrupt.  If there's nothing to do we have a stray
 543  * interrupt and can just return, leaving the interrupt masked.
 544  *
 545  * We need to schedule the interrupt and set its i_running bit.  If
 546  * we are not on the interrupt thread's cpu we have to send a message
 547  * to the correct cpu that will issue the desired action (interlocking
 548  * with the interrupt thread's critical section).  We do NOT attempt to
 549  * reschedule interrupts whos i_running bit is already set because
 550  * this would prematurely wakeup a livelock-limited interrupt thread.
 551  *
 552  * i_running is only tested/set on the same cpu as the interrupt thread.
 553  *
 554  * We are NOT in a critical section, which will allow the scheduled
 555  * interrupt to preempt us.  The MP lock might *NOT* be held here.
 556  */
 557 #ifdef SMP
 558
 559 static void
 560 sched_ithd_remote(void *arg)
 561 {
 562     sched_ithd((int)(intptr_t)arg);
 563 }
 564
 565 #endif
 566
 567 void
 568 sched_ithd(int intr)
 569 {
 570     struct intr_info *info;
 571
 572     info = &intr_info_ary[intr];
 573
 574     ++info->i_count;
 575     if (info->i_state != ISTATE_NOTHREAD) {
 576         if (info->i_reclist == NULL) {
 577             report_stray_interrupt(intr, info);
 578         } else {
 579 #ifdef SMP
 580             if (info->i_thread.td_gd == mycpu) {
 581                 if (info->i_running == 0) {
 582                     info->i_running = 1;
 583                     if (info->i_state != ISTATE_LIVELOCKED)
 584                         lwkt_schedule(&info->i_thread); /* MIGHT PREEMPT */
 585                 }
 586             } else {
 587                 lwkt_send_ipiq(info->i_thread.td_gd,
 588                                 sched_ithd_remote, (void *)(intptr_t)intr);
 589             }
 590 #else
 591             if (info->i_running == 0) {
 592                 info->i_running = 1;
 593                 if (info->i_state != ISTATE_LIVELOCKED)
 594                     lwkt_schedule(&info->i_thread); /* MIGHT PREEMPT */
 595             }
 596 #endif
 597         }
 598     } else {
 599         report_stray_interrupt(intr, info);
 600     }
 601 }
 602
 603 static void
 604 report_stray_interrupt(int intr, struct intr_info *info)
 605 {
 606         ++info->i_straycount;
 607         if (info->i_straycount < 10) {
 608                 if (info->i_errorticks == ticks)
 609                         return;
 610                 info->i_errorticks = ticks;
 611                 kprintf("sched_ithd: stray interrupt %d on cpu %d\n",
 612                         intr, mycpuid);
 613         } else if (info->i_straycount == 10) {
 614                 kprintf("sched_ithd: %ld stray interrupts %d on cpu %d - "
 615                         "there will be no further reports\n",
 616                         info->i_straycount, intr, mycpuid);
 617         }
 618 }
 619
 620 /*
 621  * This is run from a periodic SYSTIMER (and thus must be MP safe, the BGL
 622  * might not be held).
 623  */
 624 static void
 625 ithread_livelock_wakeup(systimer_t st)
 626 {
 627     struct intr_info *info;
 628
 629     info = &intr_info_ary[(int)(intptr_t)st->data];
 630     if (info->i_state != ISTATE_NOTHREAD)
 631         lwkt_schedule(&info->i_thread);
 632 }
 633
 634 /*
 635  * Schedule ithread within fast intr handler
 636  *
 637  * XXX Protect sched_ithd() call with gd_intr_nesting_level?
 638  * Interrupts aren't enabled, but still...
 639  */
 640 static __inline void
 641 ithread_fast_sched(int intr, thread_t td)
 642 {
 643     ++td->td_nest_count;
 644
 645     /*
 646      * We are already in critical section, exit it now to
 647      * allow preemption.
 648      */
 649     crit_exit_quick(td);
 650     sched_ithd(intr);
 651     crit_enter_quick(td);
 652
 653     --td->td_nest_count;
 654 }
 655
 656 /*
 657  * This function is called directly from the ICU or APIC vector code assembly
 658  * to process an interrupt.  The critical section and interrupt deferral
 659  * checks have already been done but the function is entered WITHOUT
 660  * a critical section held.  The BGL may or may not be held.
 661  *
 662  * Must return non-zero if we do not want the vector code to re-enable
 663  * the interrupt (which we don't if we have to schedule the interrupt)
 664  */
 665 int ithread_fast_handler(struct intrframe *frame);
 666
 667 int
 668 ithread_fast_handler(struct intrframe *frame)
 669 {
 670     int intr;
 671     struct intr_info *info;
 672     struct intrec **list;
 673     int must_schedule;
 674 #ifdef SMP
 675     int got_mplock;
 676 #endif
 677     TD_INVARIANTS_DECLARE;
 678     intrec_t rec, nrec;
 679     globaldata_t gd;
 680     thread_t td;
 681
 682     intr = frame->if_vec;
 683     gd = mycpu;
 684     td = curthread;
 685
 686     /* We must be in critical section. */
 687     KKASSERT(td->td_critcount);
 688
 689     info = &intr_info_ary[intr];
 690
 691     /*
 692      * If we are not processing any FAST interrupts, just schedule the thing.
 693      */
 694     if (info->i_fast == 0) {
 695         ++gd->gd_cnt.v_intr;
 696         ithread_fast_sched(intr, td);
 697         return(1);
 698     }
 699
 700     /*
 701      * This should not normally occur since interrupts ought to be
 702      * masked if the ithread has been scheduled or is running.
 703      */
 704     if (info->i_running)
 705         return(1);
 706
 707     /*
 708      * Bump the interrupt nesting level to process any FAST interrupts.
 709      * Obtain the MP lock as necessary.  If the MP lock cannot be obtained,
 710      * schedule the interrupt thread to deal with the issue instead.
 711      *
 712      * To reduce overhead, just leave the MP lock held once it has been
 713      * obtained.
 714      */
 715     ++gd->gd_intr_nesting_level;
 716     ++gd->gd_cnt.v_intr;
 717     must_schedule = info->i_slow;
 718 #ifdef SMP
 719     got_mplock = 0;
 720 #endif
 721
 722     TD_INVARIANTS_GET(td);
 723     list = &info->i_reclist;
 724
 725     for (rec = *list; rec; rec = nrec) {
 726         /* rec may be invalid after call */
 727         nrec = rec->next;
 728
 729         if (rec->intr_flags & INTR_CLOCK) {
 730 #ifdef SMP
 731             if ((rec->intr_flags & INTR_MPSAFE) == 0 && got_mplock == 0) {
 732                 if (try_mplock() == 0) {
 733                     /* Couldn't get the MP lock; just schedule it. */
 734                     must_schedule = 1;
 735                     break;
 736                 }
 737                 got_mplock = 1;
 738                 SMP_INVARIANTS_ADJMP(1);
 739             }
 740 #endif
 741             if (rec->serializer) {
 742                 must_schedule += lwkt_serialize_handler_try(
 743                                         rec->serializer, rec->handler,
 744                                         rec->argument, frame);
 745             } else {
 746                 rec->handler(rec->argument, frame);
 747             }
 748             TD_INVARIANTS_TEST(td, rec->name);
 749         }
 750     }
 751
 752     /*
 753      * Cleanup
 754      */
 755     --gd->gd_intr_nesting_level;
 756 #ifdef SMP
 757     if (got_mplock)
 758         rel_mplock();
 759 #endif
 760
 761     /*
 762      * If we had a problem, or mixed fast and slow interrupt handlers are
 763      * registered, schedule the ithread to catch the missed records (it
 764      * will just re-run all of them).  A return value of 0 indicates that
 765      * all handlers have been run and the interrupt can be re-enabled, and
 766      * a non-zero return indicates that the interrupt thread controls
 767      * re-enablement.
 768      */
 769     if (must_schedule > 0)
 770         ithread_fast_sched(intr, td);
 771     else if (must_schedule == 0)
 772         ++info->i_count;
 773     return(must_schedule);
 774 }
 775
 776 /*
 777  * Interrupt threads run this as their main loop.
 778  *
 779  * The handler begins execution outside a critical section and no MP lock.
 780  *
 781  * The i_running state starts at 0.  When an interrupt occurs, the hardware
 782  * interrupt is disabled and sched_ithd() The HW interrupt remains disabled
 783  * until all routines have run.  We then call ithread_done() to reenable
 784  * the HW interrupt and deschedule us until the next interrupt.
 785  *
 786  * We are responsible for atomically checking i_running and ithread_done()
 787  * is responsible for atomically checking for platform-specific delayed
 788  * interrupts.  i_running for our irq is only set in the context of our cpu,
 789  * so a critical section is a sufficient interlock.
 790  */
 791 #define LIVELOCK_TIMEFRAME(freq)        ((freq) >> 2)   /* 1/4 second */
 792
 793 static void
 794 ithread_handler(void *arg)
 795 {
 796     struct intr_info *info;
 797     int use_limit;
 798     __uint32_t lseconds;
 799     int intr;
 800     int mpheld;
 801     struct intrec **list;
 802     intrec_t rec, nrec;
 803     globaldata_t gd;
 804     struct systimer ill_timer;  /* enforced freq. timer */
 805     u_int ill_count;            /* interrupt livelock counter */
 806     TD_INVARIANTS_DECLARE;
 807
 808     ill_count = 0;
 809     intr = (int)(intptr_t)arg;
 810     info = &intr_info_ary[intr];
 811     list = &info->i_reclist;
 812
 813     /*
 814      * The loop must be entered with one critical section held.  The thread
 815      * does not hold the mplock on startup.
 816      */
 817     gd = mycpu;
 818     lseconds = gd->gd_time_seconds;
 819     crit_enter_gd(gd);
 820     mpheld = 0;
 821
 822     for (;;) {
 823         /*
 824          * The chain is only considered MPSAFE if all its interrupt handlers
 825          * are MPSAFE.  However, if intr_mpsafe has been turned off we
 826          * always operate with the BGL.
 827          */
 828 #ifdef SMP
 829         if (info->i_mplock_required != mpheld) {
 830             if (info->i_mplock_required) {
 831                 KKASSERT(mpheld == 0);
 832                 get_mplock();
 833                 mpheld = 1;
 834             } else {
 835                 KKASSERT(mpheld != 0);
 836                 rel_mplock();
 837                 mpheld = 0;
 838             }
 839         }
 840 #endif
 841
 842         TD_INVARIANTS_GET(gd->gd_curthread);
 843
 844         /*
 845          * If an interrupt is pending, clear i_running and execute the
 846          * handlers.  Note that certain types of interrupts can re-trigger
 847          * and set i_running again.
 848          *
 849          * Each handler is run in a critical section.  Note that we run both
 850          * FAST and SLOW designated service routines.
 851          */
 852         if (info->i_running) {
 853             ++ill_count;
 854             info->i_running = 0;
 855
 856             if (*list == NULL)
 857                 report_stray_interrupt(intr, info);
 858
 859             for (rec = *list; rec; rec = nrec) {
 860                 /* rec may be invalid after call */
 861                 nrec = rec->next;
 862                 if (rec->serializer) {
 863                     lwkt_serialize_handler_call(rec->serializer, rec->handler,
 864                                                 rec->argument, NULL);
 865                 } else {
 866                     rec->handler(rec->argument, NULL);
 867                 }
 868                 TD_INVARIANTS_TEST(gd->gd_curthread, rec->name);
 869             }
 870         }
 871
 872         /*
 873          * This is our interrupt hook to add rate randomness to the random
 874          * number generator.
 875          */
 876         if (info->i_random.sc_enabled > 0)
 877             add_interrupt_randomness(intr);
 878
 879         /*
 880          * Unmask the interrupt to allow it to trigger again.  This only
 881          * applies to certain types of interrupts (typ level interrupts).
 882          * This can result in the interrupt retriggering, but the retrigger
 883          * will not be processed until we cycle our critical section.
 884          *
 885          * Only unmask interrupts while handlers are installed.  It is
 886          * possible to hit a situation where no handlers are installed
 887          * due to a device driver livelocking and then tearing down its
 888          * interrupt on close (the parallel bus being a good example).
 889          */
 890         if (*list)
 891             machintr_intren(intr);
 892
 893         /*
 894          * Do a quick exit/enter to catch any higher-priority interrupt
 895          * sources, such as the statclock, so thread time accounting
 896          * will still work.  This may also cause an interrupt to re-trigger.
 897          */
 898         crit_exit_gd(gd);
 899         crit_enter_gd(gd);
 900
 901         /*
 902          * LIVELOCK STATE MACHINE
 903          */
 904         switch(info->i_state) {
 905         case ISTATE_NORMAL:
 906             /*
 907              * Reset the count each second.
 908              */
 909             if (lseconds != gd->gd_time_seconds) {
 910                 lseconds = gd->gd_time_seconds;
 911                 ill_count = 0;
 912             }
 913
 914             /*
 915              * If we did not exceed the frequency limit, we are done.
 916              * If the interrupt has not retriggered we deschedule ourselves.
 917              */
 918             if (ill_count <= livelock_limit) {
 919                 if (info->i_running == 0) {
 920                     lwkt_deschedule_self(gd->gd_curthread);
 921                     lwkt_switch();
 922                 }
 923                 break;
 924             }
 925
 926             /*
 927              * Otherwise we are livelocked.  Set up a periodic systimer
 928              * to wake the thread up at the limit frequency.
 929              */
 930             kprintf("intr %d at %d/%d hz, livelocked limit engaged!\n",
 931                    intr, ill_count, livelock_limit);
 932             info->i_state = ISTATE_LIVELOCKED;
 933             if ((use_limit = livelock_limit) < 100)
 934                 use_limit = 100;
 935             else if (use_limit > 500000)
 936                 use_limit = 500000;
 937             systimer_init_periodic_nq(&ill_timer, ithread_livelock_wakeup,
 938                                       (void *)(intptr_t)intr, use_limit);
 939             /* fall through */
 940         case ISTATE_LIVELOCKED:
 941             /*
 942              * Wait for our periodic timer to go off.  Since the interrupt
 943              * has re-armed it can still set i_running, but it will not
 944              * reschedule us while we are in a livelocked state.
 945              */
 946             lwkt_deschedule_self(gd->gd_curthread);
 947             lwkt_switch();
 948
 949             /*
 950              * Check once a second to see if the livelock condition no
 951              * longer applies.
 952              */
 953             if (lseconds != gd->gd_time_seconds) {
 954                 lseconds = gd->gd_time_seconds;
 955                 if (ill_count < livelock_lowater) {
 956                     info->i_state = ISTATE_NORMAL;
 957                     systimer_del(&ill_timer);
 958                     kprintf("intr %d at %d/%d hz, livelock removed\n",
 959                            intr, ill_count, livelock_lowater);
 960                 } else if (livelock_debug == intr ||
 961                            (bootverbose && cold)) {
 962                     kprintf("intr %d at %d/%d hz, in livelock\n",
 963                            intr, ill_count, livelock_lowater);
 964                 }
 965                 ill_count = 0;
 966             }
 967             break;
 968         }
 969     }
 970     /* not reached */
 971 }
 972
 973 /*
 974  * Emergency interrupt polling thread.  The thread begins execution
 975  * outside a critical section with the BGL held.
 976  *
 977  * If emergency interrupt polling is enabled, this thread will
 978  * execute all system interrupts not marked INTR_NOPOLL at the
 979  * specified polling frequency.
 980  *
 981  * WARNING!  This thread runs *ALL* interrupt service routines that
 982  * are not marked INTR_NOPOLL, which basically means everything except
 983  * the 8254 clock interrupt and the ATA interrupt.  It has very high
 984  * overhead and should only be used in situations where the machine
 985  * cannot otherwise be made to work.  Due to the severe performance
 986  * degredation, it should not be enabled on production machines.
 987  */
 988 static void
 989 ithread_emergency(void *arg __unused)
 990 {
 991     struct intr_info *info;
 992     intrec_t rec, nrec;
 993     int intr;
 994     thread_t td __debugvar = curthread;
 995     TD_INVARIANTS_DECLARE;
 996
 997     get_mplock();
 998     TD_INVARIANTS_GET(td);
 999
1000     for (;;) {
1001         for (intr = 0; intr < max_installed_hard_intr; ++intr) {
1002             info = &intr_info_ary[intr];
1003             for (rec = info->i_reclist; rec; rec = nrec) {
1004                 /* rec may be invalid after call */
1005                 nrec = rec->next;
1006                 if ((rec->intr_flags & INTR_NOPOLL) == 0) {
1007                     if (rec->serializer) {
1008                         lwkt_serialize_handler_try(rec->serializer,
1009                                                 rec->handler, rec->argument, NULL);
1010                     } else {
1011                         rec->handler(rec->argument, NULL);
1012                     }
1013                     TD_INVARIANTS_TEST(td, rec->name);
1014                 }
1015             }
1016         }
1017         lwkt_deschedule_self(curthread);
1018         lwkt_switch();
1019     }
1020 }
1021
1022 /*
1023  * Systimer callback - schedule the emergency interrupt poll thread
1024  *                     if emergency polling is enabled.
1025  */
1026 static
1027 void
1028 emergency_intr_timer_callback(systimer_t info, struct intrframe *frame __unused)
1029 {
1030     if (emergency_intr_enable)
1031         lwkt_schedule(info->data);
1032 }
1033
1034 int
1035 ithread_cpuid(int intr)
1036 {
1037         const struct intr_info *info;
1038
1039         KKASSERT(intr >= 0 && intr < MAX_INTS);
1040         info = &intr_info_ary[intr];
1041
1042         if (info->i_state == ISTATE_NOTHREAD)
1043                 return -1;
1044         return info->i_thread.td_gd->gd_cpuid;
1045 }
1046
1047 /*
1048  * Sysctls used by systat and others: hw.intrnames and hw.intrcnt.
1049  * The data for this machine dependent, and the declarations are in machine
1050  * dependent code.  The layout of intrnames and intrcnt however is machine
1051  * independent.
1052  *
1053  * We do not know the length of intrcnt and intrnames at compile time, so
1054  * calculate things at run time.
1055  */
1056
1057 static int
1058 sysctl_intrnames(SYSCTL_HANDLER_ARGS)
1059 {
1060     struct intr_info *info;
1061     intrec_t rec;
1062     int error = 0;
1063     int len;
1064     int intr;
1065     char buf[64];
1066
1067     for (intr = 0; error == 0 && intr < MAX_INTS; ++intr) {
1068         info = &intr_info_ary[intr];
1069
1070         len = 0;
1071         buf[0] = 0;
1072         for (rec = info->i_reclist; rec; rec = rec->next) {
1073             ksnprintf(buf + len, sizeof(buf) - len, "%s%s",
1074                 (len ? "/" : ""), rec->name);
1075             len += strlen(buf + len);
1076         }
1077         if (len == 0) {
1078             ksnprintf(buf, sizeof(buf), "irq%d", intr);
1079             len = strlen(buf);
1080         }
1081         error = SYSCTL_OUT(req, buf, len + 1);
1082     }
1083     return (error);
1084 }
1085
1086
1087 SYSCTL_PROC(_hw, OID_AUTO, intrnames, CTLTYPE_OPAQUE | CTLFLAG_RD,
1088         NULL, 0, sysctl_intrnames, "", "Interrupt Names");
1089
1090 static int
1091 sysctl_intrcnt(SYSCTL_HANDLER_ARGS)
1092 {
1093     struct intr_info *info;
1094     int error = 0;
1095     int intr;
1096
1097     for (intr = 0; intr < max_installed_hard_intr; ++intr) {
1098         info = &intr_info_ary[intr];
1099
1100         error = SYSCTL_OUT(req, &info->i_count, sizeof(info->i_count));
1101         if (error)
1102                 goto failed;
1103     }
1104     for (intr = FIRST_SOFTINT; intr < max_installed_soft_intr; ++intr) {
1105         info = &intr_info_ary[intr];
1106
1107         error = SYSCTL_OUT(req, &info->i_count, sizeof(info->i_count));
1108         if (error)
1109                 goto failed;
1110     }
1111 failed:
1112     return(error);
1113 }
1114
1115 SYSCTL_PROC(_hw, OID_AUTO, intrcnt, CTLTYPE_OPAQUE | CTLFLAG_RD,
1116         NULL, 0, sysctl_intrcnt, "", "Interrupt Counts");
1117
1118 static void
1119 int_moveto_destcpu(int *orig_cpuid0, int *cpuid0, int intr)
1120 {
1121     int orig_cpuid = mycpuid, cpuid;
1122     char envpath[32];
1123
1124     cpuid = orig_cpuid;
1125     ksnprintf(envpath, sizeof(envpath), "hw.irq.%d.dest", intr);
1126     kgetenv_int(envpath, &cpuid);
1127     if (cpuid >= ncpus)
1128         cpuid = orig_cpuid;
1129
1130     if (cpuid != orig_cpuid)
1131         lwkt_migratecpu(cpuid);
1132
1133     *orig_cpuid0 = orig_cpuid;
1134     *cpuid0 = cpuid;
1135 }
1136
1137 static void
1138 int_moveto_origcpu(int orig_cpuid, int cpuid)
1139 {
1140     if (cpuid != orig_cpuid)
1141         lwkt_migratecpu(orig_cpuid);
1142 }