Rename struct lttng_event to struct lttng_ust_event_recorder
[lttng-ust.git] / liblttng-ust / lttng-events.c
1 /*
2 * SPDX-License-Identifier: LGPL-2.1-only
3 *
4 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 *
6 * Holds LTTng per-session event registry.
7 */
8
9 #define _LGPL_SOURCE
10 #include <stdio.h>
11 #include <assert.h>
12 #include <errno.h>
13 #include <limits.h>
14 #include <pthread.h>
15 #include <sys/shm.h>
16 #include <sys/ipc.h>
17 #include <stdint.h>
18 #include <stddef.h>
19 #include <inttypes.h>
20 #include <time.h>
21 #include <stdbool.h>
22 #include <unistd.h>
23 #include <dlfcn.h>
24 #include <lttng/ust-endian.h>
25
26 #include <urcu/arch.h>
27 #include <urcu/compiler.h>
28 #include <urcu/hlist.h>
29 #include <urcu/list.h>
30 #include <urcu/uatomic.h>
31
32 #include <lttng/tracepoint.h>
33 #include <lttng/ust-events.h>
34
35 #include <usterr-signal-safe.h>
36 #include <ust-helper.h>
37 #include <lttng/ust-ctl.h>
38 #include <ust-comm.h>
39 #include <ust-fd.h>
40 #include <ust-dynamic-type.h>
41 #include <ust-context-provider.h>
42 #include "error.h"
43 #include "compat.h"
44 #include "lttng-ust-uuid.h"
45
46 #include "tracepoint-internal.h"
47 #include "string-utils.h"
48 #include "lttng-bytecode.h"
49 #include "lttng-tracer.h"
50 #include "lttng-tracer-core.h"
51 #include "lttng-ust-statedump.h"
52 #include "context-internal.h"
53 #include "ust-events-internal.h"
54 #include "wait.h"
55 #include "../libringbuffer/shm.h"
56 #include "../libcounter/counter.h"
57 #include "jhash.h"
58 #include <lttng/ust-abi.h>
59
60 /*
61 * All operations within this file are called by the communication
62 * thread, under ust_lock protection.
63 */
64
65 static CDS_LIST_HEAD(sessions);
66 static CDS_LIST_HEAD(event_notifier_groups);
67
68 struct cds_list_head *lttng_get_sessions(void)
69 {
70 return &sessions;
71 }
72
73 static void _lttng_event_recorder_destroy(struct lttng_ust_event_recorder *event_recorder);
74 static void _lttng_event_notifier_destroy(
75 struct lttng_event_notifier *event_notifier);
76 static void _lttng_enum_destroy(struct lttng_enum *_enum);
77
78 static
79 void lttng_session_lazy_sync_event_enablers(struct lttng_session *session);
80 static
81 void lttng_session_sync_event_enablers(struct lttng_session *session);
82 static
83 void lttng_event_notifier_group_sync_enablers(
84 struct lttng_event_notifier_group *event_notifier_group);
85 static
86 void lttng_enabler_destroy(struct lttng_enabler *enabler);
87
88 /*
89 * Called with ust lock held.
90 */
91 int lttng_session_active(void)
92 {
93 struct lttng_ust_session_private *iter;
94
95 cds_list_for_each_entry(iter, &sessions, node) {
96 if (iter->pub->active)
97 return 1;
98 }
99 return 0;
100 }
101
102 static
103 int lttng_loglevel_match(int loglevel,
104 unsigned int has_loglevel,
105 enum lttng_ust_loglevel_type req_type,
106 int req_loglevel)
107 {
108 if (!has_loglevel)
109 loglevel = TRACE_DEFAULT;
110 switch (req_type) {
111 case LTTNG_UST_LOGLEVEL_RANGE:
112 if (loglevel <= req_loglevel
113 || (req_loglevel == -1 && loglevel <= TRACE_DEBUG))
114 return 1;
115 else
116 return 0;
117 case LTTNG_UST_LOGLEVEL_SINGLE:
118 if (loglevel == req_loglevel
119 || (req_loglevel == -1 && loglevel <= TRACE_DEBUG))
120 return 1;
121 else
122 return 0;
123 case LTTNG_UST_LOGLEVEL_ALL:
124 default:
125 if (loglevel <= TRACE_DEBUG)
126 return 1;
127 else
128 return 0;
129 }
130 }
131
132 struct lttng_session *lttng_session_create(void)
133 {
134 struct lttng_session *session;
135 struct lttng_ust_session_private *session_priv;
136 int i;
137
138 session = zmalloc(sizeof(struct lttng_session));
139 if (!session)
140 return NULL;
141 session->struct_size = sizeof(struct lttng_session);
142 session_priv = zmalloc(sizeof(struct lttng_ust_session_private));
143 if (!session_priv) {
144 free(session);
145 return NULL;
146 }
147 session->priv = session_priv;
148 session_priv->pub = session;
149 if (lttng_context_init_all(&session->priv->ctx)) {
150 free(session_priv);
151 free(session);
152 return NULL;
153 }
154 CDS_INIT_LIST_HEAD(&session->priv->chan_head);
155 CDS_INIT_LIST_HEAD(&session->priv->events_head);
156 CDS_INIT_LIST_HEAD(&session->priv->enums_head);
157 CDS_INIT_LIST_HEAD(&session->priv->enablers_head);
158 for (i = 0; i < LTTNG_UST_EVENT_HT_SIZE; i++)
159 CDS_INIT_HLIST_HEAD(&session->priv->events_ht.table[i]);
160 for (i = 0; i < LTTNG_UST_ENUM_HT_SIZE; i++)
161 CDS_INIT_HLIST_HEAD(&session->priv->enums_ht.table[i]);
162 cds_list_add(&session->priv->node, &sessions);
163 return session;
164 }
165
166 struct lttng_counter *lttng_ust_counter_create(
167 const char *counter_transport_name,
168 size_t number_dimensions, const struct lttng_counter_dimension *dimensions)
169 {
170 struct lttng_counter_transport *counter_transport = NULL;
171 struct lttng_counter *counter = NULL;
172
173 counter_transport = lttng_counter_transport_find(counter_transport_name);
174 if (!counter_transport)
175 goto notransport;
176 counter = zmalloc(sizeof(struct lttng_counter));
177 if (!counter)
178 goto nomem;
179
180 counter->ops = &counter_transport->ops;
181 counter->transport = counter_transport;
182
183 counter->counter = counter->ops->counter_create(
184 number_dimensions, dimensions, 0,
185 -1, 0, NULL, false);
186 if (!counter->counter) {
187 goto create_error;
188 }
189
190 return counter;
191
192 create_error:
193 free(counter);
194 nomem:
195 notransport:
196 return NULL;
197 }
198
199 static
200 void lttng_ust_counter_destroy(struct lttng_counter *counter)
201 {
202 counter->ops->counter_destroy(counter->counter);
203 free(counter);
204 }
205
206 struct lttng_event_notifier_group *lttng_event_notifier_group_create(void)
207 {
208 struct lttng_event_notifier_group *event_notifier_group;
209 int i;
210
211 event_notifier_group = zmalloc(sizeof(struct lttng_event_notifier_group));
212 if (!event_notifier_group)
213 return NULL;
214
215 /* Add all contexts. */
216 if (lttng_context_init_all(&event_notifier_group->ctx)) {
217 free(event_notifier_group);
218 return NULL;
219 }
220
221 CDS_INIT_LIST_HEAD(&event_notifier_group->enablers_head);
222 CDS_INIT_LIST_HEAD(&event_notifier_group->event_notifiers_head);
223 for (i = 0; i < LTTNG_UST_EVENT_NOTIFIER_HT_SIZE; i++)
224 CDS_INIT_HLIST_HEAD(&event_notifier_group->event_notifiers_ht.table[i]);
225
226 cds_list_add(&event_notifier_group->node, &event_notifier_groups);
227
228 return event_notifier_group;
229 }
230
231 /*
232 * Only used internally at session destruction.
233 */
234 static
235 void _lttng_channel_unmap(struct lttng_channel *lttng_chan)
236 {
237 struct channel *chan;
238 struct lttng_ust_shm_handle *handle;
239
240 cds_list_del(&lttng_chan->node);
241 lttng_destroy_context(lttng_chan->ctx);
242 chan = lttng_chan->chan;
243 handle = lttng_chan->handle;
244 /*
245 * note: lttng_chan is private data contained within handle. It
246 * will be freed along with the handle.
247 */
248 channel_destroy(chan, handle, 0);
249 }
250
251 static
252 void register_event_recorder(struct lttng_ust_event_recorder *event_recorder)
253 {
254 int ret;
255 const struct lttng_event_desc *desc;
256
257 assert(event_recorder->parent->priv->registered == 0);
258 desc = event_recorder->parent->priv->desc;
259 ret = __tracepoint_probe_register_queue_release(desc->name,
260 desc->probe_callback,
261 event_recorder, desc->signature);
262 WARN_ON_ONCE(ret);
263 if (!ret)
264 event_recorder->parent->priv->registered = 1;
265 }
266
267 static
268 void register_event_notifier(struct lttng_event_notifier *event_notifier)
269 {
270 int ret;
271 const struct lttng_event_desc *desc;
272
273 assert(event_notifier->registered == 0);
274 desc = event_notifier->desc;
275 ret = __tracepoint_probe_register_queue_release(desc->name,
276 desc->u.ext.event_notifier_callback, event_notifier, desc->signature);
277 WARN_ON_ONCE(ret);
278 if (!ret)
279 event_notifier->registered = 1;
280 }
281
282 static
283 void unregister_event_recorder(struct lttng_ust_event_recorder *event_recorder)
284 {
285 int ret;
286 const struct lttng_event_desc *desc;
287
288 assert(event_recorder->parent->priv->registered == 1);
289 desc = event_recorder->parent->priv->desc;
290 ret = __tracepoint_probe_unregister_queue_release(desc->name,
291 desc->probe_callback,
292 event_recorder);
293 WARN_ON_ONCE(ret);
294 if (!ret)
295 event_recorder->parent->priv->registered = 0;
296 }
297
298 static
299 void unregister_event_notifier(struct lttng_event_notifier *event_notifier)
300 {
301 int ret;
302 const struct lttng_event_desc *desc;
303
304 assert(event_notifier->registered == 1);
305 desc = event_notifier->desc;
306 ret = __tracepoint_probe_unregister_queue_release(desc->name,
307 desc->u.ext.event_notifier_callback, event_notifier);
308 WARN_ON_ONCE(ret);
309 if (!ret)
310 event_notifier->registered = 0;
311 }
312
313 /*
314 * Only used internally at session destruction.
315 */
316 static
317 void _lttng_event_recorder_unregister(struct lttng_ust_event_recorder *event_recorder)
318 {
319 if (event_recorder->parent->priv->registered)
320 unregister_event_recorder(event_recorder);
321 }
322
323 /*
324 * Only used internally at session destruction.
325 */
326 static
327 void _lttng_event_notifier_unregister(struct lttng_event_notifier *event_notifier)
328 {
329 if (event_notifier->registered)
330 unregister_event_notifier(event_notifier);
331 }
332
333 void lttng_session_destroy(struct lttng_session *session)
334 {
335 struct lttng_channel *chan, *tmpchan;
336 struct lttng_ust_event_recorder_private *event_recorder_priv, *tmpevent_recorder_priv;
337 struct lttng_enum *_enum, *tmp_enum;
338 struct lttng_event_enabler *event_enabler, *event_tmpenabler;
339
340 CMM_ACCESS_ONCE(session->active) = 0;
341 cds_list_for_each_entry(event_recorder_priv, &session->priv->events_head, node) {
342 _lttng_event_recorder_unregister(event_recorder_priv->pub);
343 }
344 lttng_ust_urcu_synchronize_rcu(); /* Wait for in-flight events to complete */
345 __tracepoint_probe_prune_release_queue();
346 cds_list_for_each_entry_safe(event_enabler, event_tmpenabler,
347 &session->priv->enablers_head, node)
348 lttng_event_enabler_destroy(event_enabler);
349 cds_list_for_each_entry_safe(event_recorder_priv, tmpevent_recorder_priv,
350 &session->priv->events_head, node)
351 _lttng_event_recorder_destroy(event_recorder_priv->pub);
352 cds_list_for_each_entry_safe(_enum, tmp_enum,
353 &session->priv->enums_head, node)
354 _lttng_enum_destroy(_enum);
355 cds_list_for_each_entry_safe(chan, tmpchan, &session->priv->chan_head, node)
356 _lttng_channel_unmap(chan);
357 cds_list_del(&session->priv->node);
358 lttng_destroy_context(session->priv->ctx);
359 free(session->priv);
360 free(session);
361 }
362
363 void lttng_event_notifier_group_destroy(
364 struct lttng_event_notifier_group *event_notifier_group)
365 {
366 int close_ret;
367 struct lttng_event_notifier_enabler *notifier_enabler, *tmpnotifier_enabler;
368 struct lttng_event_notifier *notifier, *tmpnotifier;
369
370 if (!event_notifier_group) {
371 return;
372 }
373
374 cds_list_for_each_entry(notifier,
375 &event_notifier_group->event_notifiers_head, node)
376 _lttng_event_notifier_unregister(notifier);
377
378 lttng_ust_urcu_synchronize_rcu();
379
380 cds_list_for_each_entry_safe(notifier_enabler, tmpnotifier_enabler,
381 &event_notifier_group->enablers_head, node)
382 lttng_event_notifier_enabler_destroy(notifier_enabler);
383
384 cds_list_for_each_entry_safe(notifier, tmpnotifier,
385 &event_notifier_group->event_notifiers_head, node)
386 _lttng_event_notifier_destroy(notifier);
387
388 if (event_notifier_group->error_counter)
389 lttng_ust_counter_destroy(event_notifier_group->error_counter);
390
391 /* Close the notification fd to the listener of event_notifiers. */
392
393 lttng_ust_lock_fd_tracker();
394 close_ret = close(event_notifier_group->notification_fd);
395 if (!close_ret) {
396 lttng_ust_delete_fd_from_tracker(
397 event_notifier_group->notification_fd);
398 } else {
399 PERROR("close");
400 abort();
401 }
402 lttng_ust_unlock_fd_tracker();
403
404 cds_list_del(&event_notifier_group->node);
405
406 free(event_notifier_group);
407 }
408
409 static
410 void lttng_enabler_destroy(struct lttng_enabler *enabler)
411 {
412 struct lttng_ust_bytecode_node *filter_node, *tmp_filter_node;
413 struct lttng_ust_excluder_node *excluder_node, *tmp_excluder_node;
414
415 if (!enabler) {
416 return;
417 }
418
419 /* Destroy filter bytecode */
420 cds_list_for_each_entry_safe(filter_node, tmp_filter_node,
421 &enabler->filter_bytecode_head, node) {
422 free(filter_node);
423 }
424
425 /* Destroy excluders */
426 cds_list_for_each_entry_safe(excluder_node, tmp_excluder_node,
427 &enabler->excluder_head, node) {
428 free(excluder_node);
429 }
430 }
431
432 void lttng_event_notifier_enabler_destroy(struct lttng_event_notifier_enabler *event_notifier_enabler)
433 {
434 if (!event_notifier_enabler) {
435 return;
436 }
437
438 cds_list_del(&event_notifier_enabler->node);
439
440 lttng_enabler_destroy(lttng_event_notifier_enabler_as_enabler(event_notifier_enabler));
441
442 free(event_notifier_enabler);
443 }
444
445 static
446 int lttng_enum_create(const struct lttng_enum_desc *desc,
447 struct lttng_session *session)
448 {
449 const char *enum_name = desc->name;
450 struct lttng_enum *_enum;
451 struct cds_hlist_head *head;
452 int ret = 0;
453 size_t name_len = strlen(enum_name);
454 uint32_t hash;
455 int notify_socket;
456
457 /* Check if this enum is already registered for this session. */
458 hash = jhash(enum_name, name_len, 0);
459 head = &session->priv->enums_ht.table[hash & (LTTNG_UST_ENUM_HT_SIZE - 1)];
460
461 _enum = lttng_ust_enum_get_from_desc(session, desc);
462 if (_enum) {
463 ret = -EEXIST;
464 goto exist;
465 }
466
467 notify_socket = lttng_get_notify_socket(session->priv->owner);
468 if (notify_socket < 0) {
469 ret = notify_socket;
470 goto socket_error;
471 }
472
473 _enum = zmalloc(sizeof(*_enum));
474 if (!_enum) {
475 ret = -ENOMEM;
476 goto cache_error;
477 }
478 _enum->session = session;
479 _enum->desc = desc;
480
481 ret = ustcomm_register_enum(notify_socket,
482 session->priv->objd,
483 enum_name,
484 desc->nr_entries,
485 desc->entries,
486 &_enum->id);
487 if (ret < 0) {
488 DBG("Error (%d) registering enumeration to sessiond", ret);
489 goto sessiond_register_error;
490 }
491 cds_list_add(&_enum->node, &session->priv->enums_head);
492 cds_hlist_add_head(&_enum->hlist, head);
493 return 0;
494
495 sessiond_register_error:
496 free(_enum);
497 cache_error:
498 socket_error:
499 exist:
500 return ret;
501 }
502
503 static
504 int lttng_create_enum_check(const struct lttng_type *type,
505 struct lttng_session *session)
506 {
507 switch (type->atype) {
508 case atype_enum_nestable:
509 {
510 const struct lttng_enum_desc *enum_desc;
511 int ret;
512
513 enum_desc = type->u.enum_nestable.desc;
514 ret = lttng_enum_create(enum_desc, session);
515 if (ret && ret != -EEXIST) {
516 DBG("Unable to create enum error: (%d)", ret);
517 return ret;
518 }
519 break;
520 }
521 case atype_dynamic:
522 {
523 const struct lttng_event_field *tag_field_generic;
524 const struct lttng_enum_desc *enum_desc;
525 int ret;
526
527 tag_field_generic = lttng_ust_dynamic_type_tag_field();
528 enum_desc = tag_field_generic->type.u.enum_nestable.desc;
529 ret = lttng_enum_create(enum_desc, session);
530 if (ret && ret != -EEXIST) {
531 DBG("Unable to create enum error: (%d)", ret);
532 return ret;
533 }
534 break;
535 }
536 default:
537 /* TODO: nested types when they become supported. */
538 break;
539 }
540 return 0;
541 }
542
543 static
544 int lttng_create_all_event_enums(size_t nr_fields,
545 const struct lttng_event_field *event_fields,
546 struct lttng_session *session)
547 {
548 size_t i;
549 int ret;
550
551 /* For each field, ensure enum is part of the session. */
552 for (i = 0; i < nr_fields; i++) {
553 const struct lttng_type *type = &event_fields[i].type;
554
555 ret = lttng_create_enum_check(type, session);
556 if (ret)
557 return ret;
558 }
559 return 0;
560 }
561
562 static
563 int lttng_create_all_ctx_enums(size_t nr_fields,
564 const struct lttng_ctx_field *ctx_fields,
565 struct lttng_session *session)
566 {
567 size_t i;
568 int ret;
569
570 /* For each field, ensure enum is part of the session. */
571 for (i = 0; i < nr_fields; i++) {
572 const struct lttng_type *type = &ctx_fields[i].event_field.type;
573
574 ret = lttng_create_enum_check(type, session);
575 if (ret)
576 return ret;
577 }
578 return 0;
579 }
580
581 /*
582 * Ensure that a state-dump will be performed for this session at the end
583 * of the current handle_message().
584 */
585 int lttng_session_statedump(struct lttng_session *session)
586 {
587 session->priv->statedump_pending = 1;
588 lttng_ust_sockinfo_session_enabled(session->priv->owner);
589 return 0;
590 }
591
592 int lttng_session_enable(struct lttng_session *session)
593 {
594 int ret = 0;
595 struct lttng_channel *chan;
596 int notify_socket;
597
598 if (session->active) {
599 ret = -EBUSY;
600 goto end;
601 }
602
603 notify_socket = lttng_get_notify_socket(session->priv->owner);
604 if (notify_socket < 0)
605 return notify_socket;
606
607 /* Set transient enabler state to "enabled" */
608 session->priv->tstate = 1;
609
610 /* We need to sync enablers with session before activation. */
611 lttng_session_sync_event_enablers(session);
612
613 /*
614 * Snapshot the number of events per channel to know the type of header
615 * we need to use.
616 */
617 cds_list_for_each_entry(chan, &session->priv->chan_head, node) {
618 const struct lttng_ctx *ctx;
619 const struct lttng_ctx_field *fields = NULL;
620 size_t nr_fields = 0;
621 uint32_t chan_id;
622
623 /* don't change it if session stop/restart */
624 if (chan->header_type)
625 continue;
626 ctx = chan->ctx;
627 if (ctx) {
628 nr_fields = ctx->nr_fields;
629 fields = ctx->fields;
630 ret = lttng_create_all_ctx_enums(nr_fields, fields,
631 session);
632 if (ret < 0) {
633 DBG("Error (%d) adding enum to session", ret);
634 return ret;
635 }
636 }
637 ret = ustcomm_register_channel(notify_socket,
638 session,
639 session->priv->objd,
640 chan->objd,
641 nr_fields,
642 fields,
643 &chan_id,
644 &chan->header_type);
645 if (ret) {
646 DBG("Error (%d) registering channel to sessiond", ret);
647 return ret;
648 }
649 if (chan_id != chan->id) {
650 DBG("Error: channel registration id (%u) does not match id assigned at creation (%u)",
651 chan_id, chan->id);
652 return -EINVAL;
653 }
654 }
655
656 /* Set atomically the state to "active" */
657 CMM_ACCESS_ONCE(session->active) = 1;
658 CMM_ACCESS_ONCE(session->priv->been_active) = 1;
659
660 ret = lttng_session_statedump(session);
661 if (ret)
662 return ret;
663 end:
664 return ret;
665 }
666
667 int lttng_session_disable(struct lttng_session *session)
668 {
669 int ret = 0;
670
671 if (!session->active) {
672 ret = -EBUSY;
673 goto end;
674 }
675 /* Set atomically the state to "inactive" */
676 CMM_ACCESS_ONCE(session->active) = 0;
677
678 /* Set transient enabler state to "disabled" */
679 session->priv->tstate = 0;
680 lttng_session_sync_event_enablers(session);
681 end:
682 return ret;
683 }
684
685 int lttng_channel_enable(struct lttng_channel *channel)
686 {
687 int ret = 0;
688
689 if (channel->enabled) {
690 ret = -EBUSY;
691 goto end;
692 }
693 /* Set transient enabler state to "enabled" */
694 channel->tstate = 1;
695 lttng_session_sync_event_enablers(channel->session);
696 /* Set atomically the state to "enabled" */
697 CMM_ACCESS_ONCE(channel->enabled) = 1;
698 end:
699 return ret;
700 }
701
702 int lttng_channel_disable(struct lttng_channel *channel)
703 {
704 int ret = 0;
705
706 if (!channel->enabled) {
707 ret = -EBUSY;
708 goto end;
709 }
710 /* Set atomically the state to "disabled" */
711 CMM_ACCESS_ONCE(channel->enabled) = 0;
712 /* Set transient enabler state to "enabled" */
713 channel->tstate = 0;
714 lttng_session_sync_event_enablers(channel->session);
715 end:
716 return ret;
717 }
718
719 static inline
720 struct cds_hlist_head *borrow_hash_table_bucket(
721 struct cds_hlist_head *hash_table,
722 unsigned int hash_table_size,
723 const struct lttng_event_desc *desc)
724 {
725 const char *event_name;
726 size_t name_len;
727 uint32_t hash;
728
729 event_name = desc->name;
730 name_len = strlen(event_name);
731
732 hash = jhash(event_name, name_len, 0);
733 return &hash_table[hash & (hash_table_size - 1)];
734 }
735
736 /*
737 * Supports event creation while tracing session is active.
738 */
739 static
740 int lttng_event_recorder_create(const struct lttng_event_desc *desc,
741 struct lttng_channel *chan)
742 {
743 struct lttng_ust_event_recorder *event_recorder;
744 struct lttng_ust_event_recorder_private *event_recorder_priv;
745 struct lttng_session *session = chan->session;
746 struct cds_hlist_head *head;
747 int ret = 0;
748 int notify_socket, loglevel;
749 const char *uri;
750
751 head = borrow_hash_table_bucket(chan->session->priv->events_ht.table,
752 LTTNG_UST_EVENT_HT_SIZE, desc);
753
754 notify_socket = lttng_get_notify_socket(session->priv->owner);
755 if (notify_socket < 0) {
756 ret = notify_socket;
757 goto socket_error;
758 }
759
760 ret = lttng_create_all_event_enums(desc->nr_fields, desc->fields,
761 session);
762 if (ret < 0) {
763 DBG("Error (%d) adding enum to session", ret);
764 goto create_enum_error;
765 }
766
767 /*
768 * Check if loglevel match. Refuse to connect event if not.
769 */
770 event_recorder = zmalloc(sizeof(struct lttng_ust_event_recorder));
771 if (!event_recorder) {
772 ret = -ENOMEM;
773 goto cache_error;
774 }
775 event_recorder->struct_size = sizeof(struct lttng_ust_event_recorder);
776
777 event_recorder->parent = zmalloc(sizeof(struct lttng_event_common));
778 if (!event_recorder->parent) {
779 ret = -ENOMEM;
780 goto parent_error;
781 }
782 event_recorder->parent->struct_size = sizeof(struct lttng_event_common);
783
784 event_recorder_priv = zmalloc(sizeof(struct lttng_ust_event_recorder_private));
785 if (!event_recorder_priv) {
786 ret = -ENOMEM;
787 goto priv_error;
788 }
789 event_recorder->priv = event_recorder_priv;
790 event_recorder_priv->pub = event_recorder;
791 event_recorder->parent->priv = &event_recorder_priv->parent;
792 event_recorder_priv->parent.pub = event_recorder->parent;
793
794 event_recorder->chan = chan;
795
796 /* Event will be enabled by enabler sync. */
797 event_recorder->parent->enabled = 0;
798 event_recorder->parent->priv->registered = 0;
799 CDS_INIT_LIST_HEAD(&event_recorder->parent->filter_bytecode_runtime_head);
800 CDS_INIT_LIST_HEAD(&event_recorder->parent->priv->enablers_ref_head);
801 event_recorder->parent->priv->desc = desc;
802
803 if (desc->loglevel)
804 loglevel = *(*event_recorder->parent->priv->desc->loglevel);
805 else
806 loglevel = TRACE_DEFAULT;
807 if (desc->u.ext.model_emf_uri)
808 uri = *(desc->u.ext.model_emf_uri);
809 else
810 uri = NULL;
811
812 /* Fetch event ID from sessiond */
813 ret = ustcomm_register_event(notify_socket,
814 session,
815 session->priv->objd,
816 chan->objd,
817 desc->name,
818 loglevel,
819 desc->signature,
820 desc->nr_fields,
821 desc->fields,
822 uri,
823 &event_recorder->id);
824 if (ret < 0) {
825 DBG("Error (%d) registering event to sessiond", ret);
826 goto sessiond_register_error;
827 }
828
829 cds_list_add(&event_recorder->priv->node, &chan->session->priv->events_head);
830 cds_hlist_add_head(&event_recorder->priv->hlist, head);
831 return 0;
832
833 sessiond_register_error:
834 free(event_recorder_priv);
835 priv_error:
836 free(event_recorder->parent);
837 parent_error:
838 free(event_recorder);
839 cache_error:
840 create_enum_error:
841 socket_error:
842 return ret;
843 }
844
845 static
846 int lttng_event_notifier_create(const struct lttng_event_desc *desc,
847 uint64_t token, uint64_t error_counter_index,
848 struct lttng_event_notifier_group *event_notifier_group)
849 {
850 struct lttng_event_notifier *event_notifier;
851 struct cds_hlist_head *head;
852 int ret = 0;
853
854 /*
855 * Get the hashtable bucket the created lttng_event_notifier object
856 * should be inserted.
857 */
858 head = borrow_hash_table_bucket(
859 event_notifier_group->event_notifiers_ht.table,
860 LTTNG_UST_EVENT_NOTIFIER_HT_SIZE, desc);
861
862 event_notifier = zmalloc(sizeof(struct lttng_event_notifier));
863 if (!event_notifier) {
864 ret = -ENOMEM;
865 goto error;
866 }
867
868 event_notifier->group = event_notifier_group;
869 event_notifier->user_token = token;
870 event_notifier->error_counter_index = error_counter_index;
871
872 /* Event notifier will be enabled by enabler sync. */
873 event_notifier->enabled = 0;
874 event_notifier->registered = 0;
875
876 CDS_INIT_LIST_HEAD(&event_notifier->filter_bytecode_runtime_head);
877 CDS_INIT_LIST_HEAD(&event_notifier->capture_bytecode_runtime_head);
878 CDS_INIT_LIST_HEAD(&event_notifier->enablers_ref_head);
879 event_notifier->desc = desc;
880 event_notifier->notification_send = lttng_event_notifier_notification_send;
881
882 cds_list_add(&event_notifier->node,
883 &event_notifier_group->event_notifiers_head);
884 cds_hlist_add_head(&event_notifier->hlist, head);
885
886 return 0;
887
888 error:
889 return ret;
890 }
891
892 static
893 void _lttng_event_notifier_destroy(struct lttng_event_notifier *event_notifier)
894 {
895 struct lttng_enabler_ref *enabler_ref, *tmp_enabler_ref;
896
897 /* Remove from event_notifier list. */
898 cds_list_del(&event_notifier->node);
899 /* Remove from event_notifier hash table. */
900 cds_hlist_del(&event_notifier->hlist);
901
902 lttng_free_event_notifier_filter_runtime(event_notifier);
903
904 /* Free event_notifier enabler refs */
905 cds_list_for_each_entry_safe(enabler_ref, tmp_enabler_ref,
906 &event_notifier->enablers_ref_head, node)
907 free(enabler_ref);
908 free(event_notifier);
909 }
910
911 static
912 int lttng_desc_match_star_glob_enabler(const struct lttng_event_desc *desc,
913 struct lttng_enabler *enabler)
914 {
915 int loglevel = 0;
916 unsigned int has_loglevel = 0;
917
918 assert(enabler->format_type == LTTNG_ENABLER_FORMAT_STAR_GLOB);
919 if (!strutils_star_glob_match(enabler->event_param.name, SIZE_MAX,
920 desc->name, SIZE_MAX))
921 return 0;
922 if (desc->loglevel) {
923 loglevel = *(*desc->loglevel);
924 has_loglevel = 1;
925 }
926 if (!lttng_loglevel_match(loglevel,
927 has_loglevel,
928 enabler->event_param.loglevel_type,
929 enabler->event_param.loglevel))
930 return 0;
931 return 1;
932 }
933
934 static
935 int lttng_desc_match_event_enabler(const struct lttng_event_desc *desc,
936 struct lttng_enabler *enabler)
937 {
938 int loglevel = 0;
939 unsigned int has_loglevel = 0;
940
941 assert(enabler->format_type == LTTNG_ENABLER_FORMAT_EVENT);
942 if (strcmp(desc->name, enabler->event_param.name))
943 return 0;
944 if (desc->loglevel) {
945 loglevel = *(*desc->loglevel);
946 has_loglevel = 1;
947 }
948 if (!lttng_loglevel_match(loglevel,
949 has_loglevel,
950 enabler->event_param.loglevel_type,
951 enabler->event_param.loglevel))
952 return 0;
953 return 1;
954 }
955
956 static
957 int lttng_desc_match_enabler(const struct lttng_event_desc *desc,
958 struct lttng_enabler *enabler)
959 {
960 switch (enabler->format_type) {
961 case LTTNG_ENABLER_FORMAT_STAR_GLOB:
962 {
963 struct lttng_ust_excluder_node *excluder;
964
965 if (!lttng_desc_match_star_glob_enabler(desc, enabler)) {
966 return 0;
967 }
968
969 /*
970 * If the matching event matches with an excluder,
971 * return 'does not match'
972 */
973 cds_list_for_each_entry(excluder, &enabler->excluder_head, node) {
974 int count;
975
976 for (count = 0; count < excluder->excluder.count; count++) {
977 int len;
978 char *excluder_name;
979
980 excluder_name = (char *) (excluder->excluder.names)
981 + count * LTTNG_UST_SYM_NAME_LEN;
982 len = strnlen(excluder_name, LTTNG_UST_SYM_NAME_LEN);
983 if (len > 0 && strutils_star_glob_match(excluder_name, len, desc->name, SIZE_MAX))
984 return 0;
985 }
986 }
987 return 1;
988 }
989 case LTTNG_ENABLER_FORMAT_EVENT:
990 return lttng_desc_match_event_enabler(desc, enabler);
991 default:
992 return -EINVAL;
993 }
994 }
995
996 static
997 int lttng_event_enabler_match_event(struct lttng_event_enabler *event_enabler,
998 struct lttng_ust_event_recorder *event_recorder)
999 {
1000 if (lttng_desc_match_enabler(event_recorder->parent->priv->desc,
1001 lttng_event_enabler_as_enabler(event_enabler))
1002 && event_recorder->chan == event_enabler->chan)
1003 return 1;
1004 else
1005 return 0;
1006 }
1007
1008 static
1009 int lttng_event_notifier_enabler_match_event_notifier(
1010 struct lttng_event_notifier_enabler *event_notifier_enabler,
1011 struct lttng_event_notifier *event_notifier)
1012 {
1013 int desc_matches = lttng_desc_match_enabler(event_notifier->desc,
1014 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler));
1015
1016 if (desc_matches && event_notifier->group == event_notifier_enabler->group &&
1017 event_notifier->user_token == event_notifier_enabler->user_token)
1018 return 1;
1019 else
1020 return 0;
1021 }
1022
1023 static
1024 struct lttng_enabler_ref *lttng_enabler_ref(
1025 struct cds_list_head *enabler_ref_list,
1026 struct lttng_enabler *enabler)
1027 {
1028 struct lttng_enabler_ref *enabler_ref;
1029
1030 cds_list_for_each_entry(enabler_ref, enabler_ref_list, node) {
1031 if (enabler_ref->ref == enabler)
1032 return enabler_ref;
1033 }
1034 return NULL;
1035 }
1036
1037 /*
1038 * Create struct lttng_event if it is missing and present in the list of
1039 * tracepoint probes.
1040 */
1041 static
1042 void lttng_create_event_if_missing(struct lttng_event_enabler *event_enabler)
1043 {
1044 struct lttng_session *session = event_enabler->chan->session;
1045 struct lttng_probe_desc *probe_desc;
1046 const struct lttng_event_desc *desc;
1047 struct lttng_ust_event_recorder_private *event_recorder_priv;
1048 int i;
1049 struct cds_list_head *probe_list;
1050
1051 probe_list = lttng_get_probe_list_head();
1052 /*
1053 * For each probe event, if we find that a probe event matches
1054 * our enabler, create an associated lttng_event if not
1055 * already present.
1056 */
1057 cds_list_for_each_entry(probe_desc, probe_list, head) {
1058 for (i = 0; i < probe_desc->nr_events; i++) {
1059 int ret;
1060 bool found = false;
1061 struct cds_hlist_head *head;
1062 struct cds_hlist_node *node;
1063
1064 desc = probe_desc->event_desc[i];
1065 if (!lttng_desc_match_enabler(desc,
1066 lttng_event_enabler_as_enabler(event_enabler)))
1067 continue;
1068
1069 head = borrow_hash_table_bucket(
1070 session->priv->events_ht.table,
1071 LTTNG_UST_EVENT_HT_SIZE, desc);
1072
1073 cds_hlist_for_each_entry(event_recorder_priv, node, head, hlist) {
1074 if (event_recorder_priv->parent.desc == desc
1075 && event_recorder_priv->pub->chan == event_enabler->chan) {
1076 found = true;
1077 break;
1078 }
1079 }
1080 if (found)
1081 continue;
1082
1083 /*
1084 * We need to create an event for this
1085 * event probe.
1086 */
1087 ret = lttng_event_recorder_create(probe_desc->event_desc[i],
1088 event_enabler->chan);
1089 if (ret) {
1090 DBG("Unable to create event %s, error %d\n",
1091 probe_desc->event_desc[i]->name, ret);
1092 }
1093 }
1094 }
1095 }
1096
1097 static
1098 void probe_provider_event_for_each(struct lttng_probe_desc *provider_desc,
1099 void (*event_func)(struct lttng_session *session,
1100 struct lttng_ust_event_recorder *event_recorder),
1101 void (*event_notifier_func)(struct lttng_event_notifier *event_notifier))
1102 {
1103 struct cds_hlist_node *node, *tmp_node;
1104 struct cds_list_head *sessionsp;
1105 unsigned int i;
1106
1107 /* Get handle on list of sessions. */
1108 sessionsp = lttng_get_sessions();
1109
1110 /*
1111 * Iterate over all events in the probe provider descriptions and
1112 * sessions to queue the unregistration of the events.
1113 */
1114 for (i = 0; i < provider_desc->nr_events; i++) {
1115 const struct lttng_event_desc *event_desc;
1116 struct lttng_event_notifier_group *event_notifier_group;
1117 struct lttng_event_notifier *event_notifier;
1118 struct lttng_ust_session_private *session_priv;
1119 struct cds_hlist_head *head;
1120 struct lttng_ust_event_recorder_private *event_recorder_priv;
1121
1122 event_desc = provider_desc->event_desc[i];
1123
1124 /*
1125 * Iterate over all session to find the current event
1126 * description.
1127 */
1128 cds_list_for_each_entry(session_priv, sessionsp, node) {
1129 /*
1130 * Get the list of events in the hashtable bucket and
1131 * iterate to find the event matching this descriptor.
1132 */
1133 head = borrow_hash_table_bucket(
1134 session_priv->events_ht.table,
1135 LTTNG_UST_EVENT_HT_SIZE, event_desc);
1136
1137 cds_hlist_for_each_entry_safe(event_recorder_priv, node, tmp_node, head, hlist) {
1138 if (event_desc == event_recorder_priv->parent.desc) {
1139 event_func(session_priv->pub, event_recorder_priv->pub);
1140 break;
1141 }
1142 }
1143 }
1144
1145 /*
1146 * Iterate over all event_notifier groups to find the current event
1147 * description.
1148 */
1149 cds_list_for_each_entry(event_notifier_group, &event_notifier_groups, node) {
1150 /*
1151 * Get the list of event_notifiers in the hashtable bucket and
1152 * iterate to find the event_notifier matching this
1153 * descriptor.
1154 */
1155 head = borrow_hash_table_bucket(
1156 event_notifier_group->event_notifiers_ht.table,
1157 LTTNG_UST_EVENT_NOTIFIER_HT_SIZE, event_desc);
1158
1159 cds_hlist_for_each_entry_safe(event_notifier, node, tmp_node, head, hlist) {
1160 if (event_desc == event_notifier->desc) {
1161 event_notifier_func(event_notifier);
1162 break;
1163 }
1164 }
1165 }
1166 }
1167 }
1168
1169 static
1170 void _unregister_event_recorder(struct lttng_session *session,
1171 struct lttng_ust_event_recorder *event_recorder)
1172 {
1173 _lttng_event_recorder_unregister(event_recorder);
1174 }
1175
1176 static
1177 void _event_enum_destroy(struct lttng_session *session,
1178 struct lttng_ust_event_recorder *event_recorder)
1179 {
1180 unsigned int i;
1181
1182 /* Destroy enums of the current event. */
1183 for (i = 0; i < event_recorder->parent->priv->desc->nr_fields; i++) {
1184 const struct lttng_enum_desc *enum_desc;
1185 const struct lttng_event_field *field;
1186 struct lttng_enum *curr_enum;
1187
1188 field = &(event_recorder->parent->priv->desc->fields[i]);
1189 switch (field->type.atype) {
1190 case atype_enum_nestable:
1191 enum_desc = field->type.u.enum_nestable.desc;
1192 break;
1193 default:
1194 continue;
1195 }
1196
1197 curr_enum = lttng_ust_enum_get_from_desc(session, enum_desc);
1198 if (curr_enum) {
1199 _lttng_enum_destroy(curr_enum);
1200 }
1201 }
1202
1203 /* Destroy event. */
1204 _lttng_event_recorder_destroy(event_recorder);
1205 }
1206
1207 /*
1208 * Iterate over all the UST sessions to unregister and destroy all probes from
1209 * the probe provider descriptor received as argument. Must me called with the
1210 * ust_lock held.
1211 */
1212 void lttng_probe_provider_unregister_events(
1213 struct lttng_probe_desc *provider_desc)
1214 {
1215 /*
1216 * Iterate over all events in the probe provider descriptions and sessions
1217 * to queue the unregistration of the events.
1218 */
1219 probe_provider_event_for_each(provider_desc, _unregister_event_recorder,
1220 _lttng_event_notifier_unregister);
1221
1222 /* Wait for grace period. */
1223 lttng_ust_urcu_synchronize_rcu();
1224 /* Prune the unregistration queue. */
1225 __tracepoint_probe_prune_release_queue();
1226
1227 /*
1228 * It is now safe to destroy the events and remove them from the event list
1229 * and hashtables.
1230 */
1231 probe_provider_event_for_each(provider_desc, _event_enum_destroy,
1232 _lttng_event_notifier_destroy);
1233 }
1234
1235 /*
1236 * Create events associated with an event enabler (if not already present),
1237 * and add backward reference from the event to the enabler.
1238 */
1239 static
1240 int lttng_event_enabler_ref_events(struct lttng_event_enabler *event_enabler)
1241 {
1242 struct lttng_session *session = event_enabler->chan->session;
1243 struct lttng_ust_event_recorder_private *event_recorder_priv;
1244
1245 if (!lttng_event_enabler_as_enabler(event_enabler)->enabled)
1246 goto end;
1247
1248 /* First ensure that probe events are created for this enabler. */
1249 lttng_create_event_if_missing(event_enabler);
1250
1251 /* For each event matching enabler in session event list. */
1252 cds_list_for_each_entry(event_recorder_priv, &session->priv->events_head, node) {
1253 struct lttng_enabler_ref *enabler_ref;
1254
1255 if (!lttng_event_enabler_match_event(event_enabler, event_recorder_priv->pub))
1256 continue;
1257
1258 enabler_ref = lttng_enabler_ref(&event_recorder_priv->parent.enablers_ref_head,
1259 lttng_event_enabler_as_enabler(event_enabler));
1260 if (!enabler_ref) {
1261 /*
1262 * If no backward ref, create it.
1263 * Add backward ref from event to enabler.
1264 */
1265 enabler_ref = zmalloc(sizeof(*enabler_ref));
1266 if (!enabler_ref)
1267 return -ENOMEM;
1268 enabler_ref->ref = lttng_event_enabler_as_enabler(
1269 event_enabler);
1270 cds_list_add(&enabler_ref->node,
1271 &event_recorder_priv->parent.enablers_ref_head);
1272 }
1273
1274 /*
1275 * Link filter bytecodes if not linked yet.
1276 */
1277 lttng_enabler_link_bytecode(event_recorder_priv->parent.desc,
1278 &session->priv->ctx,
1279 &event_recorder_priv->pub->parent->filter_bytecode_runtime_head,
1280 &lttng_event_enabler_as_enabler(event_enabler)->filter_bytecode_head);
1281
1282 /* TODO: merge event context. */
1283 }
1284 end:
1285 return 0;
1286 }
1287
1288 /*
1289 * Called at library load: connect the probe on all enablers matching
1290 * this event.
1291 * Called with session mutex held.
1292 */
1293 int lttng_fix_pending_events(void)
1294 {
1295 struct lttng_ust_session_private *session_priv;
1296
1297 cds_list_for_each_entry(session_priv, &sessions, node) {
1298 lttng_session_lazy_sync_event_enablers(session_priv->pub);
1299 }
1300 return 0;
1301 }
1302
1303 int lttng_fix_pending_event_notifiers(void)
1304 {
1305 struct lttng_event_notifier_group *event_notifier_group;
1306
1307 cds_list_for_each_entry(event_notifier_group, &event_notifier_groups, node) {
1308 lttng_event_notifier_group_sync_enablers(event_notifier_group);
1309 }
1310 return 0;
1311 }
1312
1313 /*
1314 * For each session of the owner thread, execute pending statedump.
1315 * Only dump state for the sessions owned by the caller thread, because
1316 * we don't keep ust_lock across the entire iteration.
1317 */
1318 void lttng_handle_pending_statedump(void *owner)
1319 {
1320 struct lttng_ust_session_private *session_priv;
1321
1322 /* Execute state dump */
1323 do_lttng_ust_statedump(owner);
1324
1325 /* Clear pending state dump */
1326 if (ust_lock()) {
1327 goto end;
1328 }
1329 cds_list_for_each_entry(session_priv, &sessions, node) {
1330 if (session_priv->owner != owner)
1331 continue;
1332 if (!session_priv->statedump_pending)
1333 continue;
1334 session_priv->statedump_pending = 0;
1335 }
1336 end:
1337 ust_unlock();
1338 return;
1339 }
1340
1341 /*
1342 * Only used internally at session destruction.
1343 */
1344 static
1345 void _lttng_event_recorder_destroy(struct lttng_ust_event_recorder *event_recorder)
1346 {
1347 struct lttng_enabler_ref *enabler_ref, *tmp_enabler_ref;
1348
1349 /* Remove from event list. */
1350 cds_list_del(&event_recorder->priv->node);
1351 /* Remove from event hash table. */
1352 cds_hlist_del(&event_recorder->priv->hlist);
1353
1354 lttng_destroy_context(event_recorder->ctx);
1355 lttng_free_event_recorder_filter_runtime(event_recorder);
1356 /* Free event enabler refs */
1357 cds_list_for_each_entry_safe(enabler_ref, tmp_enabler_ref,
1358 &event_recorder->parent->priv->enablers_ref_head, node)
1359 free(enabler_ref);
1360 free(event_recorder->priv);
1361 free(event_recorder->parent);
1362 free(event_recorder);
1363 }
1364
1365 static
1366 void _lttng_enum_destroy(struct lttng_enum *_enum)
1367 {
1368 cds_list_del(&_enum->node);
1369 cds_hlist_del(&_enum->hlist);
1370 free(_enum);
1371 }
1372
1373 void lttng_ust_events_exit(void)
1374 {
1375 struct lttng_ust_session_private *session_priv, *tmpsession_priv;
1376
1377 cds_list_for_each_entry_safe(session_priv, tmpsession_priv, &sessions, node)
1378 lttng_session_destroy(session_priv->pub);
1379 }
1380
1381 /*
1382 * Enabler management.
1383 */
1384 struct lttng_event_enabler *lttng_event_enabler_create(
1385 enum lttng_enabler_format_type format_type,
1386 struct lttng_ust_event *event_param,
1387 struct lttng_channel *chan)
1388 {
1389 struct lttng_event_enabler *event_enabler;
1390
1391 event_enabler = zmalloc(sizeof(*event_enabler));
1392 if (!event_enabler)
1393 return NULL;
1394 event_enabler->base.format_type = format_type;
1395 CDS_INIT_LIST_HEAD(&event_enabler->base.filter_bytecode_head);
1396 CDS_INIT_LIST_HEAD(&event_enabler->base.excluder_head);
1397 memcpy(&event_enabler->base.event_param, event_param,
1398 sizeof(event_enabler->base.event_param));
1399 event_enabler->chan = chan;
1400 /* ctx left NULL */
1401 event_enabler->base.enabled = 0;
1402 cds_list_add(&event_enabler->node, &event_enabler->chan->session->priv->enablers_head);
1403 lttng_session_lazy_sync_event_enablers(event_enabler->chan->session);
1404
1405 return event_enabler;
1406 }
1407
1408 struct lttng_event_notifier_enabler *lttng_event_notifier_enabler_create(
1409 struct lttng_event_notifier_group *event_notifier_group,
1410 enum lttng_enabler_format_type format_type,
1411 struct lttng_ust_event_notifier *event_notifier_param)
1412 {
1413 struct lttng_event_notifier_enabler *event_notifier_enabler;
1414
1415 event_notifier_enabler = zmalloc(sizeof(*event_notifier_enabler));
1416 if (!event_notifier_enabler)
1417 return NULL;
1418 event_notifier_enabler->base.format_type = format_type;
1419 CDS_INIT_LIST_HEAD(&event_notifier_enabler->base.filter_bytecode_head);
1420 CDS_INIT_LIST_HEAD(&event_notifier_enabler->capture_bytecode_head);
1421 CDS_INIT_LIST_HEAD(&event_notifier_enabler->base.excluder_head);
1422
1423 event_notifier_enabler->user_token = event_notifier_param->event.token;
1424 event_notifier_enabler->error_counter_index = event_notifier_param->error_counter_index;
1425 event_notifier_enabler->num_captures = 0;
1426
1427 memcpy(&event_notifier_enabler->base.event_param.name,
1428 event_notifier_param->event.name,
1429 sizeof(event_notifier_enabler->base.event_param.name));
1430 event_notifier_enabler->base.event_param.instrumentation =
1431 event_notifier_param->event.instrumentation;
1432 event_notifier_enabler->base.event_param.loglevel =
1433 event_notifier_param->event.loglevel;
1434 event_notifier_enabler->base.event_param.loglevel_type =
1435 event_notifier_param->event.loglevel_type;
1436
1437 event_notifier_enabler->base.enabled = 0;
1438 event_notifier_enabler->group = event_notifier_group;
1439
1440 cds_list_add(&event_notifier_enabler->node,
1441 &event_notifier_group->enablers_head);
1442
1443 lttng_event_notifier_group_sync_enablers(event_notifier_group);
1444
1445 return event_notifier_enabler;
1446 }
1447
1448 int lttng_event_enabler_enable(struct lttng_event_enabler *event_enabler)
1449 {
1450 lttng_event_enabler_as_enabler(event_enabler)->enabled = 1;
1451 lttng_session_lazy_sync_event_enablers(event_enabler->chan->session);
1452
1453 return 0;
1454 }
1455
1456 int lttng_event_enabler_disable(struct lttng_event_enabler *event_enabler)
1457 {
1458 lttng_event_enabler_as_enabler(event_enabler)->enabled = 0;
1459 lttng_session_lazy_sync_event_enablers(event_enabler->chan->session);
1460
1461 return 0;
1462 }
1463
1464 static
1465 void _lttng_enabler_attach_filter_bytecode(struct lttng_enabler *enabler,
1466 struct lttng_ust_bytecode_node **bytecode)
1467 {
1468 (*bytecode)->enabler = enabler;
1469 cds_list_add_tail(&(*bytecode)->node, &enabler->filter_bytecode_head);
1470 /* Take ownership of bytecode */
1471 *bytecode = NULL;
1472 }
1473
1474 int lttng_event_enabler_attach_filter_bytecode(struct lttng_event_enabler *event_enabler,
1475 struct lttng_ust_bytecode_node **bytecode)
1476 {
1477 _lttng_enabler_attach_filter_bytecode(
1478 lttng_event_enabler_as_enabler(event_enabler), bytecode);
1479
1480 lttng_session_lazy_sync_event_enablers(event_enabler->chan->session);
1481 return 0;
1482 }
1483
1484 static
1485 void _lttng_enabler_attach_exclusion(struct lttng_enabler *enabler,
1486 struct lttng_ust_excluder_node **excluder)
1487 {
1488 (*excluder)->enabler = enabler;
1489 cds_list_add_tail(&(*excluder)->node, &enabler->excluder_head);
1490 /* Take ownership of excluder */
1491 *excluder = NULL;
1492 }
1493
1494 int lttng_event_enabler_attach_exclusion(struct lttng_event_enabler *event_enabler,
1495 struct lttng_ust_excluder_node **excluder)
1496 {
1497 _lttng_enabler_attach_exclusion(
1498 lttng_event_enabler_as_enabler(event_enabler), excluder);
1499
1500 lttng_session_lazy_sync_event_enablers(event_enabler->chan->session);
1501 return 0;
1502 }
1503
1504 int lttng_event_notifier_enabler_enable(
1505 struct lttng_event_notifier_enabler *event_notifier_enabler)
1506 {
1507 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)->enabled = 1;
1508 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
1509
1510 return 0;
1511 }
1512
1513 int lttng_event_notifier_enabler_disable(
1514 struct lttng_event_notifier_enabler *event_notifier_enabler)
1515 {
1516 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)->enabled = 0;
1517 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
1518
1519 return 0;
1520 }
1521
1522 int lttng_event_notifier_enabler_attach_filter_bytecode(
1523 struct lttng_event_notifier_enabler *event_notifier_enabler,
1524 struct lttng_ust_bytecode_node **bytecode)
1525 {
1526 _lttng_enabler_attach_filter_bytecode(
1527 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler),
1528 bytecode);
1529
1530 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
1531 return 0;
1532 }
1533
1534 int lttng_event_notifier_enabler_attach_capture_bytecode(
1535 struct lttng_event_notifier_enabler *event_notifier_enabler,
1536 struct lttng_ust_bytecode_node **bytecode)
1537 {
1538 (*bytecode)->enabler = lttng_event_notifier_enabler_as_enabler(
1539 event_notifier_enabler);
1540 cds_list_add_tail(&(*bytecode)->node,
1541 &event_notifier_enabler->capture_bytecode_head);
1542 /* Take ownership of bytecode */
1543 *bytecode = NULL;
1544 event_notifier_enabler->num_captures++;
1545
1546 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
1547 return 0;
1548 }
1549
1550 int lttng_event_notifier_enabler_attach_exclusion(
1551 struct lttng_event_notifier_enabler *event_notifier_enabler,
1552 struct lttng_ust_excluder_node **excluder)
1553 {
1554 _lttng_enabler_attach_exclusion(
1555 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler),
1556 excluder);
1557
1558 lttng_event_notifier_group_sync_enablers(event_notifier_enabler->group);
1559 return 0;
1560 }
1561
1562 int lttng_attach_context(struct lttng_ust_context *context_param,
1563 union ust_args *uargs,
1564 struct lttng_ctx **ctx, struct lttng_session *session)
1565 {
1566 /*
1567 * We cannot attach a context after trace has been started for a
1568 * session because the metadata does not allow expressing this
1569 * information outside of the original channel scope.
1570 */
1571 if (session->priv->been_active)
1572 return -EPERM;
1573
1574 switch (context_param->ctx) {
1575 case LTTNG_UST_CONTEXT_PTHREAD_ID:
1576 return lttng_add_pthread_id_to_ctx(ctx);
1577 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
1578 {
1579 struct lttng_ust_perf_counter_ctx *perf_ctx_param;
1580
1581 perf_ctx_param = &context_param->u.perf_counter;
1582 return lttng_add_perf_counter_to_ctx(
1583 perf_ctx_param->type,
1584 perf_ctx_param->config,
1585 perf_ctx_param->name,
1586 ctx);
1587 }
1588 case LTTNG_UST_CONTEXT_VTID:
1589 return lttng_add_vtid_to_ctx(ctx);
1590 case LTTNG_UST_CONTEXT_VPID:
1591 return lttng_add_vpid_to_ctx(ctx);
1592 case LTTNG_UST_CONTEXT_PROCNAME:
1593 return lttng_add_procname_to_ctx(ctx);
1594 case LTTNG_UST_CONTEXT_IP:
1595 return lttng_add_ip_to_ctx(ctx);
1596 case LTTNG_UST_CONTEXT_CPU_ID:
1597 return lttng_add_cpu_id_to_ctx(ctx);
1598 case LTTNG_UST_CONTEXT_APP_CONTEXT:
1599 return lttng_ust_add_app_context_to_ctx_rcu(uargs->app_context.ctxname,
1600 ctx);
1601 case LTTNG_UST_CONTEXT_CGROUP_NS:
1602 return lttng_add_cgroup_ns_to_ctx(ctx);
1603 case LTTNG_UST_CONTEXT_IPC_NS:
1604 return lttng_add_ipc_ns_to_ctx(ctx);
1605 case LTTNG_UST_CONTEXT_MNT_NS:
1606 return lttng_add_mnt_ns_to_ctx(ctx);
1607 case LTTNG_UST_CONTEXT_NET_NS:
1608 return lttng_add_net_ns_to_ctx(ctx);
1609 case LTTNG_UST_CONTEXT_PID_NS:
1610 return lttng_add_pid_ns_to_ctx(ctx);
1611 case LTTNG_UST_CONTEXT_TIME_NS:
1612 return lttng_add_time_ns_to_ctx(ctx);
1613 case LTTNG_UST_CONTEXT_USER_NS:
1614 return lttng_add_user_ns_to_ctx(ctx);
1615 case LTTNG_UST_CONTEXT_UTS_NS:
1616 return lttng_add_uts_ns_to_ctx(ctx);
1617 case LTTNG_UST_CONTEXT_VUID:
1618 return lttng_add_vuid_to_ctx(ctx);
1619 case LTTNG_UST_CONTEXT_VEUID:
1620 return lttng_add_veuid_to_ctx(ctx);
1621 case LTTNG_UST_CONTEXT_VSUID:
1622 return lttng_add_vsuid_to_ctx(ctx);
1623 case LTTNG_UST_CONTEXT_VGID:
1624 return lttng_add_vgid_to_ctx(ctx);
1625 case LTTNG_UST_CONTEXT_VEGID:
1626 return lttng_add_vegid_to_ctx(ctx);
1627 case LTTNG_UST_CONTEXT_VSGID:
1628 return lttng_add_vsgid_to_ctx(ctx);
1629 default:
1630 return -EINVAL;
1631 }
1632 }
1633
1634 int lttng_event_enabler_attach_context(struct lttng_event_enabler *enabler,
1635 struct lttng_ust_context *context_param)
1636 {
1637 return -ENOSYS;
1638 }
1639
1640 void lttng_event_enabler_destroy(struct lttng_event_enabler *event_enabler)
1641 {
1642 if (!event_enabler) {
1643 return;
1644 }
1645 cds_list_del(&event_enabler->node);
1646
1647 lttng_enabler_destroy(lttng_event_enabler_as_enabler(event_enabler));
1648
1649 lttng_destroy_context(event_enabler->ctx);
1650 free(event_enabler);
1651 }
1652
1653 /*
1654 * lttng_session_sync_event_enablers should be called just before starting a
1655 * session.
1656 */
1657 static
1658 void lttng_session_sync_event_enablers(struct lttng_session *session)
1659 {
1660 struct lttng_event_enabler *event_enabler;
1661 struct lttng_ust_event_recorder_private *event_recorder_priv;
1662
1663 cds_list_for_each_entry(event_enabler, &session->priv->enablers_head, node)
1664 lttng_event_enabler_ref_events(event_enabler);
1665 /*
1666 * For each event, if at least one of its enablers is enabled,
1667 * and its channel and session transient states are enabled, we
1668 * enable the event, else we disable it.
1669 */
1670 cds_list_for_each_entry(event_recorder_priv, &session->priv->events_head, node) {
1671 struct lttng_enabler_ref *enabler_ref;
1672 struct lttng_bytecode_runtime *runtime;
1673 int enabled = 0, has_enablers_without_bytecode = 0;
1674
1675 /* Enable events */
1676 cds_list_for_each_entry(enabler_ref,
1677 &event_recorder_priv->parent.enablers_ref_head, node) {
1678 if (enabler_ref->ref->enabled) {
1679 enabled = 1;
1680 break;
1681 }
1682 }
1683 /*
1684 * Enabled state is based on union of enablers, with
1685 * intesection of session and channel transient enable
1686 * states.
1687 */
1688 enabled = enabled && session->priv->tstate && event_recorder_priv->pub->chan->tstate;
1689
1690 CMM_STORE_SHARED(event_recorder_priv->pub->parent->enabled, enabled);
1691 /*
1692 * Sync tracepoint registration with event enabled
1693 * state.
1694 */
1695 if (enabled) {
1696 if (!event_recorder_priv->parent.registered)
1697 register_event_recorder(event_recorder_priv->pub);
1698 } else {
1699 if (event_recorder_priv->parent.registered)
1700 unregister_event_recorder(event_recorder_priv->pub);
1701 }
1702
1703 /* Check if has enablers without bytecode enabled */
1704 cds_list_for_each_entry(enabler_ref,
1705 &event_recorder_priv->parent.enablers_ref_head, node) {
1706 if (enabler_ref->ref->enabled
1707 && cds_list_empty(&enabler_ref->ref->filter_bytecode_head)) {
1708 has_enablers_without_bytecode = 1;
1709 break;
1710 }
1711 }
1712 event_recorder_priv->pub->parent->has_enablers_without_bytecode =
1713 has_enablers_without_bytecode;
1714
1715 /* Enable filters */
1716 cds_list_for_each_entry(runtime,
1717 &event_recorder_priv->pub->parent->filter_bytecode_runtime_head, node) {
1718 lttng_bytecode_filter_sync_state(runtime);
1719 }
1720 }
1721 __tracepoint_probe_prune_release_queue();
1722 }
1723
1724 /* Support for event notifier is introduced by probe provider major version 2. */
1725 static
1726 bool lttng_ust_probe_supports_event_notifier(struct lttng_probe_desc *probe_desc)
1727 {
1728 return probe_desc->major >= 2;
1729 }
1730
1731 static
1732 void lttng_create_event_notifier_if_missing(
1733 struct lttng_event_notifier_enabler *event_notifier_enabler)
1734 {
1735 struct lttng_event_notifier_group *event_notifier_group = event_notifier_enabler->group;
1736 struct lttng_probe_desc *probe_desc;
1737 struct cds_list_head *probe_list;
1738 int i;
1739
1740 probe_list = lttng_get_probe_list_head();
1741
1742 cds_list_for_each_entry(probe_desc, probe_list, head) {
1743 for (i = 0; i < probe_desc->nr_events; i++) {
1744 int ret;
1745 bool found = false;
1746 const struct lttng_event_desc *desc;
1747 struct lttng_event_notifier *event_notifier;
1748 struct cds_hlist_head *head;
1749 struct cds_hlist_node *node;
1750
1751 desc = probe_desc->event_desc[i];
1752
1753 if (!lttng_desc_match_enabler(desc,
1754 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)))
1755 continue;
1756
1757 /*
1758 * Given the current event_notifier group, get the bucket that
1759 * the target event_notifier would be if it was already
1760 * created.
1761 */
1762 head = borrow_hash_table_bucket(
1763 event_notifier_group->event_notifiers_ht.table,
1764 LTTNG_UST_EVENT_NOTIFIER_HT_SIZE, desc);
1765
1766 cds_hlist_for_each_entry(event_notifier, node, head, hlist) {
1767 /*
1768 * Check if event_notifier already exists by checking
1769 * if the event_notifier and enabler share the same
1770 * description and id.
1771 */
1772 if (event_notifier->desc == desc &&
1773 event_notifier->user_token == event_notifier_enabler->user_token) {
1774 found = true;
1775 break;
1776 }
1777 }
1778
1779 if (found)
1780 continue;
1781
1782 /* Check that the probe supports event notifiers, else report the error. */
1783 if (!lttng_ust_probe_supports_event_notifier(probe_desc)) {
1784 ERR("Probe \"%s\" contains event \"%s\" which matches an enabled event notifier, "
1785 "but its version (%u.%u) is too old and does not implement event notifiers. "
1786 "It needs to be recompiled against a newer version of LTTng-UST, otherwise "
1787 "this event will not generate any notification.",
1788 probe_desc->provider,
1789 desc->name,
1790 probe_desc->major,
1791 probe_desc->minor);
1792 continue;
1793 }
1794 /*
1795 * We need to create a event_notifier for this event probe.
1796 */
1797 ret = lttng_event_notifier_create(desc,
1798 event_notifier_enabler->user_token,
1799 event_notifier_enabler->error_counter_index,
1800 event_notifier_group);
1801 if (ret) {
1802 DBG("Unable to create event_notifier %s, error %d\n",
1803 probe_desc->event_desc[i]->name, ret);
1804 }
1805 }
1806 }
1807 }
1808
1809 /*
1810 * Create event_notifiers associated with a event_notifier enabler (if not already present).
1811 */
1812 static
1813 int lttng_event_notifier_enabler_ref_event_notifiers(
1814 struct lttng_event_notifier_enabler *event_notifier_enabler)
1815 {
1816 struct lttng_event_notifier_group *event_notifier_group = event_notifier_enabler->group;
1817 struct lttng_event_notifier *event_notifier;
1818
1819 /*
1820 * Only try to create event_notifiers for enablers that are enabled, the user
1821 * might still be attaching filter or exclusion to the
1822 * event_notifier_enabler.
1823 */
1824 if (!lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)->enabled)
1825 goto end;
1826
1827 /* First, ensure that probe event_notifiers are created for this enabler. */
1828 lttng_create_event_notifier_if_missing(event_notifier_enabler);
1829
1830 /* Link the created event_notifier with its associated enabler. */
1831 cds_list_for_each_entry(event_notifier, &event_notifier_group->event_notifiers_head, node) {
1832 struct lttng_enabler_ref *enabler_ref;
1833
1834 if (!lttng_event_notifier_enabler_match_event_notifier(event_notifier_enabler, event_notifier))
1835 continue;
1836
1837 enabler_ref = lttng_enabler_ref(&event_notifier->enablers_ref_head,
1838 lttng_event_notifier_enabler_as_enabler(event_notifier_enabler));
1839 if (!enabler_ref) {
1840 /*
1841 * If no backward ref, create it.
1842 * Add backward ref from event_notifier to enabler.
1843 */
1844 enabler_ref = zmalloc(sizeof(*enabler_ref));
1845 if (!enabler_ref)
1846 return -ENOMEM;
1847
1848 enabler_ref->ref = lttng_event_notifier_enabler_as_enabler(
1849 event_notifier_enabler);
1850 cds_list_add(&enabler_ref->node,
1851 &event_notifier->enablers_ref_head);
1852 }
1853
1854 /*
1855 * Link filter bytecodes if not linked yet.
1856 */
1857 lttng_enabler_link_bytecode(event_notifier->desc,
1858 &event_notifier_group->ctx,
1859 &event_notifier->filter_bytecode_runtime_head,
1860 &lttng_event_notifier_enabler_as_enabler(event_notifier_enabler)->filter_bytecode_head);
1861
1862 /*
1863 * Link capture bytecodes if not linked yet.
1864 */
1865 lttng_enabler_link_bytecode(event_notifier->desc,
1866 &event_notifier_group->ctx, &event_notifier->capture_bytecode_runtime_head,
1867 &event_notifier_enabler->capture_bytecode_head);
1868
1869 event_notifier->num_captures = event_notifier_enabler->num_captures;
1870 }
1871 end:
1872 return 0;
1873 }
1874
1875 static
1876 void lttng_event_notifier_group_sync_enablers(struct lttng_event_notifier_group *event_notifier_group)
1877 {
1878 struct lttng_event_notifier_enabler *event_notifier_enabler;
1879 struct lttng_event_notifier *event_notifier;
1880
1881 cds_list_for_each_entry(event_notifier_enabler, &event_notifier_group->enablers_head, node)
1882 lttng_event_notifier_enabler_ref_event_notifiers(event_notifier_enabler);
1883
1884 /*
1885 * For each event_notifier, if at least one of its enablers is enabled,
1886 * we enable the event_notifier, else we disable it.
1887 */
1888 cds_list_for_each_entry(event_notifier, &event_notifier_group->event_notifiers_head, node) {
1889 struct lttng_enabler_ref *enabler_ref;
1890 struct lttng_bytecode_runtime *runtime;
1891 int enabled = 0, has_enablers_without_bytecode = 0;
1892
1893 /* Enable event_notifiers */
1894 cds_list_for_each_entry(enabler_ref,
1895 &event_notifier->enablers_ref_head, node) {
1896 if (enabler_ref->ref->enabled) {
1897 enabled = 1;
1898 break;
1899 }
1900 }
1901
1902 CMM_STORE_SHARED(event_notifier->enabled, enabled);
1903 /*
1904 * Sync tracepoint registration with event_notifier enabled
1905 * state.
1906 */
1907 if (enabled) {
1908 if (!event_notifier->registered)
1909 register_event_notifier(event_notifier);
1910 } else {
1911 if (event_notifier->registered)
1912 unregister_event_notifier(event_notifier);
1913 }
1914
1915 /* Check if has enablers without bytecode enabled */
1916 cds_list_for_each_entry(enabler_ref,
1917 &event_notifier->enablers_ref_head, node) {
1918 if (enabler_ref->ref->enabled
1919 && cds_list_empty(&enabler_ref->ref->filter_bytecode_head)) {
1920 has_enablers_without_bytecode = 1;
1921 break;
1922 }
1923 }
1924 event_notifier->has_enablers_without_bytecode =
1925 has_enablers_without_bytecode;
1926
1927 /* Enable filters */
1928 cds_list_for_each_entry(runtime,
1929 &event_notifier->filter_bytecode_runtime_head, node) {
1930 lttng_bytecode_filter_sync_state(runtime);
1931 }
1932
1933 /* Enable captures. */
1934 cds_list_for_each_entry(runtime,
1935 &event_notifier->capture_bytecode_runtime_head, node) {
1936 lttng_bytecode_capture_sync_state(runtime);
1937 }
1938 }
1939 __tracepoint_probe_prune_release_queue();
1940 }
1941
1942 /*
1943 * Apply enablers to session events, adding events to session if need
1944 * be. It is required after each modification applied to an active
1945 * session, and right before session "start".
1946 * "lazy" sync means we only sync if required.
1947 */
1948 static
1949 void lttng_session_lazy_sync_event_enablers(struct lttng_session *session)
1950 {
1951 /* We can skip if session is not active */
1952 if (!session->active)
1953 return;
1954 lttng_session_sync_event_enablers(session);
1955 }
1956
1957 /*
1958 * Update all sessions with the given app context.
1959 * Called with ust lock held.
1960 * This is invoked when an application context gets loaded/unloaded. It
1961 * ensures the context callbacks are in sync with the application
1962 * context (either app context callbacks, or dummy callbacks).
1963 */
1964 void lttng_ust_context_set_session_provider(const char *name,
1965 size_t (*get_size)(struct lttng_ctx_field *field, size_t offset),
1966 void (*record)(struct lttng_ctx_field *field,
1967 struct lttng_ust_lib_ring_buffer_ctx *ctx,
1968 struct lttng_channel *chan),
1969 void (*get_value)(struct lttng_ctx_field *field,
1970 struct lttng_ctx_value *value))
1971 {
1972 struct lttng_ust_session_private *session_priv;
1973
1974 cds_list_for_each_entry(session_priv, &sessions, node) {
1975 struct lttng_channel *chan;
1976 struct lttng_ust_event_recorder_private *event_recorder_priv;
1977 int ret;
1978
1979 ret = lttng_ust_context_set_provider_rcu(&session_priv->ctx,
1980 name, get_size, record, get_value);
1981 if (ret)
1982 abort();
1983 cds_list_for_each_entry(chan, &session_priv->chan_head, node) {
1984 ret = lttng_ust_context_set_provider_rcu(&chan->ctx,
1985 name, get_size, record, get_value);
1986 if (ret)
1987 abort();
1988 }
1989 cds_list_for_each_entry(event_recorder_priv, &session_priv->events_head, node) {
1990 ret = lttng_ust_context_set_provider_rcu(&event_recorder_priv->pub->ctx,
1991 name, get_size, record, get_value);
1992 if (ret)
1993 abort();
1994 }
1995 }
1996 }
1997
1998 /*
1999 * Update all event_notifier groups with the given app context.
2000 * Called with ust lock held.
2001 * This is invoked when an application context gets loaded/unloaded. It
2002 * ensures the context callbacks are in sync with the application
2003 * context (either app context callbacks, or dummy callbacks).
2004 */
2005 void lttng_ust_context_set_event_notifier_group_provider(const char *name,
2006 size_t (*get_size)(struct lttng_ctx_field *field, size_t offset),
2007 void (*record)(struct lttng_ctx_field *field,
2008 struct lttng_ust_lib_ring_buffer_ctx *ctx,
2009 struct lttng_channel *chan),
2010 void (*get_value)(struct lttng_ctx_field *field,
2011 struct lttng_ctx_value *value))
2012 {
2013 struct lttng_event_notifier_group *event_notifier_group;
2014
2015 cds_list_for_each_entry(event_notifier_group, &event_notifier_groups, node) {
2016 int ret;
2017
2018 ret = lttng_ust_context_set_provider_rcu(
2019 &event_notifier_group->ctx,
2020 name, get_size, record, get_value);
2021 if (ret)
2022 abort();
2023 }
2024 }
This page took 0.068494 seconds and 5 git commands to generate.