2008-05-12 15:20:42 -04:00
|
|
|
#ifndef _LINUX_FTRACE_H
|
|
|
|
|
#define _LINUX_FTRACE_H
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_FTRACE
|
|
|
|
|
|
|
|
|
|
#include <linux/linkage.h>
|
2008-05-16 04:41:53 -04:00
|
|
|
#include <linux/fs.h>
|
2008-05-12 15:20:42 -04:00
|
|
|
|
2008-05-12 15:20:43 -04:00
|
|
|
extern int ftrace_enabled;
|
|
|
|
|
extern int
|
|
|
|
|
ftrace_enable_sysctl(struct ctl_table *table, int write,
|
|
|
|
|
struct file *filp, void __user *buffer, size_t *lenp,
|
|
|
|
|
loff_t *ppos);
|
|
|
|
|
|
2008-05-12 15:20:42 -04:00
|
|
|
typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
|
|
|
|
|
|
|
|
|
|
struct ftrace_ops {
|
|
|
|
|
ftrace_func_t func;
|
|
|
|
|
struct ftrace_ops *next;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* The ftrace_ops must be a static and should also
|
|
|
|
|
* be read_mostly. These functions do modify read_mostly variables
|
|
|
|
|
* so use them sparely. Never free an ftrace_op or modify the
|
|
|
|
|
* next pointer after it has been registered. Even after unregistering
|
|
|
|
|
* it, the next pointer may still be used internally.
|
|
|
|
|
*/
|
|
|
|
|
int register_ftrace_function(struct ftrace_ops *ops);
|
|
|
|
|
int unregister_ftrace_function(struct ftrace_ops *ops);
|
|
|
|
|
void clear_ftrace_function(void);
|
|
|
|
|
|
|
|
|
|
extern void ftrace_stub(unsigned long a0, unsigned long a1);
|
|
|
|
|
|
|
|
|
|
#else /* !CONFIG_FTRACE */
|
|
|
|
|
# define register_ftrace_function(ops) do { } while (0)
|
|
|
|
|
# define unregister_ftrace_function(ops) do { } while (0)
|
|
|
|
|
# define clear_ftrace_function(ops) do { } while (0)
|
|
|
|
|
#endif /* CONFIG_FTRACE */
|
2008-05-12 15:20:42 -04:00
|
|
|
|
ftrace: dynamic enabling/disabling of function calls
This patch adds a feature to dynamically replace the ftrace code
with the jmps to allow a kernel with ftrace configured to run
as fast as it can without it configured.
The way this works, is on bootup (if ftrace is enabled), a ftrace
function is registered to record the instruction pointer of all
places that call the function.
Later, if there's still any code to patch, a kthread is awoken
(rate limited to at most once a second) that performs a stop_machine,
and replaces all the code that was called with a jmp over the call
to ftrace. It only replaces what was found the previous time. Typically
the system reaches equilibrium quickly after bootup and there's no code
patching needed at all.
e.g.
call ftrace /* 5 bytes */
is replaced with
jmp 3f /* jmp is 2 bytes and we jump 3 forward */
3:
When we want to enable ftrace for function tracing, the IP recording
is removed, and stop_machine is called again to replace all the locations
of that were recorded back to the call of ftrace. When it is disabled,
we replace the code back to the jmp.
Allocation is done by the kthread. If the ftrace recording function is
called, and we don't have any record slots available, then we simply
skip that call. Once a second a new page (if needed) is allocated for
recording new ftrace function calls. A large batch is allocated at
boot up to get most of the calls there.
Because we do this via stop_machine, we don't have to worry about another
CPU executing a ftrace call as we modify it. But we do need to worry
about NMI's so all functions that might be called via nmi must be
annotated with notrace_nmi. When this code is configured in, the NMI code
will not call notrace.
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
2008-05-12 15:20:42 -04:00
|
|
|
#ifdef CONFIG_DYNAMIC_FTRACE
|
|
|
|
|
# define FTRACE_HASHBITS 10
|
|
|
|
|
# define FTRACE_HASHSIZE (1<<FTRACE_HASHBITS)
|
|
|
|
|
|
2008-05-12 15:20:43 -04:00
|
|
|
enum {
|
2008-05-12 15:20:48 -04:00
|
|
|
FTRACE_FL_FREE = (1 << 0),
|
|
|
|
|
FTRACE_FL_FAILED = (1 << 1),
|
|
|
|
|
FTRACE_FL_FILTER = (1 << 2),
|
|
|
|
|
FTRACE_FL_ENABLED = (1 << 3),
|
2008-05-22 11:46:33 -04:00
|
|
|
FTRACE_FL_NOTRACE = (1 << 4),
|
2008-06-01 12:17:30 -04:00
|
|
|
FTRACE_FL_CONVERTED = (1 << 5),
|
2008-06-21 14:17:53 -04:00
|
|
|
FTRACE_FL_FROZEN = (1 << 6),
|
2008-05-12 15:20:43 -04:00
|
|
|
};
|
|
|
|
|
|
ftrace: dynamic enabling/disabling of function calls
This patch adds a feature to dynamically replace the ftrace code
with the jmps to allow a kernel with ftrace configured to run
as fast as it can without it configured.
The way this works, is on bootup (if ftrace is enabled), a ftrace
function is registered to record the instruction pointer of all
places that call the function.
Later, if there's still any code to patch, a kthread is awoken
(rate limited to at most once a second) that performs a stop_machine,
and replaces all the code that was called with a jmp over the call
to ftrace. It only replaces what was found the previous time. Typically
the system reaches equilibrium quickly after bootup and there's no code
patching needed at all.
e.g.
call ftrace /* 5 bytes */
is replaced with
jmp 3f /* jmp is 2 bytes and we jump 3 forward */
3:
When we want to enable ftrace for function tracing, the IP recording
is removed, and stop_machine is called again to replace all the locations
of that were recorded back to the call of ftrace. When it is disabled,
we replace the code back to the jmp.
Allocation is done by the kthread. If the ftrace recording function is
called, and we don't have any record slots available, then we simply
skip that call. Once a second a new page (if needed) is allocated for
recording new ftrace function calls. A large batch is allocated at
boot up to get most of the calls there.
Because we do this via stop_machine, we don't have to worry about another
CPU executing a ftrace call as we modify it. But we do need to worry
about NMI's so all functions that might be called via nmi must be
annotated with notrace_nmi. When this code is configured in, the NMI code
will not call notrace.
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
2008-05-12 15:20:42 -04:00
|
|
|
struct dyn_ftrace {
|
|
|
|
|
struct hlist_node node;
|
2008-06-21 14:17:27 -04:00
|
|
|
unsigned long ip; /* address of mcount call-site */
|
2008-05-12 15:20:43 -04:00
|
|
|
unsigned long flags;
|
ftrace: dynamic enabling/disabling of function calls
This patch adds a feature to dynamically replace the ftrace code
with the jmps to allow a kernel with ftrace configured to run
as fast as it can without it configured.
The way this works, is on bootup (if ftrace is enabled), a ftrace
function is registered to record the instruction pointer of all
places that call the function.
Later, if there's still any code to patch, a kthread is awoken
(rate limited to at most once a second) that performs a stop_machine,
and replaces all the code that was called with a jmp over the call
to ftrace. It only replaces what was found the previous time. Typically
the system reaches equilibrium quickly after bootup and there's no code
patching needed at all.
e.g.
call ftrace /* 5 bytes */
is replaced with
jmp 3f /* jmp is 2 bytes and we jump 3 forward */
3:
When we want to enable ftrace for function tracing, the IP recording
is removed, and stop_machine is called again to replace all the locations
of that were recorded back to the call of ftrace. When it is disabled,
we replace the code back to the jmp.
Allocation is done by the kthread. If the ftrace recording function is
called, and we don't have any record slots available, then we simply
skip that call. Once a second a new page (if needed) is allocated for
recording new ftrace function calls. A large batch is allocated at
boot up to get most of the calls there.
Because we do this via stop_machine, we don't have to worry about another
CPU executing a ftrace call as we modify it. But we do need to worry
about NMI's so all functions that might be called via nmi must be
annotated with notrace_nmi. When this code is configured in, the NMI code
will not call notrace.
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
2008-05-12 15:20:42 -04:00
|
|
|
};
|
|
|
|
|
|
2008-05-12 15:20:44 -04:00
|
|
|
int ftrace_force_update(void);
|
2008-05-12 15:20:45 -04:00
|
|
|
void ftrace_set_filter(unsigned char *buf, int len, int reset);
|
2008-05-12 15:20:44 -04:00
|
|
|
|
ftrace: dynamic enabling/disabling of function calls
This patch adds a feature to dynamically replace the ftrace code
with the jmps to allow a kernel with ftrace configured to run
as fast as it can without it configured.
The way this works, is on bootup (if ftrace is enabled), a ftrace
function is registered to record the instruction pointer of all
places that call the function.
Later, if there's still any code to patch, a kthread is awoken
(rate limited to at most once a second) that performs a stop_machine,
and replaces all the code that was called with a jmp over the call
to ftrace. It only replaces what was found the previous time. Typically
the system reaches equilibrium quickly after bootup and there's no code
patching needed at all.
e.g.
call ftrace /* 5 bytes */
is replaced with
jmp 3f /* jmp is 2 bytes and we jump 3 forward */
3:
When we want to enable ftrace for function tracing, the IP recording
is removed, and stop_machine is called again to replace all the locations
of that were recorded back to the call of ftrace. When it is disabled,
we replace the code back to the jmp.
Allocation is done by the kthread. If the ftrace recording function is
called, and we don't have any record slots available, then we simply
skip that call. Once a second a new page (if needed) is allocated for
recording new ftrace function calls. A large batch is allocated at
boot up to get most of the calls there.
Because we do this via stop_machine, we don't have to worry about another
CPU executing a ftrace call as we modify it. But we do need to worry
about NMI's so all functions that might be called via nmi must be
annotated with notrace_nmi. When this code is configured in, the NMI code
will not call notrace.
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
2008-05-12 15:20:42 -04:00
|
|
|
/* defined in arch */
|
2008-05-12 15:20:43 -04:00
|
|
|
extern int ftrace_ip_converted(unsigned long ip);
|
|
|
|
|
extern unsigned char *ftrace_nop_replace(void);
|
|
|
|
|
extern unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr);
|
2008-05-12 15:20:43 -04:00
|
|
|
extern int ftrace_dyn_arch_init(void *data);
|
|
|
|
|
extern int ftrace_mcount_set(unsigned long *data);
|
2008-05-12 15:20:43 -04:00
|
|
|
extern int ftrace_modify_code(unsigned long ip, unsigned char *old_code,
|
|
|
|
|
unsigned char *new_code);
|
2008-05-12 15:20:43 -04:00
|
|
|
extern int ftrace_update_ftrace_func(ftrace_func_t func);
|
|
|
|
|
extern void ftrace_caller(void);
|
|
|
|
|
extern void ftrace_call(void);
|
|
|
|
|
extern void mcount_call(void);
|
ftrace: user update and disable dynamic ftrace daemon
In dynamic ftrace, the mcount function starts off pointing to a stub
function that just returns.
On start up, the call to the stub is modified to point to a "record_ip"
function. The job of the record_ip function is to add the function to
a pre-allocated hash list. If the function is already there, it simply is
ignored, otherwise it is added to the list.
Later, a ftraced daemon wakes up and calls kstop_machine if any functions
have been recorded, and changes the calls to the recorded functions to
a simple nop. If no functions were recorded, the daemon goes back to sleep.
The daemon wakes up once a second to see if it needs to update any newly
recorded functions into nops. Usually it does not, but if a lot of code
has been executed for the first time in the kernel, the ftraced daemon
will call kstop_machine to update those into nops.
The problem currently is that there's no way to stop the daemon from doing
this, and it can cause unneeded latencies (800us which for some is bothersome).
This patch adds a new file /debugfs/tracing/ftraced_enabled. If the daemon
is active, reading this will return "enabled\n" and "disabled\n" when the
daemon is not running. To disable the daemon, the user can echo "0" or
"disable" into this file, and "1" or "enable" to re-enable the daemon.
Since the daemon is used to convert the functions into nops to increase
the performance of the system, I also added that anytime something is
written into the ftraced_enabled file, kstop_machine will run if there
are new functions that have been detected that need to be converted.
This way the user can disable the daemon but still be able to control the
conversion of the mcount calls to nops by simply,
"echo 0 > /debugfs/tracing/ftraced_enabled"
when they need to do more conversions.
To see the number of converted functions:
"cat /debugfs/tracing/dyn_ftrace_total_info"
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2008-05-27 20:48:37 -04:00
|
|
|
|
2008-06-21 14:17:53 -04:00
|
|
|
extern int skip_trace(unsigned long ip);
|
|
|
|
|
|
ftrace: user update and disable dynamic ftrace daemon
In dynamic ftrace, the mcount function starts off pointing to a stub
function that just returns.
On start up, the call to the stub is modified to point to a "record_ip"
function. The job of the record_ip function is to add the function to
a pre-allocated hash list. If the function is already there, it simply is
ignored, otherwise it is added to the list.
Later, a ftraced daemon wakes up and calls kstop_machine if any functions
have been recorded, and changes the calls to the recorded functions to
a simple nop. If no functions were recorded, the daemon goes back to sleep.
The daemon wakes up once a second to see if it needs to update any newly
recorded functions into nops. Usually it does not, but if a lot of code
has been executed for the first time in the kernel, the ftraced daemon
will call kstop_machine to update those into nops.
The problem currently is that there's no way to stop the daemon from doing
this, and it can cause unneeded latencies (800us which for some is bothersome).
This patch adds a new file /debugfs/tracing/ftraced_enabled. If the daemon
is active, reading this will return "enabled\n" and "disabled\n" when the
daemon is not running. To disable the daemon, the user can echo "0" or
"disable" into this file, and "1" or "enable" to re-enable the daemon.
Since the daemon is used to convert the functions into nops to increase
the performance of the system, I also added that anytime something is
written into the ftraced_enabled file, kstop_machine will run if there
are new functions that have been detected that need to be converted.
This way the user can disable the daemon but still be able to control the
conversion of the mcount calls to nops by simply,
"echo 0 > /debugfs/tracing/ftraced_enabled"
when they need to do more conversions.
To see the number of converted functions:
"cat /debugfs/tracing/dyn_ftrace_total_info"
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2008-05-27 20:48:37 -04:00
|
|
|
void ftrace_disable_daemon(void);
|
|
|
|
|
void ftrace_enable_daemon(void);
|
|
|
|
|
|
2008-05-12 15:20:44 -04:00
|
|
|
#else
|
2008-06-21 14:17:53 -04:00
|
|
|
# define skip_trace(ip) ({ 0; })
|
2008-05-12 15:20:49 -04:00
|
|
|
# define ftrace_force_update() ({ 0; })
|
|
|
|
|
# define ftrace_set_filter(buf, len, reset) do { } while (0)
|
ftrace: user update and disable dynamic ftrace daemon
In dynamic ftrace, the mcount function starts off pointing to a stub
function that just returns.
On start up, the call to the stub is modified to point to a "record_ip"
function. The job of the record_ip function is to add the function to
a pre-allocated hash list. If the function is already there, it simply is
ignored, otherwise it is added to the list.
Later, a ftraced daemon wakes up and calls kstop_machine if any functions
have been recorded, and changes the calls to the recorded functions to
a simple nop. If no functions were recorded, the daemon goes back to sleep.
The daemon wakes up once a second to see if it needs to update any newly
recorded functions into nops. Usually it does not, but if a lot of code
has been executed for the first time in the kernel, the ftraced daemon
will call kstop_machine to update those into nops.
The problem currently is that there's no way to stop the daemon from doing
this, and it can cause unneeded latencies (800us which for some is bothersome).
This patch adds a new file /debugfs/tracing/ftraced_enabled. If the daemon
is active, reading this will return "enabled\n" and "disabled\n" when the
daemon is not running. To disable the daemon, the user can echo "0" or
"disable" into this file, and "1" or "enable" to re-enable the daemon.
Since the daemon is used to convert the functions into nops to increase
the performance of the system, I also added that anytime something is
written into the ftraced_enabled file, kstop_machine will run if there
are new functions that have been detected that need to be converted.
This way the user can disable the daemon but still be able to control the
conversion of the mcount calls to nops by simply,
"echo 0 > /debugfs/tracing/ftraced_enabled"
when they need to do more conversions.
To see the number of converted functions:
"cat /debugfs/tracing/dyn_ftrace_total_info"
Signed-off-by: Steven Rostedt <srostedt@redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
2008-05-27 20:48:37 -04:00
|
|
|
# define ftrace_disable_daemon() do { } while (0)
|
|
|
|
|
# define ftrace_enable_daemon() do { } while (0)
|
2008-06-21 14:17:53 -04:00
|
|
|
#endif /* CONFIG_DYNAMIC_FTRACE */
|
2008-05-12 15:20:42 -04:00
|
|
|
|
2008-05-12 15:20:49 -04:00
|
|
|
/* totally disable ftrace - can not re-enable after this */
|
|
|
|
|
void ftrace_kill(void);
|
2008-07-10 20:58:15 -04:00
|
|
|
void ftrace_kill_atomic(void);
|
2008-05-12 15:20:49 -04:00
|
|
|
|
2008-05-12 15:20:43 -04:00
|
|
|
static inline void tracer_disable(void)
|
|
|
|
|
{
|
|
|
|
|
#ifdef CONFIG_FTRACE
|
|
|
|
|
ftrace_enabled = 0;
|
|
|
|
|
#endif
|
|
|
|
|
}
|
|
|
|
|
|
2008-08-15 03:40:25 -04:00
|
|
|
/* Ftrace disable/restore without lock. Some synchronization mechanism
|
|
|
|
|
* must be used to prevent ftrace_enabled to be changed between
|
|
|
|
|
* disable/restore. */
|
|
|
|
|
static inline int __ftrace_enabled_save(void)
|
|
|
|
|
{
|
|
|
|
|
#ifdef CONFIG_FTRACE
|
|
|
|
|
int saved_ftrace_enabled = ftrace_enabled;
|
|
|
|
|
ftrace_enabled = 0;
|
|
|
|
|
return saved_ftrace_enabled;
|
|
|
|
|
#else
|
|
|
|
|
return 0;
|
|
|
|
|
#endif
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static inline void __ftrace_enabled_restore(int enabled)
|
|
|
|
|
{
|
|
|
|
|
#ifdef CONFIG_FTRACE
|
|
|
|
|
ftrace_enabled = enabled;
|
|
|
|
|
#endif
|
|
|
|
|
}
|
|
|
|
|
|
2008-05-12 15:20:42 -04:00
|
|
|
#ifdef CONFIG_FRAME_POINTER
|
|
|
|
|
/* TODO: need to fix this for ARM */
|
|
|
|
|
# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
|
|
|
|
|
# define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
|
|
|
|
|
# define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
|
|
|
|
|
# define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
|
|
|
|
|
# define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
|
|
|
|
|
# define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
|
2008-05-12 15:20:51 -04:00
|
|
|
# define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
|
2008-05-12 15:20:42 -04:00
|
|
|
#else
|
|
|
|
|
# define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
|
|
|
|
|
# define CALLER_ADDR1 0UL
|
|
|
|
|
# define CALLER_ADDR2 0UL
|
|
|
|
|
# define CALLER_ADDR3 0UL
|
|
|
|
|
# define CALLER_ADDR4 0UL
|
|
|
|
|
# define CALLER_ADDR5 0UL
|
2008-05-12 15:20:51 -04:00
|
|
|
# define CALLER_ADDR6 0UL
|
2008-05-12 15:20:42 -04:00
|
|
|
#endif
|
|
|
|
|
|
2008-05-12 15:20:42 -04:00
|
|
|
#ifdef CONFIG_IRQSOFF_TRACER
|
2008-02-25 07:38:05 -05:00
|
|
|
extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
|
|
|
|
|
extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
|
2008-05-12 15:20:42 -04:00
|
|
|
#else
|
|
|
|
|
# define time_hardirqs_on(a0, a1) do { } while (0)
|
|
|
|
|
# define time_hardirqs_off(a0, a1) do { } while (0)
|
|
|
|
|
#endif
|
|
|
|
|
|
2008-05-12 15:20:42 -04:00
|
|
|
#ifdef CONFIG_PREEMPT_TRACER
|
2008-02-25 07:38:05 -05:00
|
|
|
extern void trace_preempt_on(unsigned long a0, unsigned long a1);
|
|
|
|
|
extern void trace_preempt_off(unsigned long a0, unsigned long a1);
|
2008-05-12 15:20:42 -04:00
|
|
|
#else
|
|
|
|
|
# define trace_preempt_on(a0, a1) do { } while (0)
|
|
|
|
|
# define trace_preempt_off(a0, a1) do { } while (0)
|
|
|
|
|
#endif
|
|
|
|
|
|
2008-05-27 19:22:08 -04:00
|
|
|
#ifdef CONFIG_TRACING
|
2008-05-12 15:21:15 -04:00
|
|
|
extern void
|
|
|
|
|
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
|
|
|
|
|
#else
|
|
|
|
|
static inline void
|
|
|
|
|
ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
|
|
|
|
|
#endif
|
|
|
|
|
|
2008-05-12 15:20:42 -04:00
|
|
|
#endif /* _LINUX_FTRACE_H */
|
