2 * Code for replacing ftrace calls with jumps.
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/init.h>
21 #include <linux/list.h>
22 #include <linux/module.h>
24 #include <trace/syscall.h>
26 #include <asm/cacheflush.h>
27 #include <asm/kprobes.h>
28 #include <asm/ftrace.h>
31 #ifdef CONFIG_DYNAMIC_FTRACE
33 int ftrace_arch_code_modify_prepare(void)
36 set_all_modules_text_rw();
40 int ftrace_arch_code_modify_post_process(void)
42 set_all_modules_text_ro();
47 union ftrace_code_union
{
48 char code
[MCOUNT_INSN_SIZE
];
52 } __attribute__((packed
));
55 static int ftrace_calc_offset(long ip
, long addr
)
57 return (int)(addr
- ip
);
60 static unsigned char *ftrace_call_replace(unsigned long ip
, unsigned long addr
)
62 static union ftrace_code_union calc
;
65 calc
.offset
= ftrace_calc_offset(ip
+ MCOUNT_INSN_SIZE
, addr
);
68 * No locking needed, this must be called via kstop_machine
69 * which in essence is like running on a uniprocessor machine.
75 within(unsigned long addr
, unsigned long start
, unsigned long end
)
77 return addr
>= start
&& addr
< end
;
80 static unsigned long text_ip_addr(unsigned long ip
)
83 * On x86_64, kernel text mappings are mapped read-only with
84 * CONFIG_DEBUG_RODATA. So we use the kernel identity mapping instead
85 * of the kernel text mapping to modify the kernel text.
87 * For 32bit kernels, these mappings are same and we can use
88 * kernel identity mapping to modify code.
90 if (within(ip
, (unsigned long)_text
, (unsigned long)_etext
))
91 ip
= (unsigned long)__va(__pa_symbol(ip
));
96 static const unsigned char *ftrace_nop_replace(void)
98 return ideal_nops
[NOP_ATOMIC5
];
102 ftrace_modify_code_direct(unsigned long ip
, unsigned const char *old_code
,
103 unsigned const char *new_code
)
105 unsigned char replaced
[MCOUNT_INSN_SIZE
];
108 * Note: Due to modules and __init, code can
109 * disappear and change, we need to protect against faulting
110 * as well as code changing. We do this by using the
111 * probe_kernel_* functions.
113 * No real locking needed, this code is run through
114 * kstop_machine, or before SMP starts.
117 /* read the text we want to modify */
118 if (probe_kernel_read(replaced
, (void *)ip
, MCOUNT_INSN_SIZE
))
121 /* Make sure it is what we expect it to be */
122 if (memcmp(replaced
, old_code
, MCOUNT_INSN_SIZE
) != 0)
125 ip
= text_ip_addr(ip
);
127 /* replace the text with the new text */
128 if (probe_kernel_write((void *)ip
, new_code
, MCOUNT_INSN_SIZE
))
136 int ftrace_make_nop(struct module
*mod
,
137 struct dyn_ftrace
*rec
, unsigned long addr
)
139 unsigned const char *new, *old
;
140 unsigned long ip
= rec
->ip
;
142 old
= ftrace_call_replace(ip
, addr
);
143 new = ftrace_nop_replace();
146 * On boot up, and when modules are loaded, the MCOUNT_ADDR
147 * is converted to a nop, and will never become MCOUNT_ADDR
148 * again. This code is either running before SMP (on boot up)
149 * or before the code will ever be executed (module load).
150 * We do not want to use the breakpoint version in this case,
151 * just modify the code directly.
153 if (addr
== MCOUNT_ADDR
)
154 return ftrace_modify_code_direct(rec
->ip
, old
, new);
156 /* Normal cases use add_brk_on_nop */
157 WARN_ONCE(1, "invalid use of ftrace_make_nop");
161 int ftrace_make_call(struct dyn_ftrace
*rec
, unsigned long addr
)
163 unsigned const char *new, *old
;
164 unsigned long ip
= rec
->ip
;
166 old
= ftrace_nop_replace();
167 new = ftrace_call_replace(ip
, addr
);
169 /* Should only be called when module is loaded */
170 return ftrace_modify_code_direct(rec
->ip
, old
, new);
174 * The modifying_ftrace_code is used to tell the breakpoint
175 * handler to call ftrace_int3_handler(). If it fails to
176 * call this handler for a breakpoint added by ftrace, then
177 * the kernel may crash.
179 * As atomic_writes on x86 do not need a barrier, we do not
180 * need to add smp_mb()s for this to work. It is also considered
181 * that we can not read the modifying_ftrace_code before
182 * executing the breakpoint. That would be quite remarkable if
183 * it could do that. Here's the flow that is required:
189 * <trap-int3> // implicit (r)mb
190 * if (atomic_read(mfc))
191 * call ftrace_int3_handler()
193 * Then when we are finished:
197 * If we hit a breakpoint that was not set by ftrace, it does not
198 * matter if ftrace_int3_handler() is called or not. It will
199 * simply be ignored. But it is crucial that a ftrace nop/caller
200 * breakpoint is handled. No other user should ever place a
201 * breakpoint on an ftrace nop/caller location. It must only
202 * be done by this code.
204 atomic_t modifying_ftrace_code __read_mostly
;
207 ftrace_modify_code(unsigned long ip
, unsigned const char *old_code
,
208 unsigned const char *new_code
);
211 * Should never be called:
212 * As it is only called by __ftrace_replace_code() which is called by
213 * ftrace_replace_code() that x86 overrides, and by ftrace_update_code()
214 * which is called to turn mcount into nops or nops into function calls
215 * but not to convert a function from not using regs to one that uses
216 * regs, which ftrace_modify_call() is for.
218 int ftrace_modify_call(struct dyn_ftrace
*rec
, unsigned long old_addr
,
225 static unsigned long ftrace_update_func
;
227 static int update_ftrace_func(unsigned long ip
, void *new)
229 unsigned char old
[MCOUNT_INSN_SIZE
];
232 memcpy(old
, (void *)ip
, MCOUNT_INSN_SIZE
);
234 ftrace_update_func
= ip
;
235 /* Make sure the breakpoints see the ftrace_update_func update */
238 /* See comment above by declaration of modifying_ftrace_code */
239 atomic_inc(&modifying_ftrace_code
);
241 ret
= ftrace_modify_code(ip
, old
, new);
243 atomic_dec(&modifying_ftrace_code
);
248 int ftrace_update_ftrace_func(ftrace_func_t func
)
250 unsigned long ip
= (unsigned long)(&ftrace_call
);
254 new = ftrace_call_replace(ip
, (unsigned long)func
);
255 ret
= update_ftrace_func(ip
, new);
257 /* Also update the regs callback function */
259 ip
= (unsigned long)(&ftrace_regs_call
);
260 new = ftrace_call_replace(ip
, (unsigned long)func
);
261 ret
= update_ftrace_func(ip
, new);
267 static int is_ftrace_caller(unsigned long ip
)
269 if (ip
== ftrace_update_func
)
276 * A breakpoint was added to the code address we are about to
277 * modify, and this is the handle that will just skip over it.
278 * We are either changing a nop into a trace call, or a trace
279 * call to a nop. While the change is taking place, we treat
280 * it just like it was a nop.
282 int ftrace_int3_handler(struct pt_regs
*regs
)
286 if (WARN_ON_ONCE(!regs
))
290 if (!ftrace_location(ip
) && !is_ftrace_caller(ip
))
293 regs
->ip
+= MCOUNT_INSN_SIZE
- 1;
298 static int ftrace_write(unsigned long ip
, const char *val
, int size
)
300 ip
= text_ip_addr(ip
);
302 if (probe_kernel_write((void *)ip
, val
, size
))
308 static int add_break(unsigned long ip
, const char *old
)
310 unsigned char replaced
[MCOUNT_INSN_SIZE
];
311 unsigned char brk
= BREAKPOINT_INSTRUCTION
;
313 if (probe_kernel_read(replaced
, (void *)ip
, MCOUNT_INSN_SIZE
))
316 /* Make sure it is what we expect it to be */
317 if (memcmp(replaced
, old
, MCOUNT_INSN_SIZE
) != 0)
320 return ftrace_write(ip
, &brk
, 1);
323 static int add_brk_on_call(struct dyn_ftrace
*rec
, unsigned long addr
)
325 unsigned const char *old
;
326 unsigned long ip
= rec
->ip
;
328 old
= ftrace_call_replace(ip
, addr
);
330 return add_break(rec
->ip
, old
);
334 static int add_brk_on_nop(struct dyn_ftrace
*rec
)
336 unsigned const char *old
;
338 old
= ftrace_nop_replace();
340 return add_break(rec
->ip
, old
);
343 static int add_breakpoints(struct dyn_ftrace
*rec
, int enable
)
345 unsigned long ftrace_addr
;
348 ftrace_addr
= ftrace_get_addr_curr(rec
);
350 ret
= ftrace_test_record(rec
, enable
);
353 case FTRACE_UPDATE_IGNORE
:
356 case FTRACE_UPDATE_MAKE_CALL
:
357 /* converting nop to call */
358 return add_brk_on_nop(rec
);
360 case FTRACE_UPDATE_MODIFY_CALL
:
361 case FTRACE_UPDATE_MAKE_NOP
:
362 /* converting a call to a nop */
363 return add_brk_on_call(rec
, ftrace_addr
);
369 * On error, we need to remove breakpoints. This needs to
370 * be done caefully. If the address does not currently have a
371 * breakpoint, we know we are done. Otherwise, we look at the
372 * remaining 4 bytes of the instruction. If it matches a nop
373 * we replace the breakpoint with the nop. Otherwise we replace
374 * it with the call instruction.
376 static int remove_breakpoint(struct dyn_ftrace
*rec
)
378 unsigned char ins
[MCOUNT_INSN_SIZE
];
379 unsigned char brk
= BREAKPOINT_INSTRUCTION
;
380 const unsigned char *nop
;
381 unsigned long ftrace_addr
;
382 unsigned long ip
= rec
->ip
;
384 /* If we fail the read, just give up */
385 if (probe_kernel_read(ins
, (void *)ip
, MCOUNT_INSN_SIZE
))
388 /* If this does not have a breakpoint, we are done */
392 nop
= ftrace_nop_replace();
395 * If the last 4 bytes of the instruction do not match
396 * a nop, then we assume that this is a call to ftrace_addr.
398 if (memcmp(&ins
[1], &nop
[1], MCOUNT_INSN_SIZE
- 1) != 0) {
400 * For extra paranoidism, we check if the breakpoint is on
401 * a call that would actually jump to the ftrace_addr.
402 * If not, don't touch the breakpoint, we make just create
405 ftrace_addr
= ftrace_get_addr_new(rec
);
406 nop
= ftrace_call_replace(ip
, ftrace_addr
);
408 if (memcmp(&ins
[1], &nop
[1], MCOUNT_INSN_SIZE
- 1) == 0)
411 /* Check both ftrace_addr and ftrace_old_addr */
412 ftrace_addr
= ftrace_get_addr_curr(rec
);
413 nop
= ftrace_call_replace(ip
, ftrace_addr
);
415 if (memcmp(&ins
[1], &nop
[1], MCOUNT_INSN_SIZE
- 1) != 0)
420 return ftrace_write(ip
, nop
, 1);
423 static int add_update_code(unsigned long ip
, unsigned const char *new)
425 /* skip breakpoint */
428 return ftrace_write(ip
, new, MCOUNT_INSN_SIZE
- 1);
431 static int add_update_call(struct dyn_ftrace
*rec
, unsigned long addr
)
433 unsigned long ip
= rec
->ip
;
434 unsigned const char *new;
436 new = ftrace_call_replace(ip
, addr
);
437 return add_update_code(ip
, new);
440 static int add_update_nop(struct dyn_ftrace
*rec
)
442 unsigned long ip
= rec
->ip
;
443 unsigned const char *new;
445 new = ftrace_nop_replace();
446 return add_update_code(ip
, new);
449 static int add_update(struct dyn_ftrace
*rec
, int enable
)
451 unsigned long ftrace_addr
;
454 ret
= ftrace_test_record(rec
, enable
);
456 ftrace_addr
= ftrace_get_addr_new(rec
);
459 case FTRACE_UPDATE_IGNORE
:
462 case FTRACE_UPDATE_MODIFY_CALL
:
463 case FTRACE_UPDATE_MAKE_CALL
:
464 /* converting nop to call */
465 return add_update_call(rec
, ftrace_addr
);
467 case FTRACE_UPDATE_MAKE_NOP
:
468 /* converting a call to a nop */
469 return add_update_nop(rec
);
475 static int finish_update_call(struct dyn_ftrace
*rec
, unsigned long addr
)
477 unsigned long ip
= rec
->ip
;
478 unsigned const char *new;
480 new = ftrace_call_replace(ip
, addr
);
482 return ftrace_write(ip
, new, 1);
485 static int finish_update_nop(struct dyn_ftrace
*rec
)
487 unsigned long ip
= rec
->ip
;
488 unsigned const char *new;
490 new = ftrace_nop_replace();
492 return ftrace_write(ip
, new, 1);
495 static int finish_update(struct dyn_ftrace
*rec
, int enable
)
497 unsigned long ftrace_addr
;
500 ret
= ftrace_update_record(rec
, enable
);
502 ftrace_addr
= ftrace_get_addr_new(rec
);
505 case FTRACE_UPDATE_IGNORE
:
508 case FTRACE_UPDATE_MODIFY_CALL
:
509 case FTRACE_UPDATE_MAKE_CALL
:
510 /* converting nop to call */
511 return finish_update_call(rec
, ftrace_addr
);
513 case FTRACE_UPDATE_MAKE_NOP
:
514 /* converting a call to a nop */
515 return finish_update_nop(rec
);
521 static void do_sync_core(void *data
)
526 static void run_sync(void)
528 int enable_irqs
= irqs_disabled();
530 /* We may be called with interrupts disbled (on bootup). */
533 on_each_cpu(do_sync_core
, NULL
, 1);
538 void ftrace_replace_code(int enable
)
540 struct ftrace_rec_iter
*iter
;
541 struct dyn_ftrace
*rec
;
542 const char *report
= "adding breakpoints";
546 for_ftrace_rec_iter(iter
) {
547 rec
= ftrace_rec_iter_record(iter
);
549 ret
= add_breakpoints(rec
, enable
);
551 goto remove_breakpoints
;
557 report
= "updating code";
559 for_ftrace_rec_iter(iter
) {
560 rec
= ftrace_rec_iter_record(iter
);
562 ret
= add_update(rec
, enable
);
564 goto remove_breakpoints
;
569 report
= "removing breakpoints";
571 for_ftrace_rec_iter(iter
) {
572 rec
= ftrace_rec_iter_record(iter
);
574 ret
= finish_update(rec
, enable
);
576 goto remove_breakpoints
;
584 pr_warn("Failed on %s (%d):\n", report
, count
);
585 ftrace_bug(ret
, rec
? rec
->ip
: 0);
586 for_ftrace_rec_iter(iter
) {
587 rec
= ftrace_rec_iter_record(iter
);
589 * Breakpoints are handled only when this function is in
590 * progress. The system could not work with them.
592 if (remove_breakpoint(rec
))
599 ftrace_modify_code(unsigned long ip
, unsigned const char *old_code
,
600 unsigned const char *new_code
)
604 ret
= add_break(ip
, old_code
);
610 ret
= add_update_code(ip
, new_code
);
616 ret
= ftrace_write(ip
, new_code
, 1);
618 * The breakpoint is handled only when this function is in progress.
619 * The system could not work if we could not remove it.
627 /* Also here the system could not work with the breakpoint */
628 if (ftrace_write(ip
, old_code
, 1))
633 void arch_ftrace_update_code(int command
)
635 /* See comment above by declaration of modifying_ftrace_code */
636 atomic_inc(&modifying_ftrace_code
);
638 ftrace_modify_all_code(command
);
640 atomic_dec(&modifying_ftrace_code
);
643 int __init
ftrace_dyn_arch_init(void)
649 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
651 #ifdef CONFIG_DYNAMIC_FTRACE
652 extern void ftrace_graph_call(void);
654 static unsigned char *ftrace_jmp_replace(unsigned long ip
, unsigned long addr
)
656 static union ftrace_code_union calc
;
658 /* Jmp not a call (ignore the .e8) */
660 calc
.offset
= ftrace_calc_offset(ip
+ MCOUNT_INSN_SIZE
, addr
);
663 * ftrace external locks synchronize the access to the static variable.
668 static int ftrace_mod_jmp(unsigned long ip
, void *func
)
672 new = ftrace_jmp_replace(ip
, (unsigned long)func
);
674 return update_ftrace_func(ip
, new);
677 int ftrace_enable_ftrace_graph_caller(void)
679 unsigned long ip
= (unsigned long)(&ftrace_graph_call
);
681 return ftrace_mod_jmp(ip
, &ftrace_graph_caller
);
684 int ftrace_disable_ftrace_graph_caller(void)
686 unsigned long ip
= (unsigned long)(&ftrace_graph_call
);
688 return ftrace_mod_jmp(ip
, &ftrace_stub
);
691 #endif /* !CONFIG_DYNAMIC_FTRACE */
694 * Hook the return address and push it in the stack of return addrs
695 * in current thread info.
697 void prepare_ftrace_return(unsigned long *parent
, unsigned long self_addr
,
698 unsigned long frame_pointer
)
702 struct ftrace_graph_ent trace
;
703 unsigned long return_hooker
= (unsigned long)
707 * When resuming from suspend-to-ram, this function can be indirectly
708 * called from early CPU startup code while the CPU is in real mode,
709 * which would fail miserably. Make sure the stack pointer is a
712 * This check isn't as accurate as virt_addr_valid(), but it should be
713 * good enough for this purpose, and it's fast.
715 if (unlikely((long)__builtin_frame_address(0) >= 0))
718 if (unlikely(ftrace_graph_is_dead()))
721 if (unlikely(atomic_read(¤t
->tracing_graph_pause
)))
725 * Protect against fault, even if it shouldn't
726 * happen. This tool is too much intrusive to
727 * ignore such a protection.
730 "1: " _ASM_MOV
" (%[parent]), %[old]\n"
731 "2: " _ASM_MOV
" %[return_hooker], (%[parent])\n"
732 " movl $0, %[faulted]\n"
735 ".section .fixup, \"ax\"\n"
736 "4: movl $1, %[faulted]\n"
743 : [old
] "=&r" (old
), [faulted
] "=r" (faulted
)
744 : [parent
] "r" (parent
), [return_hooker
] "r" (return_hooker
)
748 if (unlikely(faulted
)) {
754 trace
.func
= self_addr
;
755 trace
.depth
= current
->curr_ret_stack
+ 1;
757 /* Only trace if the calling function expects to */
758 if (!ftrace_graph_entry(&trace
)) {
763 if (ftrace_push_return_trace(old
, self_addr
, &trace
.depth
,
764 frame_pointer
) == -EBUSY
) {
769 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */