Merge unknown syscall method with extended detail method
[lttng-modules.git] / ltt-events.h
... / ...
CommitLineData
1#ifndef _LTT_EVENTS_H
2#define _LTT_EVENTS_H
3
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 * Dual LGPL v2.1/GPL v2 license.
12 */
13
14#include <linux/list.h>
15#include <linux/kprobes.h>
16#include "wrapper/uuid.h"
17#include "ltt-debugfs-abi.h"
18
19#undef is_signed_type
20#define is_signed_type(type) (((type)(-1)) < 0)
21
22struct ltt_channel;
23struct ltt_session;
24struct lib_ring_buffer_ctx;
25struct perf_event;
26struct perf_event_attr;
27
28/* Type description */
29
30/* Update the astract_types name table in lttng-types.c along with this enum */
31enum abstract_types {
32 atype_integer,
33 atype_enum,
34 atype_array,
35 atype_sequence,
36 atype_string,
37 NR_ABSTRACT_TYPES,
38};
39
40/* Update the string_encodings name table in lttng-types.c along with this enum */
41enum lttng_string_encodings {
42 lttng_encode_none = 0,
43 lttng_encode_UTF8 = 1,
44 lttng_encode_ASCII = 2,
45 NR_STRING_ENCODINGS,
46};
47
48struct lttng_enum_entry {
49 unsigned long long start, end; /* start and end are inclusive */
50 const char *string;
51};
52
53#define __type_integer(_type, _byte_order, _base, _encoding) \
54 { \
55 .atype = atype_integer, \
56 .u.basic.integer = \
57 { \
58 .size = sizeof(_type) * CHAR_BIT, \
59 .alignment = ltt_alignof(_type) * CHAR_BIT, \
60 .signedness = is_signed_type(_type), \
61 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
62 .base = _base, \
63 .encoding = lttng_encode_##_encoding, \
64 }, \
65 } \
66
67struct lttng_integer_type {
68 unsigned int size; /* in bits */
69 unsigned short alignment; /* in bits */
70 unsigned int signedness:1;
71 unsigned int reverse_byte_order:1;
72 unsigned int base; /* 2, 8, 10, 16, for pretty print */
73 enum lttng_string_encodings encoding;
74};
75
76union _lttng_basic_type {
77 struct lttng_integer_type integer;
78 struct {
79 const char *name;
80 } enumeration;
81 struct {
82 enum lttng_string_encodings encoding;
83 } string;
84};
85
86struct lttng_basic_type {
87 enum abstract_types atype;
88 union {
89 union _lttng_basic_type basic;
90 } u;
91};
92
93struct lttng_type {
94 enum abstract_types atype;
95 union {
96 union _lttng_basic_type basic;
97 struct {
98 struct lttng_basic_type elem_type;
99 unsigned int length; /* num. elems. */
100 } array;
101 struct {
102 struct lttng_basic_type length_type;
103 struct lttng_basic_type elem_type;
104 } sequence;
105 } u;
106};
107
108struct lttng_enum {
109 const char *name;
110 struct lttng_type container_type;
111 const struct lttng_enum_entry *entries;
112 unsigned int len;
113};
114
115/* Event field description */
116
117struct lttng_event_field {
118 const char *name;
119 struct lttng_type type;
120};
121
122/*
123 * We need to keep this perf counter field separately from struct
124 * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
125 */
126struct lttng_perf_counter_field {
127 struct notifier_block nb;
128 int hp_enable;
129 struct perf_event_attr *attr;
130 struct perf_event **e; /* per-cpu array */
131};
132
133struct lttng_ctx_field {
134 struct lttng_event_field event_field;
135 size_t (*get_size)(size_t offset);
136 void (*record)(struct lttng_ctx_field *field,
137 struct lib_ring_buffer_ctx *ctx,
138 struct ltt_channel *chan);
139 union {
140 struct lttng_perf_counter_field *perf_counter;
141 } u;
142 void (*destroy)(struct lttng_ctx_field *field);
143};
144
145struct lttng_ctx {
146 struct lttng_ctx_field *fields;
147 unsigned int nr_fields;
148 unsigned int allocated_fields;
149};
150
151struct lttng_event_desc {
152 const char *name;
153 void *probe_callback;
154 const struct lttng_event_ctx *ctx; /* context */
155 const struct lttng_event_field *fields; /* event payload */
156 unsigned int nr_fields;
157 struct module *owner;
158};
159
160struct lttng_probe_desc {
161 const struct lttng_event_desc **event_desc;
162 unsigned int nr_events;
163 struct list_head head; /* chain registered probes */
164};
165
166struct lttng_krp; /* Kretprobe handling */
167
168/*
169 * ltt_event structure is referred to by the tracing fast path. It must be
170 * kept small.
171 */
172struct ltt_event {
173 unsigned int id;
174 struct ltt_channel *chan;
175 int enabled;
176 const struct lttng_event_desc *desc;
177 void *filter;
178 struct lttng_ctx *ctx;
179 enum lttng_kernel_instrumentation instrumentation;
180 union {
181 struct {
182 struct kprobe kp;
183 char *symbol_name;
184 } kprobe;
185 struct {
186 struct lttng_krp *lttng_krp;
187 char *symbol_name;
188 } kretprobe;
189 struct {
190 char *symbol_name;
191 } ftrace;
192 } u;
193 struct list_head list; /* Event list */
194 int metadata_dumped:1;
195};
196
197struct ltt_channel_ops {
198 struct channel *(*channel_create)(const char *name,
199 struct ltt_channel *ltt_chan,
200 void *buf_addr,
201 size_t subbuf_size, size_t num_subbuf,
202 unsigned int switch_timer_interval,
203 unsigned int read_timer_interval);
204 void (*channel_destroy)(struct channel *chan);
205 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
206 int (*buffer_has_read_closed_stream)(struct channel *chan);
207 void (*buffer_read_close)(struct lib_ring_buffer *buf);
208 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
209 uint32_t event_id);
210 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
211 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
212 size_t len);
213 /*
214 * packet_avail_size returns the available size in the current
215 * packet. Note that the size returned is only a hint, since it
216 * may change due to concurrent writes.
217 */
218 size_t (*packet_avail_size)(struct channel *chan);
219 wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
220 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
221 int (*is_finalized)(struct channel *chan);
222 int (*is_disabled)(struct channel *chan);
223};
224
225struct ltt_transport {
226 char *name;
227 struct module *owner;
228 struct list_head node;
229 struct ltt_channel_ops ops;
230};
231
232struct ltt_channel {
233 unsigned int id;
234 struct channel *chan; /* Channel buffers */
235 int enabled;
236 struct lttng_ctx *ctx;
237 /* Event ID management */
238 struct ltt_session *session;
239 struct file *file; /* File associated to channel */
240 unsigned int free_event_id; /* Next event ID to allocate */
241 struct list_head list; /* Channel list */
242 struct ltt_channel_ops *ops;
243 struct ltt_transport *transport;
244 struct ltt_event **sc_table; /* for syscall tracing */
245 int header_type; /* 0: unset, 1: compact, 2: large */
246 int metadata_dumped:1;
247};
248
249struct ltt_session {
250 int active; /* Is trace session active ? */
251 int been_active; /* Has trace session been active ? */
252 struct file *file; /* File associated to session */
253 struct ltt_channel *metadata; /* Metadata channel */
254 struct list_head chan; /* Channel list head */
255 struct list_head events; /* Event list head */
256 struct list_head list; /* Session list */
257 unsigned int free_chan_id; /* Next chan ID to allocate */
258 uuid_le uuid; /* Trace session unique ID */
259 int metadata_dumped:1;
260};
261
262struct ltt_session *ltt_session_create(void);
263int ltt_session_enable(struct ltt_session *session);
264int ltt_session_disable(struct ltt_session *session);
265void ltt_session_destroy(struct ltt_session *session);
266
267struct ltt_channel *ltt_channel_create(struct ltt_session *session,
268 const char *transport_name,
269 void *buf_addr,
270 size_t subbuf_size, size_t num_subbuf,
271 unsigned int switch_timer_interval,
272 unsigned int read_timer_interval);
273struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
274 int overwrite, void *buf_addr,
275 size_t subbuf_size, size_t num_subbuf,
276 unsigned int switch_timer_interval,
277 unsigned int read_timer_interval);
278
279struct ltt_event *ltt_event_create(struct ltt_channel *chan,
280 struct lttng_kernel_event *event_param,
281 void *filter,
282 const struct lttng_event_desc *internal_desc);
283
284int ltt_channel_enable(struct ltt_channel *channel);
285int ltt_channel_disable(struct ltt_channel *channel);
286int ltt_event_enable(struct ltt_event *event);
287int ltt_event_disable(struct ltt_event *event);
288
289void ltt_transport_register(struct ltt_transport *transport);
290void ltt_transport_unregister(struct ltt_transport *transport);
291
292void synchronize_trace(void);
293int ltt_debugfs_abi_init(void);
294void ltt_debugfs_abi_exit(void);
295
296int ltt_probe_register(struct lttng_probe_desc *desc);
297void ltt_probe_unregister(struct lttng_probe_desc *desc);
298const struct lttng_event_desc *ltt_event_get(const char *name);
299void ltt_event_put(const struct lttng_event_desc *desc);
300int ltt_probes_init(void);
301void ltt_probes_exit(void);
302
303#ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
304int lttng_syscalls_register(struct ltt_channel *chan, void *filter);
305int lttng_syscalls_unregister(struct ltt_channel *chan);
306#else
307static inline int lttng_syscalls_register(struct ltt_channel *chan, void *filter)
308{
309 return -ENOSYS;
310}
311
312static inline int lttng_syscalls_unregister(struct ltt_channel *chan)
313{
314 return 0;
315}
316#endif
317
318struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
319int lttng_find_context(struct lttng_ctx *ctx, const char *name);
320void lttng_remove_context_field(struct lttng_ctx **ctx,
321 struct lttng_ctx_field *field);
322void lttng_destroy_context(struct lttng_ctx *ctx);
323int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
324int lttng_add_comm_to_ctx(struct lttng_ctx **ctx);
325int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
326int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
327int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
328int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
329int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
330int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
331int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
332#if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
333int lttng_add_perf_counter_to_ctx(uint32_t type,
334 uint64_t config,
335 const char *name,
336 struct lttng_ctx **ctx);
337#else
338static inline
339int lttng_add_perf_counter_to_ctx(uint32_t type,
340 uint64_t config,
341 const char *name,
342 struct lttng_ctx **ctx)
343{
344 return -ENOSYS;
345}
346#endif
347
348#ifdef CONFIG_KPROBES
349int lttng_kprobes_register(const char *name,
350 const char *symbol_name,
351 uint64_t offset,
352 uint64_t addr,
353 struct ltt_event *event);
354void lttng_kprobes_unregister(struct ltt_event *event);
355void lttng_kprobes_destroy_private(struct ltt_event *event);
356#else
357static inline
358int lttng_kprobes_register(const char *name,
359 const char *symbol_name,
360 uint64_t offset,
361 uint64_t addr,
362 struct ltt_event *event)
363{
364 return -ENOSYS;
365}
366
367static inline
368void lttng_kprobes_unregister(struct ltt_event *event)
369{
370}
371
372static inline
373void lttng_kprobes_destroy_private(struct ltt_event *event)
374{
375}
376#endif
377
378#ifdef CONFIG_KRETPROBES
379int lttng_kretprobes_register(const char *name,
380 const char *symbol_name,
381 uint64_t offset,
382 uint64_t addr,
383 struct ltt_event *event_entry,
384 struct ltt_event *event_exit);
385void lttng_kretprobes_unregister(struct ltt_event *event);
386void lttng_kretprobes_destroy_private(struct ltt_event *event);
387#else
388static inline
389int lttng_kretprobes_register(const char *name,
390 const char *symbol_name,
391 uint64_t offset,
392 uint64_t addr,
393 struct ltt_event *event_entry,
394 struct ltt_event *event_exit)
395{
396 return -ENOSYS;
397}
398
399static inline
400void lttng_kretprobes_unregister(struct ltt_event *event)
401{
402}
403
404static inline
405void lttng_kretprobes_destroy_private(struct ltt_event *event)
406{
407}
408#endif
409
410#ifdef CONFIG_DYNAMIC_FTRACE
411int lttng_ftrace_register(const char *name,
412 const char *symbol_name,
413 struct ltt_event *event);
414void lttng_ftrace_unregister(struct ltt_event *event);
415void lttng_ftrace_destroy_private(struct ltt_event *event);
416#else
417static inline
418int lttng_ftrace_register(const char *name,
419 const char *symbol_name,
420 struct ltt_event *event)
421{
422 return -ENOSYS;
423}
424
425static inline
426void lttng_ftrace_unregister(struct ltt_event *event)
427{
428}
429
430static inline
431void lttng_ftrace_destroy_private(struct ltt_event *event)
432{
433}
434#endif
435
436int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
437
438extern const struct file_operations lttng_tracepoint_list_fops;
439
440#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
441#define TRACEPOINT_HAS_DATA_ARG
442#endif
443
444#endif /* _LTT_EVENTS_H */
This page took 0.036981 seconds and 4 git commands to generate.