Linux-libre 3.16.78-gnu
[librecmc/linux-libre.git] / include / linux / ftrace.h
1 /*
2  * Ftrace header.  For implementation details beyond the random comments
3  * scattered below, see: Documentation/trace/ftrace-design.txt
4  */
5
6 #ifndef _LINUX_FTRACE_H
7 #define _LINUX_FTRACE_H
8
9 #include <linux/trace_clock.h>
10 #include <linux/kallsyms.h>
11 #include <linux/linkage.h>
12 #include <linux/bitops.h>
13 #include <linux/ptrace.h>
14 #include <linux/ktime.h>
15 #include <linux/sched.h>
16 #include <linux/types.h>
17 #include <linux/init.h>
18 #include <linux/fs.h>
19
20 #include <asm/ftrace.h>
21
22 /*
23  * If the arch supports passing the variable contents of
24  * function_trace_op as the third parameter back from the
25  * mcount call, then the arch should define this as 1.
26  */
27 #ifndef ARCH_SUPPORTS_FTRACE_OPS
28 #define ARCH_SUPPORTS_FTRACE_OPS 0
29 #endif
30
31 /*
32  * If the arch's mcount caller does not support all of ftrace's
33  * features, then it must call an indirect function that
34  * does. Or at least does enough to prevent any unwelcomed side effects.
35  */
36 #if !defined(CONFIG_HAVE_FUNCTION_TRACE_MCOUNT_TEST) || \
37         !ARCH_SUPPORTS_FTRACE_OPS
38 # define FTRACE_FORCE_LIST_FUNC 1
39 #else
40 # define FTRACE_FORCE_LIST_FUNC 0
41 #endif
42
43
44 struct module;
45 struct ftrace_hash;
46
47 #ifdef CONFIG_FUNCTION_TRACER
48
49 extern int ftrace_enabled;
50 extern int
51 ftrace_enable_sysctl(struct ctl_table *table, int write,
52                      void __user *buffer, size_t *lenp,
53                      loff_t *ppos);
54
55 struct ftrace_ops;
56
57 typedef void (*ftrace_func_t)(unsigned long ip, unsigned long parent_ip,
58                               struct ftrace_ops *op, struct pt_regs *regs);
59
60 /*
61  * FTRACE_OPS_FL_* bits denote the state of ftrace_ops struct and are
62  * set in the flags member.
63  *
64  * ENABLED - set/unset when ftrace_ops is registered/unregistered
65  * DYNAMIC - set when ftrace_ops is registered to denote dynamically
66  *           allocated ftrace_ops which need special care
67  * CONTROL - set manualy by ftrace_ops user to denote the ftrace_ops
68  *           could be controled by following calls:
69  *             ftrace_function_local_enable
70  *             ftrace_function_local_disable
71  * SAVE_REGS - The ftrace_ops wants regs saved at each function called
72  *            and passed to the callback. If this flag is set, but the
73  *            architecture does not support passing regs
74  *            (CONFIG_DYNAMIC_FTRACE_WITH_REGS is not defined), then the
75  *            ftrace_ops will fail to register, unless the next flag
76  *            is set.
77  * SAVE_REGS_IF_SUPPORTED - This is the same as SAVE_REGS, but if the
78  *            handler can handle an arch that does not save regs
79  *            (the handler tests if regs == NULL), then it can set
80  *            this flag instead. It will not fail registering the ftrace_ops
81  *            but, the regs field will be NULL if the arch does not support
82  *            passing regs to the handler.
83  *            Note, if this flag is set, the SAVE_REGS flag will automatically
84  *            get set upon registering the ftrace_ops, if the arch supports it.
85  * RECURSION_SAFE - The ftrace_ops can set this to tell the ftrace infrastructure
86  *            that the call back has its own recursion protection. If it does
87  *            not set this, then the ftrace infrastructure will add recursion
88  *            protection for the caller.
89  * STUB   - The ftrace_ops is just a place holder.
90  * INITIALIZED - The ftrace_ops has already been initialized (first use time
91  *            register_ftrace_function() is called, it will initialized the ops)
92  * DELETED - The ops are being deleted, do not let them be registered again.
93  */
94 enum {
95         FTRACE_OPS_FL_ENABLED                   = 1 << 0,
96         FTRACE_OPS_FL_DYNAMIC                   = 1 << 1,
97         FTRACE_OPS_FL_CONTROL                   = 1 << 2,
98         FTRACE_OPS_FL_SAVE_REGS                 = 1 << 3,
99         FTRACE_OPS_FL_SAVE_REGS_IF_SUPPORTED    = 1 << 4,
100         FTRACE_OPS_FL_RECURSION_SAFE            = 1 << 5,
101         FTRACE_OPS_FL_STUB                      = 1 << 6,
102         FTRACE_OPS_FL_INITIALIZED               = 1 << 7,
103         FTRACE_OPS_FL_DELETED                   = 1 << 8,
104 };
105
106 #ifdef CONFIG_DYNAMIC_FTRACE
107 /* The hash used to know what functions callbacks trace */
108 struct ftrace_ops_hash {
109         struct ftrace_hash              *notrace_hash;
110         struct ftrace_hash              *filter_hash;
111         struct mutex                    regex_lock;
112 };
113 #endif
114
115 /*
116  * Note, ftrace_ops can be referenced outside of RCU protection.
117  * (Although, for perf, the control ops prevent that). If ftrace_ops is
118  * allocated and not part of kernel core data, the unregistering of it will
119  * perform a scheduling on all CPUs to make sure that there are no more users.
120  * Depending on the load of the system that may take a bit of time.
121  *
122  * Any private data added must also take care not to be freed and if private
123  * data is added to a ftrace_ops that is in core code, the user of the
124  * ftrace_ops must perform a schedule_on_each_cpu() before freeing it.
125  */
126 struct ftrace_ops {
127         ftrace_func_t                   func;
128         struct ftrace_ops               *next;
129         unsigned long                   flags;
130         int __percpu                    *disabled;
131         void                            *private;
132 #ifdef CONFIG_DYNAMIC_FTRACE
133         struct ftrace_ops_hash          local_hash;
134         struct ftrace_ops_hash          *func_hash;
135         struct mutex                    regex_lock;
136 #endif
137 };
138
139 extern int function_trace_stop;
140
141 /*
142  * Type of the current tracing.
143  */
144 enum ftrace_tracing_type_t {
145         FTRACE_TYPE_ENTER = 0, /* Hook the call of the function */
146         FTRACE_TYPE_RETURN,     /* Hook the return of the function */
147 };
148
149 /* Current tracing type, default is FTRACE_TYPE_ENTER */
150 extern enum ftrace_tracing_type_t ftrace_tracing_type;
151
152 /**
153  * ftrace_stop - stop function tracer.
154  *
155  * A quick way to stop the function tracer. Note this an on off switch,
156  * it is not something that is recursive like preempt_disable.
157  * This does not disable the calling of mcount, it only stops the
158  * calling of functions from mcount.
159  */
160 static inline void ftrace_stop(void)
161 {
162         function_trace_stop = 1;
163 }
164
165 /**
166  * ftrace_start - start the function tracer.
167  *
168  * This function is the inverse of ftrace_stop. This does not enable
169  * the function tracing if the function tracer is disabled. This only
170  * sets the function tracer flag to continue calling the functions
171  * from mcount.
172  */
173 static inline void ftrace_start(void)
174 {
175         function_trace_stop = 0;
176 }
177
178 /*
179  * The ftrace_ops must be a static and should also
180  * be read_mostly.  These functions do modify read_mostly variables
181  * so use them sparely. Never free an ftrace_op or modify the
182  * next pointer after it has been registered. Even after unregistering
183  * it, the next pointer may still be used internally.
184  */
185 int register_ftrace_function(struct ftrace_ops *ops);
186 int unregister_ftrace_function(struct ftrace_ops *ops);
187 void clear_ftrace_function(void);
188
189 /**
190  * ftrace_function_local_enable - enable controlled ftrace_ops on current cpu
191  *
192  * This function enables tracing on current cpu by decreasing
193  * the per cpu control variable.
194  * It must be called with preemption disabled and only on ftrace_ops
195  * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
196  * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
197  */
198 static inline void ftrace_function_local_enable(struct ftrace_ops *ops)
199 {
200         if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
201                 return;
202
203         (*this_cpu_ptr(ops->disabled))--;
204 }
205
206 /**
207  * ftrace_function_local_disable - enable controlled ftrace_ops on current cpu
208  *
209  * This function enables tracing on current cpu by decreasing
210  * the per cpu control variable.
211  * It must be called with preemption disabled and only on ftrace_ops
212  * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
213  * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
214  */
215 static inline void ftrace_function_local_disable(struct ftrace_ops *ops)
216 {
217         if (WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL)))
218                 return;
219
220         (*this_cpu_ptr(ops->disabled))++;
221 }
222
223 /**
224  * ftrace_function_local_disabled - returns ftrace_ops disabled value
225  *                                  on current cpu
226  *
227  * This function returns value of ftrace_ops::disabled on current cpu.
228  * It must be called with preemption disabled and only on ftrace_ops
229  * registered with FTRACE_OPS_FL_CONTROL. If called without preemption
230  * disabled, this_cpu_ptr will complain when CONFIG_DEBUG_PREEMPT is enabled.
231  */
232 static inline int ftrace_function_local_disabled(struct ftrace_ops *ops)
233 {
234         WARN_ON_ONCE(!(ops->flags & FTRACE_OPS_FL_CONTROL));
235         return *this_cpu_ptr(ops->disabled);
236 }
237
238 extern void ftrace_stub(unsigned long a0, unsigned long a1,
239                         struct ftrace_ops *op, struct pt_regs *regs);
240
241 #else /* !CONFIG_FUNCTION_TRACER */
242 /*
243  * (un)register_ftrace_function must be a macro since the ops parameter
244  * must not be evaluated.
245  */
246 #define register_ftrace_function(ops) ({ 0; })
247 #define unregister_ftrace_function(ops) ({ 0; })
248 static inline int ftrace_nr_registered_ops(void)
249 {
250         return 0;
251 }
252 static inline void clear_ftrace_function(void) { }
253 static inline void ftrace_kill(void) { }
254 static inline void ftrace_stop(void) { }
255 static inline void ftrace_start(void) { }
256 #endif /* CONFIG_FUNCTION_TRACER */
257
258 #ifdef CONFIG_STACK_TRACER
259 extern int stack_tracer_enabled;
260 int
261 stack_trace_sysctl(struct ctl_table *table, int write,
262                    void __user *buffer, size_t *lenp,
263                    loff_t *ppos);
264 #endif
265
266 struct ftrace_func_command {
267         struct list_head        list;
268         char                    *name;
269         int                     (*func)(struct ftrace_hash *hash,
270                                         char *func, char *cmd,
271                                         char *params, int enable);
272 };
273
274 #ifdef CONFIG_DYNAMIC_FTRACE
275
276 int ftrace_arch_code_modify_prepare(void);
277 int ftrace_arch_code_modify_post_process(void);
278
279 void ftrace_bug(int err, unsigned long ip);
280
281 struct seq_file;
282
283 struct ftrace_probe_ops {
284         void                    (*func)(unsigned long ip,
285                                         unsigned long parent_ip,
286                                         void **data);
287         int                     (*init)(struct ftrace_probe_ops *ops,
288                                         unsigned long ip, void **data);
289         void                    (*free)(struct ftrace_probe_ops *ops,
290                                         unsigned long ip, void **data);
291         int                     (*print)(struct seq_file *m,
292                                          unsigned long ip,
293                                          struct ftrace_probe_ops *ops,
294                                          void *data);
295 };
296
297 extern int
298 register_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
299                               void *data);
300 extern void
301 unregister_ftrace_function_probe(char *glob, struct ftrace_probe_ops *ops,
302                                 void *data);
303 extern void
304 unregister_ftrace_function_probe_func(char *glob, struct ftrace_probe_ops *ops);
305 extern void unregister_ftrace_function_probe_all(char *glob);
306
307 extern int ftrace_text_reserved(const void *start, const void *end);
308
309 extern int ftrace_nr_registered_ops(void);
310
311 /*
312  * The dyn_ftrace record's flags field is split into two parts.
313  * the first part which is '0-FTRACE_REF_MAX' is a counter of
314  * the number of callbacks that have registered the function that
315  * the dyn_ftrace descriptor represents.
316  *
317  * The second part is a mask:
318  *  ENABLED - the function is being traced
319  *  REGS    - the record wants the function to save regs
320  *  REGS_EN - the function is set up to save regs.
321  *
322  * When a new ftrace_ops is registered and wants a function to save
323  * pt_regs, the rec->flag REGS is set. When the function has been
324  * set up to save regs, the REG_EN flag is set. Once a function
325  * starts saving regs it will do so until all ftrace_ops are removed
326  * from tracing that function.
327  */
328 enum {
329         FTRACE_FL_ENABLED       = (1UL << 29),
330         FTRACE_FL_REGS          = (1UL << 30),
331         FTRACE_FL_REGS_EN       = (1UL << 31)
332 };
333
334 #define FTRACE_FL_MASK          (0x7UL << 29)
335 #define FTRACE_REF_MAX          ((1UL << 29) - 1)
336
337 struct dyn_ftrace {
338         unsigned long           ip; /* address of mcount call-site */
339         unsigned long           flags;
340         struct dyn_arch_ftrace  arch;
341 };
342
343 int ftrace_force_update(void);
344 int ftrace_set_filter_ip(struct ftrace_ops *ops, unsigned long ip,
345                          int remove, int reset);
346 int ftrace_set_filter(struct ftrace_ops *ops, unsigned char *buf,
347                        int len, int reset);
348 int ftrace_set_notrace(struct ftrace_ops *ops, unsigned char *buf,
349                         int len, int reset);
350 void ftrace_set_global_filter(unsigned char *buf, int len, int reset);
351 void ftrace_set_global_notrace(unsigned char *buf, int len, int reset);
352 void ftrace_free_filter(struct ftrace_ops *ops);
353
354 int register_ftrace_command(struct ftrace_func_command *cmd);
355 int unregister_ftrace_command(struct ftrace_func_command *cmd);
356
357 enum {
358         FTRACE_UPDATE_CALLS             = (1 << 0),
359         FTRACE_DISABLE_CALLS            = (1 << 1),
360         FTRACE_UPDATE_TRACE_FUNC        = (1 << 2),
361         FTRACE_START_FUNC_RET           = (1 << 3),
362         FTRACE_STOP_FUNC_RET            = (1 << 4),
363 };
364
365 /*
366  * The FTRACE_UPDATE_* enum is used to pass information back
367  * from the ftrace_update_record() and ftrace_test_record()
368  * functions. These are called by the code update routines
369  * to find out what is to be done for a given function.
370  *
371  *  IGNORE           - The function is already what we want it to be
372  *  MAKE_CALL        - Start tracing the function
373  *  MODIFY_CALL      - Stop saving regs for the function
374  *  MAKE_NOP         - Stop tracing the function
375  */
376 enum {
377         FTRACE_UPDATE_IGNORE,
378         FTRACE_UPDATE_MAKE_CALL,
379         FTRACE_UPDATE_MODIFY_CALL,
380         FTRACE_UPDATE_MAKE_NOP,
381 };
382
383 enum {
384         FTRACE_ITER_FILTER      = (1 << 0),
385         FTRACE_ITER_NOTRACE     = (1 << 1),
386         FTRACE_ITER_PRINTALL    = (1 << 2),
387         FTRACE_ITER_DO_HASH     = (1 << 3),
388         FTRACE_ITER_HASH        = (1 << 4),
389         FTRACE_ITER_ENABLED     = (1 << 5),
390 };
391
392 void arch_ftrace_update_code(int command);
393
394 struct ftrace_rec_iter;
395
396 struct ftrace_rec_iter *ftrace_rec_iter_start(void);
397 struct ftrace_rec_iter *ftrace_rec_iter_next(struct ftrace_rec_iter *iter);
398 struct dyn_ftrace *ftrace_rec_iter_record(struct ftrace_rec_iter *iter);
399
400 #define for_ftrace_rec_iter(iter)               \
401         for (iter = ftrace_rec_iter_start();    \
402              iter;                              \
403              iter = ftrace_rec_iter_next(iter))
404
405
406 int ftrace_update_record(struct dyn_ftrace *rec, int enable);
407 int ftrace_test_record(struct dyn_ftrace *rec, int enable);
408 void ftrace_run_stop_machine(int command);
409 unsigned long ftrace_location(unsigned long ip);
410 unsigned long ftrace_get_addr_new(struct dyn_ftrace *rec);
411 unsigned long ftrace_get_addr_curr(struct dyn_ftrace *rec);
412
413 extern ftrace_func_t ftrace_trace_function;
414
415 int ftrace_regex_open(struct ftrace_ops *ops, int flag,
416                   struct inode *inode, struct file *file);
417 ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
418                             size_t cnt, loff_t *ppos);
419 ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
420                              size_t cnt, loff_t *ppos);
421 int ftrace_regex_release(struct inode *inode, struct file *file);
422
423 void __init
424 ftrace_set_early_filter(struct ftrace_ops *ops, char *buf, int enable);
425
426 /* defined in arch */
427 extern int ftrace_ip_converted(unsigned long ip);
428 extern int ftrace_dyn_arch_init(void);
429 extern void ftrace_replace_code(int enable);
430 extern int ftrace_update_ftrace_func(ftrace_func_t func);
431 extern void ftrace_caller(void);
432 extern void ftrace_regs_caller(void);
433 extern void ftrace_call(void);
434 extern void ftrace_regs_call(void);
435 extern void mcount_call(void);
436
437 void ftrace_modify_all_code(int command);
438
439 #ifndef FTRACE_ADDR
440 #define FTRACE_ADDR ((unsigned long)ftrace_caller)
441 #endif
442
443 #ifndef FTRACE_REGS_ADDR
444 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
445 # define FTRACE_REGS_ADDR ((unsigned long)ftrace_regs_caller)
446 #else
447 # define FTRACE_REGS_ADDR FTRACE_ADDR
448 #endif
449 #endif
450
451 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
452 extern void ftrace_graph_caller(void);
453 extern int ftrace_enable_ftrace_graph_caller(void);
454 extern int ftrace_disable_ftrace_graph_caller(void);
455 #else
456 static inline int ftrace_enable_ftrace_graph_caller(void) { return 0; }
457 static inline int ftrace_disable_ftrace_graph_caller(void) { return 0; }
458 #endif
459
460 /**
461  * ftrace_make_nop - convert code into nop
462  * @mod: module structure if called by module load initialization
463  * @rec: the mcount call site record
464  * @addr: the address that the call site should be calling
465  *
466  * This is a very sensitive operation and great care needs
467  * to be taken by the arch.  The operation should carefully
468  * read the location, check to see if what is read is indeed
469  * what we expect it to be, and then on success of the compare,
470  * it should write to the location.
471  *
472  * The code segment at @rec->ip should be a caller to @addr
473  *
474  * Return must be:
475  *  0 on success
476  *  -EFAULT on error reading the location
477  *  -EINVAL on a failed compare of the contents
478  *  -EPERM  on error writing to the location
479  * Any other value will be considered a failure.
480  */
481 extern int ftrace_make_nop(struct module *mod,
482                            struct dyn_ftrace *rec, unsigned long addr);
483
484 /**
485  * ftrace_make_call - convert a nop call site into a call to addr
486  * @rec: the mcount call site record
487  * @addr: the address that the call site should call
488  *
489  * This is a very sensitive operation and great care needs
490  * to be taken by the arch.  The operation should carefully
491  * read the location, check to see if what is read is indeed
492  * what we expect it to be, and then on success of the compare,
493  * it should write to the location.
494  *
495  * The code segment at @rec->ip should be a nop
496  *
497  * Return must be:
498  *  0 on success
499  *  -EFAULT on error reading the location
500  *  -EINVAL on a failed compare of the contents
501  *  -EPERM  on error writing to the location
502  * Any other value will be considered a failure.
503  */
504 extern int ftrace_make_call(struct dyn_ftrace *rec, unsigned long addr);
505
506 #ifdef CONFIG_DYNAMIC_FTRACE_WITH_REGS
507 /**
508  * ftrace_modify_call - convert from one addr to another (no nop)
509  * @rec: the mcount call site record
510  * @old_addr: the address expected to be currently called to
511  * @addr: the address to change to
512  *
513  * This is a very sensitive operation and great care needs
514  * to be taken by the arch.  The operation should carefully
515  * read the location, check to see if what is read is indeed
516  * what we expect it to be, and then on success of the compare,
517  * it should write to the location.
518  *
519  * The code segment at @rec->ip should be a caller to @old_addr
520  *
521  * Return must be:
522  *  0 on success
523  *  -EFAULT on error reading the location
524  *  -EINVAL on a failed compare of the contents
525  *  -EPERM  on error writing to the location
526  * Any other value will be considered a failure.
527  */
528 extern int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
529                               unsigned long addr);
530 #else
531 /* Should never be called */
532 static inline int ftrace_modify_call(struct dyn_ftrace *rec, unsigned long old_addr,
533                                      unsigned long addr)
534 {
535         return -EINVAL;
536 }
537 #endif
538
539 /* May be defined in arch */
540 extern int ftrace_arch_read_dyn_info(char *buf, int size);
541
542 extern int skip_trace(unsigned long ip);
543 extern void ftrace_module_init(struct module *mod);
544 extern void ftrace_release_mod(struct module *mod);
545
546 extern void ftrace_disable_daemon(void);
547 extern void ftrace_enable_daemon(void);
548 #else /* CONFIG_DYNAMIC_FTRACE */
549 static inline int skip_trace(unsigned long ip) { return 0; }
550 static inline int ftrace_force_update(void) { return 0; }
551 static inline void ftrace_disable_daemon(void) { }
552 static inline void ftrace_enable_daemon(void) { }
553 static inline void ftrace_release_mod(struct module *mod) {}
554 static inline void ftrace_module_init(struct module *mod) {}
555 static inline __init int register_ftrace_command(struct ftrace_func_command *cmd)
556 {
557         return -EINVAL;
558 }
559 static inline __init int unregister_ftrace_command(char *cmd_name)
560 {
561         return -EINVAL;
562 }
563 static inline int ftrace_text_reserved(const void *start, const void *end)
564 {
565         return 0;
566 }
567 static inline unsigned long ftrace_location(unsigned long ip)
568 {
569         return 0;
570 }
571
572 /*
573  * Again users of functions that have ftrace_ops may not
574  * have them defined when ftrace is not enabled, but these
575  * functions may still be called. Use a macro instead of inline.
576  */
577 #define ftrace_regex_open(ops, flag, inod, file) ({ -ENODEV; })
578 #define ftrace_set_early_filter(ops, buf, enable) do { } while (0)
579 #define ftrace_set_filter_ip(ops, ip, remove, reset) ({ -ENODEV; })
580 #define ftrace_set_filter(ops, buf, len, reset) ({ -ENODEV; })
581 #define ftrace_set_notrace(ops, buf, len, reset) ({ -ENODEV; })
582 #define ftrace_free_filter(ops) do { } while (0)
583
584 static inline ssize_t ftrace_filter_write(struct file *file, const char __user *ubuf,
585                             size_t cnt, loff_t *ppos) { return -ENODEV; }
586 static inline ssize_t ftrace_notrace_write(struct file *file, const char __user *ubuf,
587                              size_t cnt, loff_t *ppos) { return -ENODEV; }
588 static inline int
589 ftrace_regex_release(struct inode *inode, struct file *file) { return -ENODEV; }
590 #endif /* CONFIG_DYNAMIC_FTRACE */
591
592 /* totally disable ftrace - can not re-enable after this */
593 void ftrace_kill(void);
594
595 static inline void tracer_disable(void)
596 {
597 #ifdef CONFIG_FUNCTION_TRACER
598         ftrace_enabled = 0;
599 #endif
600 }
601
602 /*
603  * Ftrace disable/restore without lock. Some synchronization mechanism
604  * must be used to prevent ftrace_enabled to be changed between
605  * disable/restore.
606  */
607 static inline int __ftrace_enabled_save(void)
608 {
609 #ifdef CONFIG_FUNCTION_TRACER
610         int saved_ftrace_enabled = ftrace_enabled;
611         ftrace_enabled = 0;
612         return saved_ftrace_enabled;
613 #else
614         return 0;
615 #endif
616 }
617
618 static inline void __ftrace_enabled_restore(int enabled)
619 {
620 #ifdef CONFIG_FUNCTION_TRACER
621         ftrace_enabled = enabled;
622 #endif
623 }
624
625 /* All archs should have this, but we define it for consistency */
626 #ifndef ftrace_return_address0
627 # define ftrace_return_address0 __builtin_return_address(0)
628 #endif
629
630 /* Archs may use other ways for ADDR1 and beyond */
631 #ifndef ftrace_return_address
632 # ifdef CONFIG_FRAME_POINTER
633 #  define ftrace_return_address(n) __builtin_return_address(n)
634 # else
635 #  define ftrace_return_address(n) 0UL
636 # endif
637 #endif
638
639 #define CALLER_ADDR0 ((unsigned long)ftrace_return_address0)
640 #define CALLER_ADDR1 ((unsigned long)ftrace_return_address(1))
641 #define CALLER_ADDR2 ((unsigned long)ftrace_return_address(2))
642 #define CALLER_ADDR3 ((unsigned long)ftrace_return_address(3))
643 #define CALLER_ADDR4 ((unsigned long)ftrace_return_address(4))
644 #define CALLER_ADDR5 ((unsigned long)ftrace_return_address(5))
645 #define CALLER_ADDR6 ((unsigned long)ftrace_return_address(6))
646
647 #ifdef CONFIG_IRQSOFF_TRACER
648   extern void time_hardirqs_on(unsigned long a0, unsigned long a1);
649   extern void time_hardirqs_off(unsigned long a0, unsigned long a1);
650 #else
651   static inline void time_hardirqs_on(unsigned long a0, unsigned long a1) { }
652   static inline void time_hardirqs_off(unsigned long a0, unsigned long a1) { }
653 #endif
654
655 #ifdef CONFIG_PREEMPT_TRACER
656   extern void trace_preempt_on(unsigned long a0, unsigned long a1);
657   extern void trace_preempt_off(unsigned long a0, unsigned long a1);
658 #else
659 /*
660  * Use defines instead of static inlines because some arches will make code out
661  * of the CALLER_ADDR, when we really want these to be a real nop.
662  */
663 # define trace_preempt_on(a0, a1) do { } while (0)
664 # define trace_preempt_off(a0, a1) do { } while (0)
665 #endif
666
667 #ifdef CONFIG_FTRACE_MCOUNT_RECORD
668 extern void ftrace_init(void);
669 #else
670 static inline void ftrace_init(void) { }
671 #endif
672
673 /*
674  * Structure that defines an entry function trace.
675  */
676 struct ftrace_graph_ent {
677         unsigned long func; /* Current function */
678         int depth;
679 };
680
681 /*
682  * Structure that defines a return function trace.
683  */
684 struct ftrace_graph_ret {
685         unsigned long func; /* Current function */
686         unsigned long long calltime;
687         unsigned long long rettime;
688         /* Number of functions that overran the depth limit for current task */
689         unsigned long overrun;
690         int depth;
691 };
692
693 /* Type of the callback handlers for tracing function graph*/
694 typedef void (*trace_func_graph_ret_t)(struct ftrace_graph_ret *); /* return */
695 typedef int (*trace_func_graph_ent_t)(struct ftrace_graph_ent *); /* entry */
696
697 #ifdef CONFIG_FUNCTION_GRAPH_TRACER
698
699 /* for init task */
700 #define INIT_FTRACE_GRAPH               .ret_stack = NULL,
701
702 /*
703  * Stack of return addresses for functions
704  * of a thread.
705  * Used in struct thread_info
706  */
707 struct ftrace_ret_stack {
708         unsigned long ret;
709         unsigned long func;
710         unsigned long long calltime;
711         unsigned long long subtime;
712         unsigned long fp;
713 };
714
715 /*
716  * Primary handler of a function return.
717  * It relays on ftrace_return_to_handler.
718  * Defined in entry_32/64.S
719  */
720 extern void return_to_handler(void);
721
722 extern int
723 ftrace_push_return_trace(unsigned long ret, unsigned long func, int *depth,
724                          unsigned long frame_pointer);
725
726 /*
727  * Sometimes we don't want to trace a function with the function
728  * graph tracer but we want them to keep traced by the usual function
729  * tracer if the function graph tracer is not configured.
730  */
731 #define __notrace_funcgraph             notrace
732
733 /*
734  * We want to which function is an entrypoint of a hardirq.
735  * That will help us to put a signal on output.
736  */
737 #define __irq_entry              __attribute__((__section__(".irqentry.text")))
738
739 /* Limits of hardirq entrypoints */
740 extern char __irqentry_text_start[];
741 extern char __irqentry_text_end[];
742
743 #define FTRACE_NOTRACE_DEPTH 65536
744 #define FTRACE_RETFUNC_DEPTH 50
745 #define FTRACE_RETSTACK_ALLOC_SIZE 32
746 extern int register_ftrace_graph(trace_func_graph_ret_t retfunc,
747                                 trace_func_graph_ent_t entryfunc);
748
749 extern void ftrace_graph_stop(void);
750
751 /* The current handlers in use */
752 extern trace_func_graph_ret_t ftrace_graph_return;
753 extern trace_func_graph_ent_t ftrace_graph_entry;
754
755 extern void unregister_ftrace_graph(void);
756
757 extern void ftrace_graph_init_task(struct task_struct *t);
758 extern void ftrace_graph_exit_task(struct task_struct *t);
759 extern void ftrace_graph_init_idle_task(struct task_struct *t, int cpu);
760
761 static inline int task_curr_ret_stack(struct task_struct *t)
762 {
763         return t->curr_ret_stack;
764 }
765
766 static inline void pause_graph_tracing(void)
767 {
768         atomic_inc(&current->tracing_graph_pause);
769 }
770
771 static inline void unpause_graph_tracing(void)
772 {
773         atomic_dec(&current->tracing_graph_pause);
774 }
775 #else /* !CONFIG_FUNCTION_GRAPH_TRACER */
776
777 #define __notrace_funcgraph
778 #define __irq_entry
779 #define INIT_FTRACE_GRAPH
780
781 static inline void ftrace_graph_init_task(struct task_struct *t) { }
782 static inline void ftrace_graph_exit_task(struct task_struct *t) { }
783 static inline void ftrace_graph_init_idle_task(struct task_struct *t, int cpu) { }
784
785 static inline int register_ftrace_graph(trace_func_graph_ret_t retfunc,
786                           trace_func_graph_ent_t entryfunc)
787 {
788         return -1;
789 }
790 static inline void unregister_ftrace_graph(void) { }
791
792 static inline int task_curr_ret_stack(struct task_struct *tsk)
793 {
794         return -1;
795 }
796
797 static inline void pause_graph_tracing(void) { }
798 static inline void unpause_graph_tracing(void) { }
799 #endif /* CONFIG_FUNCTION_GRAPH_TRACER */
800
801 #ifdef CONFIG_TRACING
802
803 /* flags for current->trace */
804 enum {
805         TSK_TRACE_FL_TRACE_BIT  = 0,
806         TSK_TRACE_FL_GRAPH_BIT  = 1,
807 };
808 enum {
809         TSK_TRACE_FL_TRACE      = 1 << TSK_TRACE_FL_TRACE_BIT,
810         TSK_TRACE_FL_GRAPH      = 1 << TSK_TRACE_FL_GRAPH_BIT,
811 };
812
813 static inline void set_tsk_trace_trace(struct task_struct *tsk)
814 {
815         set_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
816 }
817
818 static inline void clear_tsk_trace_trace(struct task_struct *tsk)
819 {
820         clear_bit(TSK_TRACE_FL_TRACE_BIT, &tsk->trace);
821 }
822
823 static inline int test_tsk_trace_trace(struct task_struct *tsk)
824 {
825         return tsk->trace & TSK_TRACE_FL_TRACE;
826 }
827
828 static inline void set_tsk_trace_graph(struct task_struct *tsk)
829 {
830         set_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
831 }
832
833 static inline void clear_tsk_trace_graph(struct task_struct *tsk)
834 {
835         clear_bit(TSK_TRACE_FL_GRAPH_BIT, &tsk->trace);
836 }
837
838 static inline int test_tsk_trace_graph(struct task_struct *tsk)
839 {
840         return tsk->trace & TSK_TRACE_FL_GRAPH;
841 }
842
843 enum ftrace_dump_mode;
844
845 extern enum ftrace_dump_mode ftrace_dump_on_oops;
846
847 extern void disable_trace_on_warning(void);
848 extern int __disable_trace_on_warning;
849
850 #ifdef CONFIG_PREEMPT
851 #define INIT_TRACE_RECURSION            .trace_recursion = 0,
852 #endif
853
854 #else /* CONFIG_TRACING */
855 static inline void  disable_trace_on_warning(void) { }
856 #endif /* CONFIG_TRACING */
857
858 #ifndef INIT_TRACE_RECURSION
859 #define INIT_TRACE_RECURSION
860 #endif
861
862 #ifdef CONFIG_FTRACE_SYSCALLS
863
864 unsigned long arch_syscall_addr(int nr);
865
866 #endif /* CONFIG_FTRACE_SYSCALLS */
867
868 #endif /* _LINUX_FTRACE_H */