Apply autoupdate to configure.ac
[lttng-ust.git] / include / lttng / ust-events.h
CommitLineData
51489cad
MD
1#ifndef _LTTNG_UST_EVENTS_H
2#define _LTTNG_UST_EVENTS_H
8020ceb5
MD
3
4/*
51489cad 5 * lttng/ust-events.h
8020ceb5
MD
6 *
7 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * Holds LTTng per-session event registry.
10 *
a60d70e6
MD
11 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
12 * OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
13 *
14 * Permission is hereby granted to use or copy this program
15 * for any purpose, provided the above notices are retained on all copies.
16 * Permission to modify the code and to distribute modified code is granted,
17 * provided the above notices are retained, and a notice that the code was
18 * modified is included with the above copyright notice.
8020ceb5
MD
19 */
20
9f3fdbc6
MD
21#include <urcu/list.h>
22#include <uuid/uuid.h>
23#include <stdint.h>
4318ae1b
MD
24#include <lttng/ust-abi.h>
25#include <lttng/ust-tracer.h>
20f1eee7
MD
26#include <endian.h>
27#include <float.h>
8020ceb5 28
8020ceb5
MD
29struct ltt_channel;
30struct ltt_session;
4cfec15c 31struct lttng_ust_lib_ring_buffer_ctx;
8020ceb5 32
c1fca457
MD
33/*
34 * LTTng client type enumeration. Used by the consumer to map the
35 * callbacks from its own address space.
36 */
37enum lttng_client_types {
38 LTTNG_CLIENT_METADATA = 0,
39 LTTNG_CLIENT_DISCARD = 1,
40 LTTNG_CLIENT_OVERWRITE = 2,
41 LTTNG_NR_CLIENT_TYPES,
42};
43
8020ceb5
MD
44/* Type description */
45
46/* Update the astract_types name table in lttng-types.c along with this enum */
47enum abstract_types {
48 atype_integer,
49 atype_enum,
50 atype_array,
51 atype_sequence,
52 atype_string,
20f1eee7 53 atype_float,
8020ceb5
MD
54 NR_ABSTRACT_TYPES,
55};
56
57/* Update the string_encodings name table in lttng-types.c along with this enum */
58enum lttng_string_encodings {
59 lttng_encode_none = 0,
60 lttng_encode_UTF8 = 1,
61 lttng_encode_ASCII = 2,
62 NR_STRING_ENCODINGS,
63};
64
65struct lttng_enum_entry {
66 unsigned long long start, end; /* start and end are inclusive */
67 const char *string;
68};
69
70#define __type_integer(_type, _byte_order, _base, _encoding) \
71 { \
72 .atype = atype_integer, \
73 .u.basic.integer = \
74 { \
75 .size = sizeof(_type) * CHAR_BIT, \
1dbfff0c
MD
76 .alignment = lttng_alignof(_type) * CHAR_BIT, \
77 .signedness = lttng_is_signed_type(_type), \
8020ceb5
MD
78 .reverse_byte_order = _byte_order != __BYTE_ORDER, \
79 .base = _base, \
80 .encoding = lttng_encode_##_encoding, \
81 }, \
82 } \
83
84struct lttng_integer_type {
85 unsigned int size; /* in bits */
86 unsigned short alignment; /* in bits */
87 unsigned int signedness:1;
88 unsigned int reverse_byte_order:1;
89 unsigned int base; /* 2, 8, 10, 16, for pretty print */
90 enum lttng_string_encodings encoding;
91};
92
d3ed854b
MD
93/*
94 * Only float and double are supported. long double is not supported at
95 * the moment.
96 */
20f1eee7
MD
97#define _float_mant_dig(_type) \
98 (sizeof(_type) == sizeof(float) ? FLT_MANT_DIG \
99 : (sizeof(_type) == sizeof(double) ? DBL_MANT_DIG \
d3ed854b 100 : 0))
20f1eee7
MD
101
102#define __type_float(_type) \
103 { \
104 .atype = atype_float, \
105 .u.basic._float = \
106 { \
107 .exp_dig = sizeof(_type) * CHAR_BIT \
108 - _float_mant_dig(_type), \
109 .mant_dig = _float_mant_dig(_type), \
1dbfff0c 110 .alignment = lttng_alignof(_type) * CHAR_BIT, \
20f1eee7
MD
111 .reverse_byte_order = __BYTE_ORDER != __FLOAT_WORD_ORDER, \
112 }, \
113 } \
114
115struct lttng_float_type {
116 unsigned int exp_dig; /* exponent digits, in bits */
117 unsigned int mant_dig; /* mantissa digits, in bits */
118 unsigned short alignment; /* in bits */
119 unsigned int reverse_byte_order:1;
120};
121
8020ceb5
MD
122union _lttng_basic_type {
123 struct lttng_integer_type integer;
124 struct {
125 const char *name;
126 } enumeration;
127 struct {
128 enum lttng_string_encodings encoding;
129 } string;
20f1eee7 130 struct lttng_float_type _float;
8020ceb5
MD
131};
132
133struct lttng_basic_type {
134 enum abstract_types atype;
135 union {
136 union _lttng_basic_type basic;
137 } u;
138};
139
140struct lttng_type {
141 enum abstract_types atype;
142 union {
143 union _lttng_basic_type basic;
144 struct {
145 struct lttng_basic_type elem_type;
146 unsigned int length; /* num. elems. */
147 } array;
148 struct {
149 struct lttng_basic_type length_type;
150 struct lttng_basic_type elem_type;
151 } sequence;
152 } u;
153};
154
155struct lttng_enum {
156 const char *name;
157 struct lttng_type container_type;
158 const struct lttng_enum_entry *entries;
23c8854a 159 unsigned int len;
8020ceb5
MD
160};
161
162/* Event field description */
163
164struct lttng_event_field {
165 const char *name;
166 struct lttng_type type;
167};
168
169struct lttng_ctx_field {
170 struct lttng_event_field event_field;
171 size_t (*get_size)(size_t offset);
172 void (*record)(struct lttng_ctx_field *field,
4cfec15c 173 struct lttng_ust_lib_ring_buffer_ctx *ctx,
8020ceb5
MD
174 struct ltt_channel *chan);
175 union {
8020ceb5
MD
176 } u;
177 void (*destroy)(struct lttng_ctx_field *field);
178};
179
180struct lttng_ctx {
181 struct lttng_ctx_field *fields;
182 unsigned int nr_fields;
183 unsigned int allocated_fields;
184};
185
186struct lttng_event_desc {
187 const char *name;
188 void *probe_callback;
189 const struct lttng_event_ctx *ctx; /* context */
190 const struct lttng_event_field *fields; /* event payload */
191 unsigned int nr_fields;
8020ceb5
MD
192};
193
194struct lttng_probe_desc {
195 const struct lttng_event_desc *event_desc;
196 unsigned int nr_events;
9f3fdbc6 197 struct cds_list_head head; /* chain registered probes */
05ceaafd 198 struct tracepoint_loglevel *loglevels;
8020ceb5
MD
199};
200
8165c8da
MD
201struct ust_pending_probe;
202
8020ceb5
MD
203/*
204 * ltt_event structure is referred to by the tracing fast path. It must be
205 * kept small.
206 */
207struct ltt_event {
208 unsigned int id;
209 struct ltt_channel *chan;
976fe9ea 210 int enabled;
8020ceb5
MD
211 const struct lttng_event_desc *desc;
212 void *filter;
213 struct lttng_ctx *ctx;
9f3fdbc6 214 enum lttng_ust_instrumentation instrumentation;
8020ceb5 215 union {
8020ceb5 216 } u;
9f3fdbc6 217 struct cds_list_head list; /* Event list */
8165c8da 218 struct ust_pending_probe *pending_probe;
8020ceb5
MD
219 int metadata_dumped:1;
220};
221
8d8a24c8 222struct channel;
38fae1d3 223struct lttng_ust_shm_handle;
8d8a24c8 224
8020ceb5 225struct ltt_channel_ops {
1d498196 226 struct ltt_channel *(*channel_create)(const char *name,
8020ceb5
MD
227 void *buf_addr,
228 size_t subbuf_size, size_t num_subbuf,
229 unsigned int switch_timer_interval,
193183fb
MD
230 unsigned int read_timer_interval,
231 int *shm_fd, int *wait_fd,
d028eddb
MD
232 uint64_t *memory_map_size,
233 struct ltt_channel *chan_priv_init);
1d498196 234 void (*channel_destroy)(struct ltt_channel *ltt_chan);
4cfec15c 235 struct lttng_ust_lib_ring_buffer *(*buffer_read_open)(struct channel *chan,
38fae1d3 236 struct lttng_ust_shm_handle *handle,
381c0f1e
MD
237 int *shm_fd, int *wait_fd,
238 uint64_t *memory_map_size);
4cfec15c 239 void (*buffer_read_close)(struct lttng_ust_lib_ring_buffer *buf,
38fae1d3 240 struct lttng_ust_shm_handle *handle);
4cfec15c 241 int (*event_reserve)(struct lttng_ust_lib_ring_buffer_ctx *ctx,
8020ceb5 242 uint32_t event_id);
4cfec15c
MD
243 void (*event_commit)(struct lttng_ust_lib_ring_buffer_ctx *ctx);
244 void (*event_write)(struct lttng_ust_lib_ring_buffer_ctx *ctx, const void *src,
8020ceb5
MD
245 size_t len);
246 /*
247 * packet_avail_size returns the available size in the current
248 * packet. Note that the size returned is only a hint, since it
249 * may change due to concurrent writes.
250 */
1d498196 251 size_t (*packet_avail_size)(struct channel *chan,
38fae1d3 252 struct lttng_ust_shm_handle *handle);
9f3fdbc6
MD
253 //wait_queue_head_t *(*get_reader_wait_queue)(struct channel *chan);
254 //wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
8020ceb5
MD
255 int (*is_finalized)(struct channel *chan);
256 int (*is_disabled)(struct channel *chan);
38fae1d3 257 int (*flush_buffer)(struct channel *chan, struct lttng_ust_shm_handle *handle);
8020ceb5
MD
258};
259
260struct ltt_channel {
a3f61e7f
MD
261 /*
262 * The pointers located in this private data are NOT safe to be
263 * dereferenced by the consumer. The only operations the
264 * consumer process is designed to be allowed to do is to read
265 * and perform subbuffer flush.
266 */
8020ceb5 267 struct channel *chan; /* Channel buffers */
976fe9ea 268 int enabled;
8020ceb5
MD
269 struct lttng_ctx *ctx;
270 /* Event ID management */
271 struct ltt_session *session;
0a42beb6 272 int objd; /* Object associated to channel */
8020ceb5 273 unsigned int free_event_id; /* Next event ID to allocate */
8165c8da 274 unsigned int used_event_id; /* Max allocated event IDs */
9f3fdbc6 275 struct cds_list_head list; /* Channel list */
8020ceb5
MD
276 struct ltt_channel_ops *ops;
277 int header_type; /* 0: unset, 1: compact, 2: large */
38fae1d3 278 struct lttng_ust_shm_handle *handle; /* shared-memory handle */
8020ceb5 279 int metadata_dumped:1;
a3f61e7f
MD
280
281 /* Channel ID, available for consumer too */
282 unsigned int id;
283 /* Copy of session UUID for consumer (availability through shm) */
284 uuid_t uuid; /* Trace session unique ID */
8020ceb5
MD
285};
286
287struct ltt_session {
288 int active; /* Is trace session active ? */
289 int been_active; /* Has trace session been active ? */
0a42beb6 290 int objd; /* Object associated to session */
8020ceb5 291 struct ltt_channel *metadata; /* Metadata channel */
9f3fdbc6
MD
292 struct cds_list_head chan; /* Channel list head */
293 struct cds_list_head events; /* Event list head */
294 struct cds_list_head list; /* Session list */
8020ceb5 295 unsigned int free_chan_id; /* Next chan ID to allocate */
9f3fdbc6 296 uuid_t uuid; /* Trace session unique ID */
8020ceb5
MD
297 int metadata_dumped:1;
298};
299
300struct ltt_transport {
301 char *name;
9f3fdbc6 302 struct cds_list_head node;
8020ceb5
MD
303 struct ltt_channel_ops ops;
304};
305
05ceaafd
MD
306struct tracepoint_loglevel_enum_entry {
307 const char *identifier;
308 long value;
309};
310
311/* mapping between tracepoint and loglevel */
312struct tracepoint_loglevel {
313 const char *name;
314 const struct tracepoint_loglevel_enum_entry *loglevel;
315};
316
8020ceb5 317struct ltt_session *ltt_session_create(void);
976fe9ea
MD
318int ltt_session_enable(struct ltt_session *session);
319int ltt_session_disable(struct ltt_session *session);
8020ceb5
MD
320void ltt_session_destroy(struct ltt_session *session);
321
322struct ltt_channel *ltt_channel_create(struct ltt_session *session,
323 const char *transport_name,
324 void *buf_addr,
325 size_t subbuf_size, size_t num_subbuf,
326 unsigned int switch_timer_interval,
193183fb
MD
327 unsigned int read_timer_interval,
328 int *shm_fd, int *wait_fd,
d028eddb
MD
329 uint64_t *memory_map_size,
330 struct ltt_channel *chan_priv_init);
8020ceb5
MD
331struct ltt_channel *ltt_global_channel_create(struct ltt_session *session,
332 int overwrite, void *buf_addr,
333 size_t subbuf_size, size_t num_subbuf,
334 unsigned int switch_timer_interval,
193183fb
MD
335 unsigned int read_timer_interval,
336 int *shm_fd, int *wait_fd,
337 uint64_t *memory_map_size);
8020ceb5
MD
338
339struct ltt_event *ltt_event_create(struct ltt_channel *chan,
9f3fdbc6 340 struct lttng_ust_event *event_param,
8020ceb5
MD
341 void *filter);
342
976fe9ea
MD
343int ltt_channel_enable(struct ltt_channel *channel);
344int ltt_channel_disable(struct ltt_channel *channel);
345int ltt_event_enable(struct ltt_event *event);
346int ltt_event_disable(struct ltt_event *event);
347
8020ceb5
MD
348void ltt_transport_register(struct ltt_transport *transport);
349void ltt_transport_unregister(struct ltt_transport *transport);
350
4b4de73e 351void synchronize_trace(void);
8020ceb5
MD
352
353int ltt_probe_register(struct lttng_probe_desc *desc);
354void ltt_probe_unregister(struct lttng_probe_desc *desc);
8165c8da 355int pending_probe_fix_events(const struct lttng_event_desc *desc);
8020ceb5
MD
356const struct lttng_event_desc *ltt_event_get(const char *name);
357void ltt_event_put(const struct lttng_event_desc *desc);
358int ltt_probes_init(void);
359void ltt_probes_exit(void);
8173ec7c
MD
360int lttng_find_context(struct lttng_ctx *ctx, const char *name);
361struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx_p);
362void lttng_remove_context_field(struct lttng_ctx **ctx_p,
8020ceb5
MD
363 struct lttng_ctx_field *field);
364void lttng_destroy_context(struct lttng_ctx *ctx);
3b402b40 365int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
c1ef86f0 366int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
8173ec7c 367int lttng_add_pthread_id_to_ctx(struct lttng_ctx **ctx);
4847e9bb 368int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
a93bfc45 369void lttng_context_vtid_reset(void);
c1ef86f0 370void lttng_context_vpid_reset(void);
9f3fdbc6 371
7a784989
MD
372const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_metadata;
373const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_discard;
374const struct lttng_ust_lib_ring_buffer_client_cb *lttng_client_callbacks_overwrite;
c1fca457 375
c1fca457
MD
376struct ltt_transport *ltt_transport_find(const char *name);
377
51489cad 378#endif /* _LTTNG_UST_EVENTS_H */
This page took 0.041831 seconds and 4 git commands to generate.