Update ftrace wrapper
[lttng-modules.git] / ltt-events.h
CommitLineData
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.
17baffe2
MD
10 *
11 * Dual LGPL v2.1/GPL v2 license.
4e3c1b9b
MD
12 */
13
14#include <linux/list.h>
d6d808f3 15#include <linux/kprobes.h>
a864fb02 16#include "wrapper/uuid.h"
11b5a3c2 17#include "ltt-debugfs-abi.h"
4e3c1b9b 18
9e7e4892
MD
19#undef is_signed_type
20#define is_signed_type(type) (((type)(-1)) < 0)
21
4e3c1b9b
MD
22struct ltt_channel;
23struct ltt_session;
1c25284c 24struct lib_ring_buffer_ctx;
ba1f5986 25struct perf_event;
833ad6a0 26struct perf_event_attr;
4e3c1b9b 27
c0edae1d
MD
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 {
e0a7a7c4
MD
42 lttng_encode_none = 0,
43 lttng_encode_UTF8 = 1,
44 lttng_encode_ASCII = 2,
c0edae1d
MD
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
64c796d8 53#define __type_integer(_type, _byte_order, _base, _encoding) \
c099397a
MD
54 { \
55 .atype = atype_integer, \
56 .u.basic.integer = \
57 { \
30bdb6e4 58 .size = sizeof(_type) * CHAR_BIT, \
d793d5e1 59 .alignment = ltt_alignof(_type) * CHAR_BIT, \
c099397a
MD
60 .signedness = is_signed_type(_type), \
61 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
e0a7a7c4 62 .base = _base, \
64c796d8 63 .encoding = lttng_encode_##_encoding, \
c099397a
MD
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;
e0a7a7c4
MD
72 unsigned int base; /* 2, 8, 10, 16, for pretty print */
73 enum lttng_string_encodings encoding;
c099397a
MD
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;
c0edae1d
MD
91};
92
93struct lttng_type {
94 enum abstract_types atype;
c0edae1d 95 union {
c099397a 96 union _lttng_basic_type basic;
c0edae1d 97 struct {
c099397a 98 struct lttng_basic_type elem_type;
c0edae1d
MD
99 unsigned int length; /* num. elems. */
100 } array;
101 struct {
c099397a
MD
102 struct lttng_basic_type length_type;
103 struct lttng_basic_type elem_type;
c0edae1d 104 } sequence;
c0edae1d 105 } u;
c099397a
MD
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};
c0edae1d
MD
114
115/* Event field description */
116
117struct lttng_event_field {
118 const char *name;
f17701fb 119 struct lttng_type type;
c0edae1d
MD
120};
121
2001023e
MD
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
ba1f5986 133struct lttng_ctx_field {
8070f5c0 134 struct lttng_event_field event_field;
f1676205
MD
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);
ba1f5986 139 union {
2001023e 140 struct lttng_perf_counter_field *perf_counter;
ba1f5986 141 } u;
2dccf128 142 void (*destroy)(struct lttng_ctx_field *field);
ba1f5986
MD
143};
144
145struct lttng_ctx {
833ad6a0 146 struct lttng_ctx_field *fields;
0d1a681e 147 unsigned int nr_fields;
ba1f5986 148 unsigned int allocated_fields;
0d1a681e
MD
149};
150
151struct lttng_event_desc {
c0edae1d
MD
152 const char *name;
153 void *probe_callback;
0d1a681e
MD
154 const struct lttng_event_ctx *ctx; /* context */
155 const struct lttng_event_field *fields; /* event payload */
c0edae1d 156 unsigned int nr_fields;
dc7f600a 157 struct module *owner;
c0edae1d
MD
158};
159
85a9ca7f
MD
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
166/*
167 * ltt_event structure is referred to by the tracing fast path. It must be
168 * kept small.
169 */
170struct ltt_event {
171 unsigned int id;
172 struct ltt_channel *chan;
e64957da 173 int enabled;
d3dbe23c 174 const struct lttng_event_desc *desc;
85a9ca7f 175 void *filter;
f1676205 176 struct lttng_ctx *ctx;
38d024ae 177 enum lttng_kernel_instrumentation instrumentation;
d6d808f3
MD
178 union {
179 struct {
180 struct kprobe kp;
181 char *symbol_name;
182 } kprobe;
e0a7a7c4
MD
183 struct {
184 char *symbol_name;
185 } ftrace;
d6d808f3 186 } u;
85a9ca7f 187 struct list_head list; /* Event list */
c099397a 188 int metadata_dumped:1;
85a9ca7f
MD
189};
190
191struct ltt_channel_ops {
192 struct channel *(*channel_create)(const char *name,
9115fbdc 193 struct ltt_channel *ltt_chan,
85a9ca7f
MD
194 void *buf_addr,
195 size_t subbuf_size, size_t num_subbuf,
196 unsigned int switch_timer_interval,
197 unsigned int read_timer_interval);
198 void (*channel_destroy)(struct channel *chan);
199 struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
f71ecafa 200 int (*buffer_has_read_closed_stream)(struct channel *chan);
85a9ca7f 201 void (*buffer_read_close)(struct lib_ring_buffer *buf);
4e1f08f4 202 int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
64c796d8 203 uint32_t event_id);
85a9ca7f
MD
204 void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
205 void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
206 size_t len);
1ec3f75a
MD
207 /*
208 * packet_avail_size returns the available size in the current
209 * packet. Note that the size returned is only a hint, since it
210 * may change due to concurrent writes.
211 */
212 size_t (*packet_avail_size)(struct channel *chan);
24cedcfe
MD
213 wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
214 wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
215 int (*is_finalized)(struct channel *chan);
254ec7bc 216 int (*is_disabled)(struct channel *chan);
85a9ca7f
MD
217};
218
a33c9927
MD
219struct ltt_transport {
220 char *name;
221 struct module *owner;
222 struct list_head node;
223 struct ltt_channel_ops ops;
224};
225
85a9ca7f 226struct ltt_channel {
c099397a 227 unsigned int id;
85a9ca7f 228 struct channel *chan; /* Channel buffers */
e64957da 229 int enabled;
f1676205 230 struct lttng_ctx *ctx;
85a9ca7f
MD
231 /* Event ID management */
232 struct ltt_session *session;
233 struct file *file; /* File associated to channel */
234 unsigned int free_event_id; /* Next event ID to allocate */
235 struct list_head list; /* Channel list */
85a9ca7f 236 struct ltt_channel_ops *ops;
a33c9927 237 struct ltt_transport *transport;
9115fbdc 238 int header_type; /* 0: unset, 1: compact, 2: large */
c099397a 239 int metadata_dumped:1;
85a9ca7f
MD
240};
241
242struct ltt_session {
243 int active; /* Is trace session active ? */
8070f5c0 244 int been_active; /* Has trace session been active ? */
85a9ca7f 245 struct file *file; /* File associated to session */
c099397a 246 struct ltt_channel *metadata; /* Metadata channel */
85a9ca7f
MD
247 struct list_head chan; /* Channel list head */
248 struct list_head events; /* Event list head */
249 struct list_head list; /* Session list */
c099397a 250 unsigned int free_chan_id; /* Next chan ID to allocate */
d793d5e1 251 uuid_le uuid; /* Trace session unique ID */
c099397a 252 int metadata_dumped:1;
85a9ca7f
MD
253};
254
baf20995 255struct ltt_session *ltt_session_create(void);
e64957da
MD
256int ltt_session_enable(struct ltt_session *session);
257int ltt_session_disable(struct ltt_session *session);
11b5a3c2 258void ltt_session_destroy(struct ltt_session *session);
4e3c1b9b 259
baf20995 260struct ltt_channel *ltt_channel_create(struct ltt_session *session,
5dbbdb43
MD
261 const char *transport_name,
262 void *buf_addr,
263 size_t subbuf_size, size_t num_subbuf,
264 unsigned int switch_timer_interval,
265 unsigned int read_timer_interval);
266struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
4e3c1b9b
MD
267 int overwrite, void *buf_addr,
268 size_t subbuf_size, size_t num_subbuf,
269 unsigned int switch_timer_interval,
270 unsigned int read_timer_interval);
4e3c1b9b 271
653fe716 272struct ltt_event *ltt_event_create(struct ltt_channel *chan,
d6d808f3 273 struct lttng_kernel_event *event_param,
85a9ca7f 274 void *filter);
c0e31d2e 275
e64957da
MD
276int ltt_channel_enable(struct ltt_channel *channel);
277int ltt_channel_disable(struct ltt_channel *channel);
278int ltt_event_enable(struct ltt_event *event);
279int ltt_event_disable(struct ltt_event *event);
280
c0e31d2e
MD
281void ltt_transport_register(struct ltt_transport *transport);
282void ltt_transport_unregister(struct ltt_transport *transport);
11b5a3c2 283
360f38ea 284void synchronize_trace(void);
1c25284c
MD
285int ltt_debugfs_abi_init(void);
286void ltt_debugfs_abi_exit(void);
287
85a9ca7f
MD
288int ltt_probe_register(struct lttng_probe_desc *desc);
289void ltt_probe_unregister(struct lttng_probe_desc *desc);
290const struct lttng_event_desc *ltt_event_get(const char *name);
291void ltt_event_put(const struct lttng_event_desc *desc);
cd4bd11f
MD
292int ltt_probes_init(void);
293void ltt_probes_exit(void);
2dccf128 294struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
44252f0f 295int lttng_find_context(struct lttng_ctx *ctx, const char *name);
8289661d
MD
296void lttng_remove_context_field(struct lttng_ctx **ctx,
297 struct lttng_ctx_field *field);
2dccf128 298void lttng_destroy_context(struct lttng_ctx *ctx);
8070f5c0 299int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
25b2f99a 300int lttng_add_comm_to_ctx(struct lttng_ctx **ctx);
a8ad3613 301int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
53f1f0ca 302int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
b64bc438
MD
303int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
304int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
305int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
306int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
307int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
1d443b34 308#ifdef CONFIG_PERF_EVENTS
c24a0d71
MD
309int lttng_add_perf_counter_to_ctx(uint32_t type,
310 uint64_t config,
311 const char *name,
312 struct lttng_ctx **ctx);
1d443b34
MD
313#else
314static inline
315int lttng_add_perf_counter_to_ctx(uint32_t type,
316 uint64_t config,
317 const char *name,
318 struct lttng_ctx **ctx)
319{
320 return -ENOSYS;
321}
322#endif
02119ee5 323
acd614cc 324#ifdef CONFIG_KPROBES
f17701fb
MD
325int lttng_kprobes_register(const char *name,
326 const char *symbol_name,
327 uint64_t offset,
328 uint64_t addr,
329 struct ltt_event *event);
330void lttng_kprobes_unregister(struct ltt_event *event);
edeb3137 331void lttng_kprobes_destroy_private(struct ltt_event *event);
acd614cc
MD
332#else
333static inline
334int lttng_kprobes_register(const char *name,
335 const char *symbol_name,
336 uint64_t offset,
337 uint64_t addr,
338 struct ltt_event *event)
339{
340 return -ENOSYS;
341}
342
25f53c39 343static inline
acd614cc
MD
344void lttng_kprobes_unregister(struct ltt_event *event)
345{
346}
edeb3137
MD
347
348static inline
349void lttng_kprobes_destroy_private(struct ltt_event *event)
350{
351}
acd614cc 352#endif
d6d808f3 353
e0a7a7c4
MD
354#ifdef CONFIG_DYNAMIC_FTRACE
355int lttng_ftrace_register(const char *name,
356 const char *symbol_name,
357 struct ltt_event *event);
358void lttng_ftrace_unregister(struct ltt_event *event);
edeb3137 359void lttng_ftrace_destroy_private(struct ltt_event *event);
e0a7a7c4
MD
360#else
361static inline
362int lttng_ftrace_register(const char *name,
363 const char *symbol_name,
364 struct ltt_event *event)
365{
acd614cc 366 return -ENOSYS;
e0a7a7c4
MD
367}
368
369static inline
370void lttng_ftrace_unregister(struct ltt_event *event)
371{
372}
edeb3137
MD
373
374static inline
375void lttng_ftrace_destroy_private(struct ltt_event *event)
376{
377}
e0a7a7c4 378#endif
271b6681
MD
379
380extern const struct file_operations lttng_tracepoint_list_fops;
381
ef200626
MD
382#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
383#define TRACEPOINT_HAS_DATA_ARG
384#endif
385
11b5a3c2 386#endif /* _LTT_EVENTS_H */
This page took 0.043333 seconds and 4 git commands to generate.