arch/arm64/kernel/alternative.c

   1 /*
   2  * alternative runtime patching
   3  * inspired by the x86 version
   4  *
   5  * Copyright (C) 2014 ARM Ltd.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #define pr_fmt(fmt) "alternatives: " fmt
  21
  22 #include <linux/init.h>
  23 #include <linux/cpu.h>
  24 #include <asm/cacheflush.h>
  25 #include <asm/alternative.h>
  26 #include <asm/cpufeature.h>
  27 #include <asm/insn.h>
  28 #include <asm/sections.h>
  29 #include <linux/stop_machine.h>
  30
  31 #define __ALT_PTR(a,f)          ((void *)&(a)->f + (a)->f)
  32 #define ALT_ORIG_PTR(a)         __ALT_PTR(a, orig_offset)
  33 #define ALT_REPL_PTR(a)         __ALT_PTR(a, alt_offset)
  34
  35 int alternatives_applied;
  36
  37 struct alt_region {
  38         struct alt_instr *begin;
  39         struct alt_instr *end;
  40 };
  41
  42 /*
  43  * Check if the target PC is within an alternative block.
  44  */
  45 static bool branch_insn_requires_update(struct alt_instr *alt, unsigned long pc)
  46 {
  47         unsigned long replptr = (unsigned long)ALT_REPL_PTR(alt);
  48         return !(pc >= replptr && pc <= (replptr + alt->alt_len));
  49 }
  50
  51 #define align_down(x, a)        ((unsigned long)(x) & ~(((unsigned long)(a)) - 1))
  52
  53 static u32 get_alt_insn(struct alt_instr *alt, __le32 *insnptr, __le32 *altinsnptr)
  54 {
  55         u32 insn;
  56
  57         insn = le32_to_cpu(*altinsnptr);
  58
  59         if (aarch64_insn_is_branch_imm(insn)) {
  60                 s32 offset = aarch64_get_branch_offset(insn);
  61                 unsigned long target;
  62
  63                 target = (unsigned long)altinsnptr + offset;
  64
  65                 /*
  66                  * If we're branching inside the alternate sequence,
  67                  * do not rewrite the instruction, as it is already
  68                  * correct. Otherwise, generate the new instruction.
  69                  */
  70                 if (branch_insn_requires_update(alt, target)) {
  71                         offset = target - (unsigned long)insnptr;
  72                         insn = aarch64_set_branch_offset(insn, offset);
  73                 }
  74         } else if (aarch64_insn_is_adrp(insn)) {
  75                 s32 orig_offset, new_offset;
  76                 unsigned long target;
  77
  78                 /*
  79                  * If we're replacing an adrp instruction, which uses PC-relative
  80                  * immediate addressing, adjust the offset to reflect the new
  81                  * PC. adrp operates on 4K aligned addresses.
  82                  */
  83                 orig_offset  = aarch64_insn_adrp_get_offset(insn);
  84                 target = align_down(altinsnptr, SZ_4K) + orig_offset;
  85                 new_offset = target - align_down(insnptr, SZ_4K);
  86                 insn = aarch64_insn_adrp_set_offset(insn, new_offset);
  87         } else if (aarch64_insn_uses_literal(insn)) {
  88                 /*
  89                  * Disallow patching unhandled instructions using PC relative
  90                  * literal addresses
  91                  */
  92                 BUG();
  93         }
  94
  95         return insn;
  96 }
  97
  98 static void patch_alternative(struct alt_instr *alt,
  99                               __le32 *origptr, __le32 *updptr, int nr_inst)
 100 {
 101         __le32 *replptr;
 102         int i;
 103
 104         replptr = ALT_REPL_PTR(alt);
 105         for (i = 0; i < nr_inst; i++) {
 106                 u32 insn;
 107
 108                 insn = get_alt_insn(alt, origptr + i, replptr + i);
 109                 updptr[i] = cpu_to_le32(insn);
 110         }
 111 }
 112
 113 static void __apply_alternatives(void *alt_region, bool use_linear_alias)
 114 {
 115         struct alt_instr *alt;
 116         struct alt_region *region = alt_region;
 117         __le32 *origptr, *updptr;
 118         alternative_cb_t alt_cb;
 119
 120         for (alt = region->begin; alt < region->end; alt++) {
 121                 int nr_inst;
 122
 123                 /* Use ARM64_CB_PATCH as an unconditional patch */
 124                 if (alt->cpufeature < ARM64_CB_PATCH &&
 125                     !cpus_have_cap(alt->cpufeature))
 126                         continue;
 127
 128                 if (alt->cpufeature == ARM64_CB_PATCH)
 129                         BUG_ON(alt->alt_len != 0);
 130                 else
 131                         BUG_ON(alt->alt_len != alt->orig_len);
 132
 133                 pr_info_once("patching kernel code\n");
 134
 135                 origptr = ALT_ORIG_PTR(alt);
 136                 updptr = use_linear_alias ? lm_alias(origptr) : origptr;
 137                 nr_inst = alt->orig_len / AARCH64_INSN_SIZE;
 138
 139                 if (alt->cpufeature < ARM64_CB_PATCH)
 140                         alt_cb = patch_alternative;
 141                 else
 142                         alt_cb  = ALT_REPL_PTR(alt);
 143
 144                 alt_cb(alt, origptr, updptr, nr_inst);
 145
 146                 flush_icache_range((uintptr_t)origptr,
 147                                    (uintptr_t)(origptr + nr_inst));
 148         }
 149 }
 150
 151 /*
 152  * We might be patching the stop_machine state machine, so implement a
 153  * really simple polling protocol here.
 154  */
 155 static int __apply_alternatives_multi_stop(void *unused)
 156 {
 157         struct alt_region region = {
 158                 .begin  = (struct alt_instr *)__alt_instructions,
 159                 .end    = (struct alt_instr *)__alt_instructions_end,
 160         };
 161
 162         /* We always have a CPU 0 at this point (__init) */
 163         if (smp_processor_id()) {
 164                 while (!READ_ONCE(alternatives_applied))
 165                         cpu_relax();
 166                 isb();
 167         } else {
 168                 BUG_ON(alternatives_applied);
 169                 __apply_alternatives(&region, true);
 170                 /* Barriers provided by the cache flushing */
 171                 WRITE_ONCE(alternatives_applied, 1);
 172         }
 173
 174         return 0;
 175 }
 176
 177 void __init apply_alternatives_all(void)
 178 {
 179         /* better not try code patching on a live SMP system */
 180         stop_machine(__apply_alternatives_multi_stop, NULL, cpu_online_mask);
 181 }
 182
 183 void apply_alternatives(void *start, size_t length)
 184 {
 185         struct alt_region region = {
 186                 .begin  = start,
 187                 .end    = start + length,
 188         };
 189
 190         __apply_alternatives(&region, false);
 191 }