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>
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_event_field
*fields
= NULL
;
264 size_t nr_fields
= 0;
266 /* don't change it if session stop/restart */
267 if (chan
->header_type
)
271 nr_fields
= ctx
->nr_fields
;
272 fields
= &ctx
->fields
->event_field
;
274 ret
= ustcomm_register_channel(notify_socket
,
282 DBG("Error (%d) registering channel to sessiond", ret
);
287 /* Set atomically the state to "active" */
288 CMM_ACCESS_ONCE(session
->active
) = 1;
289 CMM_ACCESS_ONCE(session
->been_active
) = 1;
294 int lttng_session_disable(struct lttng_session
*session
)
298 if (!session
->active
) {
302 /* Set atomically the state to "inactive" */
303 CMM_ACCESS_ONCE(session
->active
) = 0;
305 /* Set transient enabler state to "disabled" */
307 lttng_session_sync_enablers(session
);
312 int lttng_channel_enable(struct lttng_channel
*channel
)
316 if (channel
->enabled
) {
320 /* Set transient enabler state to "enabled" */
322 lttng_session_sync_enablers(channel
->session
);
323 /* Set atomically the state to "enabled" */
324 CMM_ACCESS_ONCE(channel
->enabled
) = 1;
329 int lttng_channel_disable(struct lttng_channel
*channel
)
333 if (!channel
->enabled
) {
337 /* Set atomically the state to "disabled" */
338 CMM_ACCESS_ONCE(channel
->enabled
) = 0;
339 /* Set transient enabler state to "enabled" */
341 lttng_session_sync_enablers(channel
->session
);
347 * Supports event creation while tracing session is active.
350 int lttng_event_create(const struct lttng_event_desc
*desc
,
351 struct lttng_channel
*chan
)
353 const char *event_name
= desc
->name
;
354 struct lttng_event
*event
;
355 struct lttng_session
*session
= chan
->session
;
356 struct cds_hlist_head
*head
;
357 struct cds_hlist_node
*node
;
359 size_t name_len
= strlen(event_name
);
361 int notify_socket
, loglevel
;
364 hash
= jhash(event_name
, name_len
, 0);
365 head
= &chan
->session
->events_ht
.table
[hash
& (LTTNG_UST_EVENT_HT_SIZE
- 1)];
366 cds_hlist_for_each_entry(event
, node
, head
, hlist
) {
368 if (!strncmp(event
->desc
->name
,
370 LTTNG_UST_SYM_NAME_LEN
- 1)) {
376 notify_socket
= lttng_get_notify_socket(session
->owner
);
377 if (notify_socket
< 0) {
383 * Check if loglevel match. Refuse to connect event if not.
385 event
= zmalloc(sizeof(struct lttng_event
));
392 /* Event will be enabled by enabler sync. */
394 event
->registered
= 0;
395 CDS_INIT_LIST_HEAD(&event
->bytecode_runtime_head
);
396 CDS_INIT_LIST_HEAD(&event
->enablers_ref_head
);
400 loglevel
= *(*event
->desc
->loglevel
);
402 loglevel
= TRACE_DEFAULT
;
403 if (desc
->u
.ext
.model_emf_uri
)
404 uri
= *(desc
->u
.ext
.model_emf_uri
);
408 /* Fetch event ID from sessiond */
409 ret
= ustcomm_register_event(notify_socket
,
420 DBG("Error (%d) registering event to sessiond", ret
);
421 goto sessiond_register_error
;
424 /* Populate lttng_event structure before tracepoint registration. */
426 cds_list_add(&event
->node
, &chan
->session
->events_head
);
427 cds_hlist_add_head(&event
->hlist
, head
);
430 sessiond_register_error
:
439 int lttng_desc_match_wildcard_enabler(const struct lttng_event_desc
*desc
,
440 struct lttng_enabler
*enabler
)
443 unsigned int has_loglevel
;
445 assert(enabler
->type
== LTTNG_ENABLER_WILDCARD
);
446 /* Compare excluding final '*' */
447 if (strncmp(desc
->name
, enabler
->event_param
.name
,
448 strlen(enabler
->event_param
.name
) - 1))
450 if (desc
->loglevel
) {
451 loglevel
= *(*desc
->loglevel
);
454 if (!lttng_loglevel_match(loglevel
,
456 enabler
->event_param
.loglevel_type
,
457 enabler
->event_param
.loglevel
))
463 int lttng_desc_match_event_enabler(const struct lttng_event_desc
*desc
,
464 struct lttng_enabler
*enabler
)
467 unsigned int has_loglevel
= 0;
469 assert(enabler
->type
== LTTNG_ENABLER_EVENT
);
470 if (strcmp(desc
->name
, enabler
->event_param
.name
))
472 if (desc
->loglevel
) {
473 loglevel
= *(*desc
->loglevel
);
476 if (!lttng_loglevel_match(loglevel
,
478 enabler
->event_param
.loglevel_type
,
479 enabler
->event_param
.loglevel
))
485 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
486 struct lttng_enabler
*enabler
)
488 switch (enabler
->type
) {
489 case LTTNG_ENABLER_WILDCARD
:
490 return lttng_desc_match_wildcard_enabler(desc
, enabler
);
491 case LTTNG_ENABLER_EVENT
:
492 return lttng_desc_match_event_enabler(desc
, enabler
);
499 int lttng_event_match_enabler(struct lttng_event
*event
,
500 struct lttng_enabler
*enabler
)
502 return lttng_desc_match_enabler(event
->desc
, enabler
);
506 struct lttng_enabler_ref
* lttng_event_enabler_ref(struct lttng_event
*event
,
507 struct lttng_enabler
*enabler
)
509 struct lttng_enabler_ref
*enabler_ref
;
511 cds_list_for_each_entry(enabler_ref
,
512 &event
->enablers_ref_head
, node
) {
513 if (enabler_ref
->ref
== enabler
)
520 * Create struct lttng_event if it is missing and present in the list of
524 void lttng_create_event_if_missing(struct lttng_enabler
*enabler
)
526 struct lttng_session
*session
= enabler
->chan
->session
;
527 struct lttng_probe_desc
*probe_desc
;
528 const struct lttng_event_desc
*desc
;
529 struct lttng_event
*event
;
531 struct cds_list_head
*probe_list
;
533 probe_list
= lttng_get_probe_list_head();
535 * For each probe event, if we find that a probe event matches
536 * our enabler, create an associated lttng_event if not
539 cds_list_for_each_entry(probe_desc
, probe_list
, head
) {
540 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
542 struct cds_hlist_head
*head
;
543 struct cds_hlist_node
*node
;
544 const char *event_name
;
548 desc
= probe_desc
->event_desc
[i
];
549 if (!lttng_desc_match_enabler(desc
, enabler
))
551 event_name
= desc
->name
;
552 name_len
= strlen(event_name
);
555 * Check if already created.
557 hash
= jhash(event_name
, name_len
, 0);
558 head
= &session
->events_ht
.table
[hash
& (LTTNG_UST_EVENT_HT_SIZE
- 1)];
559 cds_hlist_for_each_entry(event
, node
, head
, hlist
) {
560 if (event
->desc
== desc
)
567 * We need to create an event for this
570 ret
= lttng_event_create(probe_desc
->event_desc
[i
],
573 DBG("Unable to create event %s, error %d\n",
574 probe_desc
->event_desc
[i
]->name
, ret
);
581 * Create events associated with an enabler (if not already present),
582 * and add backward reference from the event to the enabler.
585 int lttng_enabler_ref_events(struct lttng_enabler
*enabler
)
587 struct lttng_session
*session
= enabler
->chan
->session
;
588 struct lttng_event
*event
;
590 /* First ensure that probe events are created for this enabler. */
591 lttng_create_event_if_missing(enabler
);
593 /* For each event matching enabler in session event list. */
594 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
595 struct lttng_enabler_ref
*enabler_ref
;
597 if (!lttng_event_match_enabler(event
, enabler
))
600 enabler_ref
= lttng_event_enabler_ref(event
, enabler
);
603 * If no backward ref, create it.
604 * Add backward ref from event to enabler.
606 enabler_ref
= zmalloc(sizeof(*enabler_ref
));
609 enabler_ref
->ref
= enabler
;
610 cds_list_add(&enabler_ref
->node
,
611 &event
->enablers_ref_head
);
615 * Link filter bytecodes if not linked yet.
617 lttng_enabler_event_link_bytecode(event
, enabler
);
619 /* TODO: merge event context. */
625 * Called at library load: connect the probe on all enablers matching
627 * called with session mutex held.
628 * TODO: currently, for each desc added, we iterate on all event desc
629 * (inefficient). We should create specific code that only target the
632 int lttng_fix_pending_event_desc(const struct lttng_event_desc
*desc
)
634 struct lttng_session
*session
;
636 cds_list_for_each_entry(session
, &sessions
, node
) {
637 lttng_session_lazy_sync_enablers(session
);
643 * Only used internally at session destruction.
646 void _lttng_event_destroy(struct lttng_event
*event
)
648 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
650 cds_list_del(&event
->node
);
651 lttng_destroy_context(event
->ctx
);
652 lttng_free_event_filter_runtime(event
);
653 /* Free event enabler refs */
654 cds_list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
655 &event
->enablers_ref_head
, node
)
660 void lttng_ust_events_exit(void)
662 struct lttng_session
*session
, *tmpsession
;
664 cds_list_for_each_entry_safe(session
, tmpsession
, &sessions
, node
)
665 lttng_session_destroy(session
);
669 * Enabler management.
671 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
672 struct lttng_ust_event
*event_param
,
673 struct lttng_channel
*chan
)
675 struct lttng_enabler
*enabler
;
677 enabler
= zmalloc(sizeof(*enabler
));
680 enabler
->type
= type
;
681 CDS_INIT_LIST_HEAD(&enabler
->filter_bytecode_head
);
682 memcpy(&enabler
->event_param
, event_param
,
683 sizeof(enabler
->event_param
));
684 enabler
->chan
= chan
;
686 enabler
->enabled
= 1;
687 cds_list_add(&enabler
->node
, &enabler
->chan
->session
->enablers_head
);
688 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
692 int lttng_enabler_enable(struct lttng_enabler
*enabler
)
694 enabler
->enabled
= 1;
695 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
699 int lttng_enabler_disable(struct lttng_enabler
*enabler
)
701 enabler
->enabled
= 0;
702 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
706 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
707 struct lttng_ust_filter_bytecode_node
*bytecode
)
709 bytecode
->enabler
= enabler
;
710 cds_list_add_tail(&bytecode
->node
, &enabler
->filter_bytecode_head
);
711 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
715 int lttng_attach_context(struct lttng_ust_context
*context_param
,
716 struct lttng_ctx
**ctx
, struct lttng_session
*session
)
719 * We cannot attach a context after trace has been started for a
720 * session because the metadata does not allow expressing this
721 * information outside of the original channel scope.
723 if (session
->been_active
)
726 switch (context_param
->ctx
) {
727 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
728 return lttng_add_pthread_id_to_ctx(ctx
);
729 case LTTNG_UST_CONTEXT_VTID
:
730 return lttng_add_vtid_to_ctx(ctx
);
731 case LTTNG_UST_CONTEXT_VPID
:
732 return lttng_add_vpid_to_ctx(ctx
);
733 case LTTNG_UST_CONTEXT_PROCNAME
:
734 return lttng_add_procname_to_ctx(ctx
);
740 int lttng_enabler_attach_context(struct lttng_enabler
*enabler
,
741 struct lttng_ust_context
*context_param
)
743 #if 0 // disabled for now.
744 struct lttng_session
*session
= enabler
->chan
->session
;
747 ret
= lttng_attach_context(context_param
, &enabler
->ctx
,
751 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
757 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
759 struct lttng_ust_filter_bytecode_node
*filter_node
, *tmp_filter_node
;
761 /* Destroy filter bytecode */
762 cds_list_for_each_entry_safe(filter_node
, tmp_filter_node
,
763 &enabler
->filter_bytecode_head
, node
) {
767 /* Destroy contexts */
768 lttng_destroy_context(enabler
->ctx
);
770 cds_list_del(&enabler
->node
);
775 * lttng_session_sync_enablers should be called just before starting a
779 void lttng_session_sync_enablers(struct lttng_session
*session
)
781 struct lttng_enabler
*enabler
;
782 struct lttng_event
*event
;
784 cds_list_for_each_entry(enabler
, &session
->enablers_head
, node
)
785 lttng_enabler_ref_events(enabler
);
787 * For each event, if at least one of its enablers is enabled,
788 * and its channel and session transient states are enabled, we
789 * enable the event, else we disable it.
791 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
792 struct lttng_enabler_ref
*enabler_ref
;
793 struct lttng_bytecode_runtime
*runtime
;
794 int enabled
= 0, has_enablers_without_bytecode
= 0;
797 cds_list_for_each_entry(enabler_ref
,
798 &event
->enablers_ref_head
, node
) {
799 if (enabler_ref
->ref
->enabled
) {
805 * Enabled state is based on union of enablers, with
806 * intesection of session and channel transient enable
809 enabled
= enabled
&& session
->tstate
&& event
->chan
->tstate
;
811 CMM_STORE_SHARED(event
->enabled
, enabled
);
813 * Sync tracepoint registration with event enabled
817 if (!event
->registered
)
818 register_event(event
);
820 if (event
->registered
)
821 unregister_event(event
);
824 /* Check if has enablers without bytecode enabled */
825 cds_list_for_each_entry(enabler_ref
,
826 &event
->enablers_ref_head
, node
) {
827 if (enabler_ref
->ref
->enabled
828 && cds_list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
829 has_enablers_without_bytecode
= 1;
833 event
->has_enablers_without_bytecode
=
834 has_enablers_without_bytecode
;
837 cds_list_for_each_entry(runtime
,
838 &event
->bytecode_runtime_head
, node
) {
839 lttng_filter_sync_state(runtime
);
845 * Apply enablers to session events, adding events to session if need
846 * be. It is required after each modification applied to an active
847 * session, and right before session "start".
848 * "lazy" sync means we only sync if required.
851 void lttng_session_lazy_sync_enablers(struct lttng_session
*session
)
853 /* We can skip if session is not active */
854 if (!session
->active
)
856 lttng_session_sync_enablers(session
);