Commit | Line | Data |
---|---|---|
11b5a3c2 MD |
1 | #ifndef _LTT_EVENTS_H |
2 | #define _LTT_EVENTS_H | |
3 | ||
4e3c1b9b MD |
4 | /* |
5 | * ltt-events.h | |
6 | * | |
7 | * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * | |
9 | * Holds LTTng per-session event registry. | |
10 | */ | |
11 | ||
12 | #include <linux/list.h> | |
d793d5e1 | 13 | #include <linux/uuid.h> |
d6d808f3 | 14 | #include <linux/kprobes.h> |
11b5a3c2 | 15 | #include "ltt-debugfs-abi.h" |
4e3c1b9b MD |
16 | |
17 | struct ltt_channel; | |
18 | struct ltt_session; | |
1c25284c | 19 | struct lib_ring_buffer_ctx; |
ba1f5986 | 20 | struct perf_event; |
833ad6a0 | 21 | struct perf_event_attr; |
4e3c1b9b | 22 | |
c0edae1d MD |
23 | /* Type description */ |
24 | ||
25 | /* Update the astract_types name table in lttng-types.c along with this enum */ | |
26 | enum abstract_types { | |
27 | atype_integer, | |
28 | atype_enum, | |
29 | atype_array, | |
30 | atype_sequence, | |
31 | atype_string, | |
32 | NR_ABSTRACT_TYPES, | |
33 | }; | |
34 | ||
35 | /* Update the string_encodings name table in lttng-types.c along with this enum */ | |
36 | enum lttng_string_encodings { | |
e0a7a7c4 MD |
37 | lttng_encode_none = 0, |
38 | lttng_encode_UTF8 = 1, | |
39 | lttng_encode_ASCII = 2, | |
c0edae1d MD |
40 | NR_STRING_ENCODINGS, |
41 | }; | |
42 | ||
43 | struct lttng_enum_entry { | |
44 | unsigned long long start, end; /* start and end are inclusive */ | |
45 | const char *string; | |
46 | }; | |
47 | ||
64c796d8 | 48 | #define __type_integer(_type, _byte_order, _base, _encoding) \ |
c099397a MD |
49 | { \ |
50 | .atype = atype_integer, \ | |
51 | .u.basic.integer = \ | |
52 | { \ | |
30bdb6e4 | 53 | .size = sizeof(_type) * CHAR_BIT, \ |
d793d5e1 | 54 | .alignment = ltt_alignof(_type) * CHAR_BIT, \ |
c099397a MD |
55 | .signedness = is_signed_type(_type), \ |
56 | .reverse_byte_order = _byte_order != __BYTE_ORDER, \ | |
e0a7a7c4 | 57 | .base = _base, \ |
64c796d8 | 58 | .encoding = lttng_encode_##_encoding, \ |
c099397a MD |
59 | }, \ |
60 | } \ | |
61 | ||
62 | struct lttng_integer_type { | |
63 | unsigned int size; /* in bits */ | |
64 | unsigned short alignment; /* in bits */ | |
65 | unsigned int signedness:1; | |
66 | unsigned int reverse_byte_order:1; | |
e0a7a7c4 MD |
67 | unsigned int base; /* 2, 8, 10, 16, for pretty print */ |
68 | enum lttng_string_encodings encoding; | |
c099397a MD |
69 | }; |
70 | ||
71 | union _lttng_basic_type { | |
72 | struct lttng_integer_type integer; | |
73 | struct { | |
74 | const char *name; | |
75 | } enumeration; | |
76 | struct { | |
77 | enum lttng_string_encodings encoding; | |
78 | } string; | |
79 | }; | |
80 | ||
81 | struct lttng_basic_type { | |
82 | enum abstract_types atype; | |
83 | union { | |
84 | union _lttng_basic_type basic; | |
85 | } u; | |
c0edae1d MD |
86 | }; |
87 | ||
88 | struct lttng_type { | |
89 | enum abstract_types atype; | |
c0edae1d | 90 | union { |
c099397a | 91 | union _lttng_basic_type basic; |
c0edae1d | 92 | struct { |
c099397a | 93 | struct lttng_basic_type elem_type; |
c0edae1d MD |
94 | unsigned int length; /* num. elems. */ |
95 | } array; | |
96 | struct { | |
c099397a MD |
97 | struct lttng_basic_type length_type; |
98 | struct lttng_basic_type elem_type; | |
c0edae1d | 99 | } sequence; |
c0edae1d | 100 | } u; |
c099397a MD |
101 | }; |
102 | ||
103 | struct lttng_enum { | |
104 | const char *name; | |
105 | struct lttng_type container_type; | |
106 | const struct lttng_enum_entry *entries; | |
107 | unsigned int len; | |
108 | }; | |
c0edae1d MD |
109 | |
110 | /* Event field description */ | |
111 | ||
112 | struct lttng_event_field { | |
113 | const char *name; | |
f17701fb | 114 | struct lttng_type type; |
c0edae1d MD |
115 | }; |
116 | ||
ba1f5986 MD |
117 | struct lttng_ctx_field { |
118 | const char *name; | |
119 | struct lttng_type type; | |
833ad6a0 | 120 | void *callback; |
ba1f5986 MD |
121 | union { |
122 | struct { | |
123 | struct perf_event **e; /* per-cpu array */ | |
833ad6a0 MD |
124 | struct list_head head; |
125 | struct perf_event_attr *attr; | |
ba1f5986 MD |
126 | } perf_counter; |
127 | } u; | |
128 | }; | |
129 | ||
130 | struct lttng_ctx { | |
833ad6a0 | 131 | struct lttng_ctx_field *fields; |
0d1a681e | 132 | unsigned int nr_fields; |
ba1f5986 | 133 | unsigned int allocated_fields; |
0d1a681e MD |
134 | }; |
135 | ||
136 | struct lttng_event_desc { | |
c0edae1d MD |
137 | const char *name; |
138 | void *probe_callback; | |
0d1a681e MD |
139 | const struct lttng_event_ctx *ctx; /* context */ |
140 | const struct lttng_event_field *fields; /* event payload */ | |
c0edae1d MD |
141 | unsigned int nr_fields; |
142 | }; | |
143 | ||
85a9ca7f MD |
144 | struct lttng_probe_desc { |
145 | const struct lttng_event_desc *event_desc; | |
146 | unsigned int nr_events; | |
147 | struct list_head head; /* chain registered probes */ | |
148 | }; | |
149 | ||
150 | /* | |
151 | * ltt_event structure is referred to by the tracing fast path. It must be | |
152 | * kept small. | |
153 | */ | |
154 | struct ltt_event { | |
155 | unsigned int id; | |
156 | struct ltt_channel *chan; | |
d3dbe23c | 157 | const struct lttng_event_desc *desc; |
85a9ca7f | 158 | void *filter; |
38d024ae | 159 | enum lttng_kernel_instrumentation instrumentation; |
d6d808f3 MD |
160 | union { |
161 | struct { | |
162 | struct kprobe kp; | |
163 | char *symbol_name; | |
164 | } kprobe; | |
e0a7a7c4 MD |
165 | struct { |
166 | char *symbol_name; | |
167 | } ftrace; | |
d6d808f3 | 168 | } u; |
85a9ca7f | 169 | struct list_head list; /* Event list */ |
c099397a | 170 | int metadata_dumped:1; |
85a9ca7f MD |
171 | }; |
172 | ||
173 | struct ltt_channel_ops { | |
174 | struct channel *(*channel_create)(const char *name, | |
9115fbdc | 175 | struct ltt_channel *ltt_chan, |
85a9ca7f MD |
176 | void *buf_addr, |
177 | size_t subbuf_size, size_t num_subbuf, | |
178 | unsigned int switch_timer_interval, | |
179 | unsigned int read_timer_interval); | |
180 | void (*channel_destroy)(struct channel *chan); | |
181 | struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan); | |
182 | void (*buffer_read_close)(struct lib_ring_buffer *buf); | |
4e1f08f4 | 183 | int (*event_reserve)(struct lib_ring_buffer_ctx *ctx, |
64c796d8 | 184 | uint32_t event_id); |
85a9ca7f MD |
185 | void (*event_commit)(struct lib_ring_buffer_ctx *ctx); |
186 | void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src, | |
187 | size_t len); | |
1ec3f75a MD |
188 | /* |
189 | * packet_avail_size returns the available size in the current | |
190 | * packet. Note that the size returned is only a hint, since it | |
191 | * may change due to concurrent writes. | |
192 | */ | |
193 | size_t (*packet_avail_size)(struct channel *chan); | |
c099397a | 194 | wait_queue_head_t *(*get_reader_wait_queue)(struct ltt_channel *chan); |
85a9ca7f MD |
195 | }; |
196 | ||
197 | struct ltt_channel { | |
c099397a | 198 | unsigned int id; |
85a9ca7f MD |
199 | struct channel *chan; /* Channel buffers */ |
200 | /* Event ID management */ | |
201 | struct ltt_session *session; | |
202 | struct file *file; /* File associated to channel */ | |
203 | unsigned int free_event_id; /* Next event ID to allocate */ | |
204 | struct list_head list; /* Channel list */ | |
205 | wait_queue_head_t notify_wait; /* Channel addition notif. waitqueue */ | |
206 | struct ltt_channel_ops *ops; | |
9115fbdc | 207 | int header_type; /* 0: unset, 1: compact, 2: large */ |
c099397a | 208 | int metadata_dumped:1; |
85a9ca7f MD |
209 | }; |
210 | ||
211 | struct ltt_session { | |
212 | int active; /* Is trace session active ? */ | |
213 | struct file *file; /* File associated to session */ | |
c099397a | 214 | struct ltt_channel *metadata; /* Metadata channel */ |
85a9ca7f MD |
215 | struct list_head chan; /* Channel list head */ |
216 | struct list_head events; /* Event list head */ | |
217 | struct list_head list; /* Session list */ | |
c099397a | 218 | unsigned int free_chan_id; /* Next chan ID to allocate */ |
d793d5e1 | 219 | uuid_le uuid; /* Trace session unique ID */ |
c099397a | 220 | int metadata_dumped:1; |
85a9ca7f MD |
221 | }; |
222 | ||
223 | struct ltt_transport { | |
224 | char *name; | |
225 | struct module *owner; | |
226 | struct list_head node; | |
227 | struct ltt_channel_ops ops; | |
228 | }; | |
229 | ||
baf20995 | 230 | struct ltt_session *ltt_session_create(void); |
c0e31d2e MD |
231 | int ltt_session_start(struct ltt_session *session); |
232 | int ltt_session_stop(struct ltt_session *session); | |
11b5a3c2 | 233 | void ltt_session_destroy(struct ltt_session *session); |
4e3c1b9b | 234 | |
baf20995 | 235 | struct ltt_channel *ltt_channel_create(struct ltt_session *session, |
5dbbdb43 MD |
236 | const char *transport_name, |
237 | void *buf_addr, | |
238 | size_t subbuf_size, size_t num_subbuf, | |
239 | unsigned int switch_timer_interval, | |
240 | unsigned int read_timer_interval); | |
241 | struct ltt_channel *ltt_global_channel_create(struct ltt_session *session, | |
4e3c1b9b MD |
242 | int overwrite, void *buf_addr, |
243 | size_t subbuf_size, size_t num_subbuf, | |
244 | unsigned int switch_timer_interval, | |
245 | unsigned int read_timer_interval); | |
4e3c1b9b | 246 | |
653fe716 | 247 | struct ltt_event *ltt_event_create(struct ltt_channel *chan, |
d6d808f3 | 248 | struct lttng_kernel_event *event_param, |
85a9ca7f | 249 | void *filter); |
c0e31d2e MD |
250 | |
251 | void ltt_transport_register(struct ltt_transport *transport); | |
252 | void ltt_transport_unregister(struct ltt_transport *transport); | |
11b5a3c2 | 253 | |
1c25284c MD |
254 | int ltt_debugfs_abi_init(void); |
255 | void ltt_debugfs_abi_exit(void); | |
256 | ||
85a9ca7f MD |
257 | int ltt_probe_register(struct lttng_probe_desc *desc); |
258 | void ltt_probe_unregister(struct lttng_probe_desc *desc); | |
259 | const struct lttng_event_desc *ltt_event_get(const char *name); | |
260 | void ltt_event_put(const struct lttng_event_desc *desc); | |
cd4bd11f MD |
261 | int ltt_probes_init(void); |
262 | void ltt_probes_exit(void); | |
02119ee5 | 263 | |
acd614cc | 264 | #ifdef CONFIG_KPROBES |
f17701fb MD |
265 | int lttng_kprobes_register(const char *name, |
266 | const char *symbol_name, | |
267 | uint64_t offset, | |
268 | uint64_t addr, | |
269 | struct ltt_event *event); | |
270 | void lttng_kprobes_unregister(struct ltt_event *event); | |
acd614cc MD |
271 | #else |
272 | static inline | |
273 | int lttng_kprobes_register(const char *name, | |
274 | const char *symbol_name, | |
275 | uint64_t offset, | |
276 | uint64_t addr, | |
277 | struct ltt_event *event) | |
278 | { | |
279 | return -ENOSYS; | |
280 | } | |
281 | ||
25f53c39 | 282 | static inline |
acd614cc MD |
283 | void lttng_kprobes_unregister(struct ltt_event *event) |
284 | { | |
285 | } | |
286 | #endif | |
d6d808f3 | 287 | |
e0a7a7c4 MD |
288 | #ifdef CONFIG_DYNAMIC_FTRACE |
289 | int lttng_ftrace_register(const char *name, | |
290 | const char *symbol_name, | |
291 | struct ltt_event *event); | |
292 | void lttng_ftrace_unregister(struct ltt_event *event); | |
293 | #else | |
294 | static inline | |
295 | int lttng_ftrace_register(const char *name, | |
296 | const char *symbol_name, | |
297 | struct ltt_event *event) | |
298 | { | |
acd614cc | 299 | return -ENOSYS; |
e0a7a7c4 MD |
300 | } |
301 | ||
302 | static inline | |
303 | void lttng_ftrace_unregister(struct ltt_event *event) | |
304 | { | |
305 | } | |
306 | #endif | |
11b5a3c2 | 307 | #endif /* _LTT_EVENTS_H */ |