tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1#ifndef _LINUX_FTRACE_EVENT_H
2#define _LINUX_FTRACE_EVENT_H
3
4#include <linux/ring_buffer.h>
5#include <linux/trace_seq.h>
6#include <linux/percpu.h>
7#include <linux/hardirq.h>
8
9struct trace_array;
10struct tracer;
11struct dentry;
12
13DECLARE_PER_CPU(struct trace_seq, ftrace_event_seq);
14
15struct trace_print_flags {
16 unsigned long mask;
17 const char *name;
18};
19
20const char *ftrace_print_flags_seq(struct trace_seq *p, const char *delim,
21 unsigned long flags,
22 const struct trace_print_flags *flag_array);
23
24const char *ftrace_print_symbols_seq(struct trace_seq *p, unsigned long val,
25 const struct trace_print_flags *symbol_array);
26
27/*
28 * The trace entry - the most basic unit of tracing. This is what
29 * is printed in the end as a single line in the trace output, such as:
30 *
31 * bash-15816 [01] 235.197585: idle_cpu <- irq_enter
32 */
33struct trace_entry {
34 unsigned short type;
35 unsigned char flags;
36 unsigned char preempt_count;
37 int pid;
38 int lock_depth;
39};
40
41#define FTRACE_MAX_EVENT \
42 ((1 << (sizeof(((struct trace_entry *)0)->type) * 8)) - 1)
43
44/*
45 * Trace iterator - used by printout routines who present trace
46 * results to users and which routines might sleep, etc:
47 */
48struct trace_iterator {
49 struct trace_array *tr;
50 struct tracer *trace;
51 void *private;
52 int cpu_file;
53 struct mutex mutex;
54 struct ring_buffer_iter *buffer_iter[NR_CPUS];
55 unsigned long iter_flags;
56
57 /* The below is zeroed out in pipe_read */
58 struct trace_seq seq;
59 struct trace_entry *ent;
60 int leftover;
61 int cpu;
62 u64 ts;
63
64 loff_t pos;
65 long idx;
66
67 cpumask_var_t started;
68};
69
70
71typedef enum print_line_t (*trace_print_func)(struct trace_iterator *iter,
72 int flags);
73struct trace_event {
74 struct hlist_node node;
75 struct list_head list;
76 int type;
77 trace_print_func trace;
78 trace_print_func raw;
79 trace_print_func hex;
80 trace_print_func binary;
81};
82
83extern int register_ftrace_event(struct trace_event *event);
84extern int unregister_ftrace_event(struct trace_event *event);
85
86/* Return values for print_line callback */
87enum print_line_t {
88 TRACE_TYPE_PARTIAL_LINE = 0, /* Retry after flushing the seq */
89 TRACE_TYPE_HANDLED = 1,
90 TRACE_TYPE_UNHANDLED = 2, /* Relay to other output functions */
91 TRACE_TYPE_NO_CONSUME = 3 /* Handled but ask to not consume */
92};
93
94void tracing_generic_entry_update(struct trace_entry *entry,
95 unsigned long flags,
96 int pc);
97struct ring_buffer_event *
98trace_current_buffer_lock_reserve(struct ring_buffer **current_buffer,
99 int type, unsigned long len,
100 unsigned long flags, int pc);
101void trace_current_buffer_unlock_commit(struct ring_buffer *buffer,
102 struct ring_buffer_event *event,
103 unsigned long flags, int pc);
104void trace_nowake_buffer_unlock_commit(struct ring_buffer *buffer,
105 struct ring_buffer_event *event,
106 unsigned long flags, int pc);
107void trace_current_buffer_discard_commit(struct ring_buffer *buffer,
108 struct ring_buffer_event *event);
109
110void tracing_record_cmdline(struct task_struct *tsk);
111
112struct event_filter;
113
114struct ftrace_event_call {
115 struct list_head list;
116 char *name;
117 char *system;
118 struct dentry *dir;
119 struct trace_event *event;
120 int enabled;
121 int (*regfunc)(struct ftrace_event_call *);
122 void (*unregfunc)(struct ftrace_event_call *);
123 int id;
124 int (*raw_init)(struct ftrace_event_call *);
125 int (*show_format)(struct ftrace_event_call *,
126 struct trace_seq *);
127 int (*define_fields)(struct ftrace_event_call *);
128 struct list_head fields;
129 int filter_active;
130 struct event_filter *filter;
131 void *mod;
132 void *data;
133
134 int profile_count;
135 int (*profile_enable)(struct ftrace_event_call *);
136 void (*profile_disable)(struct ftrace_event_call *);
137};
138
139#define FTRACE_MAX_PROFILE_SIZE 2048
140
141extern char *perf_trace_buf;
142extern char *perf_trace_buf_nmi;
143
144#define MAX_FILTER_PRED 32
145#define MAX_FILTER_STR_VAL 256 /* Should handle KSYM_SYMBOL_LEN */
146
147extern void destroy_preds(struct ftrace_event_call *call);
148extern int filter_match_preds(struct event_filter *filter, void *rec);
149extern int filter_current_check_discard(struct ring_buffer *buffer,
150 struct ftrace_event_call *call,
151 void *rec,
152 struct ring_buffer_event *event);
153
154enum {
155 FILTER_OTHER = 0,
156 FILTER_STATIC_STRING,
157 FILTER_DYN_STRING,
158 FILTER_PTR_STRING,
159};
160
161extern int trace_event_raw_init(struct ftrace_event_call *call);
162extern int trace_define_field(struct ftrace_event_call *call, const char *type,
163 const char *name, int offset, int size,
164 int is_signed, int filter_type);
165extern int trace_add_event_call(struct ftrace_event_call *call);
166extern void trace_remove_event_call(struct ftrace_event_call *call);
167
168#define is_signed_type(type) (((type)(-1)) < 0)
169
170int trace_set_clr_event(const char *system, const char *event, int set);
171
172/*
173 * The double __builtin_constant_p is because gcc will give us an error
174 * if we try to allocate the static variable to fmt if it is not a
175 * constant. Even with the outer if statement optimizing out.
176 */
177#define event_trace_printk(ip, fmt, args...) \
178do { \
179 __trace_printk_check_format(fmt, ##args); \
180 tracing_record_cmdline(current); \
181 if (__builtin_constant_p(fmt)) { \
182 static const char *trace_printk_fmt \
183 __attribute__((section("__trace_printk_fmt"))) = \
184 __builtin_constant_p(fmt) ? fmt : NULL; \
185 \
186 __trace_bprintk(ip, trace_printk_fmt, ##args); \
187 } else \
188 __trace_printk(ip, fmt, ##args); \
189} while (0)
190
191#ifdef CONFIG_EVENT_PROFILE
192struct perf_event;
193extern int ftrace_profile_enable(int event_id);
194extern void ftrace_profile_disable(int event_id);
195extern int ftrace_profile_set_filter(struct perf_event *event, int event_id,
196 char *filter_str);
197extern void ftrace_profile_free_filter(struct perf_event *event);
198#endif
199
200#endif /* _LINUX_FTRACE_EVENT_H */