Linux 4.9.243
[linux/fpc-iii.git] / arch / x86 / kernel / ftrace.c
blob5e06ffefc5db3d2dd997622524b25da4a75bbe28
1 /*
2 * Dynamic function tracing support.
4 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
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.
12 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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/slab.h>
21 #include <linux/init.h>
22 #include <linux/list.h>
23 #include <linux/module.h>
25 #include <trace/syscall.h>
27 #include <asm/cacheflush.h>
28 #include <asm/kprobes.h>
29 #include <asm/sections.h>
30 #include <asm/ftrace.h>
31 #include <asm/nops.h>
33 #ifdef CONFIG_DYNAMIC_FTRACE
35 int ftrace_arch_code_modify_prepare(void)
37 set_kernel_text_rw();
38 set_all_modules_text_rw();
39 return 0;
42 int ftrace_arch_code_modify_post_process(void)
44 set_all_modules_text_ro();
45 set_kernel_text_ro();
46 return 0;
49 union ftrace_code_union {
50 char code[MCOUNT_INSN_SIZE];
51 struct {
52 unsigned char e8;
53 int offset;
54 } __attribute__((packed));
57 static int ftrace_calc_offset(long ip, long addr)
59 return (int)(addr - ip);
62 static unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr)
64 static union ftrace_code_union calc;
66 calc.e8 = 0xe8;
67 calc.offset = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
70 * No locking needed, this must be called via kstop_machine
71 * which in essence is like running on a uniprocessor machine.
73 return calc.code;
76 static inline int
77 within(unsigned long addr, unsigned long start, unsigned long end)
79 return addr >= start && addr < end;
82 static unsigned long text_ip_addr(unsigned long ip)
85 * On x86_64, kernel text mappings are mapped read-only, so we use
86 * the kernel identity mapping instead of the kernel text mapping
87 * to modify the kernel text.
89 * For 32bit kernels, these mappings are same and we can use
90 * kernel identity mapping to modify code.
92 if (within(ip, (unsigned long)_text, (unsigned long)_etext))
93 ip = (unsigned long)__va(__pa_symbol(ip));
95 return ip;
98 static const unsigned char *ftrace_nop_replace(void)
100 return ideal_nops[NOP_ATOMIC5];
103 static int
104 ftrace_modify_code_direct(unsigned long ip, unsigned const char *old_code,
105 unsigned const char *new_code)
107 unsigned char replaced[MCOUNT_INSN_SIZE];
109 ftrace_expected = old_code;
112 * Note:
113 * We are paranoid about modifying text, as if a bug was to happen, it
114 * could cause us to read or write to someplace that could cause harm.
115 * Carefully read and modify the code with probe_kernel_*(), and make
116 * sure what we read is what we expected it to be before modifying it.
119 /* read the text we want to modify */
120 if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
121 return -EFAULT;
123 /* Make sure it is what we expect it to be */
124 if (memcmp(replaced, old_code, MCOUNT_INSN_SIZE) != 0)
125 return -EINVAL;
127 ip = text_ip_addr(ip);
129 /* replace the text with the new text */
130 if (probe_kernel_write((void *)ip, new_code, MCOUNT_INSN_SIZE))
131 return -EPERM;
133 sync_core();
135 return 0;
138 int ftrace_make_nop(struct module *mod,
139 struct dyn_ftrace *rec, unsigned long addr)
141 unsigned const char *new, *old;
142 unsigned long ip = rec->ip;
144 old = ftrace_call_replace(ip, addr);
145 new = ftrace_nop_replace();
148 * On boot up, and when modules are loaded, the MCOUNT_ADDR
149 * is converted to a nop, and will never become MCOUNT_ADDR
150 * again. This code is either running before SMP (on boot up)
151 * or before the code will ever be executed (module load).
152 * We do not want to use the breakpoint version in this case,
153 * just modify the code directly.
155 if (addr == MCOUNT_ADDR)
156 return ftrace_modify_code_direct(rec->ip, old, new);
158 ftrace_expected = NULL;
160 /* Normal cases use add_brk_on_nop */
161 WARN_ONCE(1, "invalid use of ftrace_make_nop");
162 return -EINVAL;
165 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
167 unsigned const char *new, *old;
168 unsigned long ip = rec->ip;
170 old = ftrace_nop_replace();
171 new = ftrace_call_replace(ip, addr);
173 /* Should only be called when module is loaded */
174 return ftrace_modify_code_direct(rec->ip, old, new);
178 * The modifying_ftrace_code is used to tell the breakpoint
179 * handler to call ftrace_int3_handler(). If it fails to
180 * call this handler for a breakpoint added by ftrace, then
181 * the kernel may crash.
183 * As atomic_writes on x86 do not need a barrier, we do not
184 * need to add smp_mb()s for this to work. It is also considered
185 * that we can not read the modifying_ftrace_code before
186 * executing the breakpoint. That would be quite remarkable if
187 * it could do that. Here's the flow that is required:
189 * CPU-0 CPU-1
191 * atomic_inc(mfc);
192 * write int3s
193 * <trap-int3> // implicit (r)mb
194 * if (atomic_read(mfc))
195 * call ftrace_int3_handler()
197 * Then when we are finished:
199 * atomic_dec(mfc);
201 * If we hit a breakpoint that was not set by ftrace, it does not
202 * matter if ftrace_int3_handler() is called or not. It will
203 * simply be ignored. But it is crucial that a ftrace nop/caller
204 * breakpoint is handled. No other user should ever place a
205 * breakpoint on an ftrace nop/caller location. It must only
206 * be done by this code.
208 atomic_t modifying_ftrace_code __read_mostly;
210 static int
211 ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
212 unsigned const char *new_code);
215 * Should never be called:
216 * As it is only called by __ftrace_replace_code() which is called by
217 * ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
218 * which is called to turn mcount into nops or nops into function calls
219 * but not to convert a function from not using regs to one that uses
220 * regs, which ftrace_modify_call() is for.
222 int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
223 unsigned long addr)
225 WARN_ON(1);
226 ftrace_expected = NULL;
227 return -EINVAL;
230 static unsigned long ftrace_update_func;
232 static int update_ftrace_func(unsigned long ip, void *new)
234 unsigned char old[MCOUNT_INSN_SIZE];
235 int ret;
237 memcpy(old, (void *)ip, MCOUNT_INSN_SIZE);
239 ftrace_update_func = ip;
240 /* Make sure the breakpoints see the ftrace_update_func update */
241 smp_wmb();
243 /* See comment above by declaration of modifying_ftrace_code */
244 atomic_inc(&modifying_ftrace_code);
246 ret = ftrace_modify_code(ip, old, new);
248 atomic_dec(&modifying_ftrace_code);
250 return ret;
253 int ftrace_update_ftrace_func(ftrace_func_t func)
255 unsigned long ip = (unsigned long)(&ftrace_call);
256 unsigned char *new;
257 int ret;
259 new = ftrace_call_replace(ip, (unsigned long)func);
260 ret = update_ftrace_func(ip, new);
262 /* Also update the regs callback function */
263 if (!ret) {
264 ip = (unsigned long)(&ftrace_regs_call);
265 new = ftrace_call_replace(ip, (unsigned long)func);
266 ret = update_ftrace_func(ip, new);
269 return ret;
272 static int is_ftrace_caller(unsigned long ip)
274 if (ip == ftrace_update_func)
275 return 1;
277 return 0;
281 * A breakpoint was added to the code address we are about to
282 * modify, and this is the handle that will just skip over it.
283 * We are either changing a nop into a trace call, or a trace
284 * call to a nop. While the change is taking place, we treat
285 * it just like it was a nop.
287 int ftrace_int3_handler(struct pt_regs *regs)
289 unsigned long ip;
291 if (WARN_ON_ONCE(!regs))
292 return 0;
294 ip = regs->ip - 1;
295 if (!ftrace_location(ip) && !is_ftrace_caller(ip))
296 return 0;
298 regs->ip += MCOUNT_INSN_SIZE - 1;
300 return 1;
303 static int ftrace_write(unsigned long ip, const char *val, int size)
305 ip = text_ip_addr(ip);
307 if (probe_kernel_write((void *)ip, val, size))
308 return -EPERM;
310 return 0;
313 static int add_break(unsigned long ip, const char *old)
315 unsigned char replaced[MCOUNT_INSN_SIZE];
316 unsigned char brk = BREAKPOINT_INSTRUCTION;
318 if (probe_kernel_read(replaced, (void *)ip, MCOUNT_INSN_SIZE))
319 return -EFAULT;
321 ftrace_expected = old;
323 /* Make sure it is what we expect it to be */
324 if (memcmp(replaced, old, MCOUNT_INSN_SIZE) != 0)
325 return -EINVAL;
327 return ftrace_write(ip, &brk, 1);
330 static int add_brk_on_call(struct dyn_ftrace *rec, unsigned long addr)
332 unsigned const char *old;
333 unsigned long ip = rec->ip;
335 old = ftrace_call_replace(ip, addr);
337 return add_break(rec->ip, old);
341 static int add_brk_on_nop(struct dyn_ftrace *rec)
343 unsigned const char *old;
345 old = ftrace_nop_replace();
347 return add_break(rec->ip, old);
350 static int add_breakpoints(struct dyn_ftrace *rec, int enable)
352 unsigned long ftrace_addr;
353 int ret;
355 ftrace_addr = ftrace_get_addr_curr(rec);
357 ret = ftrace_test_record(rec, enable);
359 switch (ret) {
360 case FTRACE_UPDATE_IGNORE:
361 return 0;
363 case FTRACE_UPDATE_MAKE_CALL:
364 /* converting nop to call */
365 return add_brk_on_nop(rec);
367 case FTRACE_UPDATE_MODIFY_CALL:
368 case FTRACE_UPDATE_MAKE_NOP:
369 /* converting a call to a nop */
370 return add_brk_on_call(rec, ftrace_addr);
372 return 0;
376 * On error, we need to remove breakpoints. This needs to
377 * be done caefully. If the address does not currently have a
378 * breakpoint, we know we are done. Otherwise, we look at the
379 * remaining 4 bytes of the instruction. If it matches a nop
380 * we replace the breakpoint with the nop. Otherwise we replace
381 * it with the call instruction.
383 static int remove_breakpoint(struct dyn_ftrace *rec)
385 unsigned char ins[MCOUNT_INSN_SIZE];
386 unsigned char brk = BREAKPOINT_INSTRUCTION;
387 const unsigned char *nop;
388 unsigned long ftrace_addr;
389 unsigned long ip = rec->ip;
391 /* If we fail the read, just give up */
392 if (probe_kernel_read(ins, (void *)ip, MCOUNT_INSN_SIZE))
393 return -EFAULT;
395 /* If this does not have a breakpoint, we are done */
396 if (ins[0] != brk)
397 return 0;
399 nop = ftrace_nop_replace();
402 * If the last 4 bytes of the instruction do not match
403 * a nop, then we assume that this is a call to ftrace_addr.
405 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0) {
407 * For extra paranoidism, we check if the breakpoint is on
408 * a call that would actually jump to the ftrace_addr.
409 * If not, don't touch the breakpoint, we make just create
410 * a disaster.
412 ftrace_addr = ftrace_get_addr_new(rec);
413 nop = ftrace_call_replace(ip, ftrace_addr);
415 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) == 0)
416 goto update;
418 /* Check both ftrace_addr and ftrace_old_addr */
419 ftrace_addr = ftrace_get_addr_curr(rec);
420 nop = ftrace_call_replace(ip, ftrace_addr);
422 ftrace_expected = nop;
424 if (memcmp(&ins[1], &nop[1], MCOUNT_INSN_SIZE - 1) != 0)
425 return -EINVAL;
428 update:
429 return ftrace_write(ip, nop, 1);
432 static int add_update_code(unsigned long ip, unsigned const char *new)
434 /* skip breakpoint */
435 ip++;
436 new++;
437 return ftrace_write(ip, new, MCOUNT_INSN_SIZE - 1);
440 static int add_update_call(struct dyn_ftrace *rec, unsigned long addr)
442 unsigned long ip = rec->ip;
443 unsigned const char *new;
445 new = ftrace_call_replace(ip, addr);
446 return add_update_code(ip, new);
449 static int add_update_nop(struct dyn_ftrace *rec)
451 unsigned long ip = rec->ip;
452 unsigned const char *new;
454 new = ftrace_nop_replace();
455 return add_update_code(ip, new);
458 static int add_update(struct dyn_ftrace *rec, int enable)
460 unsigned long ftrace_addr;
461 int ret;
463 ret = ftrace_test_record(rec, enable);
465 ftrace_addr = ftrace_get_addr_new(rec);
467 switch (ret) {
468 case FTRACE_UPDATE_IGNORE:
469 return 0;
471 case FTRACE_UPDATE_MODIFY_CALL:
472 case FTRACE_UPDATE_MAKE_CALL:
473 /* converting nop to call */
474 return add_update_call(rec, ftrace_addr);
476 case FTRACE_UPDATE_MAKE_NOP:
477 /* converting a call to a nop */
478 return add_update_nop(rec);
481 return 0;
484 static int finish_update_call(struct dyn_ftrace *rec, unsigned long addr)
486 unsigned long ip = rec->ip;
487 unsigned const char *new;
489 new = ftrace_call_replace(ip, addr);
491 return ftrace_write(ip, new, 1);
494 static int finish_update_nop(struct dyn_ftrace *rec)
496 unsigned long ip = rec->ip;
497 unsigned const char *new;
499 new = ftrace_nop_replace();
501 return ftrace_write(ip, new, 1);
504 static int finish_update(struct dyn_ftrace *rec, int enable)
506 unsigned long ftrace_addr;
507 int ret;
509 ret = ftrace_update_record(rec, enable);
511 ftrace_addr = ftrace_get_addr_new(rec);
513 switch (ret) {
514 case FTRACE_UPDATE_IGNORE:
515 return 0;
517 case FTRACE_UPDATE_MODIFY_CALL:
518 case FTRACE_UPDATE_MAKE_CALL:
519 /* converting nop to call */
520 return finish_update_call(rec, ftrace_addr);
522 case FTRACE_UPDATE_MAKE_NOP:
523 /* converting a call to a nop */
524 return finish_update_nop(rec);
527 return 0;
530 static void do_sync_core(void *data)
532 sync_core();
535 static void run_sync(void)
537 int enable_irqs = irqs_disabled();
539 /* We may be called with interrupts disbled (on bootup). */
540 if (enable_irqs)
541 local_irq_enable();
542 on_each_cpu(do_sync_core, NULL, 1);
543 if (enable_irqs)
544 local_irq_disable();
547 void ftrace_replace_code(int enable)
549 struct ftrace_rec_iter *iter;
550 struct dyn_ftrace *rec;
551 const char *report = "adding breakpoints";
552 int count = 0;
553 int ret;
555 for_ftrace_rec_iter(iter) {
556 rec = ftrace_rec_iter_record(iter);
558 ret = add_breakpoints(rec, enable);
559 if (ret)
560 goto remove_breakpoints;
561 count++;
564 run_sync();
566 report = "updating code";
567 count = 0;
569 for_ftrace_rec_iter(iter) {
570 rec = ftrace_rec_iter_record(iter);
572 ret = add_update(rec, enable);
573 if (ret)
574 goto remove_breakpoints;
575 count++;
578 run_sync();
580 report = "removing breakpoints";
581 count = 0;
583 for_ftrace_rec_iter(iter) {
584 rec = ftrace_rec_iter_record(iter);
586 ret = finish_update(rec, enable);
587 if (ret)
588 goto remove_breakpoints;
589 count++;
592 run_sync();
594 return;
596 remove_breakpoints:
597 pr_warn("Failed on %s (%d):\n", report, count);
598 ftrace_bug(ret, rec);
599 for_ftrace_rec_iter(iter) {
600 rec = ftrace_rec_iter_record(iter);
602 * Breakpoints are handled only when this function is in
603 * progress. The system could not work with them.
605 if (remove_breakpoint(rec))
606 BUG();
608 run_sync();
611 static int
612 ftrace_modify_code(unsigned long ip, unsigned const char *old_code,
613 unsigned const char *new_code)
615 int ret;
617 ret = add_break(ip, old_code);
618 if (ret)
619 goto out;
621 run_sync();
623 ret = add_update_code(ip, new_code);
624 if (ret)
625 goto fail_update;
627 run_sync();
629 ret = ftrace_write(ip, new_code, 1);
631 * The breakpoint is handled only when this function is in progress.
632 * The system could not work if we could not remove it.
634 BUG_ON(ret);
635 out:
636 run_sync();
637 return ret;
639 fail_update:
640 /* Also here the system could not work with the breakpoint */
641 if (ftrace_write(ip, old_code, 1))
642 BUG();
643 goto out;
646 void arch_ftrace_update_code(int command)
648 /* See comment above by declaration of modifying_ftrace_code */
649 atomic_inc(&modifying_ftrace_code);
651 ftrace_modify_all_code(command);
653 atomic_dec(&modifying_ftrace_code);
656 int __init ftrace_dyn_arch_init(void)
658 return 0;
661 #if defined(CONFIG_X86_64) || defined(CONFIG_FUNCTION_GRAPH_TRACER)
662 static unsigned char *ftrace_jmp_replace(unsigned long ip, unsigned long addr)
664 static union ftrace_code_union calc;
666 /* Jmp not a call (ignore the .e8) */
667 calc.e8 = 0xe9;
668 calc.offset = ftrace_calc_offset(ip + MCOUNT_INSN_SIZE, addr);
671 * ftrace external locks synchronize the access to the static variable.
673 return calc.code;
675 #endif
677 /* Currently only x86_64 supports dynamic trampolines */
678 #ifdef CONFIG_X86_64
680 #ifdef CONFIG_MODULES
681 #include <linux/moduleloader.h>
682 /* Module allocation simplifies allocating memory for code */
683 static inline void *alloc_tramp(unsigned long size)
685 return module_alloc(size);
687 static inline void tramp_free(void *tramp)
689 module_memfree(tramp);
691 #else
692 /* Trampolines can only be created if modules are supported */
693 static inline void *alloc_tramp(unsigned long size)
695 return NULL;
697 static inline void tramp_free(void *tramp) { }
698 #endif
700 /* Defined as markers to the end of the ftrace default trampolines */
701 extern void ftrace_regs_caller_end(void);
702 extern void ftrace_epilogue(void);
703 extern void ftrace_caller_op_ptr(void);
704 extern void ftrace_regs_caller_op_ptr(void);
706 /* movq function_trace_op(%rip), %rdx */
707 /* 0x48 0x8b 0x15 <offset-to-ftrace_trace_op (4 bytes)> */
708 #define OP_REF_SIZE 7
711 * The ftrace_ops is passed to the function callback. Since the
712 * trampoline only services a single ftrace_ops, we can pass in
713 * that ops directly.
715 * The ftrace_op_code_union is used to create a pointer to the
716 * ftrace_ops that will be passed to the callback function.
718 union ftrace_op_code_union {
719 char code[OP_REF_SIZE];
720 struct {
721 char op[3];
722 int offset;
723 } __attribute__((packed));
726 static unsigned long
727 create_trampoline(struct ftrace_ops *ops, unsigned int *tramp_size)
729 unsigned const char *jmp;
730 unsigned long start_offset;
731 unsigned long end_offset;
732 unsigned long op_offset;
733 unsigned long offset;
734 unsigned long size;
735 unsigned long ip;
736 unsigned long *ptr;
737 void *trampoline;
738 /* 48 8b 15 <offset> is movq <offset>(%rip), %rdx */
739 unsigned const char op_ref[] = { 0x48, 0x8b, 0x15 };
740 union ftrace_op_code_union op_ptr;
741 int ret;
743 if (ops->flags & FTRACE_OPS_FL_SAVE_REGS) {
744 start_offset = (unsigned long)ftrace_regs_caller;
745 end_offset = (unsigned long)ftrace_regs_caller_end;
746 op_offset = (unsigned long)ftrace_regs_caller_op_ptr;
747 } else {
748 start_offset = (unsigned long)ftrace_caller;
749 end_offset = (unsigned long)ftrace_epilogue;
750 op_offset = (unsigned long)ftrace_caller_op_ptr;
753 size = end_offset - start_offset;
756 * Allocate enough size to store the ftrace_caller code,
757 * the jmp to ftrace_epilogue, as well as the address of
758 * the ftrace_ops this trampoline is used for.
760 trampoline = alloc_tramp(size + MCOUNT_INSN_SIZE + sizeof(void *));
761 if (!trampoline)
762 return 0;
764 *tramp_size = size + MCOUNT_INSN_SIZE + sizeof(void *);
766 /* Copy ftrace_caller onto the trampoline memory */
767 ret = probe_kernel_read(trampoline, (void *)start_offset, size);
768 if (WARN_ON(ret < 0)) {
769 tramp_free(trampoline);
770 return 0;
773 ip = (unsigned long)trampoline + size;
775 /* The trampoline ends with a jmp to ftrace_epilogue */
776 jmp = ftrace_jmp_replace(ip, (unsigned long)ftrace_epilogue);
777 memcpy(trampoline + size, jmp, MCOUNT_INSN_SIZE);
780 * The address of the ftrace_ops that is used for this trampoline
781 * is stored at the end of the trampoline. This will be used to
782 * load the third parameter for the callback. Basically, that
783 * location at the end of the trampoline takes the place of
784 * the global function_trace_op variable.
787 ptr = (unsigned long *)(trampoline + size + MCOUNT_INSN_SIZE);
788 *ptr = (unsigned long)ops;
790 op_offset -= start_offset;
791 memcpy(&op_ptr, trampoline + op_offset, OP_REF_SIZE);
793 /* Are we pointing to the reference? */
794 if (WARN_ON(memcmp(op_ptr.op, op_ref, 3) != 0)) {
795 tramp_free(trampoline);
796 return 0;
799 /* Load the contents of ptr into the callback parameter */
800 offset = (unsigned long)ptr;
801 offset -= (unsigned long)trampoline + op_offset + OP_REF_SIZE;
803 op_ptr.offset = offset;
805 /* put in the new offset to the ftrace_ops */
806 memcpy(trampoline + op_offset, &op_ptr, OP_REF_SIZE);
808 /* ALLOC_TRAMP flags lets us know we created it */
809 ops->flags |= FTRACE_OPS_FL_ALLOC_TRAMP;
811 return (unsigned long)trampoline;
814 static unsigned long calc_trampoline_call_offset(bool save_regs)
816 unsigned long start_offset;
817 unsigned long call_offset;
819 if (save_regs) {
820 start_offset = (unsigned long)ftrace_regs_caller;
821 call_offset = (unsigned long)ftrace_regs_call;
822 } else {
823 start_offset = (unsigned long)ftrace_caller;
824 call_offset = (unsigned long)ftrace_call;
827 return call_offset - start_offset;
830 void arch_ftrace_update_trampoline(struct ftrace_ops *ops)
832 ftrace_func_t func;
833 unsigned char *new;
834 unsigned long offset;
835 unsigned long ip;
836 unsigned int size;
837 int ret;
839 if (ops->trampoline) {
841 * The ftrace_ops caller may set up its own trampoline.
842 * In such a case, this code must not modify it.
844 if (!(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
845 return;
846 } else {
847 ops->trampoline = create_trampoline(ops, &size);
848 if (!ops->trampoline)
849 return;
850 ops->trampoline_size = size;
853 offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
854 ip = ops->trampoline + offset;
856 func = ftrace_ops_get_func(ops);
858 /* Do a safe modify in case the trampoline is executing */
859 new = ftrace_call_replace(ip, (unsigned long)func);
860 ret = update_ftrace_func(ip, new);
862 /* The update should never fail */
863 WARN_ON(ret);
866 /* Return the address of the function the trampoline calls */
867 static void *addr_from_call(void *ptr)
869 union ftrace_code_union calc;
870 int ret;
872 ret = probe_kernel_read(&calc, ptr, MCOUNT_INSN_SIZE);
873 if (WARN_ON_ONCE(ret < 0))
874 return NULL;
876 /* Make sure this is a call */
877 if (WARN_ON_ONCE(calc.e8 != 0xe8)) {
878 pr_warn("Expected e8, got %x\n", calc.e8);
879 return NULL;
882 return ptr + MCOUNT_INSN_SIZE + calc.offset;
885 void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
886 unsigned long frame_pointer);
889 * If the ops->trampoline was not allocated, then it probably
890 * has a static trampoline func, or is the ftrace caller itself.
892 static void *static_tramp_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
894 unsigned long offset;
895 bool save_regs = rec->flags & FTRACE_FL_REGS_EN;
896 void *ptr;
898 if (ops && ops->trampoline) {
899 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
901 * We only know about function graph tracer setting as static
902 * trampoline.
904 if (ops->trampoline == FTRACE_GRAPH_ADDR)
905 return (void *)prepare_ftrace_return;
906 #endif
907 return NULL;
910 offset = calc_trampoline_call_offset(save_regs);
912 if (save_regs)
913 ptr = (void *)FTRACE_REGS_ADDR + offset;
914 else
915 ptr = (void *)FTRACE_ADDR + offset;
917 return addr_from_call(ptr);
920 void *arch_ftrace_trampoline_func(struct ftrace_ops *ops, struct dyn_ftrace *rec)
922 unsigned long offset;
924 /* If we didn't allocate this trampoline, consider it static */
925 if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
926 return static_tramp_func(ops, rec);
928 offset = calc_trampoline_call_offset(ops->flags & FTRACE_OPS_FL_SAVE_REGS);
929 return addr_from_call((void *)ops->trampoline + offset);
932 void arch_ftrace_trampoline_free(struct ftrace_ops *ops)
934 if (!ops || !(ops->flags & FTRACE_OPS_FL_ALLOC_TRAMP))
935 return;
937 tramp_free((void *)ops->trampoline);
938 ops->trampoline = 0;
941 #endif /* CONFIG_X86_64 */
942 #endif /* CONFIG_DYNAMIC_FTRACE */
944 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
946 #ifdef CONFIG_DYNAMIC_FTRACE
947 extern void ftrace_graph_call(void);
949 static int ftrace_mod_jmp(unsigned long ip, void *func)
951 unsigned char *new;
953 new = ftrace_jmp_replace(ip, (unsigned long)func);
955 return update_ftrace_func(ip, new);
958 int ftrace_enable_ftrace_graph_caller(void)
960 unsigned long ip = (unsigned long)(&ftrace_graph_call);
962 return ftrace_mod_jmp(ip, &ftrace_graph_caller);
965 int ftrace_disable_ftrace_graph_caller(void)
967 unsigned long ip = (unsigned long)(&ftrace_graph_call);
969 return ftrace_mod_jmp(ip, &ftrace_stub);
972 #endif /* !CONFIG_DYNAMIC_FTRACE */
975 * Hook the return address and push it in the stack of return addrs
976 * in current thread info.
978 void prepare_ftrace_return(unsigned long self_addr, unsigned long *parent,
979 unsigned long frame_pointer)
981 unsigned long old;
982 int faulted;
983 struct ftrace_graph_ent trace;
984 unsigned long return_hooker = (unsigned long)
985 &return_to_handler;
988 * When resuming from suspend-to-ram, this function can be indirectly
989 * called from early CPU startup code while the CPU is in real mode,
990 * which would fail miserably. Make sure the stack pointer is a
991 * virtual address.
993 * This check isn't as accurate as virt_addr_valid(), but it should be
994 * good enough for this purpose, and it's fast.
996 if (unlikely((long)__builtin_frame_address(0) >= 0))
997 return;
999 if (unlikely(ftrace_graph_is_dead()))
1000 return;
1002 if (unlikely(atomic_read(&current->tracing_graph_pause)))
1003 return;
1006 * Protect against fault, even if it shouldn't
1007 * happen. This tool is too much intrusive to
1008 * ignore such a protection.
1010 asm volatile(
1011 "1: " _ASM_MOV " (%[parent]), %[old]\n"
1012 "2: " _ASM_MOV " %[return_hooker], (%[parent])\n"
1013 " movl $0, %[faulted]\n"
1014 "3:\n"
1016 ".section .fixup, \"ax\"\n"
1017 "4: movl $1, %[faulted]\n"
1018 " jmp 3b\n"
1019 ".previous\n"
1021 _ASM_EXTABLE(1b, 4b)
1022 _ASM_EXTABLE(2b, 4b)
1024 : [old] "=&r" (old), [faulted] "=r" (faulted)
1025 : [parent] "r" (parent), [return_hooker] "r" (return_hooker)
1026 : "memory"
1029 if (unlikely(faulted)) {
1030 ftrace_graph_stop();
1031 WARN_ON(1);
1032 return;
1035 trace.func = self_addr;
1036 trace.depth = current->curr_ret_stack + 1;
1038 /* Only trace if the calling function expects to */
1039 if (!ftrace_graph_entry(&trace)) {
1040 *parent = old;
1041 return;
1044 if (ftrace_push_return_trace(old, self_addr, &trace.depth,
1045 frame_pointer, parent) == -EBUSY) {
1046 *parent = old;
1047 return;
1050 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */