1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_X86_TEXT_PATCHING_H
3 #define _ASM_X86_TEXT_PATCHING_H
5 #include <linux/types.h>
6 #include <linux/stddef.h>
7 #include <asm/ptrace.h>
10 * Currently, the max observed size in the kernel code is
11 * JUMP_LABEL_NOP_SIZE/RELATIVEJUMP_SIZE, which are 5.
14 #define POKE_MAX_OPCODE_SIZE 5
16 extern void text_poke_early(void *addr, const void *opcode, size_t len);
19 * Clear and restore the kernel write-protection flag on the local CPU.
20 * Allows the kernel to edit read-only pages.
21 * Side-effect: any interrupt handler running between save and restore will have
22 * the ability to write to read-only pages.
25 * Code patching in the UP case is safe if NMIs and MCE handlers are stopped and
26 * no thread can be preempted in the instructions being modified (no iret to an
27 * invalid instruction possible) or if the instructions are changed from a
28 * consistent state to another consistent state atomically.
29 * On the local CPU you need to be protected against NMI or MCE handlers seeing
30 * an inconsistent instruction while you patch.
32 extern void *text_poke(void *addr, const void *opcode, size_t len);
33 extern void text_poke_sync(void);
34 extern void *text_poke_kgdb(void *addr, const void *opcode, size_t len);
35 extern void *text_poke_copy(void *addr, const void *opcode, size_t len);
36 extern void *text_poke_copy_locked(void *addr, const void *opcode, size_t len, bool core_ok);
37 extern void *text_poke_set(void *addr, int c, size_t len);
38 extern int poke_int3_handler(struct pt_regs *regs);
39 extern void text_poke_bp(void *addr, const void *opcode, size_t len, const void *emulate);
41 extern void text_poke_queue(void *addr, const void *opcode, size_t len, const void *emulate);
42 extern void text_poke_finish(void);
44 #define INT3_INSN_SIZE 1
45 #define INT3_INSN_OPCODE 0xCC
47 #define RET_INSN_SIZE 1
48 #define RET_INSN_OPCODE 0xC3
50 #define CALL_INSN_SIZE 5
51 #define CALL_INSN_OPCODE 0xE8
53 #define JMP32_INSN_SIZE 5
54 #define JMP32_INSN_OPCODE 0xE9
56 #define JMP8_INSN_SIZE 2
57 #define JMP8_INSN_OPCODE 0xEB
61 static __always_inline int text_opcode_size(u8 opcode)
65 #define __CASE(insn) \
66 case insn##_INSN_OPCODE: size = insn##_INSN_SIZE; break
81 union text_poke_insn {
82 u8 text[POKE_MAX_OPCODE_SIZE];
86 } __attribute__((packed));
89 static __always_inline
90 void __text_gen_insn(void *buf, u8 opcode, const void *addr, const void *dest, int size)
92 union text_poke_insn *insn = buf;
94 BUG_ON(size < text_opcode_size(opcode));
97 * Hide the addresses to avoid the compiler folding in constants when
98 * referencing code, these can mess up annotations like
101 OPTIMIZER_HIDE_VAR(insn);
102 OPTIMIZER_HIDE_VAR(addr);
103 OPTIMIZER_HIDE_VAR(dest);
105 insn->opcode = opcode;
108 insn->disp = (long)dest - (long)(addr + size);
111 * Ensure that for JMP8 the displacement
112 * actually fits the signed byte.
114 BUG_ON((insn->disp >> 31) != (insn->disp >> 7));
119 static __always_inline
120 void *text_gen_insn(u8 opcode, const void *addr, const void *dest)
122 static union text_poke_insn insn; /* per instance */
123 __text_gen_insn(&insn, opcode, addr, dest, text_opcode_size(opcode));
127 extern int after_bootmem;
128 extern __ro_after_init struct mm_struct *poking_mm;
129 extern __ro_after_init unsigned long poking_addr;
131 #ifndef CONFIG_UML_X86
132 static __always_inline
133 void int3_emulate_jmp(struct pt_regs *regs, unsigned long ip)
138 static __always_inline
139 void int3_emulate_push(struct pt_regs *regs, unsigned long val)
142 * The int3 handler in entry_64.S adds a gap between the
143 * stack where the break point happened, and the saving of
144 * pt_regs. We can extend the original stack because of
145 * this gap. See the idtentry macro's create_gap option.
147 * Similarly entry_32.S will have a gap on the stack for (any) hardware
148 * exception and pt_regs; see FIXUP_FRAME.
150 regs->sp -= sizeof(unsigned long);
151 *(unsigned long *)regs->sp = val;
154 static __always_inline
155 unsigned long int3_emulate_pop(struct pt_regs *regs)
157 unsigned long val = *(unsigned long *)regs->sp;
158 regs->sp += sizeof(unsigned long);
162 static __always_inline
163 void int3_emulate_call(struct pt_regs *regs, unsigned long func)
165 int3_emulate_push(regs, regs->ip - INT3_INSN_SIZE + CALL_INSN_SIZE);
166 int3_emulate_jmp(regs, func);
169 static __always_inline
170 void int3_emulate_ret(struct pt_regs *regs)
172 unsigned long ip = int3_emulate_pop(regs);
173 int3_emulate_jmp(regs, ip);
176 static __always_inline
177 void int3_emulate_jcc(struct pt_regs *regs, u8 cc, unsigned long ip, unsigned long disp)
179 static const unsigned long jcc_mask[6] = {
183 [3] = X86_EFLAGS_CF | X86_EFLAGS_ZF,
188 bool invert = cc & 1;
192 match = regs->flags & jcc_mask[cc >> 1];
194 match = ((regs->flags & X86_EFLAGS_SF) >> X86_EFLAGS_SF_BIT) ^
195 ((regs->flags & X86_EFLAGS_OF) >> X86_EFLAGS_OF_BIT);
197 match = match || (regs->flags & X86_EFLAGS_ZF);
200 if ((match && !invert) || (!match && invert))
203 int3_emulate_jmp(regs, ip);
206 #endif /* !CONFIG_UML_X86 */
208 #endif /* _ASM_X86_TEXT_PATCHING_H */