2 * Code for replacing ftrace calls with jumps.
4 * Copyright (C) 2007-2008 Steven Rostedt <srostedt@redhat.com>
5 * Copyright (C) 2009, 2010 DSLab, Lanzhou University, China
6 * Author: Wu Zhangjin <wuzhangjin@gmail.com>
8 * Thanks goes to Steven Rostedt for writing the original x86 version.
11 #include <linux/uaccess.h>
12 #include <linux/init.h>
13 #include <linux/ftrace.h>
14 #include <linux/syscalls.h>
17 #include <asm/asm-offsets.h>
18 #include <asm/cacheflush.h>
19 #include <asm/syscall.h>
21 #include <asm/unistd.h>
23 #include <asm-generic/sections.h>
25 #if defined(KBUILD_MCOUNT_RA_ADDRESS) && defined(CONFIG_32BIT)
26 #define MCOUNT_OFFSET_INSNS 5
28 #define MCOUNT_OFFSET_INSNS 4
31 #ifdef CONFIG_DYNAMIC_FTRACE
33 /* Arch override because MIPS doesn't need to run this from stop_machine() */
34 void arch_ftrace_update_code(int command)
36 ftrace_modify_all_code(command);
41 #ifdef CONFIG_DYNAMIC_FTRACE
43 #define JAL 0x0c000000 /* jump & link: ip --> ra, jump to target */
44 #define ADDR_MASK 0x03ffffff /* op_code|addr : 31...26|25 ....0 */
45 #define JUMP_RANGE_MASK ((1UL << 28) - 1)
47 #define INSN_NOP 0x00000000 /* nop */
48 #define INSN_JAL(addr) \
49 ((unsigned int)(JAL | (((addr) >> 2) & ADDR_MASK)))
51 static unsigned int insn_jal_ftrace_caller __read_mostly;
52 static unsigned int insn_la_mcount[2] __read_mostly;
53 static unsigned int insn_j_ftrace_graph_caller __maybe_unused __read_mostly;
55 static inline void ftrace_dyn_arch_init_insns(void)
62 buf = (u32 *)&insn_la_mcount[0];
63 UASM_i_LA(&buf, v1, MCOUNT_ADDR);
65 /* jal (ftrace_caller + 8), jump over the first two instruction */
66 buf = (u32 *)&insn_jal_ftrace_caller;
67 uasm_i_jal(&buf, (FTRACE_ADDR + 8) & JUMP_RANGE_MASK);
69 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
70 /* j ftrace_graph_caller */
71 buf = (u32 *)&insn_j_ftrace_graph_caller;
72 uasm_i_j(&buf, (unsigned long)ftrace_graph_caller & JUMP_RANGE_MASK);
76 static int ftrace_modify_code(unsigned long ip, unsigned int new_code)
81 /* *(unsigned int *)ip = new_code; */
82 safe_store_code(new_code, ip, faulted);
84 if (unlikely(faulted))
89 flush_icache_range(ip, ip + 8);
96 static int ftrace_modify_code_2(unsigned long ip, unsigned int new_code1,
97 unsigned int new_code2)
102 safe_store_code(new_code1, ip, faulted);
103 if (unlikely(faulted))
107 safe_store_code(new_code2, ip, faulted);
108 if (unlikely(faulted))
114 flush_icache_range(ip, ip + 8);
120 static int ftrace_modify_code_2r(unsigned long ip, unsigned int new_code1,
121 unsigned int new_code2)
127 safe_store_code(new_code2, ip, faulted);
128 if (unlikely(faulted))
132 safe_store_code(new_code1, ip, faulted);
133 if (unlikely(faulted))
138 flush_icache_range(ip, ip + 8);
146 * The details about the calling site of mcount on MIPS
151 * jal _mcount --> nop
152 * sub sp, sp, 8 --> nop (CONFIG_32BIT)
156 * 2.1 For KBUILD_MCOUNT_RA_ADDRESS and CONFIG_32BIT
158 * lui v1, hi_16bit_of_mcount --> b 1f (0x10000005)
159 * addiu v1, v1, low_16bit_of_mcount --> nop (CONFIG_32BIT)
161 * move $12, ra_address
164 * 1: offset = 5 instructions
165 * 2.2 For the Other situations
167 * lui v1, hi_16bit_of_mcount --> b 1f (0x10000004)
168 * addiu v1, v1, low_16bit_of_mcount --> nop (CONFIG_32BIT)
171 * nop | move $12, ra_address | sub sp, sp, 8
172 * 1: offset = 4 instructions
175 #define INSN_B_1F (0x10000000 | MCOUNT_OFFSET_INSNS)
177 int ftrace_make_nop(struct module *mod,
178 struct dyn_ftrace *rec, unsigned long addr)
181 unsigned long ip = rec->ip;
184 * If ip is in kernel space, no long call, otherwise, long call is
187 new = core_kernel_text(ip) ? INSN_NOP : INSN_B_1F;
189 return ftrace_modify_code(ip, new);
192 * On 32 bit MIPS platforms, gcc adds a stack adjust
193 * instruction in the delay slot after the branch to
194 * mcount and expects mcount to restore the sp on return.
195 * This is based on a legacy API and does nothing but
196 * waste instructions so it's being removed at runtime.
198 return ftrace_modify_code_2(ip, new, INSN_NOP);
202 int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr)
205 unsigned long ip = rec->ip;
207 new = core_kernel_text(ip) ? insn_jal_ftrace_caller : insn_la_mcount[0];
210 return ftrace_modify_code(ip, new);
212 return ftrace_modify_code_2r(ip, new, core_kernel_text(ip) ?
213 INSN_NOP : insn_la_mcount[1]);
217 #define FTRACE_CALL_IP ((unsigned long)(&ftrace_call))
219 int ftrace_update_ftrace_func(ftrace_func_t func)
223 new = INSN_JAL((unsigned long)func);
225 return ftrace_modify_code(FTRACE_CALL_IP, new);
228 int __init ftrace_dyn_arch_init(void)
230 /* Encode the instructions when booting */
231 ftrace_dyn_arch_init_insns();
233 /* Remove "b ftrace_stub" to ensure ftrace_caller() is executed */
234 ftrace_modify_code(MCOUNT_ADDR, INSN_NOP);
238 #endif /* CONFIG_DYNAMIC_FTRACE */
240 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
242 #ifdef CONFIG_DYNAMIC_FTRACE
244 extern void ftrace_graph_call(void);
245 #define FTRACE_GRAPH_CALL_IP ((unsigned long)(&ftrace_graph_call))
247 int ftrace_enable_ftrace_graph_caller(void)
249 return ftrace_modify_code(FTRACE_GRAPH_CALL_IP,
250 insn_j_ftrace_graph_caller);
253 int ftrace_disable_ftrace_graph_caller(void)
255 return ftrace_modify_code(FTRACE_GRAPH_CALL_IP, INSN_NOP);
258 #endif /* CONFIG_DYNAMIC_FTRACE */
260 #ifndef KBUILD_MCOUNT_RA_ADDRESS
262 #define S_RA_SP (0xafbf << 16) /* s{d,w} ra, offset(sp) */
263 #define S_R_SP (0xafb0 << 16) /* s{d,w} R, offset(sp) */
264 #define OFFSET_MASK 0xffff /* stack offset range: 0 ~ PT_SIZE */
266 unsigned long ftrace_get_parent_ra_addr(unsigned long self_ra, unsigned long
267 old_parent_ra, unsigned long parent_ra_addr, unsigned long fp)
269 unsigned long sp, ip, tmp;
274 * For module, move the ip from the return address after the
275 * instruction "lui v1, hi_16bit_of_mcount"(offset is 24), but for
276 * kernel, move after the instruction "move ra, at"(offset is 16)
278 ip = self_ra - (core_kernel_text(self_ra) ? 16 : 24);
281 * search the text until finding the non-store instruction or "s{d,w}
282 * ra, offset(sp)" instruction
285 /* get the code at "ip": code = *(unsigned int *)ip; */
286 safe_load_code(code, ip, faulted);
288 if (unlikely(faulted))
291 * If we hit the non-store instruction before finding where the
292 * ra is stored, then this is a leaf function and it does not
293 * store the ra on the stack
295 if ((code & S_R_SP) != S_R_SP)
296 return parent_ra_addr;
298 /* Move to the next instruction */
300 } while ((code & S_RA_SP) != S_RA_SP);
302 sp = fp + (code & OFFSET_MASK);
304 /* tmp = *(unsigned long *)sp; */
305 safe_load_stack(tmp, sp, faulted);
306 if (unlikely(faulted))
309 if (tmp == old_parent_ra)
314 #endif /* !KBUILD_MCOUNT_RA_ADDRESS */
317 * Hook the return address and push it in the stack of return addrs
318 * in current thread info.
320 void prepare_ftrace_return(unsigned long *parent_ra_addr, unsigned long self_ra,
323 unsigned long old_parent_ra;
324 struct ftrace_graph_ent trace;
325 unsigned long return_hooker = (unsigned long)
329 if (unlikely(ftrace_graph_is_dead()))
332 if (unlikely(atomic_read(¤t->tracing_graph_pause)))
336 * "parent_ra_addr" is the stack address saved the return address of
337 * the caller of _mcount.
339 * if the gcc < 4.5, a leaf function does not save the return address
340 * in the stack address, so, we "emulate" one in _mcount's stack space,
341 * and hijack it directly, but for a non-leaf function, it save the
342 * return address to the its own stack space, we can not hijack it
343 * directly, but need to find the real stack address,
344 * ftrace_get_parent_addr() does it!
346 * if gcc>= 4.5, with the new -mmcount-ra-address option, for a
347 * non-leaf function, the location of the return address will be saved
348 * to $12 for us, and for a leaf function, only put a zero into $12. we
349 * do it in ftrace_graph_caller of mcount.S.
352 /* old_parent_ra = *parent_ra_addr; */
353 safe_load_stack(old_parent_ra, parent_ra_addr, faulted);
354 if (unlikely(faulted))
356 #ifndef KBUILD_MCOUNT_RA_ADDRESS
357 parent_ra_addr = (unsigned long *)ftrace_get_parent_ra_addr(self_ra,
358 old_parent_ra, (unsigned long)parent_ra_addr, fp);
360 * If fails when getting the stack address of the non-leaf function's
361 * ra, stop function graph tracer and return
363 if (parent_ra_addr == 0)
366 /* *parent_ra_addr = return_hooker; */
367 safe_store_stack(return_hooker, parent_ra_addr, faulted);
368 if (unlikely(faulted))
371 if (ftrace_push_return_trace(old_parent_ra, self_ra, &trace.depth, fp,
373 *parent_ra_addr = old_parent_ra;
378 * Get the recorded ip of the current mcount calling site in the
379 * __mcount_loc section, which will be used to filter the function
380 * entries configured through the tracing/set_graph_function interface.
383 insns = core_kernel_text(self_ra) ? 2 : MCOUNT_OFFSET_INSNS + 1;
384 trace.func = self_ra - (MCOUNT_INSN_SIZE * insns);
386 /* Only trace if the calling function expects to */
387 if (!ftrace_graph_entry(&trace)) {
388 current->curr_ret_stack--;
389 *parent_ra_addr = old_parent_ra;
396 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
398 #ifdef CONFIG_FTRACE_SYSCALLS
401 unsigned long __init arch_syscall_addr(int nr)
403 return (unsigned long)sys_call_table[nr - __NR_O32_Linux];
409 unsigned long __init arch_syscall_addr(int nr)
411 #ifdef CONFIG_MIPS32_N32
412 if (nr >= __NR_N32_Linux && nr <= __NR_N32_Linux + __NR_N32_Linux_syscalls)
413 return (unsigned long)sysn32_call_table[nr - __NR_N32_Linux];
415 if (nr >= __NR_64_Linux && nr <= __NR_64_Linux + __NR_64_Linux_syscalls)
416 return (unsigned long)sys_call_table[nr - __NR_64_Linux];
417 #ifdef CONFIG_MIPS32_O32
418 if (nr >= __NR_O32_Linux && nr <= __NR_O32_Linux + __NR_O32_Linux_syscalls)
419 return (unsigned long)sys32_call_table[nr - __NR_O32_Linux];
422 return (unsigned long) &sys_ni_syscall;
426 #endif /* CONFIG_FTRACE_SYSCALLS */