arch/powerpc/include/asm/code-patching.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 #ifndef _ASM_POWERPC_CODE_PATCHING_H
   3 #define _ASM_POWERPC_CODE_PATCHING_H
   4
   5 /*
   6  * Copyright 2008, Michael Ellerman, IBM Corporation.
   7  */
   8
   9 #include <asm/types.h>
  10 #include <asm/ppc-opcode.h>
  11 #include <linux/string.h>
  12 #include <linux/kallsyms.h>
  13 #include <asm/asm-compat.h>
  14 #include <asm/inst.h>
  15
  16 /* Flags for create_branch:
  17  * "b"   == create_branch(addr, target, 0);
  18  * "ba"  == create_branch(addr, target, BRANCH_ABSOLUTE);
  19  * "bl"  == create_branch(addr, target, BRANCH_SET_LINK);
  20  * "bla" == create_branch(addr, target, BRANCH_ABSOLUTE | BRANCH_SET_LINK);
  21  */
  22 #define BRANCH_SET_LINK 0x1
  23 #define BRANCH_ABSOLUTE 0x2
  24
  25 bool is_offset_in_branch_range(long offset);
  26 int create_branch(struct ppc_inst *instr, const struct ppc_inst *addr,
  27                   unsigned long target, int flags);
  28 int create_cond_branch(struct ppc_inst *instr, const struct ppc_inst *addr,
  29                        unsigned long target, int flags);
  30 int patch_branch(struct ppc_inst *addr, unsigned long target, int flags);
  31 int patch_instruction(struct ppc_inst *addr, struct ppc_inst instr);
  32 int raw_patch_instruction(struct ppc_inst *addr, struct ppc_inst instr);
  33
  34 static inline unsigned long patch_site_addr(s32 *site)
  35 {
  36         return (unsigned long)site + *site;
  37 }
  38
  39 static inline int patch_instruction_site(s32 *site, struct ppc_inst instr)
  40 {
  41         return patch_instruction((struct ppc_inst *)patch_site_addr(site), instr);
  42 }
  43
  44 static inline int patch_branch_site(s32 *site, unsigned long target, int flags)
  45 {
  46         return patch_branch((struct ppc_inst *)patch_site_addr(site), target, flags);
  47 }
  48
  49 static inline int modify_instruction(unsigned int *addr, unsigned int clr,
  50                                      unsigned int set)
  51 {
  52         return patch_instruction((struct ppc_inst *)addr, ppc_inst((*addr & ~clr) | set));
  53 }
  54
  55 static inline int modify_instruction_site(s32 *site, unsigned int clr, unsigned int set)
  56 {
  57         return modify_instruction((unsigned int *)patch_site_addr(site), clr, set);
  58 }
  59
  60 int instr_is_relative_branch(struct ppc_inst instr);
  61 int instr_is_relative_link_branch(struct ppc_inst instr);
  62 int instr_is_branch_to_addr(const struct ppc_inst *instr, unsigned long addr);
  63 unsigned long branch_target(const struct ppc_inst *instr);
  64 int translate_branch(struct ppc_inst *instr, const struct ppc_inst *dest,
  65                      const struct ppc_inst *src);
  66 extern bool is_conditional_branch(struct ppc_inst instr);
  67 #ifdef CONFIG_PPC_BOOK3E_64
  68 void __patch_exception(int exc, unsigned long addr);
  69 #define patch_exception(exc, name) do { \
  70         extern unsigned int name; \
  71         __patch_exception((exc), (unsigned long)&name); \
  72 } while (0)
  73 #endif
  74
  75 #define OP_RT_RA_MASK   0xffff0000UL
  76 #define LIS_R2          (PPC_INST_ADDIS | __PPC_RT(R2))
  77 #define ADDIS_R2_R12    (PPC_INST_ADDIS | __PPC_RT(R2) | __PPC_RA(R12))
  78 #define ADDI_R2_R2      (PPC_INST_ADDI  | __PPC_RT(R2) | __PPC_RA(R2))
  79
  80
  81 static inline unsigned long ppc_function_entry(void *func)
  82 {
  83 #ifdef PPC64_ELF_ABI_v2
  84         u32 *insn = func;
  85
  86         /*
  87          * A PPC64 ABIv2 function may have a local and a global entry
  88          * point. We need to use the local entry point when patching
  89          * functions, so identify and step over the global entry point
  90          * sequence.
  91          *
  92          * The global entry point sequence is always of the form:
  93          *
  94          * addis r2,r12,XXXX
  95          * addi  r2,r2,XXXX
  96          *
  97          * A linker optimisation may convert the addis to lis:
  98          *
  99          * lis   r2,XXXX
 100          * addi  r2,r2,XXXX
 101          */
 102         if ((((*insn & OP_RT_RA_MASK) == ADDIS_R2_R12) ||
 103              ((*insn & OP_RT_RA_MASK) == LIS_R2)) &&
 104             ((*(insn+1) & OP_RT_RA_MASK) == ADDI_R2_R2))
 105                 return (unsigned long)(insn + 2);
 106         else
 107                 return (unsigned long)func;
 108 #elif defined(PPC64_ELF_ABI_v1)
 109         /*
 110          * On PPC64 ABIv1 the function pointer actually points to the
 111          * function's descriptor. The first entry in the descriptor is the
 112          * address of the function text.
 113          */
 114         return ((func_descr_t *)func)->entry;
 115 #else
 116         return (unsigned long)func;
 117 #endif
 118 }
 119
 120 static inline unsigned long ppc_global_function_entry(void *func)
 121 {
 122 #ifdef PPC64_ELF_ABI_v2
 123         /* PPC64 ABIv2 the global entry point is at the address */
 124         return (unsigned long)func;
 125 #else
 126         /* All other cases there is no change vs ppc_function_entry() */
 127         return ppc_function_entry(func);
 128 #endif
 129 }
 130
 131 /*
 132  * Wrapper around kallsyms_lookup() to return function entry address:
 133  * - For ABIv1, we lookup the dot variant.
 134  * - For ABIv2, we return the local entry point.
 135  */
 136 static inline unsigned long ppc_kallsyms_lookup_name(const char *name)
 137 {
 138         unsigned long addr;
 139 #ifdef PPC64_ELF_ABI_v1
 140         /* check for dot variant */
 141         char dot_name[1 + KSYM_NAME_LEN];
 142         bool dot_appended = false;
 143
 144         if (strnlen(name, KSYM_NAME_LEN) >= KSYM_NAME_LEN)
 145                 return 0;
 146
 147         if (name[0] != '.') {
 148                 dot_name[0] = '.';
 149                 dot_name[1] = '\0';
 150                 strlcat(dot_name, name, sizeof(dot_name));
 151                 dot_appended = true;
 152         } else {
 153                 dot_name[0] = '\0';
 154                 strlcat(dot_name, name, sizeof(dot_name));
 155         }
 156         addr = kallsyms_lookup_name(dot_name);
 157         if (!addr && dot_appended)
 158                 /* Let's try the original non-dot symbol lookup */
 159                 addr = kallsyms_lookup_name(name);
 160 #elif defined(PPC64_ELF_ABI_v2)
 161         addr = kallsyms_lookup_name(name);
 162         if (addr)
 163                 addr = ppc_function_entry((void *)addr);
 164 #else
 165         addr = kallsyms_lookup_name(name);
 166 #endif
 167         return addr;
 168 }
 169
 170 #ifdef CONFIG_PPC64
 171 /*
 172  * Some instruction encodings commonly used in dynamic ftracing
 173  * and function live patching.
 174  */
 175
 176 /* This must match the definition of STK_GOT in <asm/ppc_asm.h> */
 177 #ifdef PPC64_ELF_ABI_v2
 178 #define R2_STACK_OFFSET         24
 179 #else
 180 #define R2_STACK_OFFSET         40
 181 #endif
 182
 183 #define PPC_INST_LD_TOC         (PPC_INST_LD  | ___PPC_RT(__REG_R2) | \
 184                                  ___PPC_RA(__REG_R1) | R2_STACK_OFFSET)
 185
 186 /* usually preceded by a mflr r0 */
 187 #define PPC_INST_STD_LR         (PPC_INST_STD | ___PPC_RS(__REG_R0) | \
 188                                  ___PPC_RA(__REG_R1) | PPC_LR_STKOFF)
 189 #endif /* CONFIG_PPC64 */
 190
 191 #endif /* _ASM_POWERPC_CODE_PATCHING_H */