include/linux/ftrace.h

   1 #ifndef _LINUX_FTRACE_H
   2 #define _LINUX_FTRACE_H
   3
   4 #ifdef CONFIG_FTRACE
   5
   6 #include <linux/linkage.h>
   7 #include <linux/fs.h>
   8
   9 extern int ftrace_enabled;
  10 extern int
  11 ftrace_enable_sysctl(struct ctl_table *table, int write,
  12                      struct file *filp, void __user *buffer, size_t *lenp,
  13                      loff_t *ppos);
  14
  15 typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip);
  16
  17 struct ftrace_ops {
  18         ftrace_func_t     func;
  19         struct ftrace_ops *next;
  20 };
  21
  22 /*
  23  * The ftrace_ops must be a static and should also
  24  * be read_mostly.  These functions do modify read_mostly variables
  25  * so use them sparely. Never free an ftrace_op or modify the
  26  * next pointer after it has been registered. Even after unregistering
  27  * it, the next pointer may still be used internally.
  28  */
  29 int register_ftrace_function(struct ftrace_ops *ops);
  30 int unregister_ftrace_function(struct ftrace_ops *ops);
  31 void clear_ftrace_function(void);
  32
  33 extern void ftrace_stub(unsigned long a0, unsigned long a1);
  34
  35 #else /* !CONFIG_FTRACE */
  36 # define register_ftrace_function(ops) do { } while (0)
  37 # define unregister_ftrace_function(ops) do { } while (0)
  38 # define clear_ftrace_function(ops) do { } while (0)
  39 static inline void ftrace_kill_atomic(void) { }
  40 #endif /* CONFIG_FTRACE */
  41
  42 #ifdef CONFIG_DYNAMIC_FTRACE
  43 # define FTRACE_HASHBITS        10
  44 # define FTRACE_HASHSIZE        (1<<FTRACE_HASHBITS)
  45
  46 enum {
  47         FTRACE_FL_FREE          = (1 << 0),
  48         FTRACE_FL_FAILED        = (1 << 1),
  49         FTRACE_FL_FILTER        = (1 << 2),
  50         FTRACE_FL_ENABLED       = (1 << 3),
  51         FTRACE_FL_NOTRACE       = (1 << 4),
  52         FTRACE_FL_CONVERTED     = (1 << 5),
  53         FTRACE_FL_FROZEN        = (1 << 6),
  54 };
  55
  56 struct dyn_ftrace {
  57         struct hlist_node node;
  58         unsigned long     ip; /* address of mcount call-site */
  59         unsigned long     flags;
  60 };
  61
  62 int ftrace_force_update(void);
  63 void ftrace_set_filter(unsigned char *buf, int len, int reset);
  64
  65 /* defined in arch */
  66 extern int ftrace_ip_converted(unsigned long ip);
  67 extern unsigned char *ftrace_nop_replace(void);
  68 extern unsigned char *ftrace_call_replace(unsigned long ip, unsigned long addr);
  69 extern int ftrace_dyn_arch_init(void *data);
  70 extern int ftrace_mcount_set(unsigned long *data);
  71 extern int ftrace_modify_code(unsigned long ip, unsigned char *old_code,
  72                               unsigned char *new_code);
  73 extern int ftrace_update_ftrace_func(ftrace_func_t func);
  74 extern void ftrace_caller(void);
  75 extern void ftrace_call(void);
  76 extern void mcount_call(void);
  77
  78 extern int skip_trace(unsigned long ip);
  79
  80 void ftrace_disable_daemon(void);
  81 void ftrace_enable_daemon(void);
  82
  83 #else
  84 # define skip_trace(ip)                         ({ 0; })
  85 # define ftrace_force_update()                  ({ 0; })
  86 # define ftrace_set_filter(buf, len, reset)     do { } while (0)
  87 # define ftrace_disable_daemon()                do { } while (0)
  88 # define ftrace_enable_daemon()                 do { } while (0)
  89 #endif /* CONFIG_DYNAMIC_FTRACE */
  90
  91 /* totally disable ftrace - can not re-enable after this */
  92 void ftrace_kill(void);
  93 void ftrace_kill_atomic(void);
  94
  95 static inline void tracer_disable(void)
  96 {
  97 #ifdef CONFIG_FTRACE
  98         ftrace_enabled = 0;
  99 #endif
 100 }
 101
 102 /*
 103  * Ftrace disable/restore without lock. Some synchronization mechanism
 104  * must be used to prevent ftrace_enabled to be changed between
 105  * disable/restore.
 106  */
 107 static inline int __ftrace_enabled_save(void)
 108 {
 109 #ifdef CONFIG_FTRACE
 110         int saved_ftrace_enabled = ftrace_enabled;
 111         ftrace_enabled = 0;
 112         return saved_ftrace_enabled;
 113 #else
 114         return 0;
 115 #endif
 116 }
 117
 118 static inline void __ftrace_enabled_restore(int enabled)
 119 {
 120 #ifdef CONFIG_FTRACE
 121         ftrace_enabled = enabled;
 122 #endif
 123 }
 124
 125 #ifdef CONFIG_FRAME_POINTER
 126 /* TODO: need to fix this for ARM */
 127 # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
 128 # define CALLER_ADDR1 ((unsigned long)__builtin_return_address(1))
 129 # define CALLER_ADDR2 ((unsigned long)__builtin_return_address(2))
 130 # define CALLER_ADDR3 ((unsigned long)__builtin_return_address(3))
 131 # define CALLER_ADDR4 ((unsigned long)__builtin_return_address(4))
 132 # define CALLER_ADDR5 ((unsigned long)__builtin_return_address(5))
 133 # define CALLER_ADDR6 ((unsigned long)__builtin_return_address(6))
 134 #else
 135 # define CALLER_ADDR0 ((unsigned long)__builtin_return_address(0))
 136 # define CALLER_ADDR1 0UL
 137 # define CALLER_ADDR2 0UL
 138 # define CALLER_ADDR3 0UL
 139 # define CALLER_ADDR4 0UL
 140 # define CALLER_ADDR5 0UL
 141 # define CALLER_ADDR6 0UL
 142 #endif
 143
 144 #ifdef CONFIG_IRQSOFF_TRACER
 145   extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
 146   extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
 147 #else
 148 # define time_hardirqs_on(a0, a1)               do { } while (0)
 149 # define time_hardirqs_off(a0, a1)              do { } while (0)
 150 #endif
 151
 152 #ifdef CONFIG_PREEMPT_TRACER
 153   extern void trace_preempt_on(unsigned long a0, unsigned long a1);
 154   extern void trace_preempt_off(unsigned long a0, unsigned long a1);
 155 #else
 156 # define trace_preempt_on(a0, a1)               do { } while (0)
 157 # define trace_preempt_off(a0, a1)              do { } while (0)
 158 #endif
 159
 160 #ifdef CONFIG_TRACING
 161 extern void
 162 ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
 163
 164 /**
 165  * ftrace_printk - printf formatting in the ftrace buffer
 166  * @fmt: the printf format for printing
 167  *
 168  * Note: __ftrace_printk is an internal function for ftrace_printk and
 169  *       the @ip is passed in via the ftrace_printk macro.
 170  *
 171  * This function allows a kernel developer to debug fast path sections
 172  * that printk is not appropriate for. By scattering in various
 173  * printk like tracing in the code, a developer can quickly see
 174  * where problems are occurring.
 175  *
 176  * This is intended as a debugging tool for the developer only.
 177  * Please refrain from leaving ftrace_printks scattered around in
 178  * your code.
 179  */
 180 # define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
 181 extern int
 182 __ftrace_printk(unsigned long ip, const char *fmt, ...)
 183         __attribute__ ((format (printf, 2, 3)));
 184 extern void ftrace_dump(void);
 185 #else
 186 static inline void
 187 ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3) { }
 188 static inline int
 189 ftrace_printk(const char *fmt, ...) __attribute__ ((format (printf, 1, 0)));
 190
 191 static inline int
 192 ftrace_printk(const char *fmt, ...)
 193 {
 194         return 0;
 195 }
 196 static inline void ftrace_dump(void) { }
 197 #endif
 198
 199 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
 200 extern void ftrace_init(void);
 201 extern void ftrace_init_module(unsigned long *start, unsigned long *end);
 202 extern void ftrace_release(void *start, unsigned long size);
 203 #else
 204 static inline void ftrace_init(void) { }
 205 static inline void
 206 ftrace_init_module(unsigned long *start, unsigned long *end) { }
 207 static inline void ftrace_release(void *start, unsigned long size) { }
 208 #endif
 209
 210
 211 #endif /* _LINUX_FTRACE_H */