4 * Holds LTTng per-session event registry.
6 * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; only
11 * version 2.1 of the License.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <urcu/list.h>
26 #include <urcu/hlist.h>
35 #include <lttng/ust-endian.h>
39 #include <urcu/compiler.h>
40 #include <urcu/uatomic.h>
41 #include <urcu/arch.h>
43 #include <lttng/tracepoint.h>
44 #include <lttng/ust-events.h>
46 #include <usterr-signal-safe.h>
48 #include <lttng/ust-ctl.h>
52 #include "lttng-ust-uuid.h"
54 #include "tracepoint-internal.h"
55 #include "lttng-tracer.h"
56 #include "lttng-tracer-core.h"
58 #include "../libringbuffer/shm.h"
62 * The sessions mutex is the centralized mutex across UST tracing
63 * control and probe registration. All operations within this file are
64 * called by the communication thread, under ust_lock protection.
66 static pthread_mutex_t sessions_mutex
= PTHREAD_MUTEX_INITIALIZER
;
70 pthread_mutex_lock(&sessions_mutex
);
75 pthread_mutex_unlock(&sessions_mutex
);
78 static CDS_LIST_HEAD(sessions
);
80 static void _lttng_event_destroy(struct lttng_event
*event
);
83 void lttng_session_lazy_sync_enablers(struct lttng_session
*session
);
85 void lttng_session_sync_enablers(struct lttng_session
*session
);
87 void lttng_enabler_destroy(struct lttng_enabler
*enabler
);
90 * Called with ust lock held.
92 int lttng_session_active(void)
94 struct lttng_session
*iter
;
96 cds_list_for_each_entry(iter
, &sessions
, node
) {
104 int lttng_loglevel_match(int loglevel
,
105 unsigned int has_loglevel
,
106 enum lttng_ust_loglevel_type req_type
,
109 if (req_type
== LTTNG_UST_LOGLEVEL_ALL
)
112 loglevel
= TRACE_DEFAULT
;
114 case LTTNG_UST_LOGLEVEL_RANGE
:
115 if (loglevel
<= req_loglevel
|| req_loglevel
== -1)
119 case LTTNG_UST_LOGLEVEL_SINGLE
:
120 if (loglevel
== req_loglevel
|| req_loglevel
== -1)
124 case LTTNG_UST_LOGLEVEL_ALL
:
130 void synchronize_trace(void)
135 struct lttng_session
*lttng_session_create(void)
137 struct lttng_session
*session
;
140 session
= zmalloc(sizeof(struct lttng_session
));
143 CDS_INIT_LIST_HEAD(&session
->chan_head
);
144 CDS_INIT_LIST_HEAD(&session
->events_head
);
145 CDS_INIT_LIST_HEAD(&session
->enablers_head
);
146 for (i
= 0; i
< LTTNG_UST_EVENT_HT_SIZE
; i
++)
147 CDS_INIT_HLIST_HEAD(&session
->events_ht
.table
[i
]);
148 cds_list_add(&session
->node
, &sessions
);
153 * Only used internally at session destruction.
156 void _lttng_channel_unmap(struct lttng_channel
*lttng_chan
)
158 struct channel
*chan
;
159 struct lttng_ust_shm_handle
*handle
;
161 cds_list_del(<tng_chan
->node
);
162 lttng_destroy_context(lttng_chan
->ctx
);
163 chan
= lttng_chan
->chan
;
164 handle
= lttng_chan
->handle
;
166 * note: lttng_chan is private data contained within handle. It
167 * will be freed along with the handle.
169 channel_destroy(chan
, handle
, 0);
173 void register_event(struct lttng_event
*event
)
176 const struct lttng_event_desc
*desc
;
178 assert(event
->registered
== 0);
180 ret
= __tracepoint_probe_register(desc
->name
,
181 desc
->probe_callback
,
182 event
, desc
->signature
);
185 event
->registered
= 1;
189 void unregister_event(struct lttng_event
*event
)
192 const struct lttng_event_desc
*desc
;
194 assert(event
->registered
== 1);
196 ret
= __tracepoint_probe_unregister(desc
->name
,
197 desc
->probe_callback
,
201 event
->registered
= 0;
205 * Only used internally at session destruction.
208 void _lttng_event_unregister(struct lttng_event
*event
)
210 if (event
->registered
)
211 unregister_event(event
);
214 void lttng_session_destroy(struct lttng_session
*session
)
216 struct lttng_channel
*chan
, *tmpchan
;
217 struct lttng_event
*event
, *tmpevent
;
218 struct lttng_enabler
*enabler
, *tmpenabler
;
220 CMM_ACCESS_ONCE(session
->active
) = 0;
221 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
222 _lttng_event_unregister(event
);
224 synchronize_trace(); /* Wait for in-flight events to complete */
225 cds_list_for_each_entry_safe(enabler
, tmpenabler
,
226 &session
->enablers_head
, node
)
227 lttng_enabler_destroy(enabler
);
228 cds_list_for_each_entry_safe(event
, tmpevent
,
229 &session
->events_head
, node
)
230 _lttng_event_destroy(event
);
231 cds_list_for_each_entry_safe(chan
, tmpchan
, &session
->chan_head
, node
)
232 _lttng_channel_unmap(chan
);
233 cds_list_del(&session
->node
);
237 int lttng_session_enable(struct lttng_session
*session
)
240 struct lttng_channel
*chan
;
243 if (session
->active
) {
248 notify_socket
= lttng_get_notify_socket(session
->owner
);
249 if (notify_socket
< 0)
250 return notify_socket
;
252 /* Set transient enabler state to "enabled" */
254 /* We need to sync enablers with session before activation. */
255 lttng_session_sync_enablers(session
);
258 * Snapshot the number of events per channel to know the type of header
261 cds_list_for_each_entry(chan
, &session
->chan_head
, node
) {
262 const struct lttng_ctx
*ctx
;
263 const struct lttng_ctx_field
*fields
= NULL
;
264 size_t nr_fields
= 0;
267 /* don't change it if session stop/restart */
268 if (chan
->header_type
)
272 nr_fields
= ctx
->nr_fields
;
273 fields
= ctx
->fields
;
275 ret
= ustcomm_register_channel(notify_socket
,
283 DBG("Error (%d) registering channel to sessiond", ret
);
286 if (chan_id
!= chan
->id
) {
287 DBG("Error: channel registration id (%u) does not match id assigned at creation (%u)",
293 /* Set atomically the state to "active" */
294 CMM_ACCESS_ONCE(session
->active
) = 1;
295 CMM_ACCESS_ONCE(session
->been_active
) = 1;
300 int lttng_session_disable(struct lttng_session
*session
)
304 if (!session
->active
) {
308 /* Set atomically the state to "inactive" */
309 CMM_ACCESS_ONCE(session
->active
) = 0;
311 /* Set transient enabler state to "disabled" */
313 lttng_session_sync_enablers(session
);
318 int lttng_channel_enable(struct lttng_channel
*channel
)
322 if (channel
->enabled
) {
326 /* Set transient enabler state to "enabled" */
328 lttng_session_sync_enablers(channel
->session
);
329 /* Set atomically the state to "enabled" */
330 CMM_ACCESS_ONCE(channel
->enabled
) = 1;
335 int lttng_channel_disable(struct lttng_channel
*channel
)
339 if (!channel
->enabled
) {
343 /* Set atomically the state to "disabled" */
344 CMM_ACCESS_ONCE(channel
->enabled
) = 0;
345 /* Set transient enabler state to "enabled" */
347 lttng_session_sync_enablers(channel
->session
);
353 * Supports event creation while tracing session is active.
356 int lttng_event_create(const struct lttng_event_desc
*desc
,
357 struct lttng_channel
*chan
)
359 const char *event_name
= desc
->name
;
360 struct lttng_event
*event
;
361 struct lttng_session
*session
= chan
->session
;
362 struct cds_hlist_head
*head
;
363 struct cds_hlist_node
*node
;
365 size_t name_len
= strlen(event_name
);
367 int notify_socket
, loglevel
;
370 hash
= jhash(event_name
, name_len
, 0);
371 head
= &chan
->session
->events_ht
.table
[hash
& (LTTNG_UST_EVENT_HT_SIZE
- 1)];
372 cds_hlist_for_each_entry(event
, node
, head
, hlist
) {
374 if (!strncmp(event
->desc
->name
, desc
->name
,
375 LTTNG_UST_SYM_NAME_LEN
- 1)
376 && chan
== event
->chan
) {
382 notify_socket
= lttng_get_notify_socket(session
->owner
);
383 if (notify_socket
< 0) {
389 * Check if loglevel match. Refuse to connect event if not.
391 event
= zmalloc(sizeof(struct lttng_event
));
398 /* Event will be enabled by enabler sync. */
400 event
->registered
= 0;
401 CDS_INIT_LIST_HEAD(&event
->bytecode_runtime_head
);
402 CDS_INIT_LIST_HEAD(&event
->enablers_ref_head
);
406 loglevel
= *(*event
->desc
->loglevel
);
408 loglevel
= TRACE_DEFAULT
;
409 if (desc
->u
.ext
.model_emf_uri
)
410 uri
= *(desc
->u
.ext
.model_emf_uri
);
414 /* Fetch event ID from sessiond */
415 ret
= ustcomm_register_event(notify_socket
,
426 DBG("Error (%d) registering event to sessiond", ret
);
427 goto sessiond_register_error
;
430 /* Populate lttng_event structure before tracepoint registration. */
432 cds_list_add(&event
->node
, &chan
->session
->events_head
);
433 cds_hlist_add_head(&event
->hlist
, head
);
436 sessiond_register_error
:
445 int lttng_desc_match_wildcard_enabler(const struct lttng_event_desc
*desc
,
446 struct lttng_enabler
*enabler
)
449 unsigned int has_loglevel
= 0;
451 assert(enabler
->type
== LTTNG_ENABLER_WILDCARD
);
452 /* Compare excluding final '*' */
453 if (strncmp(desc
->name
, enabler
->event_param
.name
,
454 strlen(enabler
->event_param
.name
) - 1))
456 if (desc
->loglevel
) {
457 loglevel
= *(*desc
->loglevel
);
460 if (!lttng_loglevel_match(loglevel
,
462 enabler
->event_param
.loglevel_type
,
463 enabler
->event_param
.loglevel
))
469 int lttng_desc_match_event_enabler(const struct lttng_event_desc
*desc
,
470 struct lttng_enabler
*enabler
)
473 unsigned int has_loglevel
= 0;
475 assert(enabler
->type
== LTTNG_ENABLER_EVENT
);
476 if (strcmp(desc
->name
, enabler
->event_param
.name
))
478 if (desc
->loglevel
) {
479 loglevel
= *(*desc
->loglevel
);
482 if (!lttng_loglevel_match(loglevel
,
484 enabler
->event_param
.loglevel_type
,
485 enabler
->event_param
.loglevel
))
491 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
492 struct lttng_enabler
*enabler
)
494 struct lttng_ust_excluder_node
*excluder
;
496 /* If event matches with an excluder, return 'does not match' */
497 cds_list_for_each_entry(excluder
, &enabler
->excluder_head
, node
) {
500 for (count
= 0; count
< excluder
->excluder
.count
; count
++) {
504 excluder_name
= (char *) (excluder
->excluder
.names
)
505 + count
* LTTNG_UST_SYM_NAME_LEN
;
506 len
= strnlen(excluder_name
, LTTNG_UST_SYM_NAME_LEN
);
507 if (len
> 0 && excluder_name
[len
- 1] == '*') {
508 found
= !strncmp(desc
->name
, excluder_name
,
511 found
= !strncmp(desc
->name
, excluder_name
,
512 LTTNG_UST_SYM_NAME_LEN
- 1);
519 switch (enabler
->type
) {
520 case LTTNG_ENABLER_WILDCARD
:
521 return lttng_desc_match_wildcard_enabler(desc
, enabler
);
522 case LTTNG_ENABLER_EVENT
:
523 return lttng_desc_match_event_enabler(desc
, enabler
);
530 int lttng_event_match_enabler(struct lttng_event
*event
,
531 struct lttng_enabler
*enabler
)
533 if (lttng_desc_match_enabler(event
->desc
, enabler
)
534 && event
->chan
== enabler
->chan
)
541 struct lttng_enabler_ref
* lttng_event_enabler_ref(struct lttng_event
*event
,
542 struct lttng_enabler
*enabler
)
544 struct lttng_enabler_ref
*enabler_ref
;
546 cds_list_for_each_entry(enabler_ref
,
547 &event
->enablers_ref_head
, node
) {
548 if (enabler_ref
->ref
== enabler
)
555 * Create struct lttng_event if it is missing and present in the list of
559 void lttng_create_event_if_missing(struct lttng_enabler
*enabler
)
561 struct lttng_session
*session
= enabler
->chan
->session
;
562 struct lttng_probe_desc
*probe_desc
;
563 const struct lttng_event_desc
*desc
;
564 struct lttng_event
*event
;
566 struct cds_list_head
*probe_list
;
568 probe_list
= lttng_get_probe_list_head();
570 * For each probe event, if we find that a probe event matches
571 * our enabler, create an associated lttng_event if not
574 cds_list_for_each_entry(probe_desc
, probe_list
, head
) {
575 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
577 struct cds_hlist_head
*head
;
578 struct cds_hlist_node
*node
;
579 const char *event_name
;
583 desc
= probe_desc
->event_desc
[i
];
584 if (!lttng_desc_match_enabler(desc
, enabler
))
586 event_name
= desc
->name
;
587 name_len
= strlen(event_name
);
590 * Check if already created.
592 hash
= jhash(event_name
, name_len
, 0);
593 head
= &session
->events_ht
.table
[hash
& (LTTNG_UST_EVENT_HT_SIZE
- 1)];
594 cds_hlist_for_each_entry(event
, node
, head
, hlist
) {
595 if (event
->desc
== desc
596 && event
->chan
== enabler
->chan
)
603 * We need to create an event for this
606 ret
= lttng_event_create(probe_desc
->event_desc
[i
],
609 DBG("Unable to create event %s, error %d\n",
610 probe_desc
->event_desc
[i
]->name
, ret
);
617 * Create events associated with an enabler (if not already present),
618 * and add backward reference from the event to the enabler.
621 int lttng_enabler_ref_events(struct lttng_enabler
*enabler
)
623 struct lttng_session
*session
= enabler
->chan
->session
;
624 struct lttng_event
*event
;
626 /* First ensure that probe events are created for this enabler. */
627 lttng_create_event_if_missing(enabler
);
629 /* For each event matching enabler in session event list. */
630 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
631 struct lttng_enabler_ref
*enabler_ref
;
633 if (!lttng_event_match_enabler(event
, enabler
))
636 enabler_ref
= lttng_event_enabler_ref(event
, enabler
);
639 * If no backward ref, create it.
640 * Add backward ref from event to enabler.
642 enabler_ref
= zmalloc(sizeof(*enabler_ref
));
645 enabler_ref
->ref
= enabler
;
646 cds_list_add(&enabler_ref
->node
,
647 &event
->enablers_ref_head
);
651 * Link filter bytecodes if not linked yet.
653 lttng_enabler_event_link_bytecode(event
, enabler
);
655 /* TODO: merge event context. */
661 * Called at library load: connect the probe on all enablers matching
663 * Called with session mutex held.
665 int lttng_fix_pending_events(void)
667 struct lttng_session
*session
;
669 cds_list_for_each_entry(session
, &sessions
, node
) {
670 lttng_session_lazy_sync_enablers(session
);
676 * Only used internally at session destruction.
679 void _lttng_event_destroy(struct lttng_event
*event
)
681 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
683 cds_list_del(&event
->node
);
684 lttng_destroy_context(event
->ctx
);
685 lttng_free_event_filter_runtime(event
);
686 /* Free event enabler refs */
687 cds_list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
688 &event
->enablers_ref_head
, node
)
693 void lttng_ust_events_exit(void)
695 struct lttng_session
*session
, *tmpsession
;
697 cds_list_for_each_entry_safe(session
, tmpsession
, &sessions
, node
)
698 lttng_session_destroy(session
);
702 * Enabler management.
704 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
705 struct lttng_ust_event
*event_param
,
706 struct lttng_channel
*chan
)
708 struct lttng_enabler
*enabler
;
710 enabler
= zmalloc(sizeof(*enabler
));
713 enabler
->type
= type
;
714 CDS_INIT_LIST_HEAD(&enabler
->filter_bytecode_head
);
715 CDS_INIT_LIST_HEAD(&enabler
->excluder_head
);
716 memcpy(&enabler
->event_param
, event_param
,
717 sizeof(enabler
->event_param
));
718 enabler
->chan
= chan
;
720 enabler
->enabled
= 1;
721 cds_list_add(&enabler
->node
, &enabler
->chan
->session
->enablers_head
);
722 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
726 int lttng_enabler_enable(struct lttng_enabler
*enabler
)
728 enabler
->enabled
= 1;
729 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
733 int lttng_enabler_disable(struct lttng_enabler
*enabler
)
735 enabler
->enabled
= 0;
736 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
740 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
741 struct lttng_ust_filter_bytecode_node
*bytecode
)
743 bytecode
->enabler
= enabler
;
744 cds_list_add_tail(&bytecode
->node
, &enabler
->filter_bytecode_head
);
745 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
749 int lttng_enabler_attach_exclusion(struct lttng_enabler
*enabler
,
750 struct lttng_ust_excluder_node
*excluder
)
752 excluder
->enabler
= enabler
;
753 cds_list_add_tail(&excluder
->node
, &enabler
->excluder_head
);
754 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
758 int lttng_attach_context(struct lttng_ust_context
*context_param
,
759 struct lttng_ctx
**ctx
, struct lttng_session
*session
)
762 * We cannot attach a context after trace has been started for a
763 * session because the metadata does not allow expressing this
764 * information outside of the original channel scope.
766 if (session
->been_active
)
769 switch (context_param
->ctx
) {
770 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
771 return lttng_add_pthread_id_to_ctx(ctx
);
772 case LTTNG_UST_CONTEXT_VTID
:
773 return lttng_add_vtid_to_ctx(ctx
);
774 case LTTNG_UST_CONTEXT_VPID
:
775 return lttng_add_vpid_to_ctx(ctx
);
776 case LTTNG_UST_CONTEXT_PROCNAME
:
777 return lttng_add_procname_to_ctx(ctx
);
778 case LTTNG_UST_CONTEXT_IP
:
779 return lttng_add_ip_to_ctx(ctx
);
785 int lttng_enabler_attach_context(struct lttng_enabler
*enabler
,
786 struct lttng_ust_context
*context_param
)
788 #if 0 // disabled for now.
789 struct lttng_session
*session
= enabler
->chan
->session
;
792 ret
= lttng_attach_context(context_param
, &enabler
->ctx
,
796 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
802 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
804 struct lttng_ust_filter_bytecode_node
*filter_node
, *tmp_filter_node
;
805 struct lttng_ust_excluder_node
*excluder_node
, *tmp_excluder_node
;
807 /* Destroy filter bytecode */
808 cds_list_for_each_entry_safe(filter_node
, tmp_filter_node
,
809 &enabler
->filter_bytecode_head
, node
) {
813 /* Destroy excluders */
814 cds_list_for_each_entry_safe(excluder_node
, tmp_excluder_node
,
815 &enabler
->excluder_head
, node
) {
819 /* Destroy contexts */
820 lttng_destroy_context(enabler
->ctx
);
822 cds_list_del(&enabler
->node
);
827 * lttng_session_sync_enablers should be called just before starting a
831 void lttng_session_sync_enablers(struct lttng_session
*session
)
833 struct lttng_enabler
*enabler
;
834 struct lttng_event
*event
;
836 cds_list_for_each_entry(enabler
, &session
->enablers_head
, node
)
837 lttng_enabler_ref_events(enabler
);
839 * For each event, if at least one of its enablers is enabled,
840 * and its channel and session transient states are enabled, we
841 * enable the event, else we disable it.
843 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
844 struct lttng_enabler_ref
*enabler_ref
;
845 struct lttng_bytecode_runtime
*runtime
;
846 int enabled
= 0, has_enablers_without_bytecode
= 0;
849 cds_list_for_each_entry(enabler_ref
,
850 &event
->enablers_ref_head
, node
) {
851 if (enabler_ref
->ref
->enabled
) {
857 * Enabled state is based on union of enablers, with
858 * intesection of session and channel transient enable
861 enabled
= enabled
&& session
->tstate
&& event
->chan
->tstate
;
863 CMM_STORE_SHARED(event
->enabled
, enabled
);
865 * Sync tracepoint registration with event enabled
869 if (!event
->registered
)
870 register_event(event
);
872 if (event
->registered
)
873 unregister_event(event
);
876 /* Check if has enablers without bytecode enabled */
877 cds_list_for_each_entry(enabler_ref
,
878 &event
->enablers_ref_head
, node
) {
879 if (enabler_ref
->ref
->enabled
880 && cds_list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
881 has_enablers_without_bytecode
= 1;
885 event
->has_enablers_without_bytecode
=
886 has_enablers_without_bytecode
;
889 cds_list_for_each_entry(runtime
,
890 &event
->bytecode_runtime_head
, node
) {
891 lttng_filter_sync_state(runtime
);
897 * Apply enablers to session events, adding events to session if need
898 * be. It is required after each modification applied to an active
899 * session, and right before session "start".
900 * "lazy" sync means we only sync if required.
903 void lttng_session_lazy_sync_enablers(struct lttng_session
*session
)
905 /* We can skip if session is not active */
906 if (!session
->active
)
908 lttng_session_sync_enablers(session
);