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
  27 #include <trace/syscall.h>
  28
  29 #include <asm/set_memory.h>
  30 #include <asm/kprobes.h>
  31 #include <asm/ftrace.h>
  32 #include <asm/nops.h>
  33 #include <asm/text-patching.h>
  34
  35 #ifdef CONFIG_DYNAMIC_FTRACE
  36
  37 int ftrace_arch_code_modify_prepare(void)
  38     __acquires(&text_mutex)
  39 {
  40         /*
  41          * Need to grab text_mutex to prevent a race from module loading
  42          * and live kernel patching from changing the text permissions while
  43          * ftrace has it set to "read/write".
  44          */
  45         mutex_lock(&text_mutex);
  46         set_kernel_text_rw();
  47         set_all_modules_text_rw();
  48         return 0;
  49 }
  50
  51 int ftrace_arch_code_modify_post_process(void)
  52     __releases(&text_mutex)
  53 {
  54         set_all_modules_text_ro();
  55         set_kernel_text_ro();
  56         mutex_unlock(&text_mutex);
  57         return 0;
  58 }
  59
  60 union ftrace_code_union {
  61         char code[MCOUNT_INSN_SIZE];
  62         struct {
  63                 unsigned char op;
  64                 int offset;
  65         } __attribute__((packed));
  66 };
  67
  68 static int ftrace_calc_offset(long ip, long addr)
  69 {
  70         return (int)(addr - ip);
  71 }
  72
  73 static unsigned char *
  74 ftrace_text_replace(unsigned char op, unsigned long ip, unsigned long addr)
  75 {
  76         static union ftrace_code_union calc;
  77
  78         calc.op         = op;
  79         calc.offset     = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
  80
  81         return calc.code;
  82 }
  83
  84 static unsigned char *
  85 ftrace_call_replace(unsigned long ip, unsigned long addr)
  86 {
  87         return ftrace_text_replace(0xe8, ip, addr);
  88 }
  89
  90 static inline int
  91 within(unsigned long addr, unsigned long start, unsigned long end)
  92 {
  93         return addr >= start && addr < end;
  94 }
  95
  96 static unsigned long text_ip_addr(unsigned long ip)
  97 {
  98         /*
  99          * On x86_64, kernel text mappings are mapped read-only, so we use
 100          * the kernel identity mapping instead of the kernel text mapping
 101          * to modify the kernel text.
 102          *
 103          * For 32bit kernels, these mappings are same and we can use
 104          * kernel identity mapping to modify code.
 105          */
 106         if (within(ip, (unsigned long)_text, (unsigned long)_etext))
 107                 ip = (unsigned long)__va(__pa_symbol(ip));
 108
 109         return ip;
 110 }
 111
 112 static const unsigned char *ftrace_nop_replace(void)
 113 {
 114         return ideal_nops[NOP_ATOMIC5];
 115 }
 116
 117 static int
 118 ftrace_modify_code_direct(unsigned long ip, unsigned const char *old_code,
 119                    unsigned const char *new_code)
 120 {
 121         unsigned char replaced[MCOUNT_INSN_SIZE];
 122
 123         ftrace_expected = old_code;
 124
 125         /*
 126          * Note:
 127          * We are paranoid about modifying text, as if a bug was to happen, it
 128          * could cause us to read or write to someplace that could cause harm.
 129          * Carefully read and modify the code with probe_kernel_*(), and make
 130          * sure what we read is what we expected it to be before modifying it.
 131          */
 132
 133         /* read the text we want to modify */
 134         if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
 135                 return -EFAULT;
 136
 137         /* Make sure it is what we expect it to be */
 138         if (memcmp(replaced, old_code, MCOUNT_INSN_SIZE) != 0)
 139                 return -EINVAL;
 140
 141         ip = text_ip_addr(ip);
 142
 143         /* replace the text with the new text */
 144         if (probe_kernel_write((void *)ip, new_code, MCOUNT_INSN_SIZE))
 145                 return -EPERM;
 146
 147         sync_core();
 148
 149         return 0;
 150 }
 151
 152 int ftrace_make_nop(struct module *mod,
 153                     struct dyn_ftrace *rec, unsigned long addr)
 154 {
 155         unsigned const char *new, *old;
 156         unsigned long ip = rec->ip;
 157
 158         old = ftrace_call_replace(ip, addr);
 159         new = ftrace_nop_replace();
 160
 161         /*
 162          * On boot up, and when modules are loaded, the MCOUNT_ADDR
 163          * is converted to a nop, and will never become MCOUNT_ADDR
 164          * again. This code is either running before SMP (on boot up)
 165          * or before the code will ever be executed (module load).
 166          * We do not want to use the breakpoint version in this case,
 167          * just modify the code directly.
 168          */
 169         if (addr == MCOUNT_ADDR)
 170                 return ftrace_modify_code_direct(rec->ip, old, new);
 171
 172         ftrace_expected = NULL;
 173
 174         /* Normal cases use add_brk_on_nop */
 175         WARN_ONCE(1, "invalid use of ftrace_make_nop");
 176         return -EINVAL;
 177 }
 178
 179 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
 180 {
 181         unsigned const char *new, *old;
 182         unsigned long ip = rec->ip;
 183
 184         old = ftrace_nop_replace();
 185         new = ftrace_call_replace(ip, addr);
 186
 187         /* Should only be called when module is loaded */
 188         return ftrace_modify_code_direct(rec->ip, old, new);
 189 }
 190
 191 /*
 192  * The modifying_ftrace_code is used to tell the breakpoint
 193  * handler to call ftrace_int3_handler(). If it fails to
 194  * call this handler for a breakpoint added by ftrace, then
 195  * the kernel may crash.
 196  *
 197  * As atomic_writes on x86 do not need a barrier, we do not
 198  * need to add smp_mb()s for this to work. It is also considered
 199  * that we can not read the modifying_ftrace_code before
 200  * executing the breakpoint. That would be quite remarkable if
 201  * it could do that. Here's the flow that is required:
 202  *
 203  *   CPU-0                          CPU-1
 204  *
 205  * atomic_inc(mfc);
 206  * write int3s
 207  *                              <trap-int3> // implicit (r)mb
 208  *                              if (atomic_read(mfc))
 209  *                                      call ftrace_int3_handler()
 210  *
 211  * Then when we are finished:
 212  *
 213  * atomic_dec(mfc);
 214  *
 215  * If we hit a breakpoint that was not set by ftrace, it does not
 216  * matter if ftrace_int3_handler() is called or not. It will
 217  * simply be ignored. But it is crucial that a ftrace nop/caller
 218  * breakpoint is handled. No other user should ever place a
 219  * breakpoint on an ftrace nop/caller location. It must only
 220  * be done by this code.
 221  */
 222 atomic_t modifying_ftrace_code __read_mostly;
 223
 224 static int
 225 ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
 226                    unsigned const char *new_code);
 227
 228 /*
 229  * Should never be called:
 230  *  As it is only called by __ftrace_replace_code() which is called by
 231  *  ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
 232  *  which is called to turn mcount into nops or nops into function calls
 233  *  but not to convert a function from not using regs to one that uses
 234  *  regs, which ftrace_modify_call() is for.
 235  */
 236 int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
 237                                  unsigned long addr)
 238 {
 239         WARN_ON(1);
 240         ftrace_expected = NULL;
 241         return -EINVAL;
 242 }
 243
 244 static unsigned long ftrace_update_func;
 245 static unsigned long ftrace_update_func_call;
 246
 247 static int update_ftrace_func(unsigned long ip, void *new)
 248 {
 249         unsigned char old[MCOUNT_INSN_SIZE];
 250         int ret;
 251
 252         memcpy(old, (void *)ip, MCOUNT_INSN_SIZE);
 253
 254         ftrace_update_func = ip;
 255         /* Make sure the breakpoints see the ftrace_update_func update */
 256         smp_wmb();
 257
 258         /* See comment above by declaration of modifying_ftrace_code */
 259         atomic_inc(&modifying_ftrace_code);
 260
 261         ret = ftrace_modify_code(ip, old, new);
 262
 263         atomic_dec(&modifying_ftrace_code);
 264
 265         return ret;
 266 }
 267
 268 int ftrace_update_ftrace_func(ftrace_func_t func)
 269 {
 270         unsigned long ip = (unsigned long)(&ftrace_call);
 271         unsigned char *new;
 272         int ret;
 273
 274         ftrace_update_func_call = (unsigned long)func;
 275
 276         new = ftrace_call_replace(ip, (unsigned long)func);
 277         ret = update_ftrace_func(ip, new);
 278
 279         /* Also update the regs callback function */
 280         if (!ret) {
 281                 ip = (unsigned long)(&ftrace_regs_call);
 282                 new = ftrace_call_replace(ip, (unsigned long)func);
 283                 ret = update_ftrace_func(ip, new);
 284         }
 285
 286         return ret;
 287 }
 288
 289 static nokprobe_inline int is_ftrace_caller(unsigned long ip)
 290 {
 291         if (ip == ftrace_update_func)
 292                 return 1;
 293
 294         return 0;
 295 }
 296
 297 /*
 298  * A breakpoint was added to the code address we are about to
 299  * modify, and this is the handle that will just skip over it.
 300  * We are either changing a nop into a trace call, or a trace
 301  * call to a nop. While the change is taking place, we treat
 302  * it just like it was a nop.
 303  */
 304 int ftrace_int3_handler(struct pt_regs *regs)
 305 {
 306         unsigned long ip;
 307
 308         if (WARN_ON_ONCE(!regs))
 309                 return 0;
 310
 311         ip = regs->ip - INT3_INSN_SIZE;
 312
 313 #ifdef CONFIG_X86_64
 314         if (ftrace_location(ip)) {
 315                 int3_emulate_call(regs, (unsigned long)ftrace_regs_caller);
 316                 return 1;
 317         } else if (is_ftrace_caller(ip)) {
 318                 if (!ftrace_update_func_call) {
 319                         int3_emulate_jmp(regs, ip + CALL_INSN_SIZE);
 320                         return 1;
 321                 }
 322                 int3_emulate_call(regs, ftrace_update_func_call);
 323                 return 1;
 324         }
 325 #else
 326         if (ftrace_location(ip) || is_ftrace_caller(ip)) {
 327                 int3_emulate_jmp(regs, ip + CALL_INSN_SIZE);
 328                 return 1;
 329         }
 330 #endif
 331
 332         return 0;
 333 }
 334 NOKPROBE_SYMBOL(ftrace_int3_handler);
 335
 336 static int ftrace_write(unsigned long ip, const char *val, int size)
 337 {
 338         ip = text_ip_addr(ip);
 339
 340         if (probe_kernel_write((void *)ip, val, size))
 341                 return -EPERM;
 342
 343         return 0;
 344 }
 345
 346 static int add_break(unsigned long ip, const char *old)
 347 {
 348         unsigned char replaced[MCOUNT_INSN_SIZE];
 349         unsigned char brk = BREAKPOINT_INSTRUCTION;
 350
 351         if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
 352                 return -EFAULT;
 353
 354         ftrace_expected = old;
 355
 356         /* Make sure it is what we expect it to be */
 357         if (memcmp(replaced, old, MCOUNT_INSN_SIZE) != 0)
 358                 return -EINVAL;
 359
 360         return ftrace_write(ip, &brk, 1);
 361 }
 362
 363 static int add_brk_on_call(struct dyn_ftrace *rec, unsigned long addr)
 364 {
 365         unsigned const char *old;
 366         unsigned long ip = rec->ip;
 367
 368         old = ftrace_call_replace(ip, addr);
 369
 370         return add_break(rec->ip, old);
 371 }
 372
 373
 374 static int add_brk_on_nop(struct dyn_ftrace *rec)
 375 {
 376         unsigned const char *old;
 377
 378         old = ftrace_nop_replace();
 379
 380         return add_break(rec->ip, old);
 381 }
 382
 383 static int add_breakpoints(struct dyn_ftrace *rec, int enable)
 384 {
 385         unsigned long ftrace_addr;
 386         int ret;
 387
 388         ftrace_addr = ftrace_get_addr_curr(rec);
 389
 390         ret = ftrace_test_record(rec, enable);
 391
 392         switch (ret) {
 393         case FTRACE_UPDATE_IGNORE:
 394                 return 0;
 395
 396         case FTRACE_UPDATE_MAKE_CALL:
 397                 /* converting nop to call */
 398                 return add_brk_on_nop(rec);
 399
 400         case FTRACE_UPDATE_MODIFY_CALL:
 401         case FTRACE_UPDATE_MAKE_NOP:
 402                 /* converting a call to a nop */
 403                 return add_brk_on_call(rec, ftrace_addr);
 404         }
 405         return 0;
 406 }
 407
 408 /*
 409  * On error, we need to remove breakpoints. This needs to
 410  * be done caefully. If the address does not currently have a
 411  * breakpoint, we know we are done. Otherwise, we look at the
 412  * remaining 4 bytes of the instruction. If it matches a nop
 413  * we replace the breakpoint with the nop. Otherwise we replace
 414  * it with the call instruction.
 415  */
 416 static int remove_breakpoint(struct dyn_ftrace *rec)
 417 {
 418         unsigned char ins[MCOUNT_INSN_SIZE];
 419         unsigned char brk = BREAKPOINT_INSTRUCTION;
 420         const unsigned char *nop;
 421         unsigned long ftrace_addr;
 422         unsigned long ip = rec->ip;
 423
 424         /* If we fail the read, just give up */
 425         if (probe_kernel_read(ins, (void *)ip, MCOUNT_INSN_SIZE))
 426                 return -EFAULT;
 427
 428         /* If this does not have a breakpoint, we are done */
 429         if (ins[0] != brk)
 430                 return 0;
 431
 432         nop = ftrace_nop_replace();
 433
 434         /*
 435          * If the last 4 bytes of the instruction do not match
 436          * a nop, then we assume that this is a call to ftrace_addr.
 437          */
 438         if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0) {
 439                 /*
 440                  * For extra paranoidism, we check if the breakpoint is on
 441                  * a call that would actually jump to the ftrace_addr.
 442                  * If not, don't touch the breakpoint, we make just create
 443                  * a disaster.
 444                  */
 445                 ftrace_addr = ftrace_get_addr_new(rec);
 446                 nop = ftrace_call_replace(ip, ftrace_addr);
 447
 448                 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) == 0)
 449                         goto update;
 450
 451                 /* Check both ftrace_addr and ftrace_old_addr */
 452                 ftrace_addr = ftrace_get_addr_curr(rec);
 453                 nop = ftrace_call_replace(ip, ftrace_addr);
 454
 455                 ftrace_expected = nop;
 456
 457                 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0)
 458                         return -EINVAL;
 459         }
 460
 461  update:
 462         return ftrace_write(ip, nop, 1);
 463 }
 464
 465 static int add_update_code(unsigned long ip, unsigned const char *new)
 466 {
 467         /* skip breakpoint */
 468         ip++;
 469         new++;
 470         return ftrace_write(ip, new, MCOUNT_INSN_SIZE - 1);
 471 }
 472
 473 static int add_update_call(struct dyn_ftrace *rec, unsigned long addr)
 474 {
 475         unsigned long ip = rec->ip;
 476         unsigned const char *new;
 477
 478         new = ftrace_call_replace(ip, addr);
 479         return add_update_code(ip, new);
 480 }
 481
 482 static int add_update_nop(struct dyn_ftrace *rec)
 483 {
 484         unsigned long ip = rec->ip;
 485         unsigned const char *new;
 486
 487         new = ftrace_nop_replace();
 488         return add_update_code(ip, new);
 489 }
 490
 491 static int add_update(struct dyn_ftrace *rec, int enable)
 492 {
 493         unsigned long ftrace_addr;
 494         int ret;
 495
 496         ret = ftrace_test_record(rec, enable);
 497
 498         ftrace_addr  = ftrace_get_addr_new(rec);
 499
 500         switch (ret) {
 501         case FTRACE_UPDATE_IGNORE:
 502                 return 0;
 503
 504         case FTRACE_UPDATE_MODIFY_CALL:
 505         case FTRACE_UPDATE_MAKE_CALL:
 506                 /* converting nop to call */
 507                 return add_update_call(rec, ftrace_addr);
 508
 509         case FTRACE_UPDATE_MAKE_NOP:
 510                 /* converting a call to a nop */
 511                 return add_update_nop(rec);
 512         }
 513
 514         return 0;
 515 }
 516
 517 static int finish_update_call(struct dyn_ftrace *rec, unsigned long addr)
 518 {
 519         unsigned long ip = rec->ip;
 520         unsigned const char *new;
 521
 522         new = ftrace_call_replace(ip, addr);
 523
 524         return ftrace_write(ip, new, 1);
 525 }
 526
 527 static int finish_update_nop(struct dyn_ftrace *rec)
 528 {
 529         unsigned long ip = rec->ip;
 530         unsigned const char *new;
 531
 532         new = ftrace_nop_replace();
 533
 534         return ftrace_write(ip, new, 1);
 535 }
 536
 537 static int finish_update(struct dyn_ftrace *rec, int enable)
 538 {
 539         unsigned long ftrace_addr;
 540         int ret;
 541
 542         ret = ftrace_update_record(rec, enable);
 543
 544         ftrace_addr = ftrace_get_addr_new(rec);
 545
 546         switch (ret) {
 547         case FTRACE_UPDATE_IGNORE:
 548                 return 0;
 549
 550         case FTRACE_UPDATE_MODIFY_CALL:
 551         case FTRACE_UPDATE_MAKE_CALL:
 552                 /* converting nop to call */
 553                 return finish_update_call(rec, ftrace_addr);
 554
 555         case FTRACE_UPDATE_MAKE_NOP:
 556                 /* converting a call to a nop */
 557                 return finish_update_nop(rec);
 558         }
 559
 560         return 0;
 561 }
 562
 563 static void do_sync_core(void *data)
 564 {
 565         sync_core();
 566 }
 567
 568 static void run_sync(void)
 569 {
 570         int enable_irqs;
 571
 572         /* No need to sync if there's only one CPU */
 573         if (num_online_cpus() == 1)
 574                 return;
 575
 576         enable_irqs = irqs_disabled();
 577
 578         /* We may be called with interrupts disabled (on bootup). */
 579         if (enable_irqs)
 580                 local_irq_enable();
 581         on_each_cpu(do_sync_core, NULL, 1);
 582         if (enable_irqs)
 583                 local_irq_disable();
 584 }
 585
 586 void ftrace_replace_code(int enable)
 587 {
 588         struct ftrace_rec_iter *iter;
 589         struct dyn_ftrace *rec;
 590         const char *report = "adding breakpoints";
 591         int count = 0;
 592         int ret;
 593
 594         for_ftrace_rec_iter(iter) {
 595                 rec = ftrace_rec_iter_record(iter);
 596
 597                 ret = add_breakpoints(rec, enable);
 598                 if (ret)
 599                         goto remove_breakpoints;
 600                 count++;
 601         }
 602
 603         run_sync();
 604
 605         report = "updating code";
 606         count = 0;
 607
 608         for_ftrace_rec_iter(iter) {
 609                 rec = ftrace_rec_iter_record(iter);
 610
 611                 ret = add_update(rec, enable);
 612                 if (ret)
 613                         goto remove_breakpoints;
 614                 count++;
 615         }
 616
 617         run_sync();
 618
 619         report = "removing breakpoints";
 620         count = 0;
 621
 622         for_ftrace_rec_iter(iter) {
 623                 rec = ftrace_rec_iter_record(iter);
 624
 625                 ret = finish_update(rec, enable);
 626                 if (ret)
 627                         goto remove_breakpoints;
 628                 count++;
 629         }
 630
 631         run_sync();
 632
 633         return;
 634
 635  remove_breakpoints:
 636         pr_warn("Failed on %s (%d):\n", report, count);
 637         ftrace_bug(ret, rec);
 638         for_ftrace_rec_iter(iter) {
 639                 rec = ftrace_rec_iter_record(iter);
 640                 /*
 641                  * Breakpoints are handled only when this function is in
 642                  * progress. The system could not work with them.
 643                  */
 644                 if (remove_breakpoint(rec))
 645                         BUG();
 646         }
 647         run_sync();
 648 }
 649
 650 static int
 651 ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
 652                    unsigned const char *new_code)
 653 {
 654         int ret;
 655
 656         ret = add_break(ip, old_code);
 657         if (ret)
 658                 goto out;
 659
 660         run_sync();
 661
 662         ret = add_update_code(ip, new_code);
 663         if (ret)
 664                 goto fail_update;
 665
 666         run_sync();
 667
 668         ret = ftrace_write(ip, new_code, 1);
 669         /*
 670          * The breakpoint is handled only when this function is in progress.
 671          * The system could not work if we could not remove it.
 672          */
 673         BUG_ON(ret);
 674  out:
 675         run_sync();
 676         return ret;
 677
 678  fail_update:
 679         /* Also here the system could not work with the breakpoint */
 680         if (ftrace_write(ip, old_code, 1))
 681                 BUG();
 682         goto out;
 683 }
 684
 685 void arch_ftrace_update_code(int command)
 686 {
 687         /* See comment above by declaration of modifying_ftrace_code */
 688         atomic_inc(&modifying_ftrace_code);
 689
 690         ftrace_modify_all_code(command);
 691
 692         atomic_dec(&modifying_ftrace_code);
 693 }
 694
 695 int __init ftrace_dyn_arch_init(void)
 696 {
 697         return 0;
 698 }
 699
 700 /* Currently only x86_64 supports dynamic trampolines */
 701 #ifdef CONFIG_X86_64
 702
 703 #ifdef CONFIG_MODULES
 704 #include <linux/moduleloader.h>
 705 /* Module allocation simplifies allocating memory for code */
 706 static inline void *alloc_tramp(unsigned long size)
 707 {
 708         return module_alloc(size);
 709 }
 710 static inline void tramp_free(void *tramp)
 711 {
 712         module_memfree(tramp);
 713 }
 714 #else
 715 /* Trampolines can only be created if modules are supported */
 716 static inline void *alloc_tramp(unsigned long size)
 717 {
 718         return NULL;
 719 }
 720 static inline void tramp_free(void *tramp) { }
 721 #endif
 722
 723 /* Defined as markers to the end of the ftrace default trampolines */
 724 extern void ftrace_regs_caller_end(void);
 725 extern void ftrace_epilogue(void);
 726 extern void ftrace_caller_op_ptr(void);
 727 extern void ftrace_regs_caller_op_ptr(void);
 728
 729 /* movq function_trace_op(%rip), %rdx */
 730 /* 0x48 0x8b 0x15 <offset-to-ftrace_trace_op (4 bytes)> */
 731 #define OP_REF_SIZE     7
 732
 733 /*
 734  * The ftrace_ops is passed to the function callback. Since the
 735  * trampoline only services a single ftrace_ops, we can pass in
 736  * that ops directly.
 737  *
 738  * The ftrace_op_code_union is used to create a pointer to the
 739  * ftrace_ops that will be passed to the callback function.
 740  */
 741 union ftrace_op_code_union {
 742         char code[OP_REF_SIZE];
 743         struct {
 744                 char op[3];
 745                 int offset;
 746         } __attribute__((packed));
 747 };
 748
 749 #define RET_SIZE                1
 750
 751 static unsigned long
 752 create_trampoline(struct ftrace_ops *ops, unsigned int *tramp_size)
 753 {
 754         unsigned long start_offset;
 755         unsigned long end_offset;
 756         unsigned long op_offset;
 757         unsigned long offset;
 758         unsigned long npages;
 759         unsigned long size;
 760         unsigned long retq;
 761         unsigned long *ptr;
 762         void *trampoline;
 763         void *ip;
 764         /* 48 8b 15 <offset> is movq <offset>(%rip), %rdx */
 765         unsigned const char op_ref[] = { 0x48, 0x8b, 0x15 };
 766         union ftrace_op_code_union op_ptr;
 767         int ret;
 768
 769         if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
 770                 start_offset = (unsigned long)ftrace_regs_caller;
 771                 end_offset = (unsigned long)ftrace_regs_caller_end;
 772                 op_offset = (unsigned long)ftrace_regs_caller_op_ptr;
 773         } else {
 774                 start_offset = (unsigned long)ftrace_caller;
 775                 end_offset = (unsigned long)ftrace_epilogue;
 776                 op_offset = (unsigned long)ftrace_caller_op_ptr;
 777         }
 778
 779         size = end_offset - start_offset;
 780
 781         /*
 782          * Allocate enough size to store the ftrace_caller code,
 783          * the iret , as well as the address of the ftrace_ops this
 784          * trampoline is used for.
 785          */
 786         trampoline = alloc_tramp(size + RET_SIZE + sizeof(void *));
 787         if (!trampoline)
 788                 return 0;
 789
 790         *tramp_size = size + RET_SIZE + sizeof(void *);
 791         npages = DIV_ROUND_UP(*tramp_size, PAGE_SIZE);
 792
 793         /* Copy ftrace_caller onto the trampoline memory */
 794         ret = probe_kernel_read(trampoline, (void *)start_offset, size);
 795         if (WARN_ON(ret < 0))
 796                 goto fail;
 797
 798         ip = trampoline + size;
 799
 800         /* The trampoline ends with ret(q) */
 801         retq = (unsigned long)ftrace_stub;
 802         ret = probe_kernel_read(ip, (void *)retq, RET_SIZE);
 803         if (WARN_ON(ret < 0))
 804                 goto fail;
 805
 806         /*
 807          * The address of the ftrace_ops that is used for this trampoline
 808          * is stored at the end of the trampoline. This will be used to
 809          * load the third parameter for the callback. Basically, that
 810          * location at the end of the trampoline takes the place of
 811          * the global function_trace_op variable.
 812          */
 813
 814         ptr = (unsigned long *)(trampoline + size + RET_SIZE);
 815         *ptr = (unsigned long)ops;
 816
 817         op_offset -= start_offset;
 818         memcpy(&op_ptr, trampoline + op_offset, OP_REF_SIZE);
 819
 820         /* Are we pointing to the reference? */
 821         if (WARN_ON(memcmp(op_ptr.op, op_ref, 3) != 0))
 822                 goto fail;
 823
 824         /* Load the contents of ptr into the callback parameter */
 825         offset = (unsigned long)ptr;
 826         offset -= (unsigned long)trampoline + op_offset + OP_REF_SIZE;
 827
 828         op_ptr.offset = offset;
 829
 830         /* put in the new offset to the ftrace_ops */
 831         memcpy(trampoline + op_offset, &op_ptr, OP_REF_SIZE);
 832
 833         /* ALLOC_TRAMP flags lets us know we created it */
 834         ops->flags |= FTRACE_OPS_FL_ALLOC_TRAMP;
 835
 836         set_vm_flush_reset_perms(trampoline);
 837
 838         /*
 839          * Module allocation needs to be completed by making the page
 840          * executable. The page is still writable, which is a security hazard,
 841          * but anyhow ftrace breaks W^X completely.
 842          */
 843         set_memory_x((unsigned long)trampoline, npages);
 844         return (unsigned long)trampoline;
 845 fail:
 846         tramp_free(trampoline);
 847         return 0;
 848 }
 849
 850 static unsigned long calc_trampoline_call_offset(bool save_regs)
 851 {
 852         unsigned long start_offset;
 853         unsigned long call_offset;
 854
 855         if (save_regs) {
 856                 start_offset = (unsigned long)ftrace_regs_caller;
 857                 call_offset = (unsigned long)ftrace_regs_call;
 858         } else {
 859                 start_offset = (unsigned long)ftrace_caller;
 860                 call_offset = (unsigned long)ftrace_call;
 861         }
 862
 863         return call_offset - start_offset;
 864 }
 865
 866 void arch_ftrace_update_trampoline(struct ftrace_ops *ops)
 867 {
 868         ftrace_func_t func;
 869         unsigned char *new;
 870         unsigned long offset;
 871         unsigned long ip;
 872         unsigned int size;
 873         int ret, npages;
 874
 875         if (ops->trampoline) {
 876                 /*
 877                  * The ftrace_ops caller may set up its own trampoline.
 878                  * In such a case, this code must not modify it.
 879                  */
 880                 if (!(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
 881                         return;
 882                 npages = PAGE_ALIGN(ops->trampoline_size) >> PAGE_SHIFT;
 883                 set_memory_rw(ops->trampoline, npages);
 884         } else {
 885                 ops->trampoline = create_trampoline(ops, &size);
 886                 if (!ops->trampoline)
 887                         return;
 888                 ops->trampoline_size = size;
 889                 npages = PAGE_ALIGN(size) >> PAGE_SHIFT;
 890         }
 891
 892         offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
 893         ip = ops->trampoline + offset;
 894
 895         func = ftrace_ops_get_func(ops);
 896
 897         ftrace_update_func_call = (unsigned long)func;
 898
 899         /* Do a safe modify in case the trampoline is executing */
 900         new = ftrace_call_replace(ip, (unsigned long)func);
 901         ret = update_ftrace_func(ip, new);
 902         set_memory_ro(ops->trampoline, npages);
 903
 904         /* The update should never fail */
 905         WARN_ON(ret);
 906 }
 907
 908 /* Return the address of the function the trampoline calls */
 909 static void *addr_from_call(void *ptr)
 910 {
 911         union ftrace_code_union calc;
 912         int ret;
 913
 914         ret = probe_kernel_read(&calc, ptr, MCOUNT_INSN_SIZE);
 915         if (WARN_ON_ONCE(ret < 0))
 916                 return NULL;
 917
 918         /* Make sure this is a call */
 919         if (WARN_ON_ONCE(calc.op != 0xe8)) {
 920                 pr_warn("Expected e8, got %x\n", calc.op);
 921                 return NULL;
 922         }
 923
 924         return ptr + MCOUNT_INSN_SIZE + calc.offset;
 925 }
 926
 927 void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
 928                            unsigned long frame_pointer);
 929
 930 /*
 931  * If the ops->trampoline was not allocated, then it probably
 932  * has a static trampoline func, or is the ftrace caller itself.
 933  */
 934 static void *static_tramp_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
 935 {
 936         unsigned long offset;
 937         bool save_regs = rec->flags & FTRACE_FL_REGS_EN;
 938         void *ptr;
 939
 940         if (ops && ops->trampoline) {
 941 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 942                 /*
 943                  * We only know about function graph tracer setting as static
 944                  * trampoline.
 945                  */
 946                 if (ops->trampoline == FTRACE_GRAPH_ADDR)
 947                         return (void *)prepare_ftrace_return;
 948 #endif
 949                 return NULL;
 950         }
 951
 952         offset = calc_trampoline_call_offset(save_regs);
 953
 954         if (save_regs)
 955                 ptr = (void *)FTRACE_REGS_ADDR + offset;
 956         else
 957                 ptr = (void *)FTRACE_ADDR + offset;
 958
 959         return addr_from_call(ptr);
 960 }
 961
 962 void *arch_ftrace_trampoline_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
 963 {
 964         unsigned long offset;
 965
 966         /* If we didn't allocate this trampoline, consider it static */
 967         if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
 968                 return static_tramp_func(ops, rec);
 969
 970         offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
 971         return addr_from_call((void *)ops->trampoline + offset);
 972 }
 973
 974 void arch_ftrace_trampoline_free(struct ftrace_ops *ops)
 975 {
 976         if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
 977                 return;
 978
 979         tramp_free((void *)ops->trampoline);
 980         ops->trampoline = 0;
 981 }
 982
 983 #endif /* CONFIG_X86_64 */
 984 #endif /* CONFIG_DYNAMIC_FTRACE */
 985
 986 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 987
 988 #ifdef CONFIG_DYNAMIC_FTRACE
 989 extern void ftrace_graph_call(void);
 990
 991 static unsigned char *ftrace_jmp_replace(unsigned long ip, unsigned long addr)
 992 {
 993         return ftrace_text_replace(0xe9, ip, addr);
 994 }
 995
 996 static int ftrace_mod_jmp(unsigned long ip, void *func)
 997 {
 998         unsigned char *new;
 999
1000         ftrace_update_func_call = 0UL;
1001         new = ftrace_jmp_replace(ip, (unsigned long)func);
1002
1003         return update_ftrace_func(ip, new);
1004 }
1005
1006 int ftrace_enable_ftrace_graph_caller(void)
1007 {
1008         unsigned long ip = (unsigned long)(&ftrace_graph_call);
1009
1010         return ftrace_mod_jmp(ip, &ftrace_graph_caller);
1011 }
1012
1013 int ftrace_disable_ftrace_graph_caller(void)
1014 {
1015         unsigned long ip = (unsigned long)(&ftrace_graph_call);
1016
1017         return ftrace_mod_jmp(ip, &ftrace_stub);
1018 }
1019
1020 #endif /* !CONFIG_DYNAMIC_FTRACE */
1021
1022 /*
1023  * Hook the return address and push it in the stack of return addrs
1024  * in current thread info.
1025  */
1026 void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
1027                            unsigned long frame_pointer)
1028 {
1029         unsigned long old;
1030         int faulted;
1031         unsigned long return_hooker = (unsigned long)
1032                                 &return_to_handler;
1033
1034         /*
1035          * When resuming from suspend-to-ram, this function can be indirectly
1036          * called from early CPU startup code while the CPU is in real mode,
1037          * which would fail miserably.  Make sure the stack pointer is a
1038          * virtual address.
1039          *
1040          * This check isn't as accurate as virt_addr_valid(), but it should be
1041          * good enough for this purpose, and it's fast.
1042          */
1043         if (unlikely((long)__builtin_frame_address(0) >= 0))
1044                 return;
1045
1046         if (unlikely(ftrace_graph_is_dead()))
1047                 return;
1048
1049         if (unlikely(atomic_read(&current->tracing_graph_pause)))
1050                 return;
1051
1052         /*
1053          * Protect against fault, even if it shouldn't
1054          * happen. This tool is too much intrusive to
1055          * ignore such a protection.
1056          */
1057         asm volatile(
1058                 "1: " _ASM_MOV " (%[parent]), %[old]\n"
1059                 "2: " _ASM_MOV " %[return_hooker], (%[parent])\n"
1060                 "   movl $0, %[faulted]\n"
1061                 "3:\n"
1062
1063                 ".section .fixup, \"ax\"\n"
1064                 "4: movl $1, %[faulted]\n"
1065                 "   jmp 3b\n"
1066                 ".previous\n"
1067
1068                 _ASM_EXTABLE(1b, 4b)
1069                 _ASM_EXTABLE(2b, 4b)
1070
1071                 : [old] "=&r" (old), [faulted] "=r" (faulted)
1072                 : [parent] "r" (parent), [return_hooker] "r" (return_hooker)
1073                 : "memory"
1074         );
1075
1076         if (unlikely(faulted)) {
1077                 ftrace_graph_stop();
1078                 WARN_ON(1);
1079                 return;
1080         }
1081
1082         if (function_graph_enter(old, self_addr, frame_pointer, parent))
1083                 *parent = old;
1084 }
1085 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */