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
);
81 static int _lttng_event_unregister(struct lttng_event
*event
);
84 void lttng_session_lazy_sync_enablers(struct lttng_session
*session
);
86 void lttng_session_sync_enablers(struct lttng_session
*session
);
88 void lttng_enabler_destroy(struct lttng_enabler
*enabler
);
91 * Called with ust lock held.
93 int lttng_session_active(void)
95 struct lttng_session
*iter
;
97 cds_list_for_each_entry(iter
, &sessions
, node
) {
105 int lttng_loglevel_match(int loglevel
,
106 unsigned int has_loglevel
,
107 enum lttng_ust_loglevel_type req_type
,
110 if (req_type
== LTTNG_UST_LOGLEVEL_ALL
)
113 loglevel
= TRACE_DEFAULT
;
115 case LTTNG_UST_LOGLEVEL_RANGE
:
116 if (loglevel
<= req_loglevel
|| req_loglevel
== -1)
120 case LTTNG_UST_LOGLEVEL_SINGLE
:
121 if (loglevel
== req_loglevel
|| req_loglevel
== -1)
125 case LTTNG_UST_LOGLEVEL_ALL
:
131 void synchronize_trace(void)
136 struct lttng_session
*lttng_session_create(void)
138 struct lttng_session
*session
;
141 session
= zmalloc(sizeof(struct lttng_session
));
144 CDS_INIT_LIST_HEAD(&session
->chan_head
);
145 CDS_INIT_LIST_HEAD(&session
->events_head
);
146 CDS_INIT_LIST_HEAD(&session
->enablers_head
);
147 for (i
= 0; i
< LTTNG_UST_EVENT_HT_SIZE
; i
++)
148 CDS_INIT_HLIST_HEAD(&session
->events_ht
.table
[i
]);
149 cds_list_add(&session
->node
, &sessions
);
154 * Only used internally at session destruction.
157 void _lttng_channel_unmap(struct lttng_channel
*lttng_chan
)
159 struct channel
*chan
;
160 struct lttng_ust_shm_handle
*handle
;
162 cds_list_del(<tng_chan
->node
);
163 lttng_destroy_context(lttng_chan
->ctx
);
164 chan
= lttng_chan
->chan
;
165 handle
= lttng_chan
->handle
;
167 * note: lttng_chan is private data contained within handle. It
168 * will be freed along with the handle.
170 channel_destroy(chan
, handle
, 0);
173 void lttng_session_destroy(struct lttng_session
*session
)
175 struct lttng_channel
*chan
, *tmpchan
;
176 struct lttng_event
*event
, *tmpevent
;
177 struct lttng_enabler
*enabler
, *tmpenabler
;
180 CMM_ACCESS_ONCE(session
->active
) = 0;
181 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
182 ret
= _lttng_event_unregister(event
);
185 synchronize_trace(); /* Wait for in-flight events to complete */
186 cds_list_for_each_entry_safe(enabler
, tmpenabler
,
187 &session
->enablers_head
, node
)
188 lttng_enabler_destroy(enabler
);
189 cds_list_for_each_entry_safe(event
, tmpevent
,
190 &session
->events_head
, node
)
191 _lttng_event_destroy(event
);
192 cds_list_for_each_entry_safe(chan
, tmpchan
, &session
->chan_head
, node
)
193 _lttng_channel_unmap(chan
);
194 cds_list_del(&session
->node
);
198 int lttng_session_enable(struct lttng_session
*session
)
201 struct lttng_channel
*chan
;
204 if (session
->active
) {
209 notify_socket
= lttng_get_notify_socket(session
->owner
);
210 if (notify_socket
< 0)
211 return notify_socket
;
213 /* We need to sync enablers with session before activation. */
214 lttng_session_sync_enablers(session
);
217 * Snapshot the number of events per channel to know the type of header
220 cds_list_for_each_entry(chan
, &session
->chan_head
, node
) {
221 const struct lttng_ctx
*ctx
;
222 const struct lttng_event_field
*fields
= NULL
;
223 size_t nr_fields
= 0;
225 /* don't change it if session stop/restart */
226 if (chan
->header_type
)
230 nr_fields
= ctx
->nr_fields
;
231 fields
= &ctx
->fields
->event_field
;
233 ret
= ustcomm_register_channel(notify_socket
,
244 CMM_ACCESS_ONCE(session
->active
) = 1;
245 CMM_ACCESS_ONCE(session
->been_active
) = 1;
250 int lttng_session_disable(struct lttng_session
*session
)
254 if (!session
->active
) {
258 CMM_ACCESS_ONCE(session
->active
) = 0;
263 int lttng_channel_enable(struct lttng_channel
*channel
)
267 if (channel
== channel
->session
->metadata
)
269 old
= uatomic_xchg(&channel
->enabled
, 1);
275 int lttng_channel_disable(struct lttng_channel
*channel
)
279 if (channel
== channel
->session
->metadata
)
281 old
= uatomic_xchg(&channel
->enabled
, 0);
287 int lttng_event_enable(struct lttng_event
*event
)
291 if (event
->chan
== event
->chan
->session
->metadata
)
293 old
= uatomic_xchg(&event
->enabled
, 1);
299 int lttng_event_disable(struct lttng_event
*event
)
303 if (event
->chan
== event
->chan
->session
->metadata
)
305 old
= uatomic_xchg(&event
->enabled
, 0);
312 * Supports event creation while tracing session is active.
315 int lttng_event_create(const struct lttng_event_desc
*desc
,
316 struct lttng_channel
*chan
)
318 const char *event_name
= desc
->name
;
319 struct lttng_event
*event
;
320 struct lttng_session
*session
= chan
->session
;
321 struct cds_hlist_head
*head
;
322 struct cds_hlist_node
*node
;
324 size_t name_len
= strlen(event_name
);
326 int notify_socket
, loglevel
;
329 hash
= jhash(event_name
, name_len
, 0);
330 head
= &chan
->session
->events_ht
.table
[hash
& (LTTNG_UST_EVENT_HT_SIZE
- 1)];
331 cds_hlist_for_each_entry(event
, node
, head
, hlist
) {
333 if (!strncmp(event
->desc
->name
,
335 LTTNG_UST_SYM_NAME_LEN
- 1)) {
341 notify_socket
= lttng_get_notify_socket(session
->owner
);
342 if (notify_socket
< 0) {
348 * Check if loglevel match. Refuse to connect event if not.
350 event
= zmalloc(sizeof(struct lttng_event
));
358 CDS_INIT_LIST_HEAD(&event
->bytecode_runtime_head
);
359 CDS_INIT_LIST_HEAD(&event
->enablers_ref_head
);
363 loglevel
= *(*event
->desc
->loglevel
);
365 loglevel
= TRACE_DEFAULT
;
366 if (desc
->u
.ext
.model_emf_uri
)
367 uri
= *(desc
->u
.ext
.model_emf_uri
);
371 /* Don't register metadata events */
372 if (session
->metadata
== chan
) {
375 /* Fetch event ID from sessiond */
376 ret
= ustcomm_register_event(notify_socket
,
387 goto sessiond_register_error
;
391 /* Populate lttng_event structure before tracepoint registration. */
393 ret
= __tracepoint_probe_register(event_name
,
394 desc
->probe_callback
,
395 event
, desc
->signature
);
397 goto tracepoint_register_error
;
399 cds_list_add(&event
->node
, &chan
->session
->events_head
);
400 cds_hlist_add_head(&event
->hlist
, head
);
403 tracepoint_register_error
:
404 sessiond_register_error
:
413 int lttng_desc_match_wildcard_enabler(const struct lttng_event_desc
*desc
,
414 struct lttng_enabler
*enabler
)
417 unsigned int has_loglevel
;
419 assert(enabler
->type
== LTTNG_ENABLER_WILDCARD
);
420 /* Compare excluding final '*' */
421 if (strncmp(desc
->name
, enabler
->event_param
.name
,
422 strlen(enabler
->event_param
.name
) - 1))
424 if (desc
->loglevel
) {
425 loglevel
= *(*desc
->loglevel
);
428 if (!lttng_loglevel_match(loglevel
,
430 enabler
->event_param
.loglevel_type
,
431 enabler
->event_param
.loglevel
))
437 int lttng_desc_match_event_enabler(const struct lttng_event_desc
*desc
,
438 struct lttng_enabler
*enabler
)
441 unsigned int has_loglevel
= 0;
443 assert(enabler
->type
== LTTNG_ENABLER_EVENT
);
444 if (strcmp(desc
->name
, enabler
->event_param
.name
))
446 if (desc
->loglevel
) {
447 loglevel
= *(*desc
->loglevel
);
450 if (!lttng_loglevel_match(loglevel
,
452 enabler
->event_param
.loglevel_type
,
453 enabler
->event_param
.loglevel
))
459 int lttng_desc_match_enabler(const struct lttng_event_desc
*desc
,
460 struct lttng_enabler
*enabler
)
462 switch (enabler
->type
) {
463 case LTTNG_ENABLER_WILDCARD
:
464 return lttng_desc_match_wildcard_enabler(desc
, enabler
);
465 case LTTNG_ENABLER_EVENT
:
466 return lttng_desc_match_event_enabler(desc
, enabler
);
473 int lttng_event_match_enabler(struct lttng_event
*event
,
474 struct lttng_enabler
*enabler
)
476 return lttng_desc_match_enabler(event
->desc
, enabler
);
480 struct lttng_enabler_ref
* lttng_event_enabler_ref(struct lttng_event
*event
,
481 struct lttng_enabler
*enabler
)
483 struct lttng_enabler_ref
*enabler_ref
;
485 cds_list_for_each_entry(enabler_ref
,
486 &event
->enablers_ref_head
, node
) {
487 if (enabler_ref
->ref
== enabler
)
494 * Create struct lttng_event if it is missing and present in the list of
498 void lttng_create_event_if_missing(struct lttng_enabler
*enabler
)
500 struct lttng_session
*session
= enabler
->chan
->session
;
501 struct lttng_probe_desc
*probe_desc
;
502 const struct lttng_event_desc
*desc
;
503 struct lttng_event
*event
;
505 struct cds_list_head
*probe_list
;
507 probe_list
= lttng_get_probe_list_head();
509 * For each probe event, if we find that a probe event matches
510 * our enabler, create an associated lttng_event if not
513 cds_list_for_each_entry(probe_desc
, probe_list
, head
) {
514 for (i
= 0; i
< probe_desc
->nr_events
; i
++) {
516 struct cds_hlist_head
*head
;
517 struct cds_hlist_node
*node
;
518 const char *event_name
;
522 desc
= probe_desc
->event_desc
[i
];
523 if (!lttng_desc_match_enabler(desc
, enabler
))
525 event_name
= desc
->name
;
526 name_len
= strlen(event_name
);
529 * Check if already created.
531 hash
= jhash(event_name
, name_len
, 0);
532 head
= &session
->events_ht
.table
[hash
& (LTTNG_UST_EVENT_HT_SIZE
- 1)];
533 cds_hlist_for_each_entry(event
, node
, head
, hlist
) {
534 if (event
->desc
== desc
)
541 * We need to create an event for this
544 ret
= lttng_event_create(probe_desc
->event_desc
[i
],
547 DBG("Unable to create event %s, error %d\n",
548 probe_desc
->event_desc
[i
]->name
, ret
);
555 * Create events associated with an enabler (if not already present),
556 * and add backward reference from the event to the enabler.
559 int lttng_enabler_ref_events(struct lttng_enabler
*enabler
)
561 struct lttng_session
*session
= enabler
->chan
->session
;
562 struct lttng_event
*event
;
564 /* First ensure that probe events are created for this enabler. */
565 lttng_create_event_if_missing(enabler
);
567 /* For each event matching enabler in session event list. */
568 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
569 struct lttng_enabler_ref
*enabler_ref
;
571 if (!lttng_event_match_enabler(event
, enabler
))
574 enabler_ref
= lttng_event_enabler_ref(event
, enabler
);
577 * If no backward ref, create it.
578 * Add backward ref from event to enabler.
580 enabler_ref
= zmalloc(sizeof(*enabler_ref
));
583 enabler_ref
->ref
= enabler
;
584 cds_list_add(&enabler_ref
->node
,
585 &event
->enablers_ref_head
);
589 * Link filter bytecodes if not linked yet.
591 lttng_enabler_event_link_bytecode(event
, enabler
);
593 /* TODO: merge event context. */
599 * Called at library load: connect the probe on all enablers matching
601 * called with session mutex held.
602 * TODO: currently, for each desc added, we iterate on all event desc
603 * (inefficient). We should create specific code that only target the
606 int lttng_fix_pending_event_desc(const struct lttng_event_desc
*desc
)
608 struct lttng_session
*session
;
610 cds_list_for_each_entry(session
, &sessions
, node
) {
611 lttng_session_lazy_sync_enablers(session
);
617 * Only used internally at session destruction.
619 int _lttng_event_unregister(struct lttng_event
*event
)
621 return __tracepoint_probe_unregister(event
->desc
->name
,
622 event
->desc
->probe_callback
,
627 * Only used internally at session destruction.
630 void _lttng_event_destroy(struct lttng_event
*event
)
632 struct lttng_enabler_ref
*enabler_ref
, *tmp_enabler_ref
;
634 cds_list_del(&event
->node
);
635 lttng_destroy_context(event
->ctx
);
636 lttng_free_event_filter_runtime(event
);
637 /* Free event enabler refs */
638 cds_list_for_each_entry_safe(enabler_ref
, tmp_enabler_ref
,
639 &event
->enablers_ref_head
, node
)
644 void lttng_ust_events_exit(void)
646 struct lttng_session
*session
, *tmpsession
;
648 cds_list_for_each_entry_safe(session
, tmpsession
, &sessions
, node
)
649 lttng_session_destroy(session
);
653 * Enabler management.
655 struct lttng_enabler
*lttng_enabler_create(enum lttng_enabler_type type
,
656 struct lttng_ust_event
*event_param
,
657 struct lttng_channel
*chan
)
659 struct lttng_enabler
*enabler
;
661 enabler
= zmalloc(sizeof(*enabler
));
664 enabler
->type
= type
;
665 CDS_INIT_LIST_HEAD(&enabler
->filter_bytecode_head
);
666 memcpy(&enabler
->event_param
, event_param
,
667 sizeof(enabler
->event_param
));
668 enabler
->chan
= chan
;
670 enabler
->enabled
= 1;
671 cds_list_add(&enabler
->node
, &enabler
->chan
->session
->enablers_head
);
672 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
676 int lttng_enabler_enable(struct lttng_enabler
*enabler
)
678 enabler
->enabled
= 1;
679 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
683 int lttng_enabler_disable(struct lttng_enabler
*enabler
)
685 if (enabler
->chan
== enabler
->chan
->session
->metadata
)
687 enabler
->enabled
= 0;
688 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
692 int lttng_enabler_attach_bytecode(struct lttng_enabler
*enabler
,
693 struct lttng_ust_filter_bytecode_node
*bytecode
)
695 bytecode
->enabler
= enabler
;
696 cds_list_add_tail(&bytecode
->node
, &enabler
->filter_bytecode_head
);
697 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
701 int lttng_attach_context(struct lttng_ust_context
*context_param
,
702 struct lttng_ctx
**ctx
, struct lttng_session
*session
)
705 * We cannot attach a context after trace has been started for a
706 * session because the metadata does not allow expressing this
707 * information outside of the original channel scope.
709 if (session
->been_active
)
712 switch (context_param
->ctx
) {
713 case LTTNG_UST_CONTEXT_PTHREAD_ID
:
714 return lttng_add_pthread_id_to_ctx(ctx
);
715 case LTTNG_UST_CONTEXT_VTID
:
716 return lttng_add_vtid_to_ctx(ctx
);
717 case LTTNG_UST_CONTEXT_VPID
:
718 return lttng_add_vpid_to_ctx(ctx
);
719 case LTTNG_UST_CONTEXT_PROCNAME
:
720 return lttng_add_procname_to_ctx(ctx
);
726 int lttng_enabler_attach_context(struct lttng_enabler
*enabler
,
727 struct lttng_ust_context
*context_param
)
729 #if 0 // disabled for now.
730 struct lttng_session
*session
= enabler
->chan
->session
;
733 ret
= lttng_attach_context(context_param
, &enabler
->ctx
,
737 lttng_session_lazy_sync_enablers(enabler
->chan
->session
);
743 void lttng_enabler_destroy(struct lttng_enabler
*enabler
)
745 struct lttng_ust_filter_bytecode_node
*filter_node
, *tmp_filter_node
;
747 /* Destroy filter bytecode */
748 cds_list_for_each_entry_safe(filter_node
, tmp_filter_node
,
749 &enabler
->filter_bytecode_head
, node
) {
753 /* Destroy contexts */
754 lttng_destroy_context(enabler
->ctx
);
756 cds_list_del(&enabler
->node
);
761 * lttng_session_sync_enablers should be called just before starting a
765 void lttng_session_sync_enablers(struct lttng_session
*session
)
767 struct lttng_enabler
*enabler
;
768 struct lttng_event
*event
;
770 cds_list_for_each_entry(enabler
, &session
->enablers_head
, node
)
771 lttng_enabler_ref_events(enabler
);
773 * For each event, if at least one of its enablers is enabled,
774 * we enable the event, else we disable it.
776 cds_list_for_each_entry(event
, &session
->events_head
, node
) {
777 struct lttng_enabler_ref
*enabler_ref
;
778 struct lttng_bytecode_runtime
*runtime
;
779 int enabled
= 0, has_enablers_without_bytecode
= 0;
782 cds_list_for_each_entry(enabler_ref
,
783 &event
->enablers_ref_head
, node
) {
784 if (enabler_ref
->ref
->enabled
) {
789 event
->enabled
= enabled
;
791 /* Check if has enablers without bytecode enabled */
792 cds_list_for_each_entry(enabler_ref
,
793 &event
->enablers_ref_head
, node
) {
794 if (enabler_ref
->ref
->enabled
795 && cds_list_empty(&enabler_ref
->ref
->filter_bytecode_head
)) {
796 has_enablers_without_bytecode
= 1;
800 event
->has_enablers_without_bytecode
=
801 has_enablers_without_bytecode
;
804 cds_list_for_each_entry(runtime
,
805 &event
->bytecode_runtime_head
, node
) {
806 lttng_filter_sync_state(runtime
);
812 * Apply enablers to session events, adding events to session if need
813 * be. It is required after each modification applied to an active
814 * session, and right before session "start".
815 * "lazy" sync means we only sync if required.
818 void lttng_session_lazy_sync_enablers(struct lttng_session
*session
)
820 /* We can skip if session is not active */
821 if (!session
->active
)
823 lttng_session_sync_enablers(session
);