ftrace_event.h 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. #ifndef _LINUX_FTRACE_EVENT_H
  2. #define _LINUX_FTRACE_EVENT_H
  3. #include <linux/ring_buffer.h>
  4. #include <linux/trace_seq.h>
  5. #include <linux/percpu.h>
  6. #include <linux/hardirq.h>
  7. #include <linux/perf_event.h>
  8. struct trace_array;
  9. struct tracer;
  10. struct dentry;
  11. struct trace_print_flags {
  12. unsigned long mask;
  13. const char *name;
  14. };
  15. const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
  16. unsigned long flags,
  17. const struct trace_print_flags *flag_array);
  18. const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
  19. const struct trace_print_flags *symbol_array);
  20. const char *ftrace_print_hex_seq(struct trace_seq *p,
  21. const unsigned char *buf, int len);
  22. /*
  23. * The trace entry - the most basic unit of tracing. This is what
  24. * is printed in the end as a single line in the trace output, such as:
  25. *
  26. * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
  27. */
  28. struct trace_entry {
  29. unsigned short type;
  30. unsigned char flags;
  31. unsigned char preempt_count;
  32. int pid;
  33. int lock_depth;
  34. };
  35. #define FTRACE_MAX_EVENT \
  36. ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
  37. /*
  38. * Trace iterator - used by printout routines who present trace
  39. * results to users and which routines might sleep, etc:
  40. */
  41. struct trace_iterator {
  42. struct trace_array *tr;
  43. struct tracer *trace;
  44. void *private;
  45. int cpu_file;
  46. struct mutex mutex;
  47. struct ring_buffer_iter *buffer_iter[NR_CPUS];
  48. unsigned long iter_flags;
  49. /* trace_seq for __print_flags() and __print_symbolic() etc. */
  50. struct trace_seq tmp_seq;
  51. /* The below is zeroed out in pipe_read */
  52. struct trace_seq seq;
  53. struct trace_entry *ent;
  54. unsigned long lost_events;
  55. int leftover;
  56. int cpu;
  57. u64 ts;
  58. loff_t pos;
  59. long idx;
  60. cpumask_var_t started;
  61. };
  62. struct trace_event;
  63. typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
  64. int flags, struct trace_event *event);
  65. struct trace_event_functions {
  66. trace_print_func trace;
  67. trace_print_func raw;
  68. trace_print_func hex;
  69. trace_print_func binary;
  70. };
  71. struct trace_event {
  72. struct hlist_node node;
  73. struct list_head list;
  74. int type;
  75. struct trace_event_functions *funcs;
  76. };
  77. extern int register_ftrace_event(struct trace_event *event);
  78. extern int unregister_ftrace_event(struct trace_event *event);
  79. /* Return values for print_line callback */
  80. enum print_line_t {
  81. TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
  82. TRACE_TYPE_HANDLED = 1,
  83. TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
  84. TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
  85. };
  86. void tracing_generic_entry_update(struct trace_entry *entry,
  87. unsigned long flags,
  88. int pc);
  89. struct ring_buffer_event *
  90. trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
  91. int type, unsigned long len,
  92. unsigned long flags, int pc);
  93. void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
  94. struct ring_buffer_event *event,
  95. unsigned long flags, int pc);
  96. void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
  97. struct ring_buffer_event *event,
  98. unsigned long flags, int pc);
  99. void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
  100. struct ring_buffer_event *event);
  101. void tracing_record_cmdline(struct task_struct *tsk);
  102. struct event_filter;
  103. enum trace_reg {
  104. TRACE_REG_REGISTER,
  105. TRACE_REG_UNREGISTER,
  106. TRACE_REG_PERF_REGISTER,
  107. TRACE_REG_PERF_UNREGISTER,
  108. };
  109. struct ftrace_event_call;
  110. struct ftrace_event_class {
  111. char *system;
  112. void *probe;
  113. #ifdef CONFIG_PERF_EVENTS
  114. void *perf_probe;
  115. #endif
  116. int (*reg)(struct ftrace_event_call *event,
  117. enum trace_reg type);
  118. int (*define_fields)(struct ftrace_event_call *);
  119. struct list_head *(*get_fields)(struct ftrace_event_call *);
  120. struct list_head fields;
  121. int (*raw_init)(struct ftrace_event_call *);
  122. };
  123. extern int ftrace_event_reg(struct ftrace_event_call *event,
  124. enum trace_reg type);
  125. enum {
  126. TRACE_EVENT_FL_ENABLED_BIT,
  127. TRACE_EVENT_FL_FILTERED_BIT,
  128. TRACE_EVENT_FL_RECORDED_CMD_BIT,
  129. };
  130. enum {
  131. TRACE_EVENT_FL_ENABLED = (1 << TRACE_EVENT_FL_ENABLED_BIT),
  132. TRACE_EVENT_FL_FILTERED = (1 << TRACE_EVENT_FL_FILTERED_BIT),
  133. TRACE_EVENT_FL_RECORDED_CMD = (1 << TRACE_EVENT_FL_RECORDED_CMD_BIT),
  134. };
  135. struct ftrace_event_call {
  136. struct list_head list;
  137. struct ftrace_event_class *class;
  138. char *name;
  139. struct dentry *dir;
  140. struct trace_event event;
  141. const char *print_fmt;
  142. struct event_filter *filter;
  143. void *mod;
  144. void *data;
  145. /*
  146. * 32 bit flags:
  147. * bit 1: enabled
  148. * bit 2: filter_active
  149. * bit 3: enabled cmd record
  150. *
  151. * Changes to flags must hold the event_mutex.
  152. *
  153. * Note: Reads of flags do not hold the event_mutex since
  154. * they occur in critical sections. But the way flags
  155. * is currently used, these changes do no affect the code
  156. * except that when a change is made, it may have a slight
  157. * delay in propagating the changes to other CPUs due to
  158. * caching and such.
  159. */
  160. unsigned int flags;
  161. #ifdef CONFIG_PERF_EVENTS
  162. int perf_refcount;
  163. struct hlist_head __percpu *perf_events;
  164. #endif
  165. };
  166. #define PERF_MAX_TRACE_SIZE 2048
  167. #define MAX_FILTER_PRED 32
  168. #define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
  169. extern void destroy_preds(struct ftrace_event_call *call);
  170. extern int filter_match_preds(struct event_filter *filter, void *rec);
  171. extern int filter_current_check_discard(struct ring_buffer *buffer,
  172. struct ftrace_event_call *call,
  173. void *rec,
  174. struct ring_buffer_event *event);
  175. enum {
  176. FILTER_OTHER = 0,
  177. FILTER_STATIC_STRING,
  178. FILTER_DYN_STRING,
  179. FILTER_PTR_STRING,
  180. };
  181. extern int trace_event_raw_init(struct ftrace_event_call *call);
  182. extern int trace_define_field(struct ftrace_event_call *call, const char *type,
  183. const char *name, int offset, int size,
  184. int is_signed, int filter_type);
  185. extern int trace_add_event_call(struct ftrace_event_call *call);
  186. extern void trace_remove_event_call(struct ftrace_event_call *call);
  187. #define is_signed_type(type) (((type)(-1)) < 0)
  188. int trace_set_clr_event(const char *system, const char *event, int set);
  189. /*
  190. * The double __builtin_constant_p is because gcc will give us an error
  191. * if we try to allocate the static variable to fmt if it is not a
  192. * constant. Even with the outer if statement optimizing out.
  193. */
  194. #define event_trace_printk(ip, fmt, args...) \
  195. do { \
  196. __trace_printk_check_format(fmt, ##args); \
  197. tracing_record_cmdline(current); \
  198. if (__builtin_constant_p(fmt)) { \
  199. static const char *trace_printk_fmt \
  200. __attribute__((section("__trace_printk_fmt"))) = \
  201. __builtin_constant_p(fmt) ? fmt : NULL; \
  202. \
  203. __trace_bprintk(ip, trace_printk_fmt, ##args); \
  204. } else \
  205. __trace_printk(ip, fmt, ##args); \
  206. } while (0)
  207. #ifdef CONFIG_PERF_EVENTS
  208. struct perf_event;
  209. DECLARE_PER_CPU(struct pt_regs, perf_trace_regs);
  210. extern int perf_trace_init(struct perf_event *event);
  211. extern void perf_trace_destroy(struct perf_event *event);
  212. extern int perf_trace_add(struct perf_event *event, int flags);
  213. extern void perf_trace_del(struct perf_event *event, int flags);
  214. extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
  215. char *filter_str);
  216. extern void ftrace_profile_free_filter(struct perf_event *event);
  217. extern void *perf_trace_buf_prepare(int size, unsigned short type,
  218. struct pt_regs *regs, int *rctxp);
  219. static inline void
  220. perf_trace_buf_submit(void *raw_data, int size, int rctx, u64 addr,
  221. u64 count, struct pt_regs *regs, void *head)
  222. {
  223. perf_tp_event(addr, count, raw_data, size, regs, head, rctx);
  224. }
  225. #endif
  226. #endif /* _LINUX_FTRACE_EVENT_H */