blob: 703eb53cfa2b2a1512b7ce97d9c1da218ad9ac0f [file] [log] [blame]
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02001#ifndef _LINUX_FTRACE_H
2#define _LINUX_FTRACE_H
3
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02004#include <linux/linkage.h>
Ingo Molnard49dbf32008-05-16 10:41:53 +02005#include <linux/fs.h>
Steven Noonaneb7fa932008-10-02 12:00:07 -07006#include <linux/ktime.h>
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +01007#include <linux/init.h>
8#include <linux/types.h>
Frederic Weisbecker56010202008-10-02 13:26:05 +02009#include <linux/kallsyms.h>
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020010
Steven Rostedt606576c2008-10-06 19:06:12 -040011#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnar3e1932a2008-10-02 17:45:47 +020012
Steven Rostedtb0fc4942008-05-12 21:20:43 +020013extern int ftrace_enabled;
14extern int
15ftrace_enable_sysctl(struct ctl_table *table, int write,
16 struct file *filp, void __user *buffer, size_t *lenp,
17 loff_t *ppos);
18
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020019typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
20
21struct ftrace_ops {
22 ftrace_func_t func;
23 struct ftrace_ops *next;
24};
25
26/*
27 * The ftrace_ops must be a static and should also
28 * be read_mostly. These functions do modify read_mostly variables
29 * so use them sparely. Never free an ftrace_op or modify the
30 * next pointer after it has been registered. Even after unregistering
31 * it, the next pointer may still be used internally.
32 */
33int register_ftrace_function(struct ftrace_ops *ops);
34int unregister_ftrace_function(struct ftrace_ops *ops);
35void clear_ftrace_function(void);
36
37extern void ftrace_stub(unsigned long a0, unsigned long a1);
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020038
Steven Rostedt606576c2008-10-06 19:06:12 -040039#else /* !CONFIG_FUNCTION_TRACER */
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020040# define register_ftrace_function(ops) do { } while (0)
41# define unregister_ftrace_function(ops) do { } while (0)
42# define clear_ftrace_function(ops) do { } while (0)
Steven Rostedt81adbdc2008-10-23 09:33:02 -040043static inline void ftrace_kill(void) { }
Steven Rostedt606576c2008-10-06 19:06:12 -040044#endif /* CONFIG_FUNCTION_TRACER */
Steven Rostedt352ad252008-05-12 21:20:42 +020045
Steven Rostedt3d083392008-05-12 21:20:42 +020046#ifdef CONFIG_DYNAMIC_FTRACE
Steven Rostedt3d083392008-05-12 21:20:42 +020047
Steven Rostedt3c1720f2008-05-12 21:20:43 +020048enum {
Steven Rostedt37ad5082008-05-12 21:20:48 +020049 FTRACE_FL_FREE = (1 << 0),
50 FTRACE_FL_FAILED = (1 << 1),
51 FTRACE_FL_FILTER = (1 << 2),
52 FTRACE_FL_ENABLED = (1 << 3),
Steven Rostedt41c52c02008-05-22 11:46:33 -040053 FTRACE_FL_NOTRACE = (1 << 4),
Abhishek Sagar0eb96702008-06-01 21:47:30 +053054 FTRACE_FL_CONVERTED = (1 << 5),
Abhishek Sagarecea6562008-06-21 23:47:53 +053055 FTRACE_FL_FROZEN = (1 << 6),
Steven Rostedt3c1720f2008-05-12 21:20:43 +020056};
57
Steven Rostedt3d083392008-05-12 21:20:42 +020058struct dyn_ftrace {
Steven Rostedt08f5ac902008-10-23 09:33:07 -040059 struct list_head list;
60 unsigned long ip; /* address of mcount call-site */
61 unsigned long flags;
Steven Rostedt3d083392008-05-12 21:20:42 +020062};
63
Steven Rostedte1c08bd2008-05-12 21:20:44 +020064int ftrace_force_update(void);
Steven Rostedt77a2b372008-05-12 21:20:45 +020065void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedte1c08bd2008-05-12 21:20:44 +020066
Steven Rostedt3d083392008-05-12 21:20:42 +020067/* defined in arch */
Steven Rostedt3c1720f2008-05-12 21:20:43 +020068extern int ftrace_ip_converted(unsigned long ip);
69extern unsigned char *ftrace_nop_replace(void);
70extern unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr);
Steven Rostedtd61f82d2008-05-12 21:20:43 +020071extern int ftrace_dyn_arch_init(void *data);
Steven Rostedtd61f82d2008-05-12 21:20:43 +020072extern int ftrace_update_ftrace_func(ftrace_func_t func);
73extern void ftrace_caller(void);
74extern void ftrace_call(void);
75extern void mcount_call(void);
Steven Rostedtad90c0e2008-05-27 20:48:37 -040076
Steven Rostedt593eb8a2008-10-23 09:32:59 -040077/**
78 * ftrace_modify_code - modify code segment
79 * @ip: the address of the code segment
80 * @old_code: the contents of what is expected to be there
81 * @new_code: the code to patch in
82 *
83 * This is a very sensitive operation and great care needs
84 * to be taken by the arch. The operation should carefully
85 * read the location, check to see if what is read is indeed
86 * what we expect it to be, and then on success of the compare,
87 * it should write to the location.
88 *
89 * Return must be:
90 * 0 on success
91 * -EFAULT on error reading the location
92 * -EINVAL on a failed compare of the contents
93 * -EPERM on error writing to the location
94 * Any other value will be considered a failure.
95 */
96extern int ftrace_modify_code(unsigned long ip, unsigned char *old_code,
97 unsigned char *new_code);
98
Abhishek Sagarecea6562008-06-21 23:47:53 +053099extern int skip_trace(unsigned long ip);
100
Steven Rostedtc0719e52008-09-06 01:06:03 -0400101extern void ftrace_release(void *start, unsigned long size);
102
103extern void ftrace_disable_daemon(void);
104extern void ftrace_enable_daemon(void);
Steven Rostedtad90c0e2008-05-27 20:48:37 -0400105
Steven Rostedte1c08bd2008-05-12 21:20:44 +0200106#else
Abhishek Sagarecea6562008-06-21 23:47:53 +0530107# define skip_trace(ip) ({ 0; })
Ingo Molnaraeaee8a2008-05-12 21:20:49 +0200108# define ftrace_force_update() ({ 0; })
109# define ftrace_set_filter(buf, len, reset) do { } while (0)
Steven Rostedtad90c0e2008-05-27 20:48:37 -0400110# define ftrace_disable_daemon() do { } while (0)
111# define ftrace_enable_daemon() do { } while (0)
Steven Rostedtc0719e52008-09-06 01:06:03 -0400112static inline void ftrace_release(void *start, unsigned long size) { }
Abhishek Sagarecea6562008-06-21 23:47:53 +0530113#endif /* CONFIG_DYNAMIC_FTRACE */
Steven Rostedt352ad252008-05-12 21:20:42 +0200114
Ingo Molnaraeaee8a2008-05-12 21:20:49 +0200115/* totally disable ftrace - can not re-enable after this */
116void ftrace_kill(void);
117
Ingo Molnarf43fdad2008-05-12 21:20:43 +0200118static inline void tracer_disable(void)
119{
Steven Rostedt606576c2008-10-06 19:06:12 -0400120#ifdef CONFIG_FUNCTION_TRACER
Ingo Molnarf43fdad2008-05-12 21:20:43 +0200121 ftrace_enabled = 0;
122#endif
123}
124
Huang Ying37002732008-08-18 16:24:56 +0800125/*
126 * Ftrace disable/restore without lock. Some synchronization mechanism
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700127 * must be used to prevent ftrace_enabled to be changed between
Huang Ying37002732008-08-18 16:24:56 +0800128 * disable/restore.
129 */
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700130static inline int __ftrace_enabled_save(void)
131{
Steven Rostedt606576c2008-10-06 19:06:12 -0400132#ifdef CONFIG_FUNCTION_TRACER
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700133 int saved_ftrace_enabled = ftrace_enabled;
134 ftrace_enabled = 0;
135 return saved_ftrace_enabled;
136#else
137 return 0;
138#endif
139}
140
141static inline void __ftrace_enabled_restore(int enabled)
142{
Steven Rostedt606576c2008-10-06 19:06:12 -0400143#ifdef CONFIG_FUNCTION_TRACER
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700144 ftrace_enabled = enabled;
145#endif
146}
147
Steven Rostedt352ad252008-05-12 21:20:42 +0200148#ifdef CONFIG_FRAME_POINTER
149/* TODO: need to fix this for ARM */
150# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
151# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
152# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
153# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
154# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
155# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
Ingo Molnar86387f72008-05-12 21:20:51 +0200156# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
Steven Rostedt352ad252008-05-12 21:20:42 +0200157#else
158# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
159# define CALLER_ADDR1 0UL
160# define CALLER_ADDR2 0UL
161# define CALLER_ADDR3 0UL
162# define CALLER_ADDR4 0UL
163# define CALLER_ADDR5 0UL
Ingo Molnar86387f72008-05-12 21:20:51 +0200164# define CALLER_ADDR6 0UL
Steven Rostedt352ad252008-05-12 21:20:42 +0200165#endif
166
Steven Rostedt81d68a92008-05-12 21:20:42 +0200167#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar489f1392008-02-25 13:38:05 +0100168 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
169 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
Steven Rostedt81d68a92008-05-12 21:20:42 +0200170#else
171# define time_hardirqs_on(a0, a1) do { } while (0)
172# define time_hardirqs_off(a0, a1) do { } while (0)
173#endif
174
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200175#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar489f1392008-02-25 13:38:05 +0100176 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
177 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200178#else
179# define trace_preempt_on(a0, a1) do { } while (0)
180# define trace_preempt_off(a0, a1) do { } while (0)
181#endif
182
Ingo Molnarb1829d22008-05-28 01:22:08 +0200183#ifdef CONFIG_TRACING
Ingo Molnar74f4e362008-05-12 21:21:15 +0200184extern void
185ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
Steven Rostedt2f2c99d2008-08-01 16:45:49 -0400186
187/**
188 * ftrace_printk - printf formatting in the ftrace buffer
189 * @fmt: the printf format for printing
190 *
191 * Note: __ftrace_printk is an internal function for ftrace_printk and
192 * the @ip is passed in via the ftrace_printk macro.
193 *
194 * This function allows a kernel developer to debug fast path sections
195 * that printk is not appropriate for. By scattering in various
196 * printk like tracing in the code, a developer can quickly see
197 * where problems are occurring.
198 *
199 * This is intended as a debugging tool for the developer only.
200 * Please refrain from leaving ftrace_printks scattered around in
201 * your code.
202 */
203# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400204extern int
205__ftrace_printk(unsigned long ip, const char *fmt, ...)
206 __attribute__ ((format (printf, 2, 3)));
Steven Rostedt3f5a54e2008-07-30 22:36:46 -0400207extern void ftrace_dump(void);
Ingo Molnar74f4e362008-05-12 21:21:15 +0200208#else
209static inline void
210ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400211static inline int
Ingo Molnar7b928c22008-08-15 17:48:02 +0200212ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0)));
213
214static inline int
215ftrace_printk(const char *fmt, ...)
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400216{
217 return 0;
218}
Steven Rostedt3f5a54e2008-07-30 22:36:46 -0400219static inline void ftrace_dump(void) { }
Ingo Molnar74f4e362008-05-12 21:21:15 +0200220#endif
221
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400222#ifdef CONFIG_FTRACE_MCOUNT_RECORD
223extern void ftrace_init(void);
Steven Rostedt90d595f2008-08-14 15:45:09 -0400224extern void ftrace_init_module(unsigned long *start, unsigned long *end);
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400225#else
226static inline void ftrace_init(void) { }
Steven Rostedt90d595f2008-08-14 15:45:09 -0400227static inline void
228ftrace_init_module(unsigned long *start, unsigned long *end) { }
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400229#endif
230
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400231
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100232struct boot_trace {
233 pid_t caller;
Tim Birdca538f62008-10-09 15:23:05 -0700234 char func[KSYM_NAME_LEN];
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100235 int result;
Tim Birdca538f62008-10-09 15:23:05 -0700236 unsigned long long duration; /* usecs */
Frederic Weisbeckercb5ab742008-10-02 12:59:20 +0200237 ktime_t calltime;
238 ktime_t rettime;
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100239};
240
241#ifdef CONFIG_BOOT_TRACER
Frederic Weisbecker56010202008-10-02 13:26:05 +0200242extern void trace_boot(struct boot_trace *it, initcall_t fn);
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100243extern void start_boot_trace(void);
Frederic Weisbecker097d0362008-10-03 15:39:21 +0200244extern void stop_boot_trace(void);
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100245#else
Frederic Weisbecker56010202008-10-02 13:26:05 +0200246static inline void trace_boot(struct boot_trace *it, initcall_t fn) { }
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100247static inline void start_boot_trace(void) { }
Frederic Weisbecker097d0362008-10-03 15:39:21 +0200248static inline void stop_boot_trace(void) { }
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100249#endif
250
251
252
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +0200253#endif /* _LINUX_FTRACE_H */