blob: a3d46151be195cec1d701b7058ec98662860e65b [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 Noonaneb7fa9352008-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
Ingo Molnar3e1932a2008-10-02 17:45:47 +020011#ifdef CONFIG_FTRACE
12
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
39#else /* !CONFIG_FTRACE */
40# 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)
Ingo Molnarc5131ad2008-08-15 18:22:09 +020043static inline void ftrace_kill_atomic(void) { }
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020044#endif /* CONFIG_FTRACE */
Steven Rostedt352ad252008-05-12 21:20:42 +020045
Steven Rostedt3d083392008-05-12 21:20:42 +020046#ifdef CONFIG_DYNAMIC_FTRACE
47# define FTRACE_HASHBITS 10
48# define FTRACE_HASHSIZE (1<<FTRACE_HASHBITS)
49
Steven Rostedt3c1720f2008-05-12 21:20:43 +020050enum {
Steven Rostedt37ad5082008-05-12 21:20:48 +020051 FTRACE_FL_FREE = (1 << 0),
52 FTRACE_FL_FAILED = (1 << 1),
53 FTRACE_FL_FILTER = (1 << 2),
54 FTRACE_FL_ENABLED = (1 << 3),
Steven Rostedt41c52c02008-05-22 11:46:33 -040055 FTRACE_FL_NOTRACE = (1 << 4),
Abhishek Sagar0eb96702008-06-01 21:47:30 +053056 FTRACE_FL_CONVERTED = (1 << 5),
Abhishek Sagarecea6562008-06-21 23:47:53 +053057 FTRACE_FL_FROZEN = (1 << 6),
Steven Rostedt3c1720f2008-05-12 21:20:43 +020058};
59
Steven Rostedt3d083392008-05-12 21:20:42 +020060struct dyn_ftrace {
61 struct hlist_node node;
Abhishek Sagar395a59d2008-06-21 23:47:27 +053062 unsigned long ip; /* address of mcount call-site */
Steven Rostedt3c1720f2008-05-12 21:20:43 +020063 unsigned long flags;
Steven Rostedt3d083392008-05-12 21:20:42 +020064};
65
Steven Rostedte1c08bd2008-05-12 21:20:44 +020066int ftrace_force_update(void);
Steven Rostedt77a2b372008-05-12 21:20:45 +020067void ftrace_set_filter(unsigned char *buf, int len, int reset);
Steven Rostedte1c08bd2008-05-12 21:20:44 +020068
Steven Rostedt3d083392008-05-12 21:20:42 +020069/* defined in arch */
Steven Rostedt3c1720f2008-05-12 21:20:43 +020070extern int ftrace_ip_converted(unsigned long ip);
71extern unsigned char *ftrace_nop_replace(void);
72extern unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr);
Steven Rostedtd61f82d2008-05-12 21:20:43 +020073extern int ftrace_dyn_arch_init(void *data);
74extern int ftrace_mcount_set(unsigned long *data);
Steven Rostedt3c1720f2008-05-12 21:20:43 +020075extern int ftrace_modify_code(unsigned long ip, unsigned char *old_code,
76 unsigned char *new_code);
Steven Rostedtd61f82d2008-05-12 21:20:43 +020077extern int ftrace_update_ftrace_func(ftrace_func_t func);
78extern void ftrace_caller(void);
79extern void ftrace_call(void);
80extern void mcount_call(void);
Steven Rostedtad90c0e2008-05-27 20:48:37 -040081
Abhishek Sagarecea6562008-06-21 23:47:53 +053082extern int skip_trace(unsigned long ip);
83
Steven Rostedtc0719e52008-09-06 01:06:03 -040084extern void ftrace_release(void *start, unsigned long size);
85
86extern void ftrace_disable_daemon(void);
87extern void ftrace_enable_daemon(void);
Steven Rostedtad90c0e2008-05-27 20:48:37 -040088
Steven Rostedte1c08bd2008-05-12 21:20:44 +020089#else
Abhishek Sagarecea6562008-06-21 23:47:53 +053090# define skip_trace(ip) ({ 0; })
Ingo Molnaraeaee8a2008-05-12 21:20:49 +020091# define ftrace_force_update() ({ 0; })
92# define ftrace_set_filter(buf, len, reset) do { } while (0)
Steven Rostedtad90c0e2008-05-27 20:48:37 -040093# define ftrace_disable_daemon() do { } while (0)
94# define ftrace_enable_daemon() do { } while (0)
Steven Rostedtc0719e52008-09-06 01:06:03 -040095static inline void ftrace_release(void *start, unsigned long size) { }
Abhishek Sagarecea6562008-06-21 23:47:53 +053096#endif /* CONFIG_DYNAMIC_FTRACE */
Steven Rostedt352ad252008-05-12 21:20:42 +020097
Ingo Molnaraeaee8a2008-05-12 21:20:49 +020098/* totally disable ftrace - can not re-enable after this */
99void ftrace_kill(void);
Steven Rostedta2bb6a32008-07-10 20:58:15 -0400100void ftrace_kill_atomic(void);
Ingo Molnaraeaee8a2008-05-12 21:20:49 +0200101
Ingo Molnarf43fdad2008-05-12 21:20:43 +0200102static inline void tracer_disable(void)
103{
104#ifdef CONFIG_FTRACE
105 ftrace_enabled = 0;
106#endif
107}
108
Huang Ying37002732008-08-18 16:24:56 +0800109/*
110 * Ftrace disable/restore without lock. Some synchronization mechanism
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700111 * must be used to prevent ftrace_enabled to be changed between
Huang Ying37002732008-08-18 16:24:56 +0800112 * disable/restore.
113 */
Huang Ying9bdeb7b2008-08-15 00:40:25 -0700114static inline int __ftrace_enabled_save(void)
115{
116#ifdef CONFIG_FTRACE
117 int saved_ftrace_enabled = ftrace_enabled;
118 ftrace_enabled = 0;
119 return saved_ftrace_enabled;
120#else
121 return 0;
122#endif
123}
124
125static inline void __ftrace_enabled_restore(int enabled)
126{
127#ifdef CONFIG_FTRACE
128 ftrace_enabled = enabled;
129#endif
130}
131
Steven Rostedt352ad252008-05-12 21:20:42 +0200132#ifdef CONFIG_FRAME_POINTER
133/* TODO: need to fix this for ARM */
134# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
135# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
136# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
137# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
138# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
139# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
Ingo Molnar86387f72008-05-12 21:20:51 +0200140# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
Steven Rostedt352ad252008-05-12 21:20:42 +0200141#else
142# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
143# define CALLER_ADDR1 0UL
144# define CALLER_ADDR2 0UL
145# define CALLER_ADDR3 0UL
146# define CALLER_ADDR4 0UL
147# define CALLER_ADDR5 0UL
Ingo Molnar86387f72008-05-12 21:20:51 +0200148# define CALLER_ADDR6 0UL
Steven Rostedt352ad252008-05-12 21:20:42 +0200149#endif
150
Steven Rostedt81d68a92008-05-12 21:20:42 +0200151#ifdef CONFIG_IRQSOFF_TRACER
Ingo Molnar489f1392008-02-25 13:38:05 +0100152 extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
153 extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
Steven Rostedt81d68a92008-05-12 21:20:42 +0200154#else
155# define time_hardirqs_on(a0, a1) do { } while (0)
156# define time_hardirqs_off(a0, a1) do { } while (0)
157#endif
158
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200159#ifdef CONFIG_PREEMPT_TRACER
Ingo Molnar489f1392008-02-25 13:38:05 +0100160 extern void trace_preempt_on(unsigned long a0, unsigned long a1);
161 extern void trace_preempt_off(unsigned long a0, unsigned long a1);
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200162#else
163# define trace_preempt_on(a0, a1) do { } while (0)
164# define trace_preempt_off(a0, a1) do { } while (0)
165#endif
166
Ingo Molnarb1829d22008-05-28 01:22:08 +0200167#ifdef CONFIG_TRACING
Ingo Molnar74f4e362008-05-12 21:21:15 +0200168extern void
169ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
Steven Rostedt2f2c99d2008-08-01 16:45:49 -0400170
171/**
172 * ftrace_printk - printf formatting in the ftrace buffer
173 * @fmt: the printf format for printing
174 *
175 * Note: __ftrace_printk is an internal function for ftrace_printk and
176 * the @ip is passed in via the ftrace_printk macro.
177 *
178 * This function allows a kernel developer to debug fast path sections
179 * that printk is not appropriate for. By scattering in various
180 * printk like tracing in the code, a developer can quickly see
181 * where problems are occurring.
182 *
183 * This is intended as a debugging tool for the developer only.
184 * Please refrain from leaving ftrace_printks scattered around in
185 * your code.
186 */
187# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400188extern int
189__ftrace_printk(unsigned long ip, const char *fmt, ...)
190 __attribute__ ((format (printf, 2, 3)));
Steven Rostedt3f5a54e2008-07-30 22:36:46 -0400191extern void ftrace_dump(void);
Ingo Molnar74f4e362008-05-12 21:21:15 +0200192#else
193static inline void
194ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400195static inline int
Ingo Molnar7b928c22008-08-15 17:48:02 +0200196ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0)));
197
198static inline int
199ftrace_printk(const char *fmt, ...)
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400200{
201 return 0;
202}
Steven Rostedt3f5a54e2008-07-30 22:36:46 -0400203static inline void ftrace_dump(void) { }
Ingo Molnar74f4e362008-05-12 21:21:15 +0200204#endif
205
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400206#ifdef CONFIG_FTRACE_MCOUNT_RECORD
207extern void ftrace_init(void);
Steven Rostedt90d595f2008-08-14 15:45:09 -0400208extern void ftrace_init_module(unsigned long *start, unsigned long *end);
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400209#else
210static inline void ftrace_init(void) { }
Steven Rostedt90d595f2008-08-14 15:45:09 -0400211static inline void
212ftrace_init_module(unsigned long *start, unsigned long *end) { }
Steven Rostedt68bf21a2008-08-14 15:45:08 -0400213#endif
214
Steven Rostedtdd0e5452008-08-01 12:26:41 -0400215
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100216struct boot_trace {
217 pid_t caller;
Tim Birdca538f62008-10-09 15:23:05 -0700218 char func[KSYM_NAME_LEN];
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100219 int result;
Tim Birdca538f62008-10-09 15:23:05 -0700220 unsigned long long duration; /* usecs */
Frederic Weisbeckercb5ab742008-10-02 12:59:20 +0200221 ktime_t calltime;
222 ktime_t rettime;
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100223};
224
225#ifdef CONFIG_BOOT_TRACER
Frederic Weisbecker56010202008-10-02 13:26:05 +0200226extern void trace_boot(struct boot_trace *it, initcall_t fn);
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100227extern void start_boot_trace(void);
Frederic Weisbecker097d0362008-10-03 15:39:21 +0200228extern void stop_boot_trace(void);
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100229#else
Frederic Weisbecker56010202008-10-02 13:26:05 +0200230static inline void trace_boot(struct boot_trace *it, initcall_t fn) { }
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100231static inline void start_boot_trace(void) { }
Frederic Weisbecker097d0362008-10-03 15:39:21 +0200232static inline void stop_boot_trace(void) { }
Frédéric Weisbeckerd13744c2008-09-23 11:32:08 +0100233#endif
234
235
236
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +0200237#endif /* _LINUX_FTRACE_H */