arch/x86/kernel/static_call.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/static_call.h>
   3 #include <linux/memory.h>
   4 #include <linux/bug.h>
   5 #include <asm/text-patching.h>
   6
   7 enum insn_type {
   8         CALL = 0, /* site call */
   9         NOP = 1,  /* site cond-call */
  10         JMP = 2,  /* tramp / site tail-call */
  11         RET = 3,  /* tramp / site cond-tail-call */
  12 };
  13
  14 /*
  15  * ud1 %esp, %ecx - a 3 byte #UD that is unique to trampolines, chosen such
  16  * that there is no false-positive trampoline identification while also being a
  17  * speculation stop.
  18  */
  19 static const u8 tramp_ud[] = { 0x0f, 0xb9, 0xcc };
  20
  21 /*
  22  * cs cs cs xorl %eax, %eax - a single 5 byte instruction that clears %[er]ax
  23  */
  24 static const u8 xor5rax[] = { 0x2e, 0x2e, 0x2e, 0x31, 0xc0 };
  25
  26 static const u8 retinsn[] = { RET_INSN_OPCODE, 0xcc, 0xcc, 0xcc, 0xcc };
  27
  28 static void __ref __static_call_transform(void *insn, enum insn_type type, void *func)
  29 {
  30         const void *emulate = NULL;
  31         int size = CALL_INSN_SIZE;
  32         const void *code;
  33
  34         switch (type) {
  35         case CALL:
  36                 code = text_gen_insn(CALL_INSN_OPCODE, insn, func);
  37                 if (func == &__static_call_return0) {
  38                         emulate = code;
  39                         code = &xor5rax;
  40                 }
  41
  42                 break;
  43
  44         case NOP:
  45                 code = x86_nops[5];
  46                 break;
  47
  48         case JMP:
  49                 code = text_gen_insn(JMP32_INSN_OPCODE, insn, func);
  50                 break;
  51
  52         case RET:
  53                 if (cpu_feature_enabled(X86_FEATURE_RETHUNK))
  54                         code = text_gen_insn(JMP32_INSN_OPCODE, insn, &__x86_return_thunk);
  55                 else
  56                         code = &retinsn;
  57                 break;
  58         }
  59
  60         if (memcmp(insn, code, size) == 0)
  61                 return;
  62
  63         if (unlikely(system_state == SYSTEM_BOOTING))
  64                 return text_poke_early(insn, code, size);
  65
  66         text_poke_bp(insn, code, size, emulate);
  67 }
  68
  69 static void __static_call_validate(void *insn, bool tail, bool tramp)
  70 {
  71         u8 opcode = *(u8 *)insn;
  72
  73         if (tramp && memcmp(insn+5, tramp_ud, 3)) {
  74                 pr_err("trampoline signature fail");
  75                 BUG();
  76         }
  77
  78         if (tail) {
  79                 if (opcode == JMP32_INSN_OPCODE ||
  80                     opcode == RET_INSN_OPCODE)
  81                         return;
  82         } else {
  83                 if (opcode == CALL_INSN_OPCODE ||
  84                     !memcmp(insn, x86_nops[5], 5) ||
  85                     !memcmp(insn, xor5rax, 5))
  86                         return;
  87         }
  88
  89         /*
  90          * If we ever trigger this, our text is corrupt, we'll probably not live long.
  91          */
  92         pr_err("unexpected static_call insn opcode 0x%x at %pS\n", opcode, insn);
  93         BUG();
  94 }
  95
  96 static inline enum insn_type __sc_insn(bool null, bool tail)
  97 {
  98         /*
  99          * Encode the following table without branches:
 100          *
 101          *      tail    null    insn
 102          *      -----+-------+------
 103          *        0  |   0   |  CALL
 104          *        0  |   1   |  NOP
 105          *        1  |   0   |  JMP
 106          *        1  |   1   |  RET
 107          */
 108         return 2*tail + null;
 109 }
 110
 111 void arch_static_call_transform(void *site, void *tramp, void *func, bool tail)
 112 {
 113         mutex_lock(&text_mutex);
 114
 115         if (tramp) {
 116                 __static_call_validate(tramp, true, true);
 117                 __static_call_transform(tramp, __sc_insn(!func, true), func);
 118         }
 119
 120         if (IS_ENABLED(CONFIG_HAVE_STATIC_CALL_INLINE) && site) {
 121                 __static_call_validate(site, tail, false);
 122                 __static_call_transform(site, __sc_insn(!func, tail), func);
 123         }
 124
 125         mutex_unlock(&text_mutex);
 126 }
 127 EXPORT_SYMBOL_GPL(arch_static_call_transform);
 128
 129 #ifdef CONFIG_RETHUNK
 130 /*
 131  * This is called by apply_returns() to fix up static call trampolines,
 132  * specifically ARCH_DEFINE_STATIC_CALL_NULL_TRAMP which is recorded as
 133  * having a return trampoline.
 134  *
 135  * The problem is that static_call() is available before determining
 136  * X86_FEATURE_RETHUNK and, by implication, running alternatives.
 137  *
 138  * This means that __static_call_transform() above can have overwritten the
 139  * return trampoline and we now need to fix things up to be consistent.
 140  */
 141 bool __static_call_fixup(void *tramp, u8 op, void *dest)
 142 {
 143         if (memcmp(tramp+5, tramp_ud, 3)) {
 144                 /* Not a trampoline site, not our problem. */
 145                 return false;
 146         }
 147
 148         if (op == RET_INSN_OPCODE || dest == &__x86_return_thunk)
 149                 __static_call_transform(tramp, RET, NULL);
 150
 151         return true;
 152 }
 153 #endif