arch/x86/kernel/nmi.c

   1 /*
   2  *  Copyright (C) 1991, 1992  Linus Torvalds
   3  *  Copyright (C) 2000, 2001, 2002 Andi Kleen, SuSE Labs
   4  *  Copyright (C) 2011  Don Zickus Red Hat, Inc.
   5  *
   6  *  Pentium III FXSR, SSE support
   7  *      Gareth Hughes <gareth@valinux.com>, May 2000
   8  */
   9
  10 /*
  11  * Handle hardware traps and faults.
  12  */
  13 #include <linux/spinlock.h>
  14 #include <linux/kprobes.h>
  15 #include <linux/kdebug.h>
  16 #include <linux/sched/debug.h>
  17 #include <linux/nmi.h>
  18 #include <linux/debugfs.h>
  19 #include <linux/delay.h>
  20 #include <linux/hardirq.h>
  21 #include <linux/ratelimit.h>
  22 #include <linux/slab.h>
  23 #include <linux/export.h>
  24 #include <linux/sched/clock.h>
  25
  26 #if defined(CONFIG_EDAC)
  27 #include <linux/edac.h>
  28 #endif
  29
  30 #include <linux/atomic.h>
  31 #include <asm/traps.h>
  32 #include <asm/mach_traps.h>
  33 #include <asm/nmi.h>
  34 #include <asm/x86_init.h>
  35 #include <asm/reboot.h>
  36 #include <asm/cache.h>
  37 #include <asm/nospec-branch.h>
  38
  39 #define CREATE_TRACE_POINTS
  40 #include <trace/events/nmi.h>
  41
  42 struct nmi_desc {
  43         raw_spinlock_t lock;
  44         struct list_head head;
  45 };
  46
  47 static struct nmi_desc nmi_desc[NMI_MAX] =
  48 {
  49         {
  50                 .lock = __RAW_SPIN_LOCK_UNLOCKED(&nmi_desc[0].lock),
  51                 .head = LIST_HEAD_INIT(nmi_desc[0].head),
  52         },
  53         {
  54                 .lock = __RAW_SPIN_LOCK_UNLOCKED(&nmi_desc[1].lock),
  55                 .head = LIST_HEAD_INIT(nmi_desc[1].head),
  56         },
  57         {
  58                 .lock = __RAW_SPIN_LOCK_UNLOCKED(&nmi_desc[2].lock),
  59                 .head = LIST_HEAD_INIT(nmi_desc[2].head),
  60         },
  61         {
  62                 .lock = __RAW_SPIN_LOCK_UNLOCKED(&nmi_desc[3].lock),
  63                 .head = LIST_HEAD_INIT(nmi_desc[3].head),
  64         },
  65
  66 };
  67
  68 struct nmi_stats {
  69         unsigned int normal;
  70         unsigned int unknown;
  71         unsigned int external;
  72         unsigned int swallow;
  73 };
  74
  75 static DEFINE_PER_CPU(struct nmi_stats, nmi_stats);
  76
  77 static int ignore_nmis __read_mostly;
  78
  79 int unknown_nmi_panic;
  80 /*
  81  * Prevent NMI reason port (0x61) being accessed simultaneously, can
  82  * only be used in NMI handler.
  83  */
  84 static DEFINE_RAW_SPINLOCK(nmi_reason_lock);
  85
  86 static int __init setup_unknown_nmi_panic(char *str)
  87 {
  88         unknown_nmi_panic = 1;
  89         return 1;
  90 }
  91 __setup("unknown_nmi_panic", setup_unknown_nmi_panic);
  92
  93 #define nmi_to_desc(type) (&nmi_desc[type])
  94
  95 static u64 nmi_longest_ns = 1 * NSEC_PER_MSEC;
  96
  97 static int __init nmi_warning_debugfs(void)
  98 {
  99         debugfs_create_u64("nmi_longest_ns", 0644,
 100                         arch_debugfs_dir, &nmi_longest_ns);
 101         return 0;
 102 }
 103 fs_initcall(nmi_warning_debugfs);
 104
 105 static void nmi_check_duration(struct nmiaction *action, u64 duration)
 106 {
 107         int remainder_ns, decimal_msecs;
 108
 109         if (duration < nmi_longest_ns || duration < action->max_duration)
 110                 return;
 111
 112         action->max_duration = duration;
 113
 114         remainder_ns = do_div(duration, (1000 * 1000));
 115         decimal_msecs = remainder_ns / 1000;
 116
 117         printk_ratelimited(KERN_INFO
 118                 "INFO: NMI handler (%ps) took too long to run: %lld.%03d msecs\n",
 119                 action->handler, duration, decimal_msecs);
 120 }
 121
 122 static int nmi_handle(unsigned int type, struct pt_regs *regs)
 123 {
 124         struct nmi_desc *desc = nmi_to_desc(type);
 125         struct nmiaction *a;
 126         int handled=0;
 127
 128         rcu_read_lock();
 129
 130         /*
 131          * NMIs are edge-triggered, which means if you have enough
 132          * of them concurrently, you can lose some because only one
 133          * can be latched at any given time.  Walk the whole list
 134          * to handle those situations.
 135          */
 136         list_for_each_entry_rcu(a, &desc->head, list) {
 137                 int thishandled;
 138                 u64 delta;
 139
 140                 delta = sched_clock();
 141                 thishandled = a->handler(type, regs);
 142                 handled += thishandled;
 143                 delta = sched_clock() - delta;
 144                 trace_nmi_handler(a->handler, (int)delta, thishandled);
 145
 146                 nmi_check_duration(a, delta);
 147         }
 148
 149         rcu_read_unlock();
 150
 151         /* return total number of NMI events handled */
 152         return handled;
 153 }
 154 NOKPROBE_SYMBOL(nmi_handle);
 155
 156 int __register_nmi_handler(unsigned int type, struct nmiaction *action)
 157 {
 158         struct nmi_desc *desc = nmi_to_desc(type);
 159         unsigned long flags;
 160
 161         if (!action->handler)
 162                 return -EINVAL;
 163
 164         raw_spin_lock_irqsave(&desc->lock, flags);
 165
 166         /*
 167          * Indicate if there are multiple registrations on the
 168          * internal NMI handler call chains (SERR and IO_CHECK).
 169          */
 170         WARN_ON_ONCE(type == NMI_SERR && !list_empty(&desc->head));
 171         WARN_ON_ONCE(type == NMI_IO_CHECK && !list_empty(&desc->head));
 172
 173         /*
 174          * some handlers need to be executed first otherwise a fake
 175          * event confuses some handlers (kdump uses this flag)
 176          */
 177         if (action->flags & NMI_FLAG_FIRST)
 178                 list_add_rcu(&action->list, &desc->head);
 179         else
 180                 list_add_tail_rcu(&action->list, &desc->head);
 181
 182         raw_spin_unlock_irqrestore(&desc->lock, flags);
 183         return 0;
 184 }
 185 EXPORT_SYMBOL(__register_nmi_handler);
 186
 187 void unregister_nmi_handler(unsigned int type, const char *name)
 188 {
 189         struct nmi_desc *desc = nmi_to_desc(type);
 190         struct nmiaction *n;
 191         unsigned long flags;
 192
 193         raw_spin_lock_irqsave(&desc->lock, flags);
 194
 195         list_for_each_entry_rcu(n, &desc->head, list) {
 196                 /*
 197                  * the name passed in to describe the nmi handler
 198                  * is used as the lookup key
 199                  */
 200                 if (!strcmp(n->name, name)) {
 201                         WARN(in_nmi(),
 202                                 "Trying to free NMI (%s) from NMI context!\n", n->name);
 203                         list_del_rcu(&n->list);
 204                         break;
 205                 }
 206         }
 207
 208         raw_spin_unlock_irqrestore(&desc->lock, flags);
 209         synchronize_rcu();
 210 }
 211 EXPORT_SYMBOL_GPL(unregister_nmi_handler);
 212
 213 static void
 214 pci_serr_error(unsigned char reason, struct pt_regs *regs)
 215 {
 216         /* check to see if anyone registered against these types of errors */
 217         if (nmi_handle(NMI_SERR, regs))
 218                 return;
 219
 220         pr_emerg("NMI: PCI system error (SERR) for reason %02x on CPU %d.\n",
 221                  reason, smp_processor_id());
 222
 223         if (panic_on_unrecovered_nmi)
 224                 nmi_panic(regs, "NMI: Not continuing");
 225
 226         pr_emerg("Dazed and confused, but trying to continue\n");
 227
 228         /* Clear and disable the PCI SERR error line. */
 229         reason = (reason & NMI_REASON_CLEAR_MASK) | NMI_REASON_CLEAR_SERR;
 230         outb(reason, NMI_REASON_PORT);
 231 }
 232 NOKPROBE_SYMBOL(pci_serr_error);
 233
 234 static void
 235 io_check_error(unsigned char reason, struct pt_regs *regs)
 236 {
 237         unsigned long i;
 238
 239         /* check to see if anyone registered against these types of errors */
 240         if (nmi_handle(NMI_IO_CHECK, regs))
 241                 return;
 242
 243         pr_emerg(
 244         "NMI: IOCK error (debug interrupt?) for reason %02x on CPU %d.\n",
 245                  reason, smp_processor_id());
 246         show_regs(regs);
 247
 248         if (panic_on_io_nmi) {
 249                 nmi_panic(regs, "NMI IOCK error: Not continuing");
 250
 251                 /*
 252                  * If we end up here, it means we have received an NMI while
 253                  * processing panic(). Simply return without delaying and
 254                  * re-enabling NMIs.
 255                  */
 256                 return;
 257         }
 258
 259         /* Re-enable the IOCK line, wait for a few seconds */
 260         reason = (reason & NMI_REASON_CLEAR_MASK) | NMI_REASON_CLEAR_IOCHK;
 261         outb(reason, NMI_REASON_PORT);
 262
 263         i = 20000;
 264         while (--i) {
 265                 touch_nmi_watchdog();
 266                 udelay(100);
 267         }
 268
 269         reason &= ~NMI_REASON_CLEAR_IOCHK;
 270         outb(reason, NMI_REASON_PORT);
 271 }
 272 NOKPROBE_SYMBOL(io_check_error);
 273
 274 static void
 275 unknown_nmi_error(unsigned char reason, struct pt_regs *regs)
 276 {
 277         int handled;
 278
 279         /*
 280          * Use 'false' as back-to-back NMIs are dealt with one level up.
 281          * Of course this makes having multiple 'unknown' handlers useless
 282          * as only the first one is ever run (unless it can actually determine
 283          * if it caused the NMI)
 284          */
 285         handled = nmi_handle(NMI_UNKNOWN, regs);
 286         if (handled) {
 287                 __this_cpu_add(nmi_stats.unknown, handled);
 288                 return;
 289         }
 290
 291         __this_cpu_add(nmi_stats.unknown, 1);
 292
 293         pr_emerg("Uhhuh. NMI received for unknown reason %02x on CPU %d.\n",
 294                  reason, smp_processor_id());
 295
 296         pr_emerg("Do you have a strange power saving mode enabled?\n");
 297         if (unknown_nmi_panic || panic_on_unrecovered_nmi)
 298                 nmi_panic(regs, "NMI: Not continuing");
 299
 300         pr_emerg("Dazed and confused, but trying to continue\n");
 301 }
 302 NOKPROBE_SYMBOL(unknown_nmi_error);
 303
 304 static DEFINE_PER_CPU(bool, swallow_nmi);
 305 static DEFINE_PER_CPU(unsigned long, last_nmi_rip);
 306
 307 static void default_do_nmi(struct pt_regs *regs)
 308 {
 309         unsigned char reason = 0;
 310         int handled;
 311         bool b2b = false;
 312
 313         /*
 314          * CPU-specific NMI must be processed before non-CPU-specific
 315          * NMI, otherwise we may lose it, because the CPU-specific
 316          * NMI can not be detected/processed on other CPUs.
 317          */
 318
 319         /*
 320          * Back-to-back NMIs are interesting because they can either
 321          * be two NMI or more than two NMIs (any thing over two is dropped
 322          * due to NMI being edge-triggered).  If this is the second half
 323          * of the back-to-back NMI, assume we dropped things and process
 324          * more handlers.  Otherwise reset the 'swallow' NMI behaviour
 325          */
 326         if (regs->ip == __this_cpu_read(last_nmi_rip))
 327                 b2b = true;
 328         else
 329                 __this_cpu_write(swallow_nmi, false);
 330
 331         __this_cpu_write(last_nmi_rip, regs->ip);
 332
 333         handled = nmi_handle(NMI_LOCAL, regs);
 334         __this_cpu_add(nmi_stats.normal, handled);
 335         if (handled) {
 336                 /*
 337                  * There are cases when a NMI handler handles multiple
 338                  * events in the current NMI.  One of these events may
 339                  * be queued for in the next NMI.  Because the event is
 340                  * already handled, the next NMI will result in an unknown
 341                  * NMI.  Instead lets flag this for a potential NMI to
 342                  * swallow.
 343                  */
 344                 if (handled > 1)
 345                         __this_cpu_write(swallow_nmi, true);
 346                 return;
 347         }
 348
 349         /*
 350          * Non-CPU-specific NMI: NMI sources can be processed on any CPU.
 351          *
 352          * Another CPU may be processing panic routines while holding
 353          * nmi_reason_lock. Check if the CPU issued the IPI for crash dumping,
 354          * and if so, call its callback directly.  If there is no CPU preparing
 355          * crash dump, we simply loop here.
 356          */
 357         while (!raw_spin_trylock(&nmi_reason_lock)) {
 358                 run_crash_ipi_callback(regs);
 359                 cpu_relax();
 360         }
 361
 362         reason = x86_platform.get_nmi_reason();
 363
 364         if (reason & NMI_REASON_MASK) {
 365                 if (reason & NMI_REASON_SERR)
 366                         pci_serr_error(reason, regs);
 367                 else if (reason & NMI_REASON_IOCHK)
 368                         io_check_error(reason, regs);
 369 #ifdef CONFIG_X86_32
 370                 /*
 371                  * Reassert NMI in case it became active
 372                  * meanwhile as it's edge-triggered:
 373                  */
 374                 reassert_nmi();
 375 #endif
 376                 __this_cpu_add(nmi_stats.external, 1);
 377                 raw_spin_unlock(&nmi_reason_lock);
 378                 return;
 379         }
 380         raw_spin_unlock(&nmi_reason_lock);
 381
 382         /*
 383          * Only one NMI can be latched at a time.  To handle
 384          * this we may process multiple nmi handlers at once to
 385          * cover the case where an NMI is dropped.  The downside
 386          * to this approach is we may process an NMI prematurely,
 387          * while its real NMI is sitting latched.  This will cause
 388          * an unknown NMI on the next run of the NMI processing.
 389          *
 390          * We tried to flag that condition above, by setting the
 391          * swallow_nmi flag when we process more than one event.
 392          * This condition is also only present on the second half
 393          * of a back-to-back NMI, so we flag that condition too.
 394          *
 395          * If both are true, we assume we already processed this
 396          * NMI previously and we swallow it.  Otherwise we reset
 397          * the logic.
 398          *
 399          * There are scenarios where we may accidentally swallow
 400          * a 'real' unknown NMI.  For example, while processing
 401          * a perf NMI another perf NMI comes in along with a
 402          * 'real' unknown NMI.  These two NMIs get combined into
 403          * one (as descibed above).  When the next NMI gets
 404          * processed, it will be flagged by perf as handled, but
 405          * noone will know that there was a 'real' unknown NMI sent
 406          * also.  As a result it gets swallowed.  Or if the first
 407          * perf NMI returns two events handled then the second
 408          * NMI will get eaten by the logic below, again losing a
 409          * 'real' unknown NMI.  But this is the best we can do
 410          * for now.
 411          */
 412         if (b2b && __this_cpu_read(swallow_nmi))
 413                 __this_cpu_add(nmi_stats.swallow, 1);
 414         else
 415                 unknown_nmi_error(reason, regs);
 416 }
 417 NOKPROBE_SYMBOL(default_do_nmi);
 418
 419 /*
 420  * NMIs can page fault or hit breakpoints which will cause it to lose
 421  * its NMI context with the CPU when the breakpoint or page fault does an IRET.
 422  *
 423  * As a result, NMIs can nest if NMIs get unmasked due an IRET during
 424  * NMI processing.  On x86_64, the asm glue protects us from nested NMIs
 425  * if the outer NMI came from kernel mode, but we can still nest if the
 426  * outer NMI came from user mode.
 427  *
 428  * To handle these nested NMIs, we have three states:
 429  *
 430  *  1) not running
 431  *  2) executing
 432  *  3) latched
 433  *
 434  * When no NMI is in progress, it is in the "not running" state.
 435  * When an NMI comes in, it goes into the "executing" state.
 436  * Normally, if another NMI is triggered, it does not interrupt
 437  * the running NMI and the HW will simply latch it so that when
 438  * the first NMI finishes, it will restart the second NMI.
 439  * (Note, the latch is binary, thus multiple NMIs triggering,
 440  *  when one is running, are ignored. Only one NMI is restarted.)
 441  *
 442  * If an NMI executes an iret, another NMI can preempt it. We do not
 443  * want to allow this new NMI to run, but we want to execute it when the
 444  * first one finishes.  We set the state to "latched", and the exit of
 445  * the first NMI will perform a dec_return, if the result is zero
 446  * (NOT_RUNNING), then it will simply exit the NMI handler. If not, the
 447  * dec_return would have set the state to NMI_EXECUTING (what we want it
 448  * to be when we are running). In this case, we simply jump back to
 449  * rerun the NMI handler again, and restart the 'latched' NMI.
 450  *
 451  * No trap (breakpoint or page fault) should be hit before nmi_restart,
 452  * thus there is no race between the first check of state for NOT_RUNNING
 453  * and setting it to NMI_EXECUTING. The HW will prevent nested NMIs
 454  * at this point.
 455  *
 456  * In case the NMI takes a page fault, we need to save off the CR2
 457  * because the NMI could have preempted another page fault and corrupt
 458  * the CR2 that is about to be read. As nested NMIs must be restarted
 459  * and they can not take breakpoints or page faults, the update of the
 460  * CR2 must be done before converting the nmi state back to NOT_RUNNING.
 461  * Otherwise, there would be a race of another nested NMI coming in
 462  * after setting state to NOT_RUNNING but before updating the nmi_cr2.
 463  */
 464 enum nmi_states {
 465         NMI_NOT_RUNNING = 0,
 466         NMI_EXECUTING,
 467         NMI_LATCHED,
 468 };
 469 static DEFINE_PER_CPU(enum nmi_states, nmi_state);
 470 static DEFINE_PER_CPU(unsigned long, nmi_cr2);
 471
 472 #ifdef CONFIG_X86_64
 473 /*
 474  * In x86_64, we need to handle breakpoint -> NMI -> breakpoint.  Without
 475  * some care, the inner breakpoint will clobber the outer breakpoint's
 476  * stack.
 477  *
 478  * If a breakpoint is being processed, and the debug stack is being
 479  * used, if an NMI comes in and also hits a breakpoint, the stack
 480  * pointer will be set to the same fixed address as the breakpoint that
 481  * was interrupted, causing that stack to be corrupted. To handle this
 482  * case, check if the stack that was interrupted is the debug stack, and
 483  * if so, change the IDT so that new breakpoints will use the current
 484  * stack and not switch to the fixed address. On return of the NMI,
 485  * switch back to the original IDT.
 486  */
 487 static DEFINE_PER_CPU(int, update_debug_stack);
 488 #endif
 489
 490 dotraplinkage notrace void
 491 do_nmi(struct pt_regs *regs, long error_code)
 492 {
 493         if (this_cpu_read(nmi_state) != NMI_NOT_RUNNING) {
 494                 this_cpu_write(nmi_state, NMI_LATCHED);
 495                 return;
 496         }
 497         this_cpu_write(nmi_state, NMI_EXECUTING);
 498         this_cpu_write(nmi_cr2, read_cr2());
 499 nmi_restart:
 500
 501 #ifdef CONFIG_X86_64
 502         /*
 503          * If we interrupted a breakpoint, it is possible that
 504          * the nmi handler will have breakpoints too. We need to
 505          * change the IDT such that breakpoints that happen here
 506          * continue to use the NMI stack.
 507          */
 508         if (unlikely(is_debug_stack(regs->sp))) {
 509                 debug_stack_set_zero();
 510                 this_cpu_write(update_debug_stack, 1);
 511         }
 512 #endif
 513
 514         nmi_enter();
 515
 516         inc_irq_stat(__nmi_count);
 517
 518         if (!ignore_nmis)
 519                 default_do_nmi(regs);
 520
 521         nmi_exit();
 522
 523 #ifdef CONFIG_X86_64
 524         if (unlikely(this_cpu_read(update_debug_stack))) {
 525                 debug_stack_reset();
 526                 this_cpu_write(update_debug_stack, 0);
 527         }
 528 #endif
 529
 530         if (unlikely(this_cpu_read(nmi_cr2) != read_cr2()))
 531                 write_cr2(this_cpu_read(nmi_cr2));
 532         if (this_cpu_dec_return(nmi_state))
 533                 goto nmi_restart;
 534
 535         if (user_mode(regs))
 536                 mds_user_clear_cpu_buffers();
 537 }
 538 NOKPROBE_SYMBOL(do_nmi);
 539
 540 void stop_nmi(void)
 541 {
 542         ignore_nmis++;
 543 }
 544
 545 void restart_nmi(void)
 546 {
 547         ignore_nmis--;
 548 }
 549
 550 /* reset the back-to-back NMI logic */
 551 void local_touch_nmi(void)
 552 {
 553         __this_cpu_write(last_nmi_rip, 0);
 554 }
 555 EXPORT_SYMBOL_GPL(local_touch_nmi);