xref: /openbmc/linux/arch/x86/kernel/jump_label.c (revision 001951bea748d3f675e1778f42b17290a8c551bf)
1b2441318SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0
2d9f5ab7bSJason Baron /*
3d9f5ab7bSJason Baron  * jump label x86 support
4d9f5ab7bSJason Baron  *
5d9f5ab7bSJason Baron  * Copyright (C) 2009 Jason Baron <jbaron@redhat.com>
6d9f5ab7bSJason Baron  *
7d9f5ab7bSJason Baron  */
8d9f5ab7bSJason Baron #include <linux/jump_label.h>
9d9f5ab7bSJason Baron #include <linux/memory.h>
10d9f5ab7bSJason Baron #include <linux/uaccess.h>
11d9f5ab7bSJason Baron #include <linux/module.h>
12d9f5ab7bSJason Baron #include <linux/list.h>
13d9f5ab7bSJason Baron #include <linux/jhash.h>
14d9f5ab7bSJason Baron #include <linux/cpu.h>
15d9f5ab7bSJason Baron #include <asm/kprobes.h>
16d9f5ab7bSJason Baron #include <asm/alternative.h>
1735de5b06SAndy Lutomirski #include <asm/text-patching.h>
18d9f5ab7bSJason Baron 
19fa5e5dc3SPeter Zijlstra #define JUMP_LABEL_NOP_SIZE	JMP32_INSN_SIZE
20fa5e5dc3SPeter Zijlstra 
21fa5e5dc3SPeter Zijlstra int arch_jump_entry_size(struct jump_entry *entry)
22fa5e5dc3SPeter Zijlstra {
23fa5e5dc3SPeter Zijlstra 	return JMP32_INSN_SIZE;
24fa5e5dc3SPeter Zijlstra }
25fa5e5dc3SPeter Zijlstra 
26*001951beSPeter Zijlstra struct jump_label_patch {
27*001951beSPeter Zijlstra 	const void *code;
28*001951beSPeter Zijlstra 	int size;
29*001951beSPeter Zijlstra };
30*001951beSPeter Zijlstra 
31*001951beSPeter Zijlstra static struct jump_label_patch
32*001951beSPeter Zijlstra __jump_label_patch(struct jump_entry *entry, enum jump_label_type type)
33d9f5ab7bSJason Baron {
34*001951beSPeter Zijlstra 	const void *expect, *code, *nop;
3563f62addSPeter Zijlstra 	const void *addr, *dest;
36*001951beSPeter Zijlstra 	int size;
379fc0f798SArd Biesheuvel 
3863f62addSPeter Zijlstra 	addr = (void *)jump_entry_code(entry);
3963f62addSPeter Zijlstra 	dest = (void *)jump_entry_target(entry);
4018cbc8beSPeter Zijlstra 
41*001951beSPeter Zijlstra 	size = arch_jump_entry_size(entry);
42*001951beSPeter Zijlstra 	switch (size) {
43*001951beSPeter Zijlstra 	case JMP8_INSN_SIZE:
44*001951beSPeter Zijlstra 		code = text_gen_insn(JMP8_INSN_OPCODE, addr, dest);
45*001951beSPeter Zijlstra 		nop = x86_nops[size];
46*001951beSPeter Zijlstra 		break;
47*001951beSPeter Zijlstra 
48*001951beSPeter Zijlstra 	case JMP32_INSN_SIZE:
4963f62addSPeter Zijlstra 		code = text_gen_insn(JMP32_INSN_OPCODE, addr, dest);
50*001951beSPeter Zijlstra 		nop = x86_nops[size];
51*001951beSPeter Zijlstra 		break;
52*001951beSPeter Zijlstra 
53*001951beSPeter Zijlstra 	default: BUG();
54*001951beSPeter Zijlstra 	}
55d9f5ab7bSJason Baron 
56f9510fa9SPeter Zijlstra 	if (type == JUMP_LABEL_JMP)
57*001951beSPeter Zijlstra 		expect = nop;
58f9510fa9SPeter Zijlstra 	else
59f9510fa9SPeter Zijlstra 		expect = code;
60e71a5be1SJeremy Fitzhardinge 
61*001951beSPeter Zijlstra 	if (memcmp(addr, expect, size)) {
62f9510fa9SPeter Zijlstra 		/*
63f9510fa9SPeter Zijlstra 		 * The location is not an op that we were expecting.
64f9510fa9SPeter Zijlstra 		 * Something went wrong. Crash the box, as something could be
65f9510fa9SPeter Zijlstra 		 * corrupting the kernel.
66f9510fa9SPeter Zijlstra 		 */
67*001951beSPeter Zijlstra 		pr_crit("jump_label: Fatal kernel bug, unexpected op at %pS [%p] (%5ph != %5ph)) size:%d type:%d\n",
68*001951beSPeter Zijlstra 				addr, addr, addr, expect, size, type);
69f9510fa9SPeter Zijlstra 		BUG();
70f9510fa9SPeter Zijlstra 	}
719fc0f798SArd Biesheuvel 
724cc6620bSDaniel Bristot de Oliveira 	if (type == JUMP_LABEL_NOP)
73*001951beSPeter Zijlstra 		code = nop;
7418cbc8beSPeter Zijlstra 
75*001951beSPeter Zijlstra 	return (struct jump_label_patch){.code = code, .size = size};
764cc6620bSDaniel Bristot de Oliveira }
774cc6620bSDaniel Bristot de Oliveira 
784de4952cSRandy Dunlap static inline void __jump_label_transform(struct jump_entry *entry,
794cc6620bSDaniel Bristot de Oliveira 					  enum jump_label_type type,
804cc6620bSDaniel Bristot de Oliveira 					  int init)
814cc6620bSDaniel Bristot de Oliveira {
82*001951beSPeter Zijlstra 	const struct jump_label_patch jlp = __jump_label_patch(entry, type);
834cc6620bSDaniel Bristot de Oliveira 
8451b2c07bSJiri Kosina 	/*
85bb0a008dSNadav Amit 	 * As long as only a single processor is running and the code is still
86bb0a008dSNadav Amit 	 * not marked as RO, text_poke_early() can be used; Checking that
87bb0a008dSNadav Amit 	 * system_state is SYSTEM_BOOTING guarantees it. It will be set to
88bb0a008dSNadav Amit 	 * SYSTEM_SCHEDULING before other cores are awaken and before the
89bb0a008dSNadav Amit 	 * code is write-protected.
9051b2c07bSJiri Kosina 	 *
9151b2c07bSJiri Kosina 	 * At the time the change is being done, just ignore whether we
9251b2c07bSJiri Kosina 	 * are doing nop -> jump or jump -> nop transition, and assume
9351b2c07bSJiri Kosina 	 * always nop being the 'currently valid' instruction
9451b2c07bSJiri Kosina 	 */
95bb0a008dSNadav Amit 	if (init || system_state == SYSTEM_BOOTING) {
96*001951beSPeter Zijlstra 		text_poke_early((void *)jump_entry_code(entry), jlp.code, jlp.size);
979fc0f798SArd Biesheuvel 		return;
989fc0f798SArd Biesheuvel 	}
999fc0f798SArd Biesheuvel 
100*001951beSPeter Zijlstra 	text_poke_bp((void *)jump_entry_code(entry), jlp.code, jlp.size, NULL);
10118cbc8beSPeter Zijlstra }
10218cbc8beSPeter Zijlstra 
10318cbc8beSPeter Zijlstra static void __ref jump_label_transform(struct jump_entry *entry,
10418cbc8beSPeter Zijlstra 				       enum jump_label_type type,
10518cbc8beSPeter Zijlstra 				       int init)
10618cbc8beSPeter Zijlstra {
10718cbc8beSPeter Zijlstra 	mutex_lock(&text_mutex);
10818cbc8beSPeter Zijlstra 	__jump_label_transform(entry, type, init);
10918cbc8beSPeter Zijlstra 	mutex_unlock(&text_mutex);
110e71a5be1SJeremy Fitzhardinge }
111e71a5be1SJeremy Fitzhardinge 
112e71a5be1SJeremy Fitzhardinge void arch_jump_label_transform(struct jump_entry *entry,
113e71a5be1SJeremy Fitzhardinge 			       enum jump_label_type type)
114e71a5be1SJeremy Fitzhardinge {
11518cbc8beSPeter Zijlstra 	jump_label_transform(entry, type, 0);
116d9f5ab7bSJason Baron }
117d9f5ab7bSJason Baron 
118ba54f0c3SDaniel Bristot de Oliveira bool arch_jump_label_transform_queue(struct jump_entry *entry,
119ba54f0c3SDaniel Bristot de Oliveira 				     enum jump_label_type type)
120ba54f0c3SDaniel Bristot de Oliveira {
121*001951beSPeter Zijlstra 	struct jump_label_patch jlp;
122ba54f0c3SDaniel Bristot de Oliveira 
123ba54f0c3SDaniel Bristot de Oliveira 	if (system_state == SYSTEM_BOOTING) {
124ba54f0c3SDaniel Bristot de Oliveira 		/*
125ba54f0c3SDaniel Bristot de Oliveira 		 * Fallback to the non-batching mode.
126ba54f0c3SDaniel Bristot de Oliveira 		 */
127ba54f0c3SDaniel Bristot de Oliveira 		arch_jump_label_transform(entry, type);
128ba54f0c3SDaniel Bristot de Oliveira 		return true;
129ba54f0c3SDaniel Bristot de Oliveira 	}
130ba54f0c3SDaniel Bristot de Oliveira 
13118cbc8beSPeter Zijlstra 	mutex_lock(&text_mutex);
132*001951beSPeter Zijlstra 	jlp = __jump_label_patch(entry, type);
133*001951beSPeter Zijlstra 	text_poke_queue((void *)jump_entry_code(entry), jlp.code, jlp.size, NULL);
13418cbc8beSPeter Zijlstra 	mutex_unlock(&text_mutex);
135ba54f0c3SDaniel Bristot de Oliveira 	return true;
136ba54f0c3SDaniel Bristot de Oliveira }
137ba54f0c3SDaniel Bristot de Oliveira 
138ba54f0c3SDaniel Bristot de Oliveira void arch_jump_label_transform_apply(void)
139ba54f0c3SDaniel Bristot de Oliveira {
140ba54f0c3SDaniel Bristot de Oliveira 	mutex_lock(&text_mutex);
14118cbc8beSPeter Zijlstra 	text_poke_finish();
142ba54f0c3SDaniel Bristot de Oliveira 	mutex_unlock(&text_mutex);
143ba54f0c3SDaniel Bristot de Oliveira }
144ba54f0c3SDaniel Bristot de Oliveira 
14511570da1SSteven Rostedt static enum {
14611570da1SSteven Rostedt 	JL_STATE_START,
14711570da1SSteven Rostedt 	JL_STATE_NO_UPDATE,
14811570da1SSteven Rostedt 	JL_STATE_UPDATE,
14911570da1SSteven Rostedt } jlstate __initdata_or_module = JL_STATE_START;
15011570da1SSteven Rostedt 
1519cdbe1cbSPeter Zijlstra __init_or_module void arch_jump_label_transform_static(struct jump_entry *entry,
152e71a5be1SJeremy Fitzhardinge 				      enum jump_label_type type)
153e71a5be1SJeremy Fitzhardinge {
15411570da1SSteven Rostedt 	if (jlstate == JL_STATE_UPDATE)
15518cbc8beSPeter Zijlstra 		jump_label_transform(entry, type, 1);
156e71a5be1SJeremy Fitzhardinge }
157