2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <common/common.h>
26 #include <common/defaults.h>
28 #include "buffer-registry.h"
29 #include "trace-ust.h"
33 * Match function for the events hash table lookup.
35 * Matches by name only. Used by the disable command.
37 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
40 struct ltt_ust_event
*event
;
46 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
50 if (strncmp(event
->attr
.name
, name
, sizeof(event
->attr
.name
)) != 0) {
62 * Match function for the hash table lookup.
64 * It matches an ust event based on three attributes which are the event name,
65 * the filter bytecode and the loglevel.
67 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
)
69 struct ltt_ust_event
*event
;
70 const struct ltt_ust_ht_key
*key
;
75 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
78 /* Match the 4 elements of the key: name, filter, loglevel, exclusions. */
81 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
86 if (event
->attr
.loglevel
!= key
->loglevel
) {
87 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
88 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
90 * Match is accepted. This is because on event creation, the
91 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
92 * -1 are accepted for this loglevel type since 0 is the one set by
93 * the API when receiving an enable event.
100 /* Only one of the filters is NULL, fail. */
101 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
105 if (key
->filter
&& event
->filter
) {
106 /* Both filters exists, check length followed by the bytecode. */
107 if (event
->filter
->len
!= key
->filter
->len
||
108 memcmp(event
->filter
->data
, key
->filter
->data
,
109 event
->filter
->len
) != 0) {
114 /* If only one of the exclusions is NULL, fail. */
115 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
119 if (key
->exclusion
&& event
->exclusion
) {
120 /* Both exclusions exist; check count followed by names. */
121 if (event
->exclusion
->count
!= key
->exclusion
->count
||
122 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
123 event
->exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
) != 0) {
135 * Find the channel in the hashtable and return channel pointer. RCU read side
136 * lock MUST be acquired before calling this.
138 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
141 struct lttng_ht_node_str
*node
;
142 struct lttng_ht_iter iter
;
145 * If we receive an empty string for channel name, it means the
146 * default channel name is requested.
149 name
= DEFAULT_CHANNEL_NAME
;
151 lttng_ht_lookup(ht
, (void *)name
, &iter
);
152 node
= lttng_ht_iter_get_node_str(&iter
);
157 DBG2("Trace UST channel %s found by name", name
);
159 return caa_container_of(node
, struct ltt_ust_channel
, node
);
162 DBG2("Trace UST channel %s not found by name", name
);
167 * Find the event in the hashtable and return event pointer. RCU read side lock
168 * MUST be acquired before calling this.
170 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
171 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
,
172 struct lttng_event_exclusion
*exclusion
)
174 struct lttng_ht_node_str
*node
;
175 struct lttng_ht_iter iter
;
176 struct ltt_ust_ht_key key
;
183 key
.loglevel
= loglevel
;
184 key
.exclusion
= exclusion
;
186 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
187 trace_ust_ht_match_event
, &key
, &iter
.iter
);
188 node
= lttng_ht_iter_get_node_str(&iter
);
193 DBG2("Trace UST event %s found", key
.name
);
195 return caa_container_of(node
, struct ltt_ust_event
, node
);
198 DBG2("Trace UST event %s NOT found", key
.name
);
203 * Lookup an agent in the session agents hash table by domain type and return
204 * the object if found else NULL.
206 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
207 enum lttng_domain_type domain_type
)
209 struct agent
*agt
= NULL
;
210 struct lttng_ht_node_u64
*node
;
211 struct lttng_ht_iter iter
;
216 DBG3("Trace ust agent lookup for domain %d", domain_type
);
220 lttng_ht_lookup(session
->agents
, &key
, &iter
);
221 node
= lttng_ht_iter_get_node_u64(&iter
);
225 agt
= caa_container_of(node
, struct agent
, node
);
232 * Allocate and initialize a ust session data structure.
234 * Return pointer to structure or NULL.
236 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
238 struct ltt_ust_session
*lus
;
240 /* Allocate a new ltt ust session */
241 lus
= zmalloc(sizeof(struct ltt_ust_session
));
243 PERROR("create ust session zmalloc");
247 /* Init data structure */
248 lus
->id
= session_id
;
251 /* Set default metadata channel attribute. */
252 lus
->metadata_attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
253 lus
->metadata_attr
.subbuf_size
= default_get_metadata_subbuf_size();
254 lus
->metadata_attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
255 lus
->metadata_attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
256 lus
->metadata_attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
257 lus
->metadata_attr
.output
= LTTNG_UST_MMAP
;
260 * Default buffer type. This can be changed through an enable channel
261 * requesting a different type. Note that this can only be changed once
262 * during the session lifetime which is at the first enable channel and
263 * only before start. The flag buffer_type_changed indicates the status.
265 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
266 /* Once set to 1, the buffer_type is immutable for the session. */
267 lus
->buffer_type_changed
= 0;
268 /* Init it in case it get used after allocation. */
269 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
271 /* Alloc UST global domain channels' HT */
272 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
273 /* Alloc agent hash table. */
274 lus
->agents
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
276 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
277 if (lus
->consumer
== NULL
) {
282 * The tmp_consumer stays NULL until a set_consumer_uri command is
283 * executed. At this point, the consumer should be nullify until an
284 * enable_consumer command. This assignment is symbolic since we've zmalloc
287 lus
->tmp_consumer
= NULL
;
289 DBG2("UST trace session create successful");
294 ht_cleanup_push(lus
->domain_global
.channels
);
295 ht_cleanup_push(lus
->agents
);
302 * Allocate and initialize a ust channel data structure.
304 * Return pointer to structure or NULL.
306 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
308 struct ltt_ust_channel
*luc
;
312 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
314 PERROR("ltt_ust_channel zmalloc");
318 /* Copy UST channel attributes */
319 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
320 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
321 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
322 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
323 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
324 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
326 /* Translate to UST output enum */
327 switch (luc
->attr
.output
) {
329 luc
->attr
.output
= LTTNG_UST_MMAP
;
334 * If we receive an empty string for channel name, it means the
335 * default channel name is requested.
337 if (chan
->name
[0] == '\0') {
338 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
340 /* Copy channel name */
341 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
343 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
346 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
347 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
349 /* Alloc hash tables */
350 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
351 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
353 /* On-disk circular buffer parameters */
354 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
355 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
357 DBG2("Trace UST channel %s created", luc
->name
);
364 * Allocate and initialize a ust event. Set name and event type.
366 * Return pointer to structure or NULL.
368 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
369 char *filter_expression
,
370 struct lttng_filter_bytecode
*filter
,
371 struct lttng_event_exclusion
*exclusion
)
373 struct ltt_ust_event
*lue
;
377 lue
= zmalloc(sizeof(struct ltt_ust_event
));
379 PERROR("ust event zmalloc");
384 case LTTNG_EVENT_PROBE
:
385 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
387 case LTTNG_EVENT_FUNCTION
:
388 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
390 case LTTNG_EVENT_FUNCTION_ENTRY
:
391 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
393 case LTTNG_EVENT_TRACEPOINT
:
394 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
397 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
398 goto error_free_event
;
401 /* Copy event name */
402 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
403 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
405 switch (ev
->loglevel_type
) {
406 case LTTNG_EVENT_LOGLEVEL_ALL
:
407 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
408 lue
->attr
.loglevel
= -1; /* Force to -1 */
410 case LTTNG_EVENT_LOGLEVEL_RANGE
:
411 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
412 lue
->attr
.loglevel
= ev
->loglevel
;
414 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
415 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
416 lue
->attr
.loglevel
= ev
->loglevel
;
419 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
420 goto error_free_event
;
423 * Fix for enabler race. Enable is now done explicitly by
424 * sessiond after setting filter.
426 lue
->attr
.disabled
= 1;
429 lue
->filter_expression
= filter_expression
;
430 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
431 lue
->exclusion
= (struct lttng_event_exclusion
*) exclusion
;
434 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
436 DBG2("Trace UST event %s, loglevel (%d,%d) created",
437 lue
->attr
.name
, lue
->attr
.loglevel_type
,
449 int trace_ust_context_type_event_to_ust(enum lttng_event_context_type type
)
454 case LTTNG_EVENT_CONTEXT_VTID
:
455 utype
= LTTNG_UST_CONTEXT_VTID
;
457 case LTTNG_EVENT_CONTEXT_VPID
:
458 utype
= LTTNG_UST_CONTEXT_VPID
;
460 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
461 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
463 case LTTNG_EVENT_CONTEXT_PROCNAME
:
464 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
466 case LTTNG_EVENT_CONTEXT_IP
:
467 utype
= LTTNG_UST_CONTEXT_IP
;
469 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
470 utype
= LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
;
473 ERR("Invalid UST context");
481 * Return 1 if contexts match, 0 otherwise.
483 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
484 struct lttng_event_context
*ctx
)
488 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
492 if (uctx
->ctx
.ctx
!= utype
) {
496 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
497 if (uctx
->ctx
.u
.perf_counter
.type
498 != ctx
->u
.perf_counter
.type
) {
501 if (uctx
->ctx
.u
.perf_counter
.config
502 != ctx
->u
.perf_counter
.config
) {
505 if (strncmp(uctx
->ctx
.u
.perf_counter
.name
,
506 ctx
->u
.perf_counter
.name
,
507 LTTNG_UST_SYM_NAME_LEN
)) {
519 * Allocate and initialize an UST context.
521 * Return pointer to structure or NULL.
523 struct ltt_ust_context
*trace_ust_create_context(
524 struct lttng_event_context
*ctx
)
526 struct ltt_ust_context
*uctx
;
531 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
536 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
538 PERROR("zmalloc ltt_ust_context");
542 uctx
->ctx
.ctx
= (enum lttng_ust_context_type
) utype
;
544 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
545 uctx
->ctx
.u
.perf_counter
.type
= ctx
->u
.perf_counter
.type
;
546 uctx
->ctx
.u
.perf_counter
.config
= ctx
->u
.perf_counter
.config
;
547 strncpy(uctx
->ctx
.u
.perf_counter
.name
, ctx
->u
.perf_counter
.name
,
548 LTTNG_UST_SYM_NAME_LEN
);
549 uctx
->ctx
.u
.perf_counter
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
554 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
563 * RCU safe free context structure.
565 static void destroy_context_rcu(struct rcu_head
*head
)
567 struct lttng_ht_node_ulong
*node
=
568 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
569 struct ltt_ust_context
*ctx
=
570 caa_container_of(node
, struct ltt_ust_context
, node
);
576 * Cleanup UST context hash table.
578 static void destroy_contexts(struct lttng_ht
*ht
)
581 struct lttng_ht_node_ulong
*node
;
582 struct lttng_ht_iter iter
;
583 struct ltt_ust_context
*ctx
;
588 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
589 /* Remove from ordered list. */
590 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
591 cds_list_del(&ctx
->list
);
592 /* Remove from channel's hash table. */
593 ret
= lttng_ht_del(ht
, &iter
);
595 call_rcu(&node
->head
, destroy_context_rcu
);
604 * Cleanup ust event structure.
606 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
610 DBG2("Trace destroy UST event %s", event
->attr
.name
);
611 free(event
->filter_expression
);
613 free(event
->exclusion
);
618 * URCU intermediate call to complete destroy event.
620 static void destroy_event_rcu(struct rcu_head
*head
)
622 struct lttng_ht_node_str
*node
=
623 caa_container_of(head
, struct lttng_ht_node_str
, head
);
624 struct ltt_ust_event
*event
=
625 caa_container_of(node
, struct ltt_ust_event
, node
);
627 trace_ust_destroy_event(event
);
631 * Cleanup UST events hashtable.
633 static void destroy_events(struct lttng_ht
*events
)
636 struct lttng_ht_node_str
*node
;
637 struct lttng_ht_iter iter
;
642 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
643 ret
= lttng_ht_del(events
, &iter
);
645 call_rcu(&node
->head
, destroy_event_rcu
);
649 ht_cleanup_push(events
);
653 * Cleanup ust channel structure.
655 * Should _NOT_ be called with RCU read lock held.
657 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
661 DBG2("Trace destroy UST channel %s", channel
->name
);
663 /* Destroying all events of the channel */
664 destroy_events(channel
->events
);
665 /* Destroying all context of the channel */
666 destroy_contexts(channel
->ctx
);
672 * URCU intermediate call to complete destroy channel.
674 static void destroy_channel_rcu(struct rcu_head
*head
)
676 struct lttng_ht_node_str
*node
=
677 caa_container_of(head
, struct lttng_ht_node_str
, head
);
678 struct ltt_ust_channel
*channel
=
679 caa_container_of(node
, struct ltt_ust_channel
, node
);
681 _trace_ust_destroy_channel(channel
);
684 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
686 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
690 * Remove an UST channel from a channel HT.
692 void trace_ust_delete_channel(struct lttng_ht
*ht
,
693 struct ltt_ust_channel
*channel
)
696 struct lttng_ht_iter iter
;
701 iter
.iter
.node
= &channel
->node
.node
;
702 ret
= lttng_ht_del(ht
, &iter
);
707 * Iterate over a hash table containing channels and cleanup safely.
709 static void destroy_channels(struct lttng_ht
*channels
)
712 struct lttng_ht_node_str
*node
;
713 struct lttng_ht_iter iter
;
719 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
720 ret
= lttng_ht_del(channels
, &iter
);
722 call_rcu(&node
->head
, destroy_channel_rcu
);
726 ht_cleanup_push(channels
);
730 * Cleanup UST global domain.
732 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
736 destroy_channels(dom
->channels
);
740 * Cleanup ust session structure
742 * Should *NOT* be called with RCU read-side lock held.
744 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
747 struct buffer_reg_uid
*reg
, *sreg
;
748 struct lttng_ht_iter iter
;
752 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
754 /* Cleaning up UST domain */
755 destroy_domain_global(&session
->domain_global
);
757 cds_lfht_for_each_entry(session
->agents
->ht
, &iter
.iter
, agt
, node
.node
) {
758 lttng_ht_del(session
->agents
, &iter
);
762 /* Cleanup UID buffer registry object(s). */
763 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
765 cds_list_del(®
->lnode
);
766 buffer_reg_uid_remove(reg
);
767 buffer_reg_uid_destroy(reg
, session
->consumer
);
770 consumer_destroy_output(session
->consumer
);
771 consumer_destroy_output(session
->tmp_consumer
);