arch/x86/kernel/alternative.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 #define pr_fmt(fmt) "SMP alternatives: " fmt
   3
   4 #include <linux/module.h>
   5 #include <linux/sched.h>
   6 #include <linux/mutex.h>
   7 #include <linux/list.h>
   8 #include <linux/stringify.h>
   9 #include <linux/mm.h>
  10 #include <linux/vmalloc.h>
  11 #include <linux/memory.h>
  12 #include <linux/stop_machine.h>
  13 #include <linux/slab.h>
  14 #include <linux/kdebug.h>
  15 #include <linux/kprobes.h>
  16 #include <linux/mmu_context.h>
  17 #include <linux/bsearch.h>
  18 #include <asm/text-patching.h>
  19 #include <asm/alternative.h>
  20 #include <asm/sections.h>
  21 #include <asm/pgtable.h>
  22 #include <asm/mce.h>
  23 #include <asm/nmi.h>
  24 #include <asm/cacheflush.h>
  25 #include <asm/tlbflush.h>
  26 #include <asm/io.h>
  27 #include <asm/fixmap.h>
  28
  29 int __read_mostly alternatives_patched;
  30
  31 EXPORT_SYMBOL_GPL(alternatives_patched);
  32
  33 #define MAX_PATCH_LEN (255-1)
  34
  35 static int __initdata_or_module debug_alternative;
  36
  37 static int __init debug_alt(char *str)
  38 {
  39         debug_alternative = 1;
  40         return 1;
  41 }
  42 __setup("debug-alternative", debug_alt);
  43
  44 static int noreplace_smp;
  45
  46 static int __init setup_noreplace_smp(char *str)
  47 {
  48         noreplace_smp = 1;
  49         return 1;
  50 }
  51 __setup("noreplace-smp", setup_noreplace_smp);
  52
  53 #define DPRINTK(fmt, args...)                                           \
  54 do {                                                                    \
  55         if (debug_alternative)                                          \
  56                 printk(KERN_DEBUG "%s: " fmt "\n", __func__, ##args);   \
  57 } while (0)
  58
  59 #define DUMP_BYTES(buf, len, fmt, args...)                              \
  60 do {                                                                    \
  61         if (unlikely(debug_alternative)) {                              \
  62                 int j;                                                  \
  63                                                                         \
  64                 if (!(len))                                             \
  65                         break;                                          \
  66                                                                         \
  67                 printk(KERN_DEBUG fmt, ##args);                         \
  68                 for (j = 0; j < (len) - 1; j++)                         \
  69                         printk(KERN_CONT "%02hhx ", buf[j]);            \
  70                 printk(KERN_CONT "%02hhx\n", buf[j]);                   \
  71         }                                                               \
  72 } while (0)
  73
  74 /*
  75  * Each GENERIC_NOPX is of X bytes, and defined as an array of bytes
  76  * that correspond to that nop. Getting from one nop to the next, we
  77  * add to the array the offset that is equal to the sum of all sizes of
  78  * nops preceding the one we are after.
  79  *
  80  * Note: The GENERIC_NOP5_ATOMIC is at the end, as it breaks the
  81  * nice symmetry of sizes of the previous nops.
  82  */
  83 #if defined(GENERIC_NOP1) && !defined(CONFIG_X86_64)
  84 static const unsigned char intelnops[] =
  85 {
  86         GENERIC_NOP1,
  87         GENERIC_NOP2,
  88         GENERIC_NOP3,
  89         GENERIC_NOP4,
  90         GENERIC_NOP5,
  91         GENERIC_NOP6,
  92         GENERIC_NOP7,
  93         GENERIC_NOP8,
  94         GENERIC_NOP5_ATOMIC
  95 };
  96 static const unsigned char * const intel_nops[ASM_NOP_MAX+2] =
  97 {
  98         NULL,
  99         intelnops,
 100         intelnops + 1,
 101         intelnops + 1 + 2,
 102         intelnops + 1 + 2 + 3,
 103         intelnops + 1 + 2 + 3 + 4,
 104         intelnops + 1 + 2 + 3 + 4 + 5,
 105         intelnops + 1 + 2 + 3 + 4 + 5 + 6,
 106         intelnops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
 107         intelnops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
 108 };
 109 #endif
 110
 111 #ifdef K8_NOP1
 112 static const unsigned char k8nops[] =
 113 {
 114         K8_NOP1,
 115         K8_NOP2,
 116         K8_NOP3,
 117         K8_NOP4,
 118         K8_NOP5,
 119         K8_NOP6,
 120         K8_NOP7,
 121         K8_NOP8,
 122         K8_NOP5_ATOMIC
 123 };
 124 static const unsigned char * const k8_nops[ASM_NOP_MAX+2] =
 125 {
 126         NULL,
 127         k8nops,
 128         k8nops + 1,
 129         k8nops + 1 + 2,
 130         k8nops + 1 + 2 + 3,
 131         k8nops + 1 + 2 + 3 + 4,
 132         k8nops + 1 + 2 + 3 + 4 + 5,
 133         k8nops + 1 + 2 + 3 + 4 + 5 + 6,
 134         k8nops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
 135         k8nops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
 136 };
 137 #endif
 138
 139 #if defined(K7_NOP1) && !defined(CONFIG_X86_64)
 140 static const unsigned char k7nops[] =
 141 {
 142         K7_NOP1,
 143         K7_NOP2,
 144         K7_NOP3,
 145         K7_NOP4,
 146         K7_NOP5,
 147         K7_NOP6,
 148         K7_NOP7,
 149         K7_NOP8,
 150         K7_NOP5_ATOMIC
 151 };
 152 static const unsigned char * const k7_nops[ASM_NOP_MAX+2] =
 153 {
 154         NULL,
 155         k7nops,
 156         k7nops + 1,
 157         k7nops + 1 + 2,
 158         k7nops + 1 + 2 + 3,
 159         k7nops + 1 + 2 + 3 + 4,
 160         k7nops + 1 + 2 + 3 + 4 + 5,
 161         k7nops + 1 + 2 + 3 + 4 + 5 + 6,
 162         k7nops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
 163         k7nops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
 164 };
 165 #endif
 166
 167 #ifdef P6_NOP1
 168 static const unsigned char p6nops[] =
 169 {
 170         P6_NOP1,
 171         P6_NOP2,
 172         P6_NOP3,
 173         P6_NOP4,
 174         P6_NOP5,
 175         P6_NOP6,
 176         P6_NOP7,
 177         P6_NOP8,
 178         P6_NOP5_ATOMIC
 179 };
 180 static const unsigned char * const p6_nops[ASM_NOP_MAX+2] =
 181 {
 182         NULL,
 183         p6nops,
 184         p6nops + 1,
 185         p6nops + 1 + 2,
 186         p6nops + 1 + 2 + 3,
 187         p6nops + 1 + 2 + 3 + 4,
 188         p6nops + 1 + 2 + 3 + 4 + 5,
 189         p6nops + 1 + 2 + 3 + 4 + 5 + 6,
 190         p6nops + 1 + 2 + 3 + 4 + 5 + 6 + 7,
 191         p6nops + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8,
 192 };
 193 #endif
 194
 195 /* Initialize these to a safe default */
 196 #ifdef CONFIG_X86_64
 197 const unsigned char * const *ideal_nops = p6_nops;
 198 #else
 199 const unsigned char * const *ideal_nops = intel_nops;
 200 #endif
 201
 202 void __init arch_init_ideal_nops(void)
 203 {
 204         switch (boot_cpu_data.x86_vendor) {
 205         case X86_VENDOR_INTEL:
 206                 /*
 207                  * Due to a decoder implementation quirk, some
 208                  * specific Intel CPUs actually perform better with
 209                  * the "k8_nops" than with the SDM-recommended NOPs.
 210                  */
 211                 if (boot_cpu_data.x86 == 6 &&
 212                     boot_cpu_data.x86_model >= 0x0f &&
 213                     boot_cpu_data.x86_model != 0x1c &&
 214                     boot_cpu_data.x86_model != 0x26 &&
 215                     boot_cpu_data.x86_model != 0x27 &&
 216                     boot_cpu_data.x86_model < 0x30) {
 217                         ideal_nops = k8_nops;
 218                 } else if (boot_cpu_has(X86_FEATURE_NOPL)) {
 219                            ideal_nops = p6_nops;
 220                 } else {
 221 #ifdef CONFIG_X86_64
 222                         ideal_nops = k8_nops;
 223 #else
 224                         ideal_nops = intel_nops;
 225 #endif
 226                 }
 227                 break;
 228
 229         case X86_VENDOR_HYGON:
 230                 ideal_nops = p6_nops;
 231                 return;
 232
 233         case X86_VENDOR_AMD:
 234                 if (boot_cpu_data.x86 > 0xf) {
 235                         ideal_nops = p6_nops;
 236                         return;
 237                 }
 238
 239                 /* fall through */
 240
 241         default:
 242 #ifdef CONFIG_X86_64
 243                 ideal_nops = k8_nops;
 244 #else
 245                 if (boot_cpu_has(X86_FEATURE_K8))
 246                         ideal_nops = k8_nops;
 247                 else if (boot_cpu_has(X86_FEATURE_K7))
 248                         ideal_nops = k7_nops;
 249                 else
 250                         ideal_nops = intel_nops;
 251 #endif
 252         }
 253 }
 254
 255 /* Use this to add nops to a buffer, then text_poke the whole buffer. */
 256 static void __init_or_module add_nops(void *insns, unsigned int len)
 257 {
 258         while (len > 0) {
 259                 unsigned int noplen = len;
 260                 if (noplen > ASM_NOP_MAX)
 261                         noplen = ASM_NOP_MAX;
 262                 memcpy(insns, ideal_nops[noplen], noplen);
 263                 insns += noplen;
 264                 len -= noplen;
 265         }
 266 }
 267
 268 extern struct alt_instr __alt_instructions[], __alt_instructions_end[];
 269 extern s32 __smp_locks[], __smp_locks_end[];
 270 void text_poke_early(void *addr, const void *opcode, size_t len);
 271
 272 /*
 273  * Are we looking at a near JMP with a 1 or 4-byte displacement.
 274  */
 275 static inline bool is_jmp(const u8 opcode)
 276 {
 277         return opcode == 0xeb || opcode == 0xe9;
 278 }
 279
 280 static void __init_or_module
 281 recompute_jump(struct alt_instr *a, u8 *orig_insn, u8 *repl_insn, u8 *insn_buff)
 282 {
 283         u8 *next_rip, *tgt_rip;
 284         s32 n_dspl, o_dspl;
 285         int repl_len;
 286
 287         if (a->replacementlen != 5)
 288                 return;
 289
 290         o_dspl = *(s32 *)(insn_buff + 1);
 291
 292         /* next_rip of the replacement JMP */
 293         next_rip = repl_insn + a->replacementlen;
 294         /* target rip of the replacement JMP */
 295         tgt_rip  = next_rip + o_dspl;
 296         n_dspl = tgt_rip - orig_insn;
 297
 298         DPRINTK("target RIP: %px, new_displ: 0x%x", tgt_rip, n_dspl);
 299
 300         if (tgt_rip - orig_insn >= 0) {
 301                 if (n_dspl - 2 <= 127)
 302                         goto two_byte_jmp;
 303                 else
 304                         goto five_byte_jmp;
 305         /* negative offset */
 306         } else {
 307                 if (((n_dspl - 2) & 0xff) == (n_dspl - 2))
 308                         goto two_byte_jmp;
 309                 else
 310                         goto five_byte_jmp;
 311         }
 312
 313 two_byte_jmp:
 314         n_dspl -= 2;
 315
 316         insn_buff[0] = 0xeb;
 317         insn_buff[1] = (s8)n_dspl;
 318         add_nops(insn_buff + 2, 3);
 319
 320         repl_len = 2;
 321         goto done;
 322
 323 five_byte_jmp:
 324         n_dspl -= 5;
 325
 326         insn_buff[0] = 0xe9;
 327         *(s32 *)&insn_buff[1] = n_dspl;
 328
 329         repl_len = 5;
 330
 331 done:
 332
 333         DPRINTK("final displ: 0x%08x, JMP 0x%lx",
 334                 n_dspl, (unsigned long)orig_insn + n_dspl + repl_len);
 335 }
 336
 337 /*
 338  * "noinline" to cause control flow change and thus invalidate I$ and
 339  * cause refetch after modification.
 340  */
 341 static void __init_or_module noinline optimize_nops(struct alt_instr *a, u8 *instr)
 342 {
 343         unsigned long flags;
 344         int i;
 345
 346         for (i = 0; i < a->padlen; i++) {
 347                 if (instr[i] != 0x90)
 348                         return;
 349         }
 350
 351         local_irq_save(flags);
 352         add_nops(instr + (a->instrlen - a->padlen), a->padlen);
 353         local_irq_restore(flags);
 354
 355         DUMP_BYTES(instr, a->instrlen, "%px: [%d:%d) optimized NOPs: ",
 356                    instr, a->instrlen - a->padlen, a->padlen);
 357 }
 358
 359 /*
 360  * Replace instructions with better alternatives for this CPU type. This runs
 361  * before SMP is initialized to avoid SMP problems with self modifying code.
 362  * This implies that asymmetric systems where APs have less capabilities than
 363  * the boot processor are not handled. Tough. Make sure you disable such
 364  * features by hand.
 365  *
 366  * Marked "noinline" to cause control flow change and thus insn cache
 367  * to refetch changed I$ lines.
 368  */
 369 void __init_or_module noinline apply_alternatives(struct alt_instr *start,
 370                                                   struct alt_instr *end)
 371 {
 372         struct alt_instr *a;
 373         u8 *instr, *replacement;
 374         u8 insn_buff[MAX_PATCH_LEN];
 375
 376         DPRINTK("alt table %px, -> %px", start, end);
 377         /*
 378          * The scan order should be from start to end. A later scanned
 379          * alternative code can overwrite previously scanned alternative code.
 380          * Some kernel functions (e.g. memcpy, memset, etc) use this order to
 381          * patch code.
 382          *
 383          * So be careful if you want to change the scan order to any other
 384          * order.
 385          */
 386         for (a = start; a < end; a++) {
 387                 int insn_buff_sz = 0;
 388
 389                 instr = (u8 *)&a->instr_offset + a->instr_offset;
 390                 replacement = (u8 *)&a->repl_offset + a->repl_offset;
 391                 BUG_ON(a->instrlen > sizeof(insn_buff));
 392                 BUG_ON(a->cpuid >= (NCAPINTS + NBUGINTS) * 32);
 393                 if (!boot_cpu_has(a->cpuid)) {
 394                         if (a->padlen > 1)
 395                                 optimize_nops(a, instr);
 396
 397                         continue;
 398                 }
 399
 400                 DPRINTK("feat: %d*32+%d, old: (%pS (%px) len: %d), repl: (%px, len: %d), pad: %d",
 401                         a->cpuid >> 5,
 402                         a->cpuid & 0x1f,
 403                         instr, instr, a->instrlen,
 404                         replacement, a->replacementlen, a->padlen);
 405
 406                 DUMP_BYTES(instr, a->instrlen, "%px: old_insn: ", instr);
 407                 DUMP_BYTES(replacement, a->replacementlen, "%px: rpl_insn: ", replacement);
 408
 409                 memcpy(insn_buff, replacement, a->replacementlen);
 410                 insn_buff_sz = a->replacementlen;
 411
 412                 /*
 413                  * 0xe8 is a relative jump; fix the offset.
 414                  *
 415                  * Instruction length is checked before the opcode to avoid
 416                  * accessing uninitialized bytes for zero-length replacements.
 417                  */
 418                 if (a->replacementlen == 5 && *insn_buff == 0xe8) {
 419                         *(s32 *)(insn_buff + 1) += replacement - instr;
 420                         DPRINTK("Fix CALL offset: 0x%x, CALL 0x%lx",
 421                                 *(s32 *)(insn_buff + 1),
 422                                 (unsigned long)instr + *(s32 *)(insn_buff + 1) + 5);
 423                 }
 424
 425                 if (a->replacementlen && is_jmp(replacement[0]))
 426                         recompute_jump(a, instr, replacement, insn_buff);
 427
 428                 if (a->instrlen > a->replacementlen) {
 429                         add_nops(insn_buff + a->replacementlen,
 430                                  a->instrlen - a->replacementlen);
 431                         insn_buff_sz += a->instrlen - a->replacementlen;
 432                 }
 433                 DUMP_BYTES(insn_buff, insn_buff_sz, "%px: final_insn: ", instr);
 434
 435                 text_poke_early(instr, insn_buff, insn_buff_sz);
 436         }
 437 }
 438
 439 #ifdef CONFIG_SMP
 440 static void alternatives_smp_lock(const s32 *start, const s32 *end,
 441                                   u8 *text, u8 *text_end)
 442 {
 443         const s32 *poff;
 444
 445         for (poff = start; poff < end; poff++) {
 446                 u8 *ptr = (u8 *)poff + *poff;
 447
 448                 if (!*poff || ptr < text || ptr >= text_end)
 449                         continue;
 450                 /* turn DS segment override prefix into lock prefix */
 451                 if (*ptr == 0x3e)
 452                         text_poke(ptr, ((unsigned char []){0xf0}), 1);
 453         }
 454 }
 455
 456 static void alternatives_smp_unlock(const s32 *start, const s32 *end,
 457                                     u8 *text, u8 *text_end)
 458 {
 459         const s32 *poff;
 460
 461         for (poff = start; poff < end; poff++) {
 462                 u8 *ptr = (u8 *)poff + *poff;
 463
 464                 if (!*poff || ptr < text || ptr >= text_end)
 465                         continue;
 466                 /* turn lock prefix into DS segment override prefix */
 467                 if (*ptr == 0xf0)
 468                         text_poke(ptr, ((unsigned char []){0x3E}), 1);
 469         }
 470 }
 471
 472 struct smp_alt_module {
 473         /* what is this ??? */
 474         struct module   *mod;
 475         char            *name;
 476
 477         /* ptrs to lock prefixes */
 478         const s32       *locks;
 479         const s32       *locks_end;
 480
 481         /* .text segment, needed to avoid patching init code ;) */
 482         u8              *text;
 483         u8              *text_end;
 484
 485         struct list_head next;
 486 };
 487 static LIST_HEAD(smp_alt_modules);
 488 static bool uniproc_patched = false;    /* protected by text_mutex */
 489
 490 void __init_or_module alternatives_smp_module_add(struct module *mod,
 491                                                   char *name,
 492                                                   void *locks, void *locks_end,
 493                                                   void *text,  void *text_end)
 494 {
 495         struct smp_alt_module *smp;
 496
 497         mutex_lock(&text_mutex);
 498         if (!uniproc_patched)
 499                 goto unlock;
 500
 501         if (num_possible_cpus() == 1)
 502                 /* Don't bother remembering, we'll never have to undo it. */
 503                 goto smp_unlock;
 504
 505         smp = kzalloc(sizeof(*smp), GFP_KERNEL);
 506         if (NULL == smp)
 507                 /* we'll run the (safe but slow) SMP code then ... */
 508                 goto unlock;
 509
 510         smp->mod        = mod;
 511         smp->name       = name;
 512         smp->locks      = locks;
 513         smp->locks_end  = locks_end;
 514         smp->text       = text;
 515         smp->text_end   = text_end;
 516         DPRINTK("locks %p -> %p, text %p -> %p, name %s\n",
 517                 smp->locks, smp->locks_end,
 518                 smp->text, smp->text_end, smp->name);
 519
 520         list_add_tail(&smp->next, &smp_alt_modules);
 521 smp_unlock:
 522         alternatives_smp_unlock(locks, locks_end, text, text_end);
 523 unlock:
 524         mutex_unlock(&text_mutex);
 525 }
 526
 527 void __init_or_module alternatives_smp_module_del(struct module *mod)
 528 {
 529         struct smp_alt_module *item;
 530
 531         mutex_lock(&text_mutex);
 532         list_for_each_entry(item, &smp_alt_modules, next) {
 533                 if (mod != item->mod)
 534                         continue;
 535                 list_del(&item->next);
 536                 kfree(item);
 537                 break;
 538         }
 539         mutex_unlock(&text_mutex);
 540 }
 541
 542 void alternatives_enable_smp(void)
 543 {
 544         struct smp_alt_module *mod;
 545
 546         /* Why bother if there are no other CPUs? */
 547         BUG_ON(num_possible_cpus() == 1);
 548
 549         mutex_lock(&text_mutex);
 550
 551         if (uniproc_patched) {
 552                 pr_info("switching to SMP code\n");
 553                 BUG_ON(num_online_cpus() != 1);
 554                 clear_cpu_cap(&boot_cpu_data, X86_FEATURE_UP);
 555                 clear_cpu_cap(&cpu_data(0), X86_FEATURE_UP);
 556                 list_for_each_entry(mod, &smp_alt_modules, next)
 557                         alternatives_smp_lock(mod->locks, mod->locks_end,
 558                                               mod->text, mod->text_end);
 559                 uniproc_patched = false;
 560         }
 561         mutex_unlock(&text_mutex);
 562 }
 563
 564 /*
 565  * Return 1 if the address range is reserved for SMP-alternatives.
 566  * Must hold text_mutex.
 567  */
 568 int alternatives_text_reserved(void *start, void *end)
 569 {
 570         struct smp_alt_module *mod;
 571         const s32 *poff;
 572         u8 *text_start = start;
 573         u8 *text_end = end;
 574
 575         lockdep_assert_held(&text_mutex);
 576
 577         list_for_each_entry(mod, &smp_alt_modules, next) {
 578                 if (mod->text > text_end || mod->text_end < text_start)
 579                         continue;
 580                 for (poff = mod->locks; poff < mod->locks_end; poff++) {
 581                         const u8 *ptr = (const u8 *)poff + *poff;
 582
 583                         if (text_start <= ptr && text_end > ptr)
 584                                 return 1;
 585                 }
 586         }
 587
 588         return 0;
 589 }
 590 #endif /* CONFIG_SMP */
 591
 592 #ifdef CONFIG_PARAVIRT
 593 void __init_or_module apply_paravirt(struct paravirt_patch_site *start,
 594                                      struct paravirt_patch_site *end)
 595 {
 596         struct paravirt_patch_site *p;
 597         char insn_buff[MAX_PATCH_LEN];
 598
 599         for (p = start; p < end; p++) {
 600                 unsigned int used;
 601
 602                 BUG_ON(p->len > MAX_PATCH_LEN);
 603                 /* prep the buffer with the original instructions */
 604                 memcpy(insn_buff, p->instr, p->len);
 605                 used = pv_ops.init.patch(p->type, insn_buff, (unsigned long)p->instr, p->len);
 606
 607                 BUG_ON(used > p->len);
 608
 609                 /* Pad the rest with nops */
 610                 add_nops(insn_buff + used, p->len - used);
 611                 text_poke_early(p->instr, insn_buff, p->len);
 612         }
 613 }
 614 extern struct paravirt_patch_site __start_parainstructions[],
 615         __stop_parainstructions[];
 616 #endif  /* CONFIG_PARAVIRT */
 617
 618 /*
 619  * Self-test for the INT3 based CALL emulation code.
 620  *
 621  * This exercises int3_emulate_call() to make sure INT3 pt_regs are set up
 622  * properly and that there is a stack gap between the INT3 frame and the
 623  * previous context. Without this gap doing a virtual PUSH on the interrupted
 624  * stack would corrupt the INT3 IRET frame.
 625  *
 626  * See entry_{32,64}.S for more details.
 627  */
 628 static void __init int3_magic(unsigned int *ptr)
 629 {
 630         *ptr = 1;
 631 }
 632
 633 extern __initdata unsigned long int3_selftest_ip; /* defined in asm below */
 634
 635 static int __init
 636 int3_exception_notify(struct notifier_block *self, unsigned long val, void *data)
 637 {
 638         struct die_args *args = data;
 639         struct pt_regs *regs = args->regs;
 640
 641         if (!regs || user_mode(regs))
 642                 return NOTIFY_DONE;
 643
 644         if (val != DIE_INT3)
 645                 return NOTIFY_DONE;
 646
 647         if (regs->ip - INT3_INSN_SIZE != int3_selftest_ip)
 648                 return NOTIFY_DONE;
 649
 650         int3_emulate_call(regs, (unsigned long)&int3_magic);
 651         return NOTIFY_STOP;
 652 }
 653
 654 static void __init int3_selftest(void)
 655 {
 656         static __initdata struct notifier_block int3_exception_nb = {
 657                 .notifier_call  = int3_exception_notify,
 658                 .priority       = INT_MAX-1, /* last */
 659         };
 660         unsigned int val = 0;
 661
 662         BUG_ON(register_die_notifier(&int3_exception_nb));
 663
 664         /*
 665          * Basically: int3_magic(&val); but really complicated :-)
 666          *
 667          * Stick the address of the INT3 instruction into int3_selftest_ip,
 668          * then trigger the INT3, padded with NOPs to match a CALL instruction
 669          * length.
 670          */
 671         asm volatile ("1: int3; nop; nop; nop; nop\n\t"
 672                       ".pushsection .init.data,\"aw\"\n\t"
 673                       ".align " __ASM_SEL(4, 8) "\n\t"
 674                       ".type int3_selftest_ip, @object\n\t"
 675                       ".size int3_selftest_ip, " __ASM_SEL(4, 8) "\n\t"
 676                       "int3_selftest_ip:\n\t"
 677                       __ASM_SEL(.long, .quad) " 1b\n\t"
 678                       ".popsection\n\t"
 679                       : : __ASM_SEL_RAW(a, D) (&val) : "memory");
 680
 681         BUG_ON(val != 1);
 682
 683         unregister_die_notifier(&int3_exception_nb);
 684 }
 685
 686 void __init alternative_instructions(void)
 687 {
 688         int3_selftest();
 689
 690         /*
 691          * The patching is not fully atomic, so try to avoid local
 692          * interruptions that might execute the to be patched code.
 693          * Other CPUs are not running.
 694          */
 695         stop_nmi();
 696
 697         /*
 698          * Don't stop machine check exceptions while patching.
 699          * MCEs only happen when something got corrupted and in this
 700          * case we must do something about the corruption.
 701          * Ignoring it is worse than a unlikely patching race.
 702          * Also machine checks tend to be broadcast and if one CPU
 703          * goes into machine check the others follow quickly, so we don't
 704          * expect a machine check to cause undue problems during to code
 705          * patching.
 706          */
 707
 708         apply_alternatives(__alt_instructions, __alt_instructions_end);
 709
 710 #ifdef CONFIG_SMP
 711         /* Patch to UP if other cpus not imminent. */
 712         if (!noreplace_smp && (num_present_cpus() == 1 || setup_max_cpus <= 1)) {
 713                 uniproc_patched = true;
 714                 alternatives_smp_module_add(NULL, "core kernel",
 715                                             __smp_locks, __smp_locks_end,
 716                                             _text, _etext);
 717         }
 718
 719         if (!uniproc_patched || num_possible_cpus() == 1) {
 720                 free_init_pages("SMP alternatives",
 721                                 (unsigned long)__smp_locks,
 722                                 (unsigned long)__smp_locks_end);
 723         }
 724 #endif
 725
 726         apply_paravirt(__parainstructions, __parainstructions_end);
 727
 728         restart_nmi();
 729         alternatives_patched = 1;
 730 }
 731
 732 /**
 733  * text_poke_early - Update instructions on a live kernel at boot time
 734  * @addr: address to modify
 735  * @opcode: source of the copy
 736  * @len: length to copy
 737  *
 738  * When you use this code to patch more than one byte of an instruction
 739  * you need to make sure that other CPUs cannot execute this code in parallel.
 740  * Also no thread must be currently preempted in the middle of these
 741  * instructions. And on the local CPU you need to be protected again NMI or MCE
 742  * handlers seeing an inconsistent instruction while you patch.
 743  */
 744 void __init_or_module text_poke_early(void *addr, const void *opcode,
 745                                       size_t len)
 746 {
 747         unsigned long flags;
 748
 749         if (boot_cpu_has(X86_FEATURE_NX) &&
 750             is_module_text_address((unsigned long)addr)) {
 751                 /*
 752                  * Modules text is marked initially as non-executable, so the
 753                  * code cannot be running and speculative code-fetches are
 754                  * prevented. Just change the code.
 755                  */
 756                 memcpy(addr, opcode, len);
 757         } else {
 758                 local_irq_save(flags);
 759                 memcpy(addr, opcode, len);
 760                 local_irq_restore(flags);
 761                 sync_core();
 762
 763                 /*
 764                  * Could also do a CLFLUSH here to speed up CPU recovery; but
 765                  * that causes hangs on some VIA CPUs.
 766                  */
 767         }
 768 }
 769
 770 __ro_after_init struct mm_struct *poking_mm;
 771 __ro_after_init unsigned long poking_addr;
 772
 773 static void *__text_poke(void *addr, const void *opcode, size_t len)
 774 {
 775         bool cross_page_boundary = offset_in_page(addr) + len > PAGE_SIZE;
 776         struct page *pages[2] = {NULL};
 777         temp_mm_state_t prev;
 778         unsigned long flags;
 779         pte_t pte, *ptep;
 780         spinlock_t *ptl;
 781         pgprot_t pgprot;
 782
 783         /*
 784          * While boot memory allocator is running we cannot use struct pages as
 785          * they are not yet initialized. There is no way to recover.
 786          */
 787         BUG_ON(!after_bootmem);
 788
 789         if (!core_kernel_text((unsigned long)addr)) {
 790                 pages[0] = vmalloc_to_page(addr);
 791                 if (cross_page_boundary)
 792                         pages[1] = vmalloc_to_page(addr + PAGE_SIZE);
 793         } else {
 794                 pages[0] = virt_to_page(addr);
 795                 WARN_ON(!PageReserved(pages[0]));
 796                 if (cross_page_boundary)
 797                         pages[1] = virt_to_page(addr + PAGE_SIZE);
 798         }
 799         /*
 800          * If something went wrong, crash and burn since recovery paths are not
 801          * implemented.
 802          */
 803         BUG_ON(!pages[0] || (cross_page_boundary && !pages[1]));
 804
 805         local_irq_save(flags);
 806
 807         /*
 808          * Map the page without the global bit, as TLB flushing is done with
 809          * flush_tlb_mm_range(), which is intended for non-global PTEs.
 810          */
 811         pgprot = __pgprot(pgprot_val(PAGE_KERNEL) & ~_PAGE_GLOBAL);
 812
 813         /*
 814          * The lock is not really needed, but this allows to avoid open-coding.
 815          */
 816         ptep = get_locked_pte(poking_mm, poking_addr, &ptl);
 817
 818         /*
 819          * This must not fail; preallocated in poking_init().
 820          */
 821         VM_BUG_ON(!ptep);
 822
 823         pte = mk_pte(pages[0], pgprot);
 824         set_pte_at(poking_mm, poking_addr, ptep, pte);
 825
 826         if (cross_page_boundary) {
 827                 pte = mk_pte(pages[1], pgprot);
 828                 set_pte_at(poking_mm, poking_addr + PAGE_SIZE, ptep + 1, pte);
 829         }
 830
 831         /*
 832          * Loading the temporary mm behaves as a compiler barrier, which
 833          * guarantees that the PTE will be set at the time memcpy() is done.
 834          */
 835         prev = use_temporary_mm(poking_mm);
 836
 837         kasan_disable_current();
 838         memcpy((u8 *)poking_addr + offset_in_page(addr), opcode, len);
 839         kasan_enable_current();
 840
 841         /*
 842          * Ensure that the PTE is only cleared after the instructions of memcpy
 843          * were issued by using a compiler barrier.
 844          */
 845         barrier();
 846
 847         pte_clear(poking_mm, poking_addr, ptep);
 848         if (cross_page_boundary)
 849                 pte_clear(poking_mm, poking_addr + PAGE_SIZE, ptep + 1);
 850
 851         /*
 852          * Loading the previous page-table hierarchy requires a serializing
 853          * instruction that already allows the core to see the updated version.
 854          * Xen-PV is assumed to serialize execution in a similar manner.
 855          */
 856         unuse_temporary_mm(prev);
 857
 858         /*
 859          * Flushing the TLB might involve IPIs, which would require enabled
 860          * IRQs, but not if the mm is not used, as it is in this point.
 861          */
 862         flush_tlb_mm_range(poking_mm, poking_addr, poking_addr +
 863                            (cross_page_boundary ? 2 : 1) * PAGE_SIZE,
 864                            PAGE_SHIFT, false);
 865
 866         /*
 867          * If the text does not match what we just wrote then something is
 868          * fundamentally screwy; there's nothing we can really do about that.
 869          */
 870         BUG_ON(memcmp(addr, opcode, len));
 871
 872         pte_unmap_unlock(ptep, ptl);
 873         local_irq_restore(flags);
 874         return addr;
 875 }
 876
 877 /**
 878  * text_poke - Update instructions on a live kernel
 879  * @addr: address to modify
 880  * @opcode: source of the copy
 881  * @len: length to copy
 882  *
 883  * Only atomic text poke/set should be allowed when not doing early patching.
 884  * It means the size must be writable atomically and the address must be aligned
 885  * in a way that permits an atomic write. It also makes sure we fit on a single
 886  * page.
 887  *
 888  * Note that the caller must ensure that if the modified code is part of a
 889  * module, the module would not be removed during poking. This can be achieved
 890  * by registering a module notifier, and ordering module removal and patching
 891  * trough a mutex.
 892  */
 893 void *text_poke(void *addr, const void *opcode, size_t len)
 894 {
 895         lockdep_assert_held(&text_mutex);
 896
 897         return __text_poke(addr, opcode, len);
 898 }
 899
 900 /**
 901  * text_poke_kgdb - Update instructions on a live kernel by kgdb
 902  * @addr: address to modify
 903  * @opcode: source of the copy
 904  * @len: length to copy
 905  *
 906  * Only atomic text poke/set should be allowed when not doing early patching.
 907  * It means the size must be writable atomically and the address must be aligned
 908  * in a way that permits an atomic write. It also makes sure we fit on a single
 909  * page.
 910  *
 911  * Context: should only be used by kgdb, which ensures no other core is running,
 912  *          despite the fact it does not hold the text_mutex.
 913  */
 914 void *text_poke_kgdb(void *addr, const void *opcode, size_t len)
 915 {
 916         return __text_poke(addr, opcode, len);
 917 }
 918
 919 static void do_sync_core(void *info)
 920 {
 921         sync_core();
 922 }
 923
 924 static struct bp_patching_desc {
 925         struct text_poke_loc *vec;
 926         int nr_entries;
 927 } bp_patching;
 928
 929 static int patch_cmp(const void *key, const void *elt)
 930 {
 931         struct text_poke_loc *tp = (struct text_poke_loc *) elt;
 932
 933         if (key < tp->addr)
 934                 return -1;
 935         if (key > tp->addr)
 936                 return 1;
 937         return 0;
 938 }
 939 NOKPROBE_SYMBOL(patch_cmp);
 940
 941 int poke_int3_handler(struct pt_regs *regs)
 942 {
 943         struct text_poke_loc *tp;
 944         unsigned char int3 = 0xcc;
 945         void *ip;
 946
 947         /*
 948          * Having observed our INT3 instruction, we now must observe
 949          * bp_patching.nr_entries.
 950          *
 951          *      nr_entries != 0                 INT3
 952          *      WMB                             RMB
 953          *      write INT3                      if (nr_entries)
 954          *
 955          * Idem for other elements in bp_patching.
 956          */
 957         smp_rmb();
 958
 959         if (likely(!bp_patching.nr_entries))
 960                 return 0;
 961
 962         if (user_mode(regs))
 963                 return 0;
 964
 965         /*
 966          * Discount the sizeof(int3). See text_poke_bp_batch().
 967          */
 968         ip = (void *) regs->ip - sizeof(int3);
 969
 970         /*
 971          * Skip the binary search if there is a single member in the vector.
 972          */
 973         if (unlikely(bp_patching.nr_entries > 1)) {
 974                 tp = bsearch(ip, bp_patching.vec, bp_patching.nr_entries,
 975                              sizeof(struct text_poke_loc),
 976                              patch_cmp);
 977                 if (!tp)
 978                         return 0;
 979         } else {
 980                 tp = bp_patching.vec;
 981                 if (tp->addr != ip)
 982                         return 0;
 983         }
 984
 985         /* set up the specified breakpoint detour */
 986         regs->ip = (unsigned long) tp->detour;
 987
 988         return 1;
 989 }
 990 NOKPROBE_SYMBOL(poke_int3_handler);
 991
 992 /**
 993  * text_poke_bp_batch() -- update instructions on live kernel on SMP
 994  * @tp:                 vector of instructions to patch
 995  * @nr_entries:         number of entries in the vector
 996  *
 997  * Modify multi-byte instruction by using int3 breakpoint on SMP.
 998  * We completely avoid stop_machine() here, and achieve the
 999  * synchronization using int3 breakpoint.
1000  *
1001  * The way it is done:
1002  *      - For each entry in the vector:
1003  *              - add a int3 trap to the address that will be patched
1004  *      - sync cores
1005  *      - For each entry in the vector:
1006  *              - update all but the first byte of the patched range
1007  *      - sync cores
1008  *      - For each entry in the vector:
1009  *              - replace the first byte (int3) by the first byte of
1010  *                replacing opcode
1011  *      - sync cores
1012  */
1013 void text_poke_bp_batch(struct text_poke_loc *tp, unsigned int nr_entries)
1014 {
1015         int patched_all_but_first = 0;
1016         unsigned char int3 = 0xcc;
1017         unsigned int i;
1018
1019         lockdep_assert_held(&text_mutex);
1020
1021         bp_patching.vec = tp;
1022         bp_patching.nr_entries = nr_entries;
1023
1024         /*
1025          * Corresponding read barrier in int3 notifier for making sure the
1026          * nr_entries and handler are correctly ordered wrt. patching.
1027          */
1028         smp_wmb();
1029
1030         /*
1031          * First step: add a int3 trap to the address that will be patched.
1032          */
1033         for (i = 0; i < nr_entries; i++)
1034                 text_poke(tp[i].addr, &int3, sizeof(int3));
1035
1036         on_each_cpu(do_sync_core, NULL, 1);
1037
1038         /*
1039          * Second step: update all but the first byte of the patched range.
1040          */
1041         for (i = 0; i < nr_entries; i++) {
1042                 if (tp[i].len - sizeof(int3) > 0) {
1043                         text_poke((char *)tp[i].addr + sizeof(int3),
1044                                   (const char *)tp[i].opcode + sizeof(int3),
1045                                   tp[i].len - sizeof(int3));
1046                         patched_all_but_first++;
1047                 }
1048         }
1049
1050         if (patched_all_but_first) {
1051                 /*
1052                  * According to Intel, this core syncing is very likely
1053                  * not necessary and we'd be safe even without it. But
1054                  * better safe than sorry (plus there's not only Intel).
1055                  */
1056                 on_each_cpu(do_sync_core, NULL, 1);
1057         }
1058
1059         /*
1060          * Third step: replace the first byte (int3) by the first byte of
1061          * replacing opcode.
1062          */
1063         for (i = 0; i < nr_entries; i++)
1064                 text_poke(tp[i].addr, tp[i].opcode, sizeof(int3));
1065
1066         on_each_cpu(do_sync_core, NULL, 1);
1067         /*
1068          * sync_core() implies an smp_mb() and orders this store against
1069          * the writing of the new instruction.
1070          */
1071         bp_patching.vec = NULL;
1072         bp_patching.nr_entries = 0;
1073 }
1074
1075 /**
1076  * text_poke_bp() -- update instructions on live kernel on SMP
1077  * @addr:       address to patch
1078  * @opcode:     opcode of new instruction
1079  * @len:        length to copy
1080  * @handler:    address to jump to when the temporary breakpoint is hit
1081  *
1082  * Update a single instruction with the vector in the stack, avoiding
1083  * dynamically allocated memory. This function should be used when it is
1084  * not possible to allocate memory.
1085  */
1086 void text_poke_bp(void *addr, const void *opcode, size_t len, void *handler)
1087 {
1088         struct text_poke_loc tp = {
1089                 .detour = handler,
1090                 .addr = addr,
1091                 .len = len,
1092         };
1093
1094         if (len > POKE_MAX_OPCODE_SIZE) {
1095                 WARN_ONCE(1, "len is larger than %d\n", POKE_MAX_OPCODE_SIZE);
1096                 return;
1097         }
1098
1099         memcpy((void *)tp.opcode, opcode, len);
1100
1101         text_poke_bp_batch(&tp, 1);
1102 }