arch/x86/include/asm/text-patching.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _ASM_X86_TEXT_PATCHING_H
   3 #define _ASM_X86_TEXT_PATCHING_H
   4
   5 #include <linux/types.h>
   6 #include <linux/stddef.h>
   7 #include <asm/ptrace.h>
   8
   9 struct paravirt_patch_site;
  10 #ifdef CONFIG_PARAVIRT
  11 void apply_paravirt(struct paravirt_patch_site *start,
  12                     struct paravirt_patch_site *end);
  13 #else
  14 static inline void apply_paravirt(struct paravirt_patch_site *start,
  15                                   struct paravirt_patch_site *end)
  16 {}
  17 #define __parainstructions      NULL
  18 #define __parainstructions_end  NULL
  19 #endif
  20
  21 /*
  22  * Currently, the max observed size in the kernel code is
  23  * JUMP_LABEL_NOP_SIZE/RELATIVEJUMP_SIZE, which are 5.
  24  * Raise it if needed.
  25  */
  26 #define POKE_MAX_OPCODE_SIZE    5
  27
  28 extern void text_poke_early(void *addr, const void *opcode, size_t len);
  29
  30 /*
  31  * Clear and restore the kernel write-protection flag on the local CPU.
  32  * Allows the kernel to edit read-only pages.
  33  * Side-effect: any interrupt handler running between save and restore will have
  34  * the ability to write to read-only pages.
  35  *
  36  * Warning:
  37  * Code patching in the UP case is safe if NMIs and MCE handlers are stopped and
  38  * no thread can be preempted in the instructions being modified (no iret to an
  39  * invalid instruction possible) or if the instructions are changed from a
  40  * consistent state to another consistent state atomically.
  41  * On the local CPU you need to be protected against NMI or MCE handlers seeing
  42  * an inconsistent instruction while you patch.
  43  */
  44 extern void *text_poke(void *addr, const void *opcode, size_t len);
  45 extern void text_poke_sync(void);
  46 extern void *text_poke_kgdb(void *addr, const void *opcode, size_t len);
  47 extern void *text_poke_copy(void *addr, const void *opcode, size_t len);
  48 extern int poke_int3_handler(struct pt_regs *regs);
  49 extern void text_poke_bp(void *addr, const void *opcode, size_t len, const void *emulate);
  50
  51 extern void text_poke_queue(void *addr, const void *opcode, size_t len, const void *emulate);
  52 extern void text_poke_finish(void);
  53
  54 #define INT3_INSN_SIZE          1
  55 #define INT3_INSN_OPCODE        0xCC
  56
  57 #define RET_INSN_SIZE           1
  58 #define RET_INSN_OPCODE         0xC3
  59
  60 #define CALL_INSN_SIZE          5
  61 #define CALL_INSN_OPCODE        0xE8
  62
  63 #define JMP32_INSN_SIZE         5
  64 #define JMP32_INSN_OPCODE       0xE9
  65
  66 #define JMP8_INSN_SIZE          2
  67 #define JMP8_INSN_OPCODE        0xEB
  68
  69 #define DISP32_SIZE             4
  70
  71 static __always_inline int text_opcode_size(u8 opcode)
  72 {
  73         int size = 0;
  74
  75 #define __CASE(insn)    \
  76         case insn##_INSN_OPCODE: size = insn##_INSN_SIZE; break
  77
  78         switch(opcode) {
  79         __CASE(INT3);
  80         __CASE(RET);
  81         __CASE(CALL);
  82         __CASE(JMP32);
  83         __CASE(JMP8);
  84         }
  85
  86 #undef __CASE
  87
  88         return size;
  89 }
  90
  91 union text_poke_insn {
  92         u8 text[POKE_MAX_OPCODE_SIZE];
  93         struct {
  94                 u8 opcode;
  95                 s32 disp;
  96         } __attribute__((packed));
  97 };
  98
  99 static __always_inline
 100 void *text_gen_insn(u8 opcode, const void *addr, const void *dest)
 101 {
 102         static union text_poke_insn insn; /* per instance */
 103         int size = text_opcode_size(opcode);
 104
 105         insn.opcode = opcode;
 106
 107         if (size > 1) {
 108                 insn.disp = (long)dest - (long)(addr + size);
 109                 if (size == 2) {
 110                         /*
 111                          * Ensure that for JMP9 the displacement
 112                          * actually fits the signed byte.
 113                          */
 114                         BUG_ON((insn.disp >> 31) != (insn.disp >> 7));
 115                 }
 116         }
 117
 118         return &insn.text;
 119 }
 120
 121 extern int after_bootmem;
 122 extern __ro_after_init struct mm_struct *poking_mm;
 123 extern __ro_after_init unsigned long poking_addr;
 124
 125 #ifndef CONFIG_UML_X86
 126 static __always_inline
 127 void int3_emulate_jmp(struct pt_regs *regs, unsigned long ip)
 128 {
 129         regs->ip = ip;
 130 }
 131
 132 static __always_inline
 133 void int3_emulate_push(struct pt_regs *regs, unsigned long val)
 134 {
 135         /*
 136          * The int3 handler in entry_64.S adds a gap between the
 137          * stack where the break point happened, and the saving of
 138          * pt_regs. We can extend the original stack because of
 139          * this gap. See the idtentry macro's create_gap option.
 140          *
 141          * Similarly entry_32.S will have a gap on the stack for (any) hardware
 142          * exception and pt_regs; see FIXUP_FRAME.
 143          */
 144         regs->sp -= sizeof(unsigned long);
 145         *(unsigned long *)regs->sp = val;
 146 }
 147
 148 static __always_inline
 149 unsigned long int3_emulate_pop(struct pt_regs *regs)
 150 {
 151         unsigned long val = *(unsigned long *)regs->sp;
 152         regs->sp += sizeof(unsigned long);
 153         return val;
 154 }
 155
 156 static __always_inline
 157 void int3_emulate_call(struct pt_regs *regs, unsigned long func)
 158 {
 159         int3_emulate_push(regs, regs->ip - INT3_INSN_SIZE + CALL_INSN_SIZE);
 160         int3_emulate_jmp(regs, func);
 161 }
 162
 163 static __always_inline
 164 void int3_emulate_ret(struct pt_regs *regs)
 165 {
 166         unsigned long ip = int3_emulate_pop(regs);
 167         int3_emulate_jmp(regs, ip);
 168 }
 169 #endif /* !CONFIG_UML_X86 */
 170
 171 #endif /* _ASM_X86_TEXT_PATCHING_H */