arch/x86/kernel/ftrace.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Dynamic function tracing support.
   4  *
   5  * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
   6  *
   7  * Thanks goes to Ingo Molnar, for suggesting the idea.
   8  * Mathieu Desnoyers, for suggesting postponing the modifications.
   9  * Arjan van de Ven, for keeping me straight, and explaining to me
  10  * the dangers of modifying code on the run.
  11  */
  12
  13 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  14
  15 #include <linux/spinlock.h>
  16 #include <linux/hardirq.h>
  17 #include <linux/uaccess.h>
  18 #include <linux/ftrace.h>
  19 #include <linux/percpu.h>
  20 #include <linux/sched.h>
  21 #include <linux/slab.h>
  22 #include <linux/init.h>
  23 #include <linux/list.h>
  24 #include <linux/module.h>
  25 #include <linux/memory.h>
  26 #include <linux/vmalloc.h>
  27
  28 #include <trace/syscall.h>
  29
  30 #include <asm/set_memory.h>
  31 #include <asm/kprobes.h>
  32 #include <asm/ftrace.h>
  33 #include <asm/nops.h>
  34 #include <asm/text-patching.h>
  35
  36 #ifdef CONFIG_DYNAMIC_FTRACE
  37
  38 static int ftrace_poke_late = 0;
  39
  40 int ftrace_arch_code_modify_prepare(void)
  41     __acquires(&text_mutex)
  42 {
  43         /*
  44          * Need to grab text_mutex to prevent a race from module loading
  45          * and live kernel patching from changing the text permissions while
  46          * ftrace has it set to "read/write".
  47          */
  48         mutex_lock(&text_mutex);
  49         ftrace_poke_late = 1;
  50         return 0;
  51 }
  52
  53 int ftrace_arch_code_modify_post_process(void)
  54     __releases(&text_mutex)
  55 {
  56         /*
  57          * ftrace_make_{call,nop}() may be called during
  58          * module load, and we need to finish the text_poke_queue()
  59          * that they do, here.
  60          */
  61         text_poke_finish();
  62         ftrace_poke_late = 0;
  63         mutex_unlock(&text_mutex);
  64         return 0;
  65 }
  66
  67 static const char *ftrace_nop_replace(void)
  68 {
  69         return ideal_nops[NOP_ATOMIC5];
  70 }
  71
  72 static const char *ftrace_call_replace(unsigned long ip, unsigned long addr)
  73 {
  74         return text_gen_insn(CALL_INSN_OPCODE, (void *)ip, (void *)addr);
  75 }
  76
  77 static int ftrace_verify_code(unsigned long ip, const char *old_code)
  78 {
  79         char cur_code[MCOUNT_INSN_SIZE];
  80
  81         /*
  82          * Note:
  83          * We are paranoid about modifying text, as if a bug was to happen, it
  84          * could cause us to read or write to someplace that could cause harm.
  85          * Carefully read and modify the code with probe_kernel_*(), and make
  86          * sure what we read is what we expected it to be before modifying it.
  87          */
  88         /* read the text we want to modify */
  89         if (probe_kernel_read(cur_code, (void *)ip, MCOUNT_INSN_SIZE)) {
  90                 WARN_ON(1);
  91                 return -EFAULT;
  92         }
  93
  94         /* Make sure it is what we expect it to be */
  95         if (memcmp(cur_code, old_code, MCOUNT_INSN_SIZE) != 0) {
  96                 WARN_ON(1);
  97                 return -EINVAL;
  98         }
  99
 100         return 0;
 101 }
 102
 103 /*
 104  * Marked __ref because it calls text_poke_early() which is .init.text. That is
 105  * ok because that call will happen early, during boot, when .init sections are
 106  * still present.
 107  */
 108 static int __ref
 109 ftrace_modify_code_direct(unsigned long ip, const char *old_code,
 110                           const char *new_code)
 111 {
 112         int ret = ftrace_verify_code(ip, old_code);
 113         if (ret)
 114                 return ret;
 115
 116         /* replace the text with the new text */
 117         if (ftrace_poke_late)
 118                 text_poke_queue((void *)ip, new_code, MCOUNT_INSN_SIZE, NULL);
 119         else
 120                 text_poke_early((void *)ip, new_code, MCOUNT_INSN_SIZE);
 121         return 0;
 122 }
 123
 124 int ftrace_make_nop(struct module *mod, struct dyn_ftrace *rec, unsigned long addr)
 125 {
 126         unsigned long ip = rec->ip;
 127         const char *new, *old;
 128
 129         old = ftrace_call_replace(ip, addr);
 130         new = ftrace_nop_replace();
 131
 132         /*
 133          * On boot up, and when modules are loaded, the MCOUNT_ADDR
 134          * is converted to a nop, and will never become MCOUNT_ADDR
 135          * again. This code is either running before SMP (on boot up)
 136          * or before the code will ever be executed (module load).
 137          * We do not want to use the breakpoint version in this case,
 138          * just modify the code directly.
 139          */
 140         if (addr == MCOUNT_ADDR)
 141                 return ftrace_modify_code_direct(ip, old, new);
 142
 143         /*
 144          * x86 overrides ftrace_replace_code -- this function will never be used
 145          * in this case.
 146          */
 147         WARN_ONCE(1, "invalid use of ftrace_make_nop");
 148         return -EINVAL;
 149 }
 150
 151 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
 152 {
 153         unsigned long ip = rec->ip;
 154         const char *new, *old;
 155
 156         old = ftrace_nop_replace();
 157         new = ftrace_call_replace(ip, addr);
 158
 159         /* Should only be called when module is loaded */
 160         return ftrace_modify_code_direct(rec->ip, old, new);
 161 }
 162
 163 /*
 164  * Should never be called:
 165  *  As it is only called by __ftrace_replace_code() which is called by
 166  *  ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
 167  *  which is called to turn mcount into nops or nops into function calls
 168  *  but not to convert a function from not using regs to one that uses
 169  *  regs, which ftrace_modify_call() is for.
 170  */
 171 int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
 172                                  unsigned long addr)
 173 {
 174         WARN_ON(1);
 175         return -EINVAL;
 176 }
 177
 178 int ftrace_update_ftrace_func(ftrace_func_t func)
 179 {
 180         unsigned long ip;
 181         const char *new;
 182
 183         ip = (unsigned long)(&ftrace_call);
 184         new = ftrace_call_replace(ip, (unsigned long)func);
 185         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
 186
 187         ip = (unsigned long)(&ftrace_regs_call);
 188         new = ftrace_call_replace(ip, (unsigned long)func);
 189         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
 190
 191         return 0;
 192 }
 193
 194 void ftrace_replace_code(int enable)
 195 {
 196         struct ftrace_rec_iter *iter;
 197         struct dyn_ftrace *rec;
 198         const char *new, *old;
 199         int ret;
 200
 201         for_ftrace_rec_iter(iter) {
 202                 rec = ftrace_rec_iter_record(iter);
 203
 204                 switch (ftrace_test_record(rec, enable)) {
 205                 case FTRACE_UPDATE_IGNORE:
 206                 default:
 207                         continue;
 208
 209                 case FTRACE_UPDATE_MAKE_CALL:
 210                         old = ftrace_nop_replace();
 211                         break;
 212
 213                 case FTRACE_UPDATE_MODIFY_CALL:
 214                 case FTRACE_UPDATE_MAKE_NOP:
 215                         old = ftrace_call_replace(rec->ip, ftrace_get_addr_curr(rec));
 216                         break;
 217                 }
 218
 219                 ret = ftrace_verify_code(rec->ip, old);
 220                 if (ret) {
 221                         ftrace_bug(ret, rec);
 222                         return;
 223                 }
 224         }
 225
 226         for_ftrace_rec_iter(iter) {
 227                 rec = ftrace_rec_iter_record(iter);
 228
 229                 switch (ftrace_test_record(rec, enable)) {
 230                 case FTRACE_UPDATE_IGNORE:
 231                 default:
 232                         continue;
 233
 234                 case FTRACE_UPDATE_MAKE_CALL:
 235                 case FTRACE_UPDATE_MODIFY_CALL:
 236                         new = ftrace_call_replace(rec->ip, ftrace_get_addr_new(rec));
 237                         break;
 238
 239                 case FTRACE_UPDATE_MAKE_NOP:
 240                         new = ftrace_nop_replace();
 241                         break;
 242                 }
 243
 244                 text_poke_queue((void *)rec->ip, new, MCOUNT_INSN_SIZE, NULL);
 245                 ftrace_update_record(rec, enable);
 246         }
 247         text_poke_finish();
 248 }
 249
 250 void arch_ftrace_update_code(int command)
 251 {
 252         ftrace_modify_all_code(command);
 253 }
 254
 255 int __init ftrace_dyn_arch_init(void)
 256 {
 257         return 0;
 258 }
 259
 260 /* Currently only x86_64 supports dynamic trampolines */
 261 #ifdef CONFIG_X86_64
 262
 263 #ifdef CONFIG_MODULES
 264 #include <linux/moduleloader.h>
 265 /* Module allocation simplifies allocating memory for code */
 266 static inline void *alloc_tramp(unsigned long size)
 267 {
 268         return module_alloc(size);
 269 }
 270 static inline void tramp_free(void *tramp)
 271 {
 272         module_memfree(tramp);
 273 }
 274 #else
 275 /* Trampolines can only be created if modules are supported */
 276 static inline void *alloc_tramp(unsigned long size)
 277 {
 278         return NULL;
 279 }
 280 static inline void tramp_free(void *tramp) { }
 281 #endif
 282
 283 /* Defined as markers to the end of the ftrace default trampolines */
 284 extern void ftrace_regs_caller_end(void);
 285 extern void ftrace_regs_caller_ret(void);
 286 extern void ftrace_caller_end(void);
 287 extern void ftrace_caller_op_ptr(void);
 288 extern void ftrace_regs_caller_op_ptr(void);
 289
 290 /* movq function_trace_op(%rip), %rdx */
 291 /* 0x48 0x8b 0x15 <offset-to-ftrace_trace_op (4 bytes)> */
 292 #define OP_REF_SIZE     7
 293
 294 /*
 295  * The ftrace_ops is passed to the function callback. Since the
 296  * trampoline only services a single ftrace_ops, we can pass in
 297  * that ops directly.
 298  *
 299  * The ftrace_op_code_union is used to create a pointer to the
 300  * ftrace_ops that will be passed to the callback function.
 301  */
 302 union ftrace_op_code_union {
 303         char code[OP_REF_SIZE];
 304         struct {
 305                 char op[3];
 306                 int offset;
 307         } __attribute__((packed));
 308 };
 309
 310 #define RET_SIZE                1
 311
 312 static unsigned long
 313 create_trampoline(struct ftrace_ops *ops, unsigned int *tramp_size)
 314 {
 315         unsigned long start_offset;
 316         unsigned long end_offset;
 317         unsigned long op_offset;
 318         unsigned long call_offset;
 319         unsigned long offset;
 320         unsigned long npages;
 321         unsigned long size;
 322         unsigned long retq;
 323         unsigned long *ptr;
 324         void *trampoline;
 325         void *ip;
 326         /* 48 8b 15 <offset> is movq <offset>(%rip), %rdx */
 327         unsigned const char op_ref[] = { 0x48, 0x8b, 0x15 };
 328         union ftrace_op_code_union op_ptr;
 329         int ret;
 330
 331         if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
 332                 start_offset = (unsigned long)ftrace_regs_caller;
 333                 end_offset = (unsigned long)ftrace_regs_caller_end;
 334                 op_offset = (unsigned long)ftrace_regs_caller_op_ptr;
 335                 call_offset = (unsigned long)ftrace_regs_call;
 336         } else {
 337                 start_offset = (unsigned long)ftrace_caller;
 338                 end_offset = (unsigned long)ftrace_caller_end;
 339                 op_offset = (unsigned long)ftrace_caller_op_ptr;
 340                 call_offset = (unsigned long)ftrace_call;
 341         }
 342
 343         size = end_offset - start_offset;
 344
 345         /*
 346          * Allocate enough size to store the ftrace_caller code,
 347          * the iret , as well as the address of the ftrace_ops this
 348          * trampoline is used for.
 349          */
 350         trampoline = alloc_tramp(size + RET_SIZE + sizeof(void *));
 351         if (!trampoline)
 352                 return 0;
 353
 354         *tramp_size = size + RET_SIZE + sizeof(void *);
 355         npages = DIV_ROUND_UP(*tramp_size, PAGE_SIZE);
 356
 357         /* Copy ftrace_caller onto the trampoline memory */
 358         ret = probe_kernel_read(trampoline, (void *)start_offset, size);
 359         if (WARN_ON(ret < 0))
 360                 goto fail;
 361
 362         ip = trampoline + size;
 363
 364         /* The trampoline ends with ret(q) */
 365         retq = (unsigned long)ftrace_stub;
 366         ret = probe_kernel_read(ip, (void *)retq, RET_SIZE);
 367         if (WARN_ON(ret < 0))
 368                 goto fail;
 369
 370         if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
 371                 ip = trampoline + (ftrace_regs_caller_ret - ftrace_regs_caller);
 372                 ret = probe_kernel_read(ip, (void *)retq, RET_SIZE);
 373                 if (WARN_ON(ret < 0))
 374                         goto fail;
 375         }
 376
 377         /*
 378          * The address of the ftrace_ops that is used for this trampoline
 379          * is stored at the end of the trampoline. This will be used to
 380          * load the third parameter for the callback. Basically, that
 381          * location at the end of the trampoline takes the place of
 382          * the global function_trace_op variable.
 383          */
 384
 385         ptr = (unsigned long *)(trampoline + size + RET_SIZE);
 386         *ptr = (unsigned long)ops;
 387
 388         op_offset -= start_offset;
 389         memcpy(&op_ptr, trampoline + op_offset, OP_REF_SIZE);
 390
 391         /* Are we pointing to the reference? */
 392         if (WARN_ON(memcmp(op_ptr.op, op_ref, 3) != 0))
 393                 goto fail;
 394
 395         /* Load the contents of ptr into the callback parameter */
 396         offset = (unsigned long)ptr;
 397         offset -= (unsigned long)trampoline + op_offset + OP_REF_SIZE;
 398
 399         op_ptr.offset = offset;
 400
 401         /* put in the new offset to the ftrace_ops */
 402         memcpy(trampoline + op_offset, &op_ptr, OP_REF_SIZE);
 403
 404         /* put in the call to the function */
 405         mutex_lock(&text_mutex);
 406         call_offset -= start_offset;
 407         memcpy(trampoline + call_offset,
 408                text_gen_insn(CALL_INSN_OPCODE,
 409                              trampoline + call_offset,
 410                              ftrace_ops_get_func(ops)), CALL_INSN_SIZE);
 411         mutex_unlock(&text_mutex);
 412
 413         /* ALLOC_TRAMP flags lets us know we created it */
 414         ops->flags |= FTRACE_OPS_FL_ALLOC_TRAMP;
 415
 416         set_vm_flush_reset_perms(trampoline);
 417
 418         set_memory_ro((unsigned long)trampoline, npages);
 419         set_memory_x((unsigned long)trampoline, npages);
 420         return (unsigned long)trampoline;
 421 fail:
 422         tramp_free(trampoline);
 423         return 0;
 424 }
 425
 426 static unsigned long calc_trampoline_call_offset(bool save_regs)
 427 {
 428         unsigned long start_offset;
 429         unsigned long call_offset;
 430
 431         if (save_regs) {
 432                 start_offset = (unsigned long)ftrace_regs_caller;
 433                 call_offset = (unsigned long)ftrace_regs_call;
 434         } else {
 435                 start_offset = (unsigned long)ftrace_caller;
 436                 call_offset = (unsigned long)ftrace_call;
 437         }
 438
 439         return call_offset - start_offset;
 440 }
 441
 442 void arch_ftrace_update_trampoline(struct ftrace_ops *ops)
 443 {
 444         ftrace_func_t func;
 445         unsigned long offset;
 446         unsigned long ip;
 447         unsigned int size;
 448         const char *new;
 449
 450         if (!ops->trampoline) {
 451                 ops->trampoline = create_trampoline(ops, &size);
 452                 if (!ops->trampoline)
 453                         return;
 454                 ops->trampoline_size = size;
 455                 return;
 456         }
 457
 458         /*
 459          * The ftrace_ops caller may set up its own trampoline.
 460          * In such a case, this code must not modify it.
 461          */
 462         if (!(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
 463                 return;
 464
 465         offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
 466         ip = ops->trampoline + offset;
 467         func = ftrace_ops_get_func(ops);
 468
 469         mutex_lock(&text_mutex);
 470         /* Do a safe modify in case the trampoline is executing */
 471         new = ftrace_call_replace(ip, (unsigned long)func);
 472         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
 473         mutex_unlock(&text_mutex);
 474 }
 475
 476 /* Return the address of the function the trampoline calls */
 477 static void *addr_from_call(void *ptr)
 478 {
 479         union text_poke_insn call;
 480         int ret;
 481
 482         ret = probe_kernel_read(&call, ptr, CALL_INSN_SIZE);
 483         if (WARN_ON_ONCE(ret < 0))
 484                 return NULL;
 485
 486         /* Make sure this is a call */
 487         if (WARN_ON_ONCE(call.opcode != CALL_INSN_OPCODE)) {
 488                 pr_warn("Expected E8, got %x\n", call.opcode);
 489                 return NULL;
 490         }
 491
 492         return ptr + CALL_INSN_SIZE + call.disp;
 493 }
 494
 495 void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
 496                            unsigned long frame_pointer);
 497
 498 /*
 499  * If the ops->trampoline was not allocated, then it probably
 500  * has a static trampoline func, or is the ftrace caller itself.
 501  */
 502 static void *static_tramp_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
 503 {
 504         unsigned long offset;
 505         bool save_regs = rec->flags & FTRACE_FL_REGS_EN;
 506         void *ptr;
 507
 508         if (ops && ops->trampoline) {
 509 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 510                 /*
 511                  * We only know about function graph tracer setting as static
 512                  * trampoline.
 513                  */
 514                 if (ops->trampoline == FTRACE_GRAPH_ADDR)
 515                         return (void *)prepare_ftrace_return;
 516 #endif
 517                 return NULL;
 518         }
 519
 520         offset = calc_trampoline_call_offset(save_regs);
 521
 522         if (save_regs)
 523                 ptr = (void *)FTRACE_REGS_ADDR + offset;
 524         else
 525                 ptr = (void *)FTRACE_ADDR + offset;
 526
 527         return addr_from_call(ptr);
 528 }
 529
 530 void *arch_ftrace_trampoline_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
 531 {
 532         unsigned long offset;
 533
 534         /* If we didn't allocate this trampoline, consider it static */
 535         if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
 536                 return static_tramp_func(ops, rec);
 537
 538         offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
 539         return addr_from_call((void *)ops->trampoline + offset);
 540 }
 541
 542 void arch_ftrace_trampoline_free(struct ftrace_ops *ops)
 543 {
 544         if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
 545                 return;
 546
 547         tramp_free((void *)ops->trampoline);
 548         ops->trampoline = 0;
 549 }
 550
 551 #endif /* CONFIG_X86_64 */
 552 #endif /* CONFIG_DYNAMIC_FTRACE */
 553
 554 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 555
 556 #ifdef CONFIG_DYNAMIC_FTRACE
 557 extern void ftrace_graph_call(void);
 558
 559 static const char *ftrace_jmp_replace(unsigned long ip, unsigned long addr)
 560 {
 561         return text_gen_insn(JMP32_INSN_OPCODE, (void *)ip, (void *)addr);
 562 }
 563
 564 static int ftrace_mod_jmp(unsigned long ip, void *func)
 565 {
 566         const char *new;
 567
 568         new = ftrace_jmp_replace(ip, (unsigned long)func);
 569         text_poke_bp((void *)ip, new, MCOUNT_INSN_SIZE, NULL);
 570         return 0;
 571 }
 572
 573 int ftrace_enable_ftrace_graph_caller(void)
 574 {
 575         unsigned long ip = (unsigned long)(&ftrace_graph_call);
 576
 577         return ftrace_mod_jmp(ip, &ftrace_graph_caller);
 578 }
 579
 580 int ftrace_disable_ftrace_graph_caller(void)
 581 {
 582         unsigned long ip = (unsigned long)(&ftrace_graph_call);
 583
 584         return ftrace_mod_jmp(ip, &ftrace_stub);
 585 }
 586
 587 #endif /* !CONFIG_DYNAMIC_FTRACE */
 588
 589 /*
 590  * Hook the return address and push it in the stack of return addrs
 591  * in current thread info.
 592  */
 593 void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
 594                            unsigned long frame_pointer)
 595 {
 596         unsigned long return_hooker = (unsigned long)&return_to_handler;
 597         unsigned long old;
 598         int faulted;
 599
 600         /*
 601          * When resuming from suspend-to-ram, this function can be indirectly
 602          * called from early CPU startup code while the CPU is in real mode,
 603          * which would fail miserably.  Make sure the stack pointer is a
 604          * virtual address.
 605          *
 606          * This check isn't as accurate as virt_addr_valid(), but it should be
 607          * good enough for this purpose, and it's fast.
 608          */
 609         if (unlikely((long)__builtin_frame_address(0) >= 0))
 610                 return;
 611
 612         if (unlikely(ftrace_graph_is_dead()))
 613                 return;
 614
 615         if (unlikely(atomic_read(&current->tracing_graph_pause)))
 616                 return;
 617
 618         /*
 619          * Protect against fault, even if it shouldn't
 620          * happen. This tool is too much intrusive to
 621          * ignore such a protection.
 622          */
 623         asm volatile(
 624                 "1: " _ASM_MOV " (%[parent]), %[old]\n"
 625                 "2: " _ASM_MOV " %[return_hooker], (%[parent])\n"
 626                 "   movl $0, %[faulted]\n"
 627                 "3:\n"
 628
 629                 ".section .fixup, \"ax\"\n"
 630                 "4: movl $1, %[faulted]\n"
 631                 "   jmp 3b\n"
 632                 ".previous\n"
 633
 634                 _ASM_EXTABLE(1b, 4b)
 635                 _ASM_EXTABLE(2b, 4b)
 636
 637                 : [old] "=&r" (old), [faulted] "=r" (faulted)
 638                 : [parent] "r" (parent), [return_hooker] "r" (return_hooker)
 639                 : "memory"
 640         );
 641
 642         if (unlikely(faulted)) {
 643                 ftrace_graph_stop();
 644                 WARN_ON(1);
 645                 return;
 646         }
 647
 648         if (function_graph_enter(old, self_addr, frame_pointer, parent))
 649                 *parent = old;
 650 }
 651 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */