Refactoring: introduce bytecode runtime private structure
[lttng-ust.git] / liblttng-ust / ust-events-internal.h
CommitLineData
d871c65b 1/*
c0c0989a 2 * SPDX-License-Identifier: MIT
d871c65b 3 *
c0c0989a 4 * Copyright 2019 (c) Francis Deslauriers <francis.deslauriers@efficios.com>
d871c65b
FD
5 */
6
c0c0989a
MJ
7#ifndef _LTTNG_UST_EVENTS_INTERNAL_H
8#define _LTTNG_UST_EVENTS_INTERNAL_H
9
d871c65b
FD
10#include <stdint.h>
11
12#include <urcu/list.h>
13#include <urcu/hlist.h>
14
864a1eda 15#include <ust-helper.h>
d871c65b
FD
16#include <lttng/ust-events.h>
17
8665f6a4
MJ
18enum lttng_enabler_format_type {
19 LTTNG_ENABLER_FORMAT_STAR_GLOB,
20 LTTNG_ENABLER_FORMAT_EVENT,
21};
22
23/*
24 * Enabler field, within whatever object is enabling an event. Target of
25 * backward reference.
26 */
27struct lttng_enabler {
28 enum lttng_enabler_format_type format_type;
29
30 /* head list of struct lttng_ust_filter_bytecode_node */
31 struct cds_list_head filter_bytecode_head;
32 /* head list of struct lttng_ust_excluder_node */
33 struct cds_list_head excluder_head;
34
35 struct lttng_ust_event event_param;
36 unsigned int enabled:1;
37};
38
d871c65b
FD
39struct lttng_event_enabler {
40 struct lttng_enabler base;
41 struct cds_list_head node; /* per-session list of enablers */
42 struct lttng_channel *chan;
43 /*
44 * Unused, but kept around to make it explicit that the tracer can do
45 * it.
46 */
47 struct lttng_ctx *ctx;
48};
49
d8d2416d
FD
50struct lttng_event_notifier_enabler {
51 struct lttng_enabler base;
6566528b 52 uint64_t error_counter_index;
d37ecb3f
FD
53 struct cds_list_head node; /* per-app list of event_notifier enablers */
54 struct cds_list_head capture_bytecode_head;
d8d2416d
FD
55 struct lttng_event_notifier_group *group; /* weak ref */
56 uint64_t user_token; /* User-provided token */
d37ecb3f 57 uint64_t num_captures;
d8d2416d
FD
58};
59
ab249ecf
FD
60enum lttng_ust_bytecode_node_type {
61 LTTNG_UST_BYTECODE_NODE_TYPE_FILTER,
d37ecb3f 62 LTTNG_UST_BYTECODE_NODE_TYPE_CAPTURE,
ab249ecf
FD
63};
64
65struct lttng_ust_bytecode_node {
66 enum lttng_ust_bytecode_node_type type;
92495593
FD
67 struct cds_list_head node;
68 struct lttng_enabler *enabler;
ab249ecf
FD
69 struct {
70 uint32_t len;
71 uint32_t reloc_offset;
72 uint64_t seqnum;
73 char data[];
74 } bc;
92495593
FD
75};
76
77struct lttng_ust_excluder_node {
78 struct cds_list_head node;
79 struct lttng_enabler *enabler;
80 /*
81 * struct lttng_ust_event_exclusion had variable sized array,
82 * must be last field.
83 */
84 struct lttng_ust_event_exclusion excluder;
85};
86
bb7ad29d
MJ
87/* Data structures used by the tracer. */
88
89struct tp_list_entry {
90 struct lttng_ust_tracepoint_iter tp;
91 struct cds_list_head head;
92};
93
94struct lttng_ust_tracepoint_list {
95 struct tp_list_entry *iter;
96 struct cds_list_head head;
97};
98
99struct tp_field_list_entry {
100 struct lttng_ust_field_iter field;
101 struct cds_list_head head;
102};
103
104struct lttng_ust_field_list {
105 struct tp_field_list_entry *iter;
106 struct cds_list_head head;
107};
108
109/*
110 * Objects in a linked-list of enablers, owned by an event or event_notifier.
111 * This is used because an event (or a event_notifier) can be enabled by more
112 * than one enabler and we want a quick way to iterate over all enablers of an
113 * object.
114 *
115 * For example, event rules "my_app:a*" and "my_app:ab*" will both match the
116 * event with the name "my_app:abc".
117 */
118struct lttng_enabler_ref {
119 struct cds_list_head node; /* enabler ref list */
120 struct lttng_enabler *ref; /* backward ref */
121};
122
123#define LTTNG_COUNTER_DIMENSION_MAX 8
124struct lttng_counter_dimension {
125 uint64_t size;
126 uint64_t underflow_index;
127 uint64_t overflow_index;
128 uint8_t has_underflow;
129 uint8_t has_overflow;
130};
131
132struct lttng_counter {
133 int objd;
134 struct lttng_event_notifier_group *event_notifier_group; /* owner */
135 struct lttng_counter_transport *transport;
136 struct lib_counter *counter;
137 struct lttng_counter_ops *ops;
138};
139
140struct lttng_event_notifier_group {
141 int objd;
142 void *owner;
143 int notification_fd;
144 struct cds_list_head node; /* Event notifier group handle list */
145 struct cds_list_head enablers_head;
146 struct cds_list_head event_notifiers_head; /* list of event_notifiers */
147 struct lttng_ust_event_notifier_ht event_notifiers_ht; /* hashtable of event_notifiers */
148 struct lttng_ctx *ctx; /* contexts for filters. */
149
150 struct lttng_counter *error_counter;
151 size_t error_counter_len;
152};
153
154struct lttng_transport {
155 char *name;
156 struct cds_list_head node;
157 struct lttng_channel_ops ops;
158 const struct lttng_ust_lib_ring_buffer_config *client_config;
159};
160
161struct lttng_counter_transport {
162 char *name;
163 struct cds_list_head node;
164 struct lttng_counter_ops ops;
165 const struct lib_counter_config *client_config;
166};
167
68bb7559
MD
168struct lttng_ust_event_private {
169 struct lttng_event *pub; /* Public event interface */
170
171 const struct lttng_event_desc *desc;
172 enum lttng_ust_instrumentation instrumentation;
173 struct cds_list_head node; /* Event list in session */
174
175 /* Backward references: list of lttng_enabler_ref (ref to enablers) */
176 struct cds_list_head enablers_ref_head;
177 struct cds_hlist_node hlist; /* session ht of events */
178 int registered; /* has reg'd tracepoint probe */
179};
180
362a65de
MD
181struct lttng_ust_bytecode_runtime_private {
182 struct bytecode_runtime *pub; /* Public bytecode runtime interface */
183
184 struct lttng_ust_bytecode_node *bc;
185 int link_failed;
186 /*
187 * Pointer to a URCU-protected pointer owned by an `struct
188 * lttng_session`or `struct lttng_event_notifier_group`.
189 */
190 struct lttng_ctx **pctx;
191};
192
d871c65b
FD
193static inline
194struct lttng_enabler *lttng_event_enabler_as_enabler(
195 struct lttng_event_enabler *event_enabler)
196{
197 return &event_enabler->base;
198}
199
d8d2416d
FD
200static inline
201struct lttng_enabler *lttng_event_notifier_enabler_as_enabler(
202 struct lttng_event_notifier_enabler *event_notifier_enabler)
203{
204 return &event_notifier_enabler->base;
205}
d871c65b
FD
206
207/*
208 * Allocate and initialize a `struct lttng_event_enabler` object.
209 *
210 * On success, returns a `struct lttng_event_enabler`,
211 * On memory error, returns NULL.
212 */
213LTTNG_HIDDEN
214struct lttng_event_enabler *lttng_event_enabler_create(
215 enum lttng_enabler_format_type format_type,
216 struct lttng_ust_event *event_param,
217 struct lttng_channel *chan);
218
219/*
220 * Destroy a `struct lttng_event_enabler` object.
221 */
222LTTNG_HIDDEN
223void lttng_event_enabler_destroy(struct lttng_event_enabler *enabler);
224
225/*
226 * Enable a `struct lttng_event_enabler` object and all events related to this
227 * enabler.
228 */
229LTTNG_HIDDEN
230int lttng_event_enabler_enable(struct lttng_event_enabler *enabler);
231
232/*
233 * Disable a `struct lttng_event_enabler` object and all events related to this
234 * enabler.
235 */
236LTTNG_HIDDEN
237int lttng_event_enabler_disable(struct lttng_event_enabler *enabler);
238
239/*
240 * Attach filter bytecode program to `struct lttng_event_enabler` and all
241 * events related to this enabler.
242 */
243LTTNG_HIDDEN
a56fd376
FD
244int lttng_event_enabler_attach_filter_bytecode(
245 struct lttng_event_enabler *enabler,
ab89263e 246 struct lttng_ust_bytecode_node **bytecode);
d871c65b
FD
247
248/*
249 * Attach an application context to an event enabler.
250 *
251 * Not implemented.
252 */
253LTTNG_HIDDEN
254int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
255 struct lttng_ust_context *ctx);
256
257/*
258 * Attach exclusion list to `struct lttng_event_enabler` and all
259 * events related to this enabler.
260 */
261LTTNG_HIDDEN
262int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *enabler,
e9fe6aad 263 struct lttng_ust_excluder_node **excluder);
d871c65b
FD
264
265/*
d37ecb3f
FD
266 * Synchronize bytecodes for the enabler and the instance (event or
267 * event_notifier).
d871c65b 268 *
621c07fc 269 * This function goes over all bytecode programs of the enabler (event or
d37ecb3f 270 * event_notifier enabler) to ensure each is linked to the provided instance.
d871c65b
FD
271 */
272LTTNG_HIDDEN
53b9d7db
FD
273void lttng_enabler_link_bytecode(const struct lttng_event_desc *event_desc,
274 struct lttng_ctx **ctx,
621c07fc
FD
275 struct cds_list_head *instance_bytecode_runtime_head,
276 struct cds_list_head *enabler_bytecode_runtime_head);
d871c65b 277
d8d2416d
FD
278/*
279 * Allocate and initialize a `struct lttng_event_notifier_group` object.
280 *
281 * On success, returns a `struct lttng_triggre_group`,
282 * on memory error, returns NULL.
283 */
284LTTNG_HIDDEN
285struct lttng_event_notifier_group *lttng_event_notifier_group_create(void);
286
287/*
288 * Destroy a `struct lttng_event_notifier_group` object.
289 */
290LTTNG_HIDDEN
291void lttng_event_notifier_group_destroy(
292 struct lttng_event_notifier_group *event_notifier_group);
293
294/*
295 * Allocate and initialize a `struct lttng_event_notifier_enabler` object.
296 *
297 * On success, returns a `struct lttng_event_notifier_enabler`,
298 * On memory error, returns NULL.
299 */
300LTTNG_HIDDEN
301struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
302 struct lttng_event_notifier_group *event_notifier_group,
303 enum lttng_enabler_format_type format_type,
304 struct lttng_ust_event_notifier *event_notifier_param);
305
306/*
307 * Destroy a `struct lttng_event_notifier_enabler` object.
308 */
309LTTNG_HIDDEN
310void lttng_event_notifier_enabler_destroy(
311 struct lttng_event_notifier_enabler *event_notifier_enabler);
312
313/*
314 * Enable a `struct lttng_event_notifier_enabler` object and all event
315 * notifiers related to this enabler.
316 */
317LTTNG_HIDDEN
318int lttng_event_notifier_enabler_enable(
319 struct lttng_event_notifier_enabler *event_notifier_enabler);
320
321/*
322 * Disable a `struct lttng_event_notifier_enabler` object and all event
323 * notifiers related to this enabler.
324 */
325LTTNG_HIDDEN
326int lttng_event_notifier_enabler_disable(
327 struct lttng_event_notifier_enabler *event_notifier_enabler);
328
329/*
330 * Attach filter bytecode program to `struct lttng_event_notifier_enabler` and
331 * all event notifiers related to this enabler.
332 */
333LTTNG_HIDDEN
a56fd376 334int lttng_event_notifier_enabler_attach_filter_bytecode(
d8d2416d 335 struct lttng_event_notifier_enabler *event_notifier_enabler,
ab89263e 336 struct lttng_ust_bytecode_node **bytecode);
d8d2416d 337
d37ecb3f
FD
338/*
339 * Attach capture bytecode program to `struct lttng_event_notifier_enabler` and
340 * all event_notifiers related to this enabler.
341 */
342LTTNG_HIDDEN
343int lttng_event_notifier_enabler_attach_capture_bytecode(
344 struct lttng_event_notifier_enabler *event_notifier_enabler,
49cde654 345 struct lttng_ust_bytecode_node **bytecode);
d37ecb3f 346
d8d2416d
FD
347/*
348 * Attach exclusion list to `struct lttng_event_notifier_enabler` and all
349 * event notifiers related to this enabler.
350 */
351LTTNG_HIDDEN
352int lttng_event_notifier_enabler_attach_exclusion(
353 struct lttng_event_notifier_enabler *event_notifier_enabler,
e9fe6aad 354 struct lttng_ust_excluder_node **excluder);
d8d2416d 355
7753d283
MJ
356LTTNG_HIDDEN
357void lttng_free_event_filter_runtime(struct lttng_event *event);
358
d8d2416d
FD
359LTTNG_HIDDEN
360void lttng_free_event_notifier_filter_runtime(
361 struct lttng_event_notifier *event_notifier);
362
363/*
364 * Connect the probe on all enablers matching this event description.
365 * Called on library load.
366 */
367LTTNG_HIDDEN
368int lttng_fix_pending_event_notifiers(void);
369
67d4e8f5
MJ
370LTTNG_HIDDEN
371struct lttng_counter *lttng_ust_counter_create(
372 const char *counter_transport_name,
373 size_t number_dimensions, const struct lttng_counter_dimension *dimensions);
374
bd8c1787
MJ
375#ifdef HAVE_PERF_EVENT
376
377LTTNG_HIDDEN
378int lttng_add_perf_counter_to_ctx(uint32_t type,
379 uint64_t config,
380 const char *name,
381 struct lttng_ctx **ctx);
382LTTNG_HIDDEN
383int lttng_perf_counter_init(void);
384LTTNG_HIDDEN
385void lttng_perf_counter_exit(void);
386
387#else /* #ifdef HAVE_PERF_EVENT */
388
389static inline
390int lttng_add_perf_counter_to_ctx(uint32_t type,
391 uint64_t config,
392 const char *name,
393 struct lttng_ctx **ctx)
394{
395 return -ENOSYS;
396}
397static inline
398int lttng_perf_counter_init(void)
399{
400 return 0;
401}
402static inline
403void lttng_perf_counter_exit(void)
404{
405}
406#endif /* #else #ifdef HAVE_PERF_EVENT */
407
7753d283
MJ
408LTTNG_HIDDEN
409int lttng_probes_get_event_list(struct lttng_ust_tracepoint_list *list);
410LTTNG_HIDDEN
411void lttng_probes_prune_event_list(struct lttng_ust_tracepoint_list *list);
412
413LTTNG_HIDDEN
414int lttng_probes_get_field_list(struct lttng_ust_field_list *list);
415LTTNG_HIDDEN
416void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
417
418LTTNG_HIDDEN
419struct lttng_ust_tracepoint_iter *
420 lttng_ust_tracepoint_list_get_iter_next(struct lttng_ust_tracepoint_list *list);
421LTTNG_HIDDEN
422struct lttng_ust_field_iter *
423 lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
424
425LTTNG_HIDDEN
426struct lttng_session *lttng_session_create(void);
427LTTNG_HIDDEN
428int lttng_session_enable(struct lttng_session *session);
429LTTNG_HIDDEN
430int lttng_session_disable(struct lttng_session *session);
431LTTNG_HIDDEN
432int lttng_session_statedump(struct lttng_session *session);
433LTTNG_HIDDEN
434void lttng_session_destroy(struct lttng_session *session);
435
436LTTNG_HIDDEN
437struct cds_list_head *lttng_get_sessions(void);
438
439LTTNG_HIDDEN
440void lttng_handle_pending_statedump(void *owner);
441
442LTTNG_HIDDEN
443struct lttng_channel *lttng_channel_create(struct lttng_session *session,
444 const char *transport_name,
445 void *buf_addr,
446 size_t subbuf_size, size_t num_subbuf,
447 unsigned int switch_timer_interval,
448 unsigned int read_timer_interval,
449 int **shm_fd, int **wait_fd,
450 uint64_t **memory_map_size,
451 struct lttng_channel *chan_priv_init);
452
453LTTNG_HIDDEN
454int lttng_channel_enable(struct lttng_channel *channel);
455LTTNG_HIDDEN
456int lttng_channel_disable(struct lttng_channel *channel);
457
458LTTNG_HIDDEN
459void lttng_transport_register(struct lttng_transport *transport);
460LTTNG_HIDDEN
461void lttng_transport_unregister(struct lttng_transport *transport);
462
463LTTNG_HIDDEN
464void lttng_probe_provider_unregister_events(struct lttng_probe_desc *desc);
465
466LTTNG_HIDDEN
467int lttng_fix_pending_events(void);
468
469LTTNG_HIDDEN
470struct cds_list_head *lttng_get_probe_list_head(void);
471
472LTTNG_HIDDEN
473struct lttng_enum *lttng_ust_enum_get_from_desc(struct lttng_session *session,
474 const struct lttng_enum_desc *enum_desc);
475
d871c65b 476#endif /* _LTTNG_UST_EVENTS_INTERNAL_H */
This page took 0.042178 seconds and 4 git commands to generate.