arch/x86/kernel/ftrace.c

   1 /*
   2  * Code for replacing ftrace calls with jumps.
   3  *
   4  * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
   5  *
   6  * Thanks goes to Ingo Molnar, for suggesting the idea.
   7  * Mathieu Desnoyers, for suggesting postponing the modifications.
   8  * Arjan van de Ven, for keeping me straight, and explaining to me
   9  * the dangers of modifying code on the run.
  10  */
  11
  12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  13
  14 #include <linux/spinlock.h>
  15 #include <linux/hardirq.h>
  16 #include <linux/uaccess.h>
  17 #include <linux/ftrace.h>
  18 #include <linux/percpu.h>
  19 #include <linux/sched.h>
  20 #include <linux/init.h>
  21 #include <linux/list.h>
  22
  23 #include <trace/syscall.h>
  24
  25 #include <asm/cacheflush.h>
  26 #include <asm/ftrace.h>
  27 #include <asm/nops.h>
  28 #include <asm/nmi.h>
  29
  30
  31 #ifdef CONFIG_DYNAMIC_FTRACE
  32
  33 int ftrace_arch_code_modify_prepare(void)
  34 {
  35         set_kernel_text_rw();
  36         return 0;
  37 }
  38
  39 int ftrace_arch_code_modify_post_process(void)
  40 {
  41         set_kernel_text_ro();
  42         return 0;
  43 }
  44
  45 union ftrace_code_union {
  46         char code[MCOUNT_INSN_SIZE];
  47         struct {
  48                 char e8;
  49                 int offset;
  50         } __attribute__((packed));
  51 };
  52
  53 static int ftrace_calc_offset(long ip, long addr)
  54 {
  55         return (int)(addr - ip);
  56 }
  57
  58 static unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr)
  59 {
  60         static union ftrace_code_union calc;
  61
  62         calc.e8         = 0xe8;
  63         calc.offset     = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
  64
  65         /*
  66          * No locking needed, this must be called via kstop_machine
  67          * which in essence is like running on a uniprocessor machine.
  68          */
  69         return calc.code;
  70 }
  71
  72 /*
  73  * Modifying code must take extra care. On an SMP machine, if
  74  * the code being modified is also being executed on another CPU
  75  * that CPU will have undefined results and possibly take a GPF.
  76  * We use kstop_machine to stop other CPUS from exectuing code.
  77  * But this does not stop NMIs from happening. We still need
  78  * to protect against that. We separate out the modification of
  79  * the code to take care of this.
  80  *
  81  * Two buffers are added: An IP buffer and a "code" buffer.
  82  *
  83  * 1) Put the instruction pointer into the IP buffer
  84  *    and the new code into the "code" buffer.
  85  * 2) Wait for any running NMIs to finish and set a flag that says
  86  *    we are modifying code, it is done in an atomic operation.
  87  * 3) Write the code
  88  * 4) clear the flag.
  89  * 5) Wait for any running NMIs to finish.
  90  *
  91  * If an NMI is executed, the first thing it does is to call
  92  * "ftrace_nmi_enter". This will check if the flag is set to write
  93  * and if it is, it will write what is in the IP and "code" buffers.
  94  *
  95  * The trick is, it does not matter if everyone is writing the same
  96  * content to the code location. Also, if a CPU is executing code
  97  * it is OK to write to that code location if the contents being written
  98  * are the same as what exists.
  99  */
 100
 101 #define MOD_CODE_WRITE_FLAG (1 << 31)   /* set when NMI should do the write */
 102 static atomic_t nmi_running = ATOMIC_INIT(0);
 103 static int mod_code_status;             /* holds return value of text write */
 104 static void *mod_code_ip;               /* holds the IP to write to */
 105 static void *mod_code_newcode;          /* holds the text to write to the IP */
 106
 107 static unsigned nmi_wait_count;
 108 static atomic_t nmi_update_count = ATOMIC_INIT(0);
 109
 110 int ftrace_arch_read_dyn_info(char *buf, int size)
 111 {
 112         int r;
 113
 114         r = snprintf(buf, size, "%u %u",
 115                      nmi_wait_count,
 116                      atomic_read(&nmi_update_count));
 117         return r;
 118 }
 119
 120 static void clear_mod_flag(void)
 121 {
 122         int old = atomic_read(&nmi_running);
 123
 124         for (;;) {
 125                 int new = old & ~MOD_CODE_WRITE_FLAG;
 126
 127                 if (old == new)
 128                         break;
 129
 130                 old = atomic_cmpxchg(&nmi_running, old, new);
 131         }
 132 }
 133
 134 static void ftrace_mod_code(void)
 135 {
 136         /*
 137          * Yes, more than one CPU process can be writing to mod_code_status.
 138          *    (and the code itself)
 139          * But if one were to fail, then they all should, and if one were
 140          * to succeed, then they all should.
 141          */
 142         mod_code_status = probe_kernel_write(mod_code_ip, mod_code_newcode,
 143                                              MCOUNT_INSN_SIZE);
 144
 145         /* if we fail, then kill any new writers */
 146         if (mod_code_status)
 147                 clear_mod_flag();
 148 }
 149
 150 void ftrace_nmi_enter(void)
 151 {
 152         if (atomic_inc_return(&nmi_running) & MOD_CODE_WRITE_FLAG) {
 153                 smp_rmb();
 154                 ftrace_mod_code();
 155                 atomic_inc(&nmi_update_count);
 156         }
 157         /* Must have previous changes seen before executions */
 158         smp_mb();
 159 }
 160
 161 void ftrace_nmi_exit(void)
 162 {
 163         /* Finish all executions before clearing nmi_running */
 164         smp_mb();
 165         atomic_dec(&nmi_running);
 166 }
 167
 168 static void wait_for_nmi_and_set_mod_flag(void)
 169 {
 170         if (!atomic_cmpxchg(&nmi_running, 0, MOD_CODE_WRITE_FLAG))
 171                 return;
 172
 173         do {
 174                 cpu_relax();
 175         } while (atomic_cmpxchg(&nmi_running, 0, MOD_CODE_WRITE_FLAG));
 176
 177         nmi_wait_count++;
 178 }
 179
 180 static void wait_for_nmi(void)
 181 {
 182         if (!atomic_read(&nmi_running))
 183                 return;
 184
 185         do {
 186                 cpu_relax();
 187         } while (atomic_read(&nmi_running));
 188
 189         nmi_wait_count++;
 190 }
 191
 192 static int
 193 do_ftrace_mod_code(unsigned long ip, void *new_code)
 194 {
 195         mod_code_ip = (void *)ip;
 196         mod_code_newcode = new_code;
 197
 198         /* The buffers need to be visible before we let NMIs write them */
 199         smp_mb();
 200
 201         wait_for_nmi_and_set_mod_flag();
 202
 203         /* Make sure all running NMIs have finished before we write the code */
 204         smp_mb();
 205
 206         ftrace_mod_code();
 207
 208         /* Make sure the write happens before clearing the bit */
 209         smp_mb();
 210
 211         clear_mod_flag();
 212         wait_for_nmi();
 213
 214         return mod_code_status;
 215 }
 216
 217
 218
 219
 220 static unsigned char ftrace_nop[MCOUNT_INSN_SIZE];
 221
 222 static unsigned char *ftrace_nop_replace(void)
 223 {
 224         return ftrace_nop;
 225 }
 226
 227 static int
 228 ftrace_modify_code(unsigned long ip, unsigned char *old_code,
 229                    unsigned char *new_code)
 230 {
 231         unsigned char replaced[MCOUNT_INSN_SIZE];
 232
 233         /*
 234          * Note: Due to modules and __init, code can
 235          *  disappear and change, we need to protect against faulting
 236          *  as well as code changing. We do this by using the
 237          *  probe_kernel_* functions.
 238          *
 239          * No real locking needed, this code is run through
 240          * kstop_machine, or before SMP starts.
 241          */
 242
 243         /* read the text we want to modify */
 244         if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
 245                 return -EFAULT;
 246
 247         /* Make sure it is what we expect it to be */
 248         if (memcmp(replaced, old_code, MCOUNT_INSN_SIZE) != 0)
 249                 return -EINVAL;
 250
 251         /* replace the text with the new text */
 252         if (do_ftrace_mod_code(ip, new_code))
 253                 return -EPERM;
 254
 255         sync_core();
 256
 257         return 0;
 258 }
 259
 260 int ftrace_make_nop(struct module *mod,
 261                     struct dyn_ftrace *rec, unsigned long addr)
 262 {
 263         unsigned char *new, *old;
 264         unsigned long ip = rec->ip;
 265
 266         old = ftrace_call_replace(ip, addr);
 267         new = ftrace_nop_replace();
 268
 269         return ftrace_modify_code(rec->ip, old, new);
 270 }
 271
 272 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
 273 {
 274         unsigned char *new, *old;
 275         unsigned long ip = rec->ip;
 276
 277         old = ftrace_nop_replace();
 278         new = ftrace_call_replace(ip, addr);
 279
 280         return ftrace_modify_code(rec->ip, old, new);
 281 }
 282
 283 int ftrace_update_ftrace_func(ftrace_func_t func)
 284 {
 285         unsigned long ip = (unsigned long)(&ftrace_call);
 286         unsigned char old[MCOUNT_INSN_SIZE], *new;
 287         int ret;
 288
 289         memcpy(old, &ftrace_call, MCOUNT_INSN_SIZE);
 290         new = ftrace_call_replace(ip, (unsigned long)func);
 291         ret = ftrace_modify_code(ip, old, new);
 292
 293         return ret;
 294 }
 295
 296 int __init ftrace_dyn_arch_init(void *data)
 297 {
 298         extern const unsigned char ftrace_test_p6nop[];
 299         extern const unsigned char ftrace_test_nop5[];
 300         extern const unsigned char ftrace_test_jmp[];
 301         int faulted = 0;
 302
 303         /*
 304          * There is no good nop for all x86 archs.
 305          * We will default to using the P6_NOP5, but first we
 306          * will test to make sure that the nop will actually
 307          * work on this CPU. If it faults, we will then
 308          * go to a lesser efficient 5 byte nop. If that fails
 309          * we then just use a jmp as our nop. This isn't the most
 310          * efficient nop, but we can not use a multi part nop
 311          * since we would then risk being preempted in the middle
 312          * of that nop, and if we enabled tracing then, it might
 313          * cause a system crash.
 314          *
 315          * TODO: check the cpuid to determine the best nop.
 316          */
 317         asm volatile (
 318                 "ftrace_test_jmp:"
 319                 "jmp ftrace_test_p6nop\n"
 320                 "nop\n"
 321                 "nop\n"
 322                 "nop\n"  /* 2 byte jmp + 3 bytes */
 323                 "ftrace_test_p6nop:"
 324                 P6_NOP5
 325                 "jmp 1f\n"
 326                 "ftrace_test_nop5:"
 327                 ".byte 0x66,0x66,0x66,0x66,0x90\n"
 328                 "1:"
 329                 ".section .fixup, \"ax\"\n"
 330                 "2:     movl $1, %0\n"
 331                 "       jmp ftrace_test_nop5\n"
 332                 "3:     movl $2, %0\n"
 333                 "       jmp 1b\n"
 334                 ".previous\n"
 335                 _ASM_EXTABLE(ftrace_test_p6nop, 2b)
 336                 _ASM_EXTABLE(ftrace_test_nop5, 3b)
 337                 : "=r"(faulted) : "0" (faulted));
 338
 339         switch (faulted) {
 340         case 0:
 341                 pr_info("converting mcount calls to 0f 1f 44 00 00\n");
 342                 memcpy(ftrace_nop, ftrace_test_p6nop, MCOUNT_INSN_SIZE);
 343                 break;
 344         case 1:
 345                 pr_info("converting mcount calls to 66 66 66 66 90\n");
 346                 memcpy(ftrace_nop, ftrace_test_nop5, MCOUNT_INSN_SIZE);
 347                 break;
 348         case 2:
 349                 pr_info("converting mcount calls to jmp . + 5\n");
 350                 memcpy(ftrace_nop, ftrace_test_jmp, MCOUNT_INSN_SIZE);
 351                 break;
 352         }
 353
 354         /* The return code is retured via data */
 355         *(unsigned long *)data = 0;
 356
 357         return 0;
 358 }
 359 #endif
 360
 361 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
 362
 363 #ifdef CONFIG_DYNAMIC_FTRACE
 364 extern void ftrace_graph_call(void);
 365
 366 static int ftrace_mod_jmp(unsigned long ip,
 367                           int old_offset, int new_offset)
 368 {
 369         unsigned char code[MCOUNT_INSN_SIZE];
 370
 371         if (probe_kernel_read(code, (void *)ip, MCOUNT_INSN_SIZE))
 372                 return -EFAULT;
 373
 374         if (code[0] != 0xe9 || old_offset != *(int *)(&code[1]))
 375                 return -EINVAL;
 376
 377         *(int *)(&code[1]) = new_offset;
 378
 379         if (do_ftrace_mod_code(ip, &code))
 380                 return -EPERM;
 381
 382         return 0;
 383 }
 384
 385 int ftrace_enable_ftrace_graph_caller(void)
 386 {
 387         unsigned long ip = (unsigned long)(&ftrace_graph_call);
 388         int old_offset, new_offset;
 389
 390         old_offset = (unsigned long)(&ftrace_stub) - (ip + MCOUNT_INSN_SIZE);
 391         new_offset = (unsigned long)(&ftrace_graph_caller) - (ip + MCOUNT_INSN_SIZE);
 392
 393         return ftrace_mod_jmp(ip, old_offset, new_offset);
 394 }
 395
 396 int ftrace_disable_ftrace_graph_caller(void)
 397 {
 398         unsigned long ip = (unsigned long)(&ftrace_graph_call);
 399         int old_offset, new_offset;
 400
 401         old_offset = (unsigned long)(&ftrace_graph_caller) - (ip + MCOUNT_INSN_SIZE);
 402         new_offset = (unsigned long)(&ftrace_stub) - (ip + MCOUNT_INSN_SIZE);
 403
 404         return ftrace_mod_jmp(ip, old_offset, new_offset);
 405 }
 406
 407 #endif /* !CONFIG_DYNAMIC_FTRACE */
 408
 409 /*
 410  * Hook the return address and push it in the stack of return addrs
 411  * in current thread info.
 412  */
 413 void prepare_ftrace_return(unsigned long *parent, unsigned long self_addr,
 414                            unsigned long frame_pointer)
 415 {
 416         unsigned long old;
 417         int faulted;
 418         struct ftrace_graph_ent trace;
 419         unsigned long return_hooker = (unsigned long)
 420                                 &return_to_handler;
 421
 422         if (unlikely(atomic_read(&current->tracing_graph_pause)))
 423                 return;
 424
 425         /*
 426          * Protect against fault, even if it shouldn't
 427          * happen. This tool is too much intrusive to
 428          * ignore such a protection.
 429          */
 430         asm volatile(
 431                 "1: " _ASM_MOV " (%[parent]), %[old]\n"
 432                 "2: " _ASM_MOV " %[return_hooker], (%[parent])\n"
 433                 "   movl $0, %[faulted]\n"
 434                 "3:\n"
 435
 436                 ".section .fixup, \"ax\"\n"
 437                 "4: movl $1, %[faulted]\n"
 438                 "   jmp 3b\n"
 439                 ".previous\n"
 440
 441                 _ASM_EXTABLE(1b, 4b)
 442                 _ASM_EXTABLE(2b, 4b)
 443
 444                 : [old] "=&r" (old), [faulted] "=r" (faulted)
 445                 : [parent] "r" (parent), [return_hooker] "r" (return_hooker)
 446                 : "memory"
 447         );
 448
 449         if (unlikely(faulted)) {
 450                 ftrace_graph_stop();
 451                 WARN_ON(1);
 452                 return;
 453         }
 454
 455         if (ftrace_push_return_trace(old, self_addr, &trace.depth,
 456                     frame_pointer) == -EBUSY) {
 457                 *parent = old;
 458                 return;
 459         }
 460
 461         trace.func = self_addr;
 462
 463         /* Only trace if the calling function expects to */
 464         if (!ftrace_graph_entry(&trace)) {
 465                 current->curr_ret_stack--;
 466                 *parent = old;
 467         }
 468 }
 469 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
 470
 471 #ifdef CONFIG_FTRACE_SYSCALLS
 472
 473 extern unsigned long __start_syscalls_metadata[];
 474 extern unsigned long __stop_syscalls_metadata[];
 475 extern unsigned long *sys_call_table;
 476
 477 static struct syscall_metadata **syscalls_metadata;
 478
 479 static struct syscall_metadata *find_syscall_meta(unsigned long *syscall)
 480 {
 481         struct syscall_metadata *start;
 482         struct syscall_metadata *stop;
 483         char str[KSYM_SYMBOL_LEN];
 484
 485
 486         start = (struct syscall_metadata *)__start_syscalls_metadata;
 487         stop = (struct syscall_metadata *)__stop_syscalls_metadata;
 488         kallsyms_lookup((unsigned long) syscall, NULL, NULL, NULL, str);
 489
 490         for ( ; start < stop; start++) {
 491                 if (start->name && !strcmp(start->name, str))
 492                         return start;
 493         }
 494         return NULL;
 495 }
 496
 497 struct syscall_metadata *syscall_nr_to_meta(int nr)
 498 {
 499         if (!syscalls_metadata || nr >= NR_syscalls || nr < 0)
 500                 return NULL;
 501
 502         return syscalls_metadata[nr];
 503 }
 504
 505 int syscall_name_to_nr(char *name)
 506 {
 507         int i;
 508
 509         if (!syscalls_metadata)
 510                 return -1;
 511
 512         for (i = 0; i < NR_syscalls; i++) {
 513                 if (syscalls_metadata[i]) {
 514                         if (!strcmp(syscalls_metadata[i]->name, name))
 515                                 return i;
 516                 }
 517         }
 518         return -1;
 519 }
 520
 521 void set_syscall_enter_id(int num, int id)
 522 {
 523         syscalls_metadata[num]->enter_id = id;
 524 }
 525
 526 void set_syscall_exit_id(int num, int id)
 527 {
 528         syscalls_metadata[num]->exit_id = id;
 529 }
 530
 531 static int __init arch_init_ftrace_syscalls(void)
 532 {
 533         int i;
 534         struct syscall_metadata *meta;
 535         unsigned long **psys_syscall_table = &sys_call_table;
 536
 537         syscalls_metadata = kzalloc(sizeof(*syscalls_metadata) *
 538                                         NR_syscalls, GFP_KERNEL);
 539         if (!syscalls_metadata) {
 540                 WARN_ON(1);
 541                 return -ENOMEM;
 542         }
 543
 544         for (i = 0; i < NR_syscalls; i++) {
 545                 meta = find_syscall_meta(psys_syscall_table[i]);
 546                 syscalls_metadata[i] = meta;
 547         }
 548         return 0;
 549 }
 550 arch_initcall(arch_init_ftrace_syscalls);
 551 #endif