Merge branch 'linux-linaro-lsk-v4.4' into linux-linaro-lsk-v4.4-android
[firefly-linux-kernel-4.4.55.git] / arch / arm64 / kernel / armv8_deprecated.c
1 /*
2  *  Copyright (C) 2014 ARM Limited
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  */
8
9 #include <linux/cpu.h>
10 #include <linux/init.h>
11 #include <linux/list.h>
12 #include <linux/perf_event.h>
13 #include <linux/sched.h>
14 #include <linux/slab.h>
15 #include <linux/sysctl.h>
16
17 #include <asm/alternative.h>
18 #include <asm/cpufeature.h>
19 #include <asm/insn.h>
20 #include <asm/opcodes.h>
21 #include <asm/sysreg.h>
22 #include <asm/system_misc.h>
23 #include <asm/traps.h>
24 #include <asm/uaccess.h>
25 #include <asm/cpufeature.h>
26
27 #define CREATE_TRACE_POINTS
28 #include "trace-events-emulation.h"
29
30 /*
31  * The runtime support for deprecated instruction support can be in one of
32  * following three states -
33  *
34  * 0 = undef
35  * 1 = emulate (software emulation)
36  * 2 = hw (supported in hardware)
37  */
38 enum insn_emulation_mode {
39         INSN_UNDEF,
40         INSN_EMULATE,
41         INSN_HW,
42 };
43
44 enum legacy_insn_status {
45         INSN_DEPRECATED,
46         INSN_OBSOLETE,
47 };
48
49 struct insn_emulation_ops {
50         const char              *name;
51         enum legacy_insn_status status;
52         struct undef_hook       *hooks;
53         int                     (*set_hw_mode)(bool enable);
54 };
55
56 struct insn_emulation {
57         struct list_head node;
58         struct insn_emulation_ops *ops;
59         int current_mode;
60         int min;
61         int max;
62 };
63
64 static LIST_HEAD(insn_emulation);
65 static int nr_insn_emulated __initdata;
66 static DEFINE_RAW_SPINLOCK(insn_emulation_lock);
67
68 static void register_emulation_hooks(struct insn_emulation_ops *ops)
69 {
70         struct undef_hook *hook;
71
72         BUG_ON(!ops->hooks);
73
74         for (hook = ops->hooks; hook->instr_mask; hook++)
75                 register_undef_hook(hook);
76
77         pr_notice("Registered %s emulation handler\n", ops->name);
78 }
79
80 static void remove_emulation_hooks(struct insn_emulation_ops *ops)
81 {
82         struct undef_hook *hook;
83
84         BUG_ON(!ops->hooks);
85
86         for (hook = ops->hooks; hook->instr_mask; hook++)
87                 unregister_undef_hook(hook);
88
89         pr_notice("Removed %s emulation handler\n", ops->name);
90 }
91
92 static void enable_insn_hw_mode(void *data)
93 {
94         struct insn_emulation *insn = (struct insn_emulation *)data;
95         if (insn->ops->set_hw_mode)
96                 insn->ops->set_hw_mode(true);
97 }
98
99 static void disable_insn_hw_mode(void *data)
100 {
101         struct insn_emulation *insn = (struct insn_emulation *)data;
102         if (insn->ops->set_hw_mode)
103                 insn->ops->set_hw_mode(false);
104 }
105
106 /* Run set_hw_mode(mode) on all active CPUs */
107 static int run_all_cpu_set_hw_mode(struct insn_emulation *insn, bool enable)
108 {
109         if (!insn->ops->set_hw_mode)
110                 return -EINVAL;
111         if (enable)
112                 on_each_cpu(enable_insn_hw_mode, (void *)insn, true);
113         else
114                 on_each_cpu(disable_insn_hw_mode, (void *)insn, true);
115         return 0;
116 }
117
118 /*
119  * Run set_hw_mode for all insns on a starting CPU.
120  * Returns:
121  *  0           - If all the hooks ran successfully.
122  * -EINVAL      - At least one hook is not supported by the CPU.
123  */
124 static int run_all_insn_set_hw_mode(unsigned long cpu)
125 {
126         int rc = 0;
127         unsigned long flags;
128         struct insn_emulation *insn;
129
130         raw_spin_lock_irqsave(&insn_emulation_lock, flags);
131         list_for_each_entry(insn, &insn_emulation, node) {
132                 bool enable = (insn->current_mode == INSN_HW);
133                 if (insn->ops->set_hw_mode && insn->ops->set_hw_mode(enable)) {
134                         pr_warn("CPU[%ld] cannot support the emulation of %s",
135                                 cpu, insn->ops->name);
136                         rc = -EINVAL;
137                 }
138         }
139         raw_spin_unlock_irqrestore(&insn_emulation_lock, flags);
140         return rc;
141 }
142
143 static int update_insn_emulation_mode(struct insn_emulation *insn,
144                                        enum insn_emulation_mode prev)
145 {
146         int ret = 0;
147
148         switch (prev) {
149         case INSN_UNDEF: /* Nothing to be done */
150                 break;
151         case INSN_EMULATE:
152                 remove_emulation_hooks(insn->ops);
153                 break;
154         case INSN_HW:
155                 if (!run_all_cpu_set_hw_mode(insn, false))
156                         pr_notice("Disabled %s support\n", insn->ops->name);
157                 break;
158         }
159
160         switch (insn->current_mode) {
161         case INSN_UNDEF:
162                 break;
163         case INSN_EMULATE:
164                 register_emulation_hooks(insn->ops);
165                 break;
166         case INSN_HW:
167                 ret = run_all_cpu_set_hw_mode(insn, true);
168                 if (!ret)
169                         pr_notice("Enabled %s support\n", insn->ops->name);
170                 break;
171         }
172
173         return ret;
174 }
175
176 static void __init register_insn_emulation(struct insn_emulation_ops *ops)
177 {
178         unsigned long flags;
179         struct insn_emulation *insn;
180
181         insn = kzalloc(sizeof(*insn), GFP_KERNEL);
182         insn->ops = ops;
183         insn->min = INSN_UNDEF;
184
185         switch (ops->status) {
186         case INSN_DEPRECATED:
187                 insn->current_mode = INSN_EMULATE;
188                 /* Disable the HW mode if it was turned on at early boot time */
189                 run_all_cpu_set_hw_mode(insn, false);
190                 insn->max = INSN_HW;
191                 break;
192         case INSN_OBSOLETE:
193                 insn->current_mode = INSN_UNDEF;
194                 insn->max = INSN_EMULATE;
195                 break;
196         }
197
198         raw_spin_lock_irqsave(&insn_emulation_lock, flags);
199         list_add(&insn->node, &insn_emulation);
200         nr_insn_emulated++;
201         raw_spin_unlock_irqrestore(&insn_emulation_lock, flags);
202
203         /* Register any handlers if required */
204         update_insn_emulation_mode(insn, INSN_UNDEF);
205 }
206
207 static int emulation_proc_handler(struct ctl_table *table, int write,
208                                   void __user *buffer, size_t *lenp,
209                                   loff_t *ppos)
210 {
211         int ret = 0;
212         struct insn_emulation *insn = (struct insn_emulation *) table->data;
213         enum insn_emulation_mode prev_mode = insn->current_mode;
214
215         table->data = &insn->current_mode;
216         ret = proc_dointvec_minmax(table, write, buffer, lenp, ppos);
217
218         if (ret || !write || prev_mode == insn->current_mode)
219                 goto ret;
220
221         ret = update_insn_emulation_mode(insn, prev_mode);
222         if (ret) {
223                 /* Mode change failed, revert to previous mode. */
224                 insn->current_mode = prev_mode;
225                 update_insn_emulation_mode(insn, INSN_UNDEF);
226         }
227 ret:
228         table->data = insn;
229         return ret;
230 }
231
232 static struct ctl_table ctl_abi[] = {
233         {
234                 .procname = "abi",
235                 .mode = 0555,
236         },
237         { }
238 };
239
240 static void __init register_insn_emulation_sysctl(struct ctl_table *table)
241 {
242         unsigned long flags;
243         int i = 0;
244         struct insn_emulation *insn;
245         struct ctl_table *insns_sysctl, *sysctl;
246
247         insns_sysctl = kzalloc(sizeof(*sysctl) * (nr_insn_emulated + 1),
248                               GFP_KERNEL);
249
250         raw_spin_lock_irqsave(&insn_emulation_lock, flags);
251         list_for_each_entry(insn, &insn_emulation, node) {
252                 sysctl = &insns_sysctl[i];
253
254                 sysctl->mode = 0644;
255                 sysctl->maxlen = sizeof(int);
256
257                 sysctl->procname = insn->ops->name;
258                 sysctl->data = insn;
259                 sysctl->extra1 = &insn->min;
260                 sysctl->extra2 = &insn->max;
261                 sysctl->proc_handler = emulation_proc_handler;
262                 i++;
263         }
264         raw_spin_unlock_irqrestore(&insn_emulation_lock, flags);
265
266         table->child = insns_sysctl;
267         register_sysctl_table(table);
268 }
269
270 /*
271  *  Implement emulation of the SWP/SWPB instructions using load-exclusive and
272  *  store-exclusive.
273  *
274  *  Syntax of SWP{B} instruction: SWP{B}<c> <Rt>, <Rt2>, [<Rn>]
275  *  Where: Rt  = destination
276  *         Rt2 = source
277  *         Rn  = address
278  */
279
280 /*
281  * Error-checking SWP macros implemented using ldxr{b}/stxr{b}
282  */
283 #define __user_swpX_asm(data, addr, res, temp, B)               \
284 do {                                                            \
285         uaccess_enable();                                       \
286         __asm__ __volatile__(                                   \
287         "0:     ldxr"B"         %w2, [%3]\n"                    \
288         "1:     stxr"B"         %w0, %w1, [%3]\n"               \
289         "       cbz             %w0, 2f\n"                      \
290         "       mov             %w0, %w4\n"                     \
291         "       b               3f\n"                           \
292         "2:\n"                                                  \
293         "       mov             %w1, %w2\n"                     \
294         "3:\n"                                                  \
295         "       .pushsection     .fixup,\"ax\"\n"               \
296         "       .align          2\n"                            \
297         "4:     mov             %w0, %w5\n"                     \
298         "       b               3b\n"                           \
299         "       .popsection"                                    \
300         _ASM_EXTABLE(0b, 4b)                                    \
301         _ASM_EXTABLE(1b, 4b)                                    \
302         : "=&r" (res), "+r" (data), "=&r" (temp)                \
303         : "r" (addr), "i" (-EAGAIN), "i" (-EFAULT)              \
304         : "memory");                                            \
305         uaccess_disable();                                      \
306 } while (0)
307
308 #define __user_swp_asm(data, addr, res, temp) \
309         __user_swpX_asm(data, addr, res, temp, "")
310 #define __user_swpb_asm(data, addr, res, temp) \
311         __user_swpX_asm(data, addr, res, temp, "b")
312
313 /*
314  * Bit 22 of the instruction encoding distinguishes between
315  * the SWP and SWPB variants (bit set means SWPB).
316  */
317 #define TYPE_SWPB (1 << 22)
318
319 /*
320  * Set up process info to signal segmentation fault - called on access error.
321  */
322 static void set_segfault(struct pt_regs *regs, unsigned long addr)
323 {
324         siginfo_t info;
325
326         down_read(&current->mm->mmap_sem);
327         if (find_vma(current->mm, addr) == NULL)
328                 info.si_code = SEGV_MAPERR;
329         else
330                 info.si_code = SEGV_ACCERR;
331         up_read(&current->mm->mmap_sem);
332
333         info.si_signo = SIGSEGV;
334         info.si_errno = 0;
335         info.si_addr  = (void *) instruction_pointer(regs);
336
337         pr_debug("SWP{B} emulation: access caused memory abort!\n");
338         arm64_notify_die("Illegal memory access", regs, &info, 0);
339 }
340
341 static int emulate_swpX(unsigned int address, unsigned int *data,
342                         unsigned int type)
343 {
344         unsigned int res = 0;
345
346         if ((type != TYPE_SWPB) && (address & 0x3)) {
347                 /* SWP to unaligned address not permitted */
348                 pr_debug("SWP instruction on unaligned pointer!\n");
349                 return -EFAULT;
350         }
351
352         while (1) {
353                 unsigned long temp;
354
355                 if (type == TYPE_SWPB)
356                         __user_swpb_asm(*data, address, res, temp);
357                 else
358                         __user_swp_asm(*data, address, res, temp);
359
360                 if (likely(res != -EAGAIN) || signal_pending(current))
361                         break;
362
363                 cond_resched();
364         }
365
366         return res;
367 }
368
369 #define ARM_OPCODE_CONDITION_UNCOND     0xf
370
371 static unsigned int __kprobes aarch32_check_condition(u32 opcode, u32 psr)
372 {
373         u32 cc_bits  = opcode >> 28;
374
375         if (cc_bits != ARM_OPCODE_CONDITION_UNCOND) {
376                 if ((*aarch32_opcode_cond_checks[cc_bits])(psr))
377                         return ARM_OPCODE_CONDTEST_PASS;
378                 else
379                         return ARM_OPCODE_CONDTEST_FAIL;
380         }
381         return ARM_OPCODE_CONDTEST_UNCOND;
382 }
383
384 /*
385  * swp_handler logs the id of calling process, dissects the instruction, sanity
386  * checks the memory location, calls emulate_swpX for the actual operation and
387  * deals with fixup/error handling before returning
388  */
389 static int swp_handler(struct pt_regs *regs, u32 instr)
390 {
391         u32 destreg, data, type, address = 0;
392         int rn, rt2, res = 0;
393
394         perf_sw_event(PERF_COUNT_SW_EMULATION_FAULTS, 1, regs, regs->pc);
395
396         type = instr & TYPE_SWPB;
397
398         switch (aarch32_check_condition(instr, regs->pstate)) {
399         case ARM_OPCODE_CONDTEST_PASS:
400                 break;
401         case ARM_OPCODE_CONDTEST_FAIL:
402                 /* Condition failed - return to next instruction */
403                 goto ret;
404         case ARM_OPCODE_CONDTEST_UNCOND:
405                 /* If unconditional encoding - not a SWP, undef */
406                 return -EFAULT;
407         default:
408                 return -EINVAL;
409         }
410
411         rn = aarch32_insn_extract_reg_num(instr, A32_RN_OFFSET);
412         rt2 = aarch32_insn_extract_reg_num(instr, A32_RT2_OFFSET);
413
414         address = (u32)regs->user_regs.regs[rn];
415         data    = (u32)regs->user_regs.regs[rt2];
416         destreg = aarch32_insn_extract_reg_num(instr, A32_RT_OFFSET);
417
418         pr_debug("addr in r%d->0x%08x, dest is r%d, source in r%d->0x%08x)\n",
419                 rn, address, destreg,
420                 aarch32_insn_extract_reg_num(instr, A32_RT2_OFFSET), data);
421
422         /* Check access in reasonable access range for both SWP and SWPB */
423         if (!access_ok(VERIFY_WRITE, (address & ~3), 4)) {
424                 pr_debug("SWP{B} emulation: access to 0x%08x not allowed!\n",
425                         address);
426                 goto fault;
427         }
428
429         res = emulate_swpX(address, &data, type);
430         if (res == -EFAULT)
431                 goto fault;
432         else if (res == 0)
433                 regs->user_regs.regs[destreg] = data;
434
435 ret:
436         if (type == TYPE_SWPB)
437                 trace_instruction_emulation("swpb", regs->pc);
438         else
439                 trace_instruction_emulation("swp", regs->pc);
440
441         pr_warn_ratelimited("\"%s\" (%ld) uses obsolete SWP{B} instruction at 0x%llx\n",
442                         current->comm, (unsigned long)current->pid, regs->pc);
443
444         regs->pc += 4;
445         return 0;
446
447 fault:
448         set_segfault(regs, address);
449
450         return 0;
451 }
452
453 /*
454  * Only emulate SWP/SWPB executed in ARM state/User mode.
455  * The kernel must be SWP free and SWP{B} does not exist in Thumb.
456  */
457 static struct undef_hook swp_hooks[] = {
458         {
459                 .instr_mask     = 0x0fb00ff0,
460                 .instr_val      = 0x01000090,
461                 .pstate_mask    = COMPAT_PSR_MODE_MASK,
462                 .pstate_val     = COMPAT_PSR_MODE_USR,
463                 .fn             = swp_handler
464         },
465         { }
466 };
467
468 static struct insn_emulation_ops swp_ops = {
469         .name = "swp",
470         .status = INSN_OBSOLETE,
471         .hooks = swp_hooks,
472         .set_hw_mode = NULL,
473 };
474
475 static int cp15barrier_handler(struct pt_regs *regs, u32 instr)
476 {
477         perf_sw_event(PERF_COUNT_SW_EMULATION_FAULTS, 1, regs, regs->pc);
478
479         switch (aarch32_check_condition(instr, regs->pstate)) {
480         case ARM_OPCODE_CONDTEST_PASS:
481                 break;
482         case ARM_OPCODE_CONDTEST_FAIL:
483                 /* Condition failed - return to next instruction */
484                 goto ret;
485         case ARM_OPCODE_CONDTEST_UNCOND:
486                 /* If unconditional encoding - not a barrier instruction */
487                 return -EFAULT;
488         default:
489                 return -EINVAL;
490         }
491
492         switch (aarch32_insn_mcr_extract_crm(instr)) {
493         case 10:
494                 /*
495                  * dmb - mcr p15, 0, Rt, c7, c10, 5
496                  * dsb - mcr p15, 0, Rt, c7, c10, 4
497                  */
498                 if (aarch32_insn_mcr_extract_opc2(instr) == 5) {
499                         dmb(sy);
500                         trace_instruction_emulation(
501                                 "mcr p15, 0, Rt, c7, c10, 5 ; dmb", regs->pc);
502                 } else {
503                         dsb(sy);
504                         trace_instruction_emulation(
505                                 "mcr p15, 0, Rt, c7, c10, 4 ; dsb", regs->pc);
506                 }
507                 break;
508         case 5:
509                 /*
510                  * isb - mcr p15, 0, Rt, c7, c5, 4
511                  *
512                  * Taking an exception or returning from one acts as an
513                  * instruction barrier. So no explicit barrier needed here.
514                  */
515                 trace_instruction_emulation(
516                         "mcr p15, 0, Rt, c7, c5, 4 ; isb", regs->pc);
517                 break;
518         }
519
520 ret:
521         pr_warn_ratelimited("\"%s\" (%ld) uses deprecated CP15 Barrier instruction at 0x%llx\n",
522                         current->comm, (unsigned long)current->pid, regs->pc);
523
524         regs->pc += 4;
525         return 0;
526 }
527
528 static int cp15_barrier_set_hw_mode(bool enable)
529 {
530         if (enable)
531                 config_sctlr_el1(0, SCTLR_EL1_CP15BEN);
532         else
533                 config_sctlr_el1(SCTLR_EL1_CP15BEN, 0);
534         return 0;
535 }
536
537 static struct undef_hook cp15_barrier_hooks[] = {
538         {
539                 .instr_mask     = 0x0fff0fdf,
540                 .instr_val      = 0x0e070f9a,
541                 .pstate_mask    = COMPAT_PSR_MODE_MASK,
542                 .pstate_val     = COMPAT_PSR_MODE_USR,
543                 .fn             = cp15barrier_handler,
544         },
545         {
546                 .instr_mask     = 0x0fff0fff,
547                 .instr_val      = 0x0e070f95,
548                 .pstate_mask    = COMPAT_PSR_MODE_MASK,
549                 .pstate_val     = COMPAT_PSR_MODE_USR,
550                 .fn             = cp15barrier_handler,
551         },
552         { }
553 };
554
555 static struct insn_emulation_ops cp15_barrier_ops = {
556         .name = "cp15_barrier",
557         .status = INSN_DEPRECATED,
558         .hooks = cp15_barrier_hooks,
559         .set_hw_mode = cp15_barrier_set_hw_mode,
560 };
561
562 static int setend_set_hw_mode(bool enable)
563 {
564         if (!cpu_supports_mixed_endian_el0())
565                 return -EINVAL;
566
567         if (enable)
568                 config_sctlr_el1(SCTLR_EL1_SED, 0);
569         else
570                 config_sctlr_el1(0, SCTLR_EL1_SED);
571         return 0;
572 }
573
574 static int compat_setend_handler(struct pt_regs *regs, u32 big_endian)
575 {
576         char *insn;
577
578         perf_sw_event(PERF_COUNT_SW_EMULATION_FAULTS, 1, regs, regs->pc);
579
580         if (big_endian) {
581                 insn = "setend be";
582                 regs->pstate |= COMPAT_PSR_E_BIT;
583         } else {
584                 insn = "setend le";
585                 regs->pstate &= ~COMPAT_PSR_E_BIT;
586         }
587
588         trace_instruction_emulation(insn, regs->pc);
589         pr_warn_ratelimited("\"%s\" (%ld) uses deprecated setend instruction at 0x%llx\n",
590                         current->comm, (unsigned long)current->pid, regs->pc);
591
592         return 0;
593 }
594
595 static int a32_setend_handler(struct pt_regs *regs, u32 instr)
596 {
597         int rc = compat_setend_handler(regs, (instr >> 9) & 1);
598         regs->pc += 4;
599         return rc;
600 }
601
602 static int t16_setend_handler(struct pt_regs *regs, u32 instr)
603 {
604         int rc = compat_setend_handler(regs, (instr >> 3) & 1);
605         regs->pc += 2;
606         return rc;
607 }
608
609 static struct undef_hook setend_hooks[] = {
610         {
611                 .instr_mask     = 0xfffffdff,
612                 .instr_val      = 0xf1010000,
613                 .pstate_mask    = COMPAT_PSR_MODE_MASK,
614                 .pstate_val     = COMPAT_PSR_MODE_USR,
615                 .fn             = a32_setend_handler,
616         },
617         {
618                 /* Thumb mode */
619                 .instr_mask     = 0x0000fff7,
620                 .instr_val      = 0x0000b650,
621                 .pstate_mask    = (COMPAT_PSR_T_BIT | COMPAT_PSR_MODE_MASK),
622                 .pstate_val     = (COMPAT_PSR_T_BIT | COMPAT_PSR_MODE_USR),
623                 .fn             = t16_setend_handler,
624         },
625         {}
626 };
627
628 static struct insn_emulation_ops setend_ops = {
629         .name = "setend",
630         .status = INSN_DEPRECATED,
631         .hooks = setend_hooks,
632         .set_hw_mode = setend_set_hw_mode,
633 };
634
635 static int insn_cpu_hotplug_notify(struct notifier_block *b,
636                               unsigned long action, void *hcpu)
637 {
638         int rc = 0;
639         if ((action & ~CPU_TASKS_FROZEN) == CPU_STARTING)
640                 rc = run_all_insn_set_hw_mode((unsigned long)hcpu);
641
642         return notifier_from_errno(rc);
643 }
644
645 static struct notifier_block insn_cpu_hotplug_notifier = {
646         .notifier_call = insn_cpu_hotplug_notify,
647 };
648
649 /*
650  * Invoked as late_initcall, since not needed before init spawned.
651  */
652 static int __init armv8_deprecated_init(void)
653 {
654         if (IS_ENABLED(CONFIG_SWP_EMULATION))
655                 register_insn_emulation(&swp_ops);
656
657         if (IS_ENABLED(CONFIG_CP15_BARRIER_EMULATION))
658                 register_insn_emulation(&cp15_barrier_ops);
659
660         if (IS_ENABLED(CONFIG_SETEND_EMULATION)) {
661                 if(system_supports_mixed_endian_el0())
662                         register_insn_emulation(&setend_ops);
663                 else
664                         pr_info("setend instruction emulation is not supported on the system");
665         }
666
667         register_cpu_notifier(&insn_cpu_hotplug_notifier);
668         register_insn_emulation_sysctl(ctl_abi);
669
670         return 0;
671 }
672
673 late_initcall(armv8_deprecated_init);