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

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