arch/arm64/kernel/entry-ftrace.S

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * arch/arm64/kernel/entry-ftrace.S
   4  *
   5  * Copyright (C) 2013 Linaro Limited
   6  * Author: AKASHI Takahiro <[email protected]>
   7  */
   8
   9 #include <linux/linkage.h>
  10 #include <asm/asm-offsets.h>
  11 #include <asm/assembler.h>
  12 #include <asm/ftrace.h>
  13 #include <asm/insn.h>
  14
  15 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
  16 /*
  17  * Due to -fpatchable-function-entry=2, the compiler has placed two NOPs before
  18  * the regular function prologue. For an enabled callsite, ftrace_init_nop() and
  19  * ftrace_make_call() have patched those NOPs to:
  20  *
  21  *      MOV     X9, LR
  22  *      BL      <entry>
  23  *
  24  * ... where <entry> is either ftrace_caller or ftrace_regs_caller.
  25  *
  26  * Each instrumented function follows the AAPCS, so here x0-x8 and x18-x30 are
  27  * live (x18 holds the Shadow Call Stack pointer), and x9-x17 are safe to
  28  * clobber.
  29  *
  30  * We save the callsite's context into a pt_regs before invoking any ftrace
  31  * callbacks. So that we can get a sensible backtrace, we create a stack record
  32  * for the callsite and the ftrace entry assembly. This is not sufficient for
  33  * reliable stacktrace: until we create the callsite stack record, its caller
  34  * is missing from the LR and existing chain of frame records.
  35  */
  36         .macro  ftrace_regs_entry, allregs=0
  37         /* Make room for pt_regs, plus a callee frame */
  38         sub     sp, sp, #(PT_REGS_SIZE + 16)
  39
  40         /* Save function arguments (and x9 for simplicity) */
  41         stp     x0, x1, [sp, #S_X0]
  42         stp     x2, x3, [sp, #S_X2]
  43         stp     x4, x5, [sp, #S_X4]
  44         stp     x6, x7, [sp, #S_X6]
  45         stp     x8, x9, [sp, #S_X8]
  46
  47         /* Optionally save the callee-saved registers, always save the FP */
  48         .if \allregs == 1
  49         stp     x10, x11, [sp, #S_X10]
  50         stp     x12, x13, [sp, #S_X12]
  51         stp     x14, x15, [sp, #S_X14]
  52         stp     x16, x17, [sp, #S_X16]
  53         stp     x18, x19, [sp, #S_X18]
  54         stp     x20, x21, [sp, #S_X20]
  55         stp     x22, x23, [sp, #S_X22]
  56         stp     x24, x25, [sp, #S_X24]
  57         stp     x26, x27, [sp, #S_X26]
  58         stp     x28, x29, [sp, #S_X28]
  59         .else
  60         str     x29, [sp, #S_FP]
  61         .endif
  62
  63         /* Save the callsite's SP and LR */
  64         add     x10, sp, #(PT_REGS_SIZE + 16)
  65         stp     x9, x10, [sp, #S_LR]
  66
  67         /* Save the PC after the ftrace callsite */
  68         str     x30, [sp, #S_PC]
  69
  70         /* Create a frame record for the callsite above pt_regs */
  71         stp     x29, x9, [sp, #PT_REGS_SIZE]
  72         add     x29, sp, #PT_REGS_SIZE
  73
  74         /* Create our frame record within pt_regs. */
  75         stp     x29, x30, [sp, #S_STACKFRAME]
  76         add     x29, sp, #S_STACKFRAME
  77         .endm
  78
  79 SYM_CODE_START(ftrace_regs_caller)
  80         bti     c
  81         ftrace_regs_entry       1
  82         b       ftrace_common
  83 SYM_CODE_END(ftrace_regs_caller)
  84
  85 SYM_CODE_START(ftrace_caller)
  86         bti     c
  87         ftrace_regs_entry       0
  88         b       ftrace_common
  89 SYM_CODE_END(ftrace_caller)
  90
  91 SYM_CODE_START(ftrace_common)
  92         sub     x0, x30, #AARCH64_INSN_SIZE     // ip (callsite's BL insn)
  93         mov     x1, x9                          // parent_ip (callsite's LR)
  94         ldr_l   x2, function_trace_op           // op
  95         mov     x3, sp                          // regs
  96
  97 SYM_INNER_LABEL(ftrace_call, SYM_L_GLOBAL)
  98         bl      ftrace_stub
  99
 100 /*
 101  * At the callsite x0-x8 and x19-x30 were live. Any C code will have preserved
 102  * x19-x29 per the AAPCS, and we created frame records upon entry, so we need
 103  * to restore x0-x8, x29, and x30.
 104  */
 105 ftrace_common_return:
 106         /* Restore function arguments */
 107         ldp     x0, x1, [sp]
 108         ldp     x2, x3, [sp, #S_X2]
 109         ldp     x4, x5, [sp, #S_X4]
 110         ldp     x6, x7, [sp, #S_X6]
 111         ldr     x8, [sp, #S_X8]
 112
 113         /* Restore the callsite's FP, LR, PC */
 114         ldr     x29, [sp, #S_FP]
 115         ldr     x30, [sp, #S_LR]
 116         ldr     x9, [sp, #S_PC]
 117
 118         /* Restore the callsite's SP */
 119         add     sp, sp, #PT_REGS_SIZE + 16
 120
 121         ret     x9
 122 SYM_CODE_END(ftrace_common)
 123
 124 #else /* CONFIG_DYNAMIC_FTRACE_WITH_REGS */
 125
 126 /*
 127  * Gcc with -pg will put the following code in the beginning of each function:
 128  *      mov x0, x30
 129  *      bl _mcount
 130  *      [function's body ...]
 131  * "bl _mcount" may be replaced to "bl ftrace_caller" or NOP if dynamic
 132  * ftrace is enabled.
 133  *
 134  * Please note that x0 as an argument will not be used here because we can
 135  * get lr(x30) of instrumented function at any time by winding up call stack
 136  * as long as the kernel is compiled without -fomit-frame-pointer.
 137  * (or CONFIG_FRAME_POINTER, this is forced on arm64)
 138  *
 139  * stack layout after mcount_enter in _mcount():
 140  *
 141  * current sp/fp =>  0:+-----+
 142  * in _mcount()        | x29 | -> instrumented function's fp
 143  *                     +-----+
 144  *                     | x30 | -> _mcount()'s lr (= instrumented function's pc)
 145  * old sp       => +16:+-----+
 146  * when instrumented   |     |
 147  * function calls      | ... |
 148  * _mcount()           |     |
 149  *                     |     |
 150  * instrumented => +xx:+-----+
 151  * function's fp       | x29 | -> parent's fp
 152  *                     +-----+
 153  *                     | x30 | -> instrumented function's lr (= parent's pc)
 154  *                     +-----+
 155  *                     | ... |
 156  */
 157
 158         .macro mcount_enter
 159         stp     x29, x30, [sp, #-16]!
 160         mov     x29, sp
 161         .endm
 162
 163         .macro mcount_exit
 164         ldp     x29, x30, [sp], #16
 165         ret
 166         .endm
 167
 168         .macro mcount_adjust_addr rd, rn
 169         sub     \rd, \rn, #AARCH64_INSN_SIZE
 170         .endm
 171
 172         /* for instrumented function's parent */
 173         .macro mcount_get_parent_fp reg
 174         ldr     \reg, [x29]
 175         ldr     \reg, [\reg]
 176         .endm
 177
 178         /* for instrumented function */
 179         .macro mcount_get_pc0 reg
 180         mcount_adjust_addr      \reg, x30
 181         .endm
 182
 183         .macro mcount_get_pc reg
 184         ldr     \reg, [x29, #8]
 185         mcount_adjust_addr      \reg, \reg
 186         .endm
 187
 188         .macro mcount_get_lr reg
 189         ldr     \reg, [x29]
 190         ldr     \reg, [\reg, #8]
 191         .endm
 192
 193         .macro mcount_get_lr_addr reg
 194         ldr     \reg, [x29]
 195         add     \reg, \reg, #8
 196         .endm
 197
 198 #ifndef CONFIG_DYNAMIC_FTRACE
 199 /*
 200  * void _mcount(unsigned long return_address)
 201  * @return_address: return address to instrumented function
 202  *
 203  * This function makes calls, if enabled, to:
 204  *     - tracer function to probe instrumented function's entry,
 205  *     - ftrace_graph_caller to set up an exit hook
 206  */
 207 SYM_FUNC_START(_mcount)
 208         mcount_enter
 209
 210         ldr_l   x2, ftrace_trace_function
 211         adr     x0, ftrace_stub
 212         cmp     x0, x2                  // if (ftrace_trace_function
 213         b.eq    skip_ftrace_call        //     != ftrace_stub) {
 214
 215         mcount_get_pc   x0              //       function's pc
 216         mcount_get_lr   x1              //       function's lr (= parent's pc)
 217         blr     x2                      //   (*ftrace_trace_function)(pc, lr);
 218
 219 skip_ftrace_call:                       // }
 220 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 221         ldr_l   x2, ftrace_graph_return
 222         cmp     x0, x2                  //   if ((ftrace_graph_return
 223         b.ne    ftrace_graph_caller     //        != ftrace_stub)
 224
 225         ldr_l   x2, ftrace_graph_entry  //     || (ftrace_graph_entry
 226         adr_l   x0, ftrace_graph_entry_stub //     != ftrace_graph_entry_stub))
 227         cmp     x0, x2
 228         b.ne    ftrace_graph_caller     //     ftrace_graph_caller();
 229 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 230         mcount_exit
 231 SYM_FUNC_END(_mcount)
 232 EXPORT_SYMBOL(_mcount)
 233 NOKPROBE(_mcount)
 234
 235 #else /* CONFIG_DYNAMIC_FTRACE */
 236 /*
 237  * _mcount() is used to build the kernel with -pg option, but all the branch
 238  * instructions to _mcount() are replaced to NOP initially at kernel start up,
 239  * and later on, NOP to branch to ftrace_caller() when enabled or branch to
 240  * NOP when disabled per-function base.
 241  */
 242 SYM_FUNC_START(_mcount)
 243         ret
 244 SYM_FUNC_END(_mcount)
 245 EXPORT_SYMBOL(_mcount)
 246 NOKPROBE(_mcount)
 247
 248 /*
 249  * void ftrace_caller(unsigned long return_address)
 250  * @return_address: return address to instrumented function
 251  *
 252  * This function is a counterpart of _mcount() in 'static' ftrace, and
 253  * makes calls to:
 254  *     - tracer function to probe instrumented function's entry,
 255  *     - ftrace_graph_caller to set up an exit hook
 256  */
 257 SYM_FUNC_START(ftrace_caller)
 258         mcount_enter
 259
 260         mcount_get_pc0  x0              //     function's pc
 261         mcount_get_lr   x1              //     function's lr
 262
 263 SYM_INNER_LABEL(ftrace_call, SYM_L_GLOBAL)      // tracer(pc, lr);
 264         nop                             // This will be replaced with "bl xxx"
 265                                         // where xxx can be any kind of tracer.
 266
 267 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 268 SYM_INNER_LABEL(ftrace_graph_call, SYM_L_GLOBAL) // ftrace_graph_caller();
 269         nop                             // If enabled, this will be replaced
 270                                         // "b ftrace_graph_caller"
 271 #endif
 272
 273         mcount_exit
 274 SYM_FUNC_END(ftrace_caller)
 275 #endif /* CONFIG_DYNAMIC_FTRACE */
 276
 277 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 278 /*
 279  * void ftrace_graph_caller(void)
 280  *
 281  * Called from _mcount() or ftrace_caller() when function_graph tracer is
 282  * selected.
 283  * This function w/ prepare_ftrace_return() fakes link register's value on
 284  * the call stack in order to intercept instrumented function's return path
 285  * and run return_to_handler() later on its exit.
 286  */
 287 SYM_FUNC_START(ftrace_graph_caller)
 288         mcount_get_pc             x0    //     function's pc
 289         mcount_get_lr_addr        x1    //     pointer to function's saved lr
 290         mcount_get_parent_fp      x2    //     parent's fp
 291         bl      prepare_ftrace_return   // prepare_ftrace_return(pc, &lr, fp)
 292
 293         mcount_exit
 294 SYM_FUNC_END(ftrace_graph_caller)
 295 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 296 #endif /* CONFIG_DYNAMIC_FTRACE_WITH_REGS */
 297
 298 SYM_FUNC_START(ftrace_stub)
 299         ret
 300 SYM_FUNC_END(ftrace_stub)
 301
 302 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 303 /*
 304  * void return_to_handler(void)
 305  *
 306  * Run ftrace_return_to_handler() before going back to parent.
 307  * @fp is checked against the value passed by ftrace_graph_caller().
 308  */
 309 SYM_CODE_START(return_to_handler)
 310         /* save return value regs */
 311         sub sp, sp, #64
 312         stp x0, x1, [sp]
 313         stp x2, x3, [sp, #16]
 314         stp x4, x5, [sp, #32]
 315         stp x6, x7, [sp, #48]
 316
 317         mov     x0, x29                 //     parent's fp
 318         bl      ftrace_return_to_handler// addr = ftrace_return_to_hander(fp);
 319         mov     x30, x0                 // restore the original return address
 320
 321         /* restore return value regs */
 322         ldp x0, x1, [sp]
 323         ldp x2, x3, [sp, #16]
 324         ldp x4, x5, [sp, #32]
 325         ldp x6, x7, [sp, #48]
 326         add sp, sp, #64
 327
 328         ret
 329 SYM_CODE_END(return_to_handler)
 330 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */