1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2014 ARM Limited
7 #include <linux/init.h>
8 #include <linux/list.h>
9 #include <linux/perf_event.h>
10 #include <linux/sched.h>
11 #include <linux/slab.h>
12 #include <linux/sysctl.h>
13 #include <linux/uaccess.h>
15 #include <asm/cpufeature.h>
17 #include <asm/sysreg.h>
18 #include <asm/system_misc.h>
19 #include <asm/traps.h>
20 #include <asm/kprobes.h>
22 #define CREATE_TRACE_POINTS
23 #include "trace-events-emulation.h"
26 * The runtime support for deprecated instruction support can be in one of
27 * following three states -
30 * 1 = emulate (software emulation)
31 * 2 = hw (supported in hardware)
33 enum insn_emulation_mode {
39 enum legacy_insn_status {
44 struct insn_emulation_ops {
46 enum legacy_insn_status status;
47 struct undef_hook *hooks;
48 int (*set_hw_mode)(bool enable);
51 struct insn_emulation {
52 struct list_head node;
53 struct insn_emulation_ops *ops;
59 static LIST_HEAD(insn_emulation);
60 static int nr_insn_emulated __initdata;
61 static DEFINE_RAW_SPINLOCK(insn_emulation_lock);
62 static DEFINE_MUTEX(insn_emulation_mutex);
64 static void register_emulation_hooks(struct insn_emulation_ops *ops)
66 struct undef_hook *hook;
70 for (hook = ops->hooks; hook->instr_mask; hook++)
71 register_undef_hook(hook);
73 pr_notice("Registered %s emulation handler\n", ops->name);
76 static void remove_emulation_hooks(struct insn_emulation_ops *ops)
78 struct undef_hook *hook;
82 for (hook = ops->hooks; hook->instr_mask; hook++)
83 unregister_undef_hook(hook);
85 pr_notice("Removed %s emulation handler\n", ops->name);
88 static void enable_insn_hw_mode(void *data)
90 struct insn_emulation *insn = (struct insn_emulation *)data;
91 if (insn->ops->set_hw_mode)
92 insn->ops->set_hw_mode(true);
95 static void disable_insn_hw_mode(void *data)
97 struct insn_emulation *insn = (struct insn_emulation *)data;
98 if (insn->ops->set_hw_mode)
99 insn->ops->set_hw_mode(false);
102 /* Run set_hw_mode(mode) on all active CPUs */
103 static int run_all_cpu_set_hw_mode(struct insn_emulation *insn, bool enable)
105 if (!insn->ops->set_hw_mode)
108 on_each_cpu(enable_insn_hw_mode, (void *)insn, true);
110 on_each_cpu(disable_insn_hw_mode, (void *)insn, true);
115 * Run set_hw_mode for all insns on a starting CPU.
117 * 0 - If all the hooks ran successfully.
118 * -EINVAL - At least one hook is not supported by the CPU.
120 static int run_all_insn_set_hw_mode(unsigned int cpu)
124 struct insn_emulation *insn;
126 raw_spin_lock_irqsave(&insn_emulation_lock, flags);
127 list_for_each_entry(insn, &insn_emulation, node) {
128 bool enable = (insn->current_mode == INSN_HW);
129 if (insn->ops->set_hw_mode && insn->ops->set_hw_mode(enable)) {
130 pr_warn("CPU[%u] cannot support the emulation of %s",
131 cpu, insn->ops->name);
135 raw_spin_unlock_irqrestore(&insn_emulation_lock, flags);
139 static int update_insn_emulation_mode(struct insn_emulation *insn,
140 enum insn_emulation_mode prev)
145 case INSN_UNDEF: /* Nothing to be done */
148 remove_emulation_hooks(insn->ops);
151 if (!run_all_cpu_set_hw_mode(insn, false))
152 pr_notice("Disabled %s support\n", insn->ops->name);
156 switch (insn->current_mode) {
160 register_emulation_hooks(insn->ops);
163 ret = run_all_cpu_set_hw_mode(insn, true);
165 pr_notice("Enabled %s support\n", insn->ops->name);
172 static void __init register_insn_emulation(struct insn_emulation_ops *ops)
175 struct insn_emulation *insn;
177 insn = kzalloc(sizeof(*insn), GFP_KERNEL);
182 insn->min = INSN_UNDEF;
184 switch (ops->status) {
185 case INSN_DEPRECATED:
186 insn->current_mode = INSN_EMULATE;
187 /* Disable the HW mode if it was turned on at early boot time */
188 run_all_cpu_set_hw_mode(insn, false);
192 insn->current_mode = INSN_UNDEF;
193 insn->max = INSN_EMULATE;
197 raw_spin_lock_irqsave(&insn_emulation_lock, flags);
198 list_add(&insn->node, &insn_emulation);
200 raw_spin_unlock_irqrestore(&insn_emulation_lock, flags);
202 /* Register any handlers if required */
203 update_insn_emulation_mode(insn, INSN_UNDEF);
206 static int emulation_proc_handler(struct ctl_table *table, int write,
207 void *buffer, size_t *lenp,
211 struct insn_emulation *insn = container_of(table->data, struct insn_emulation, current_mode);
212 enum insn_emulation_mode prev_mode = insn->current_mode;
214 mutex_lock(&insn_emulation_mutex);
215 ret = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
217 if (ret || !write || prev_mode == insn->current_mode)
220 ret = update_insn_emulation_mode(insn, prev_mode);
222 /* Mode change failed, revert to previous mode. */
223 insn->current_mode = prev_mode;
224 update_insn_emulation_mode(insn, INSN_UNDEF);
227 mutex_unlock(&insn_emulation_mutex);
231 static void __init register_insn_emulation_sysctl(void)
235 struct insn_emulation *insn;
236 struct ctl_table *insns_sysctl, *sysctl;
238 insns_sysctl = kcalloc(nr_insn_emulated + 1, sizeof(*sysctl),
243 raw_spin_lock_irqsave(&insn_emulation_lock, flags);
244 list_for_each_entry(insn, &insn_emulation, node) {
245 sysctl = &insns_sysctl[i];
248 sysctl->maxlen = sizeof(int);
250 sysctl->procname = insn->ops->name;
251 sysctl->data = &insn->current_mode;
252 sysctl->extra1 = &insn->min;
253 sysctl->extra2 = &insn->max;
254 sysctl->proc_handler = emulation_proc_handler;
257 raw_spin_unlock_irqrestore(&insn_emulation_lock, flags);
259 register_sysctl("abi", insns_sysctl);
263 * Implement emulation of the SWP/SWPB instructions using load-exclusive and
266 * Syntax of SWP{B} instruction: SWP{B}<c> <Rt>, <Rt2>, [<Rn>]
267 * Where: Rt = destination
273 * Error-checking SWP macros implemented using ldxr{b}/stxr{b}
276 /* Arbitrary constant to ensure forward-progress of the LL/SC loop */
277 #define __SWP_LL_SC_LOOPS 4
279 #define __user_swpX_asm(data, addr, res, temp, temp2, B) \
281 uaccess_enable_privileged(); \
282 __asm__ __volatile__( \
284 "0: ldxr"B" %w2, [%4]\n" \
285 "1: stxr"B" %w0, %w1, [%4]\n" \
287 " sub %w3, %w3, #1\n" \
294 " .pushsection .fixup,\"ax\"\n" \
296 "4: mov %w0, %w6\n" \
299 _ASM_EXTABLE(0b, 4b) \
300 _ASM_EXTABLE(1b, 4b) \
301 : "=&r" (res), "+r" (data), "=&r" (temp), "=&r" (temp2) \
302 : "r" ((unsigned long)addr), "i" (-EAGAIN), \
304 "i" (__SWP_LL_SC_LOOPS) \
306 uaccess_disable_privileged(); \
309 #define __user_swp_asm(data, addr, res, temp, temp2) \
310 __user_swpX_asm(data, addr, res, temp, temp2, "")
311 #define __user_swpb_asm(data, addr, res, temp, temp2) \
312 __user_swpX_asm(data, addr, res, temp, temp2, "b")
315 * Bit 22 of the instruction encoding distinguishes between
316 * the SWP and SWPB variants (bit set means SWPB).
318 #define TYPE_SWPB (1 << 22)
320 static int emulate_swpX(unsigned int address, unsigned int *data,
323 unsigned int res = 0;
325 if ((type != TYPE_SWPB) && (address & 0x3)) {
326 /* SWP to unaligned address not permitted */
327 pr_debug("SWP instruction on unaligned pointer!\n");
332 unsigned long temp, temp2;
334 if (type == TYPE_SWPB)
335 __user_swpb_asm(*data, address, res, temp, temp2);
337 __user_swp_asm(*data, address, res, temp, temp2);
339 if (likely(res != -EAGAIN) || signal_pending(current))
348 #define ARM_OPCODE_CONDTEST_FAIL 0
349 #define ARM_OPCODE_CONDTEST_PASS 1
350 #define ARM_OPCODE_CONDTEST_UNCOND 2
352 #define ARM_OPCODE_CONDITION_UNCOND 0xf
354 static unsigned int __kprobes aarch32_check_condition(u32 opcode, u32 psr)
356 u32 cc_bits = opcode >> 28;
358 if (cc_bits != ARM_OPCODE_CONDITION_UNCOND) {
359 if ((*aarch32_opcode_cond_checks[cc_bits])(psr))
360 return ARM_OPCODE_CONDTEST_PASS;
362 return ARM_OPCODE_CONDTEST_FAIL;
364 return ARM_OPCODE_CONDTEST_UNCOND;
368 * swp_handler logs the id of calling process, dissects the instruction, sanity
369 * checks the memory location, calls emulate_swpX for the actual operation and
370 * deals with fixup/error handling before returning
372 static int swp_handler(struct pt_regs *regs, u32 instr)
374 u32 destreg, data, type, address = 0;
375 const void __user *user_ptr;
376 int rn, rt2, res = 0;
378 perf_sw_event(PERF_COUNT_SW_EMULATION_FAULTS, 1, regs, regs->pc);
380 type = instr & TYPE_SWPB;
382 switch (aarch32_check_condition(instr, regs->pstate)) {
383 case ARM_OPCODE_CONDTEST_PASS:
385 case ARM_OPCODE_CONDTEST_FAIL:
386 /* Condition failed - return to next instruction */
388 case ARM_OPCODE_CONDTEST_UNCOND:
389 /* If unconditional encoding - not a SWP, undef */
395 rn = aarch32_insn_extract_reg_num(instr, A32_RN_OFFSET);
396 rt2 = aarch32_insn_extract_reg_num(instr, A32_RT2_OFFSET);
398 address = (u32)regs->user_regs.regs[rn];
399 data = (u32)regs->user_regs.regs[rt2];
400 destreg = aarch32_insn_extract_reg_num(instr, A32_RT_OFFSET);
402 pr_debug("addr in r%d->0x%08x, dest is r%d, source in r%d->0x%08x)\n",
403 rn, address, destreg,
404 aarch32_insn_extract_reg_num(instr, A32_RT2_OFFSET), data);
406 /* Check access in reasonable access range for both SWP and SWPB */
407 user_ptr = (const void __user *)(unsigned long)(address & ~3);
408 if (!access_ok(user_ptr, 4)) {
409 pr_debug("SWP{B} emulation: access to 0x%08x not allowed!\n",
414 res = emulate_swpX(address, &data, type);
418 regs->user_regs.regs[destreg] = data;
421 if (type == TYPE_SWPB)
422 trace_instruction_emulation("swpb", regs->pc);
424 trace_instruction_emulation("swp", regs->pc);
426 pr_warn_ratelimited("\"%s\" (%ld) uses obsolete SWP{B} instruction at 0x%llx\n",
427 current->comm, (unsigned long)current->pid, regs->pc);
429 arm64_skip_faulting_instruction(regs, 4);
433 pr_debug("SWP{B} emulation: access caused memory abort!\n");
434 arm64_notify_segfault(address);
440 * Only emulate SWP/SWPB executed in ARM state/User mode.
441 * The kernel must be SWP free and SWP{B} does not exist in Thumb.
443 static struct undef_hook swp_hooks[] = {
445 .instr_mask = 0x0fb00ff0,
446 .instr_val = 0x01000090,
447 .pstate_mask = PSR_AA32_MODE_MASK,
448 .pstate_val = PSR_AA32_MODE_USR,
454 static struct insn_emulation_ops swp_ops = {
456 .status = INSN_OBSOLETE,
461 static int cp15barrier_handler(struct pt_regs *regs, u32 instr)
463 perf_sw_event(PERF_COUNT_SW_EMULATION_FAULTS, 1, regs, regs->pc);
465 switch (aarch32_check_condition(instr, regs->pstate)) {
466 case ARM_OPCODE_CONDTEST_PASS:
468 case ARM_OPCODE_CONDTEST_FAIL:
469 /* Condition failed - return to next instruction */
471 case ARM_OPCODE_CONDTEST_UNCOND:
472 /* If unconditional encoding - not a barrier instruction */
478 switch (aarch32_insn_mcr_extract_crm(instr)) {
481 * dmb - mcr p15, 0, Rt, c7, c10, 5
482 * dsb - mcr p15, 0, Rt, c7, c10, 4
484 if (aarch32_insn_mcr_extract_opc2(instr) == 5) {
486 trace_instruction_emulation(
487 "mcr p15, 0, Rt, c7, c10, 5 ; dmb", regs->pc);
490 trace_instruction_emulation(
491 "mcr p15, 0, Rt, c7, c10, 4 ; dsb", regs->pc);
496 * isb - mcr p15, 0, Rt, c7, c5, 4
498 * Taking an exception or returning from one acts as an
499 * instruction barrier. So no explicit barrier needed here.
501 trace_instruction_emulation(
502 "mcr p15, 0, Rt, c7, c5, 4 ; isb", regs->pc);
507 pr_warn_ratelimited("\"%s\" (%ld) uses deprecated CP15 Barrier instruction at 0x%llx\n",
508 current->comm, (unsigned long)current->pid, regs->pc);
510 arm64_skip_faulting_instruction(regs, 4);
514 static int cp15_barrier_set_hw_mode(bool enable)
517 sysreg_clear_set(sctlr_el1, 0, SCTLR_EL1_CP15BEN);
519 sysreg_clear_set(sctlr_el1, SCTLR_EL1_CP15BEN, 0);
523 static struct undef_hook cp15_barrier_hooks[] = {
525 .instr_mask = 0x0fff0fdf,
526 .instr_val = 0x0e070f9a,
527 .pstate_mask = PSR_AA32_MODE_MASK,
528 .pstate_val = PSR_AA32_MODE_USR,
529 .fn = cp15barrier_handler,
532 .instr_mask = 0x0fff0fff,
533 .instr_val = 0x0e070f95,
534 .pstate_mask = PSR_AA32_MODE_MASK,
535 .pstate_val = PSR_AA32_MODE_USR,
536 .fn = cp15barrier_handler,
541 static struct insn_emulation_ops cp15_barrier_ops = {
542 .name = "cp15_barrier",
543 .status = INSN_DEPRECATED,
544 .hooks = cp15_barrier_hooks,
545 .set_hw_mode = cp15_barrier_set_hw_mode,
548 static int setend_set_hw_mode(bool enable)
550 if (!cpu_supports_mixed_endian_el0())
554 sysreg_clear_set(sctlr_el1, SCTLR_EL1_SED, 0);
556 sysreg_clear_set(sctlr_el1, 0, SCTLR_EL1_SED);
560 static int compat_setend_handler(struct pt_regs *regs, u32 big_endian)
564 perf_sw_event(PERF_COUNT_SW_EMULATION_FAULTS, 1, regs, regs->pc);
568 regs->pstate |= PSR_AA32_E_BIT;
571 regs->pstate &= ~PSR_AA32_E_BIT;
574 trace_instruction_emulation(insn, regs->pc);
575 pr_warn_ratelimited("\"%s\" (%ld) uses deprecated setend instruction at 0x%llx\n",
576 current->comm, (unsigned long)current->pid, regs->pc);
581 static int a32_setend_handler(struct pt_regs *regs, u32 instr)
583 int rc = compat_setend_handler(regs, (instr >> 9) & 1);
584 arm64_skip_faulting_instruction(regs, 4);
588 static int t16_setend_handler(struct pt_regs *regs, u32 instr)
590 int rc = compat_setend_handler(regs, (instr >> 3) & 1);
591 arm64_skip_faulting_instruction(regs, 2);
595 static struct undef_hook setend_hooks[] = {
597 .instr_mask = 0xfffffdff,
598 .instr_val = 0xf1010000,
599 .pstate_mask = PSR_AA32_MODE_MASK,
600 .pstate_val = PSR_AA32_MODE_USR,
601 .fn = a32_setend_handler,
605 .instr_mask = 0xfffffff7,
606 .instr_val = 0x0000b650,
607 .pstate_mask = (PSR_AA32_T_BIT | PSR_AA32_MODE_MASK),
608 .pstate_val = (PSR_AA32_T_BIT | PSR_AA32_MODE_USR),
609 .fn = t16_setend_handler,
614 static struct insn_emulation_ops setend_ops = {
616 .status = INSN_DEPRECATED,
617 .hooks = setend_hooks,
618 .set_hw_mode = setend_set_hw_mode,
622 * Invoked as core_initcall, which guarantees that the instruction
623 * emulation is ready for userspace.
625 static int __init armv8_deprecated_init(void)
627 if (IS_ENABLED(CONFIG_SWP_EMULATION))
628 register_insn_emulation(&swp_ops);
630 if (IS_ENABLED(CONFIG_CP15_BARRIER_EMULATION))
631 register_insn_emulation(&cp15_barrier_ops);
633 if (IS_ENABLED(CONFIG_SETEND_EMULATION)) {
634 if (system_supports_mixed_endian_el0())
635 register_insn_emulation(&setend_ops);
637 pr_info("setend instruction emulation is not supported on this system\n");
640 cpuhp_setup_state_nocalls(CPUHP_AP_ARM64_ISNDEP_STARTING,
641 "arm64/isndep:starting",
642 run_all_insn_set_hw_mode, NULL);
643 register_insn_emulation_sysctl();
648 core_initcall(armv8_deprecated_init);