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.
26 #include <common/common.h>
27 #include <common/defaults.h>
29 #include "buffer-registry.h"
30 #include "trace-ust.h"
34 * Match function for the events hash table lookup.
36 * Matches by name only. Used by the disable command.
38 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
41 struct ltt_ust_event
*event
;
47 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
51 if (strncmp(event
->attr
.name
, name
, sizeof(event
->attr
.name
)) != 0) {
63 * Match function for the hash table lookup.
65 * It matches an ust event based on three attributes which are the event name,
66 * the filter bytecode and the loglevel.
68 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
)
70 struct ltt_ust_event
*event
;
71 const struct ltt_ust_ht_key
*key
;
76 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
79 /* Match the 4 elements of the key: name, filter, loglevel, exclusions. */
82 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
87 if (event
->attr
.loglevel
!= key
->loglevel
) {
88 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
89 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
91 * Match is accepted. This is because on event creation, the
92 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
93 * -1 are accepted for this loglevel type since 0 is the one set by
94 * the API when receiving an enable event.
101 /* Only one of the filters is NULL, fail. */
102 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
106 if (key
->filter
&& event
->filter
) {
107 /* Both filters exists, check length followed by the bytecode. */
108 if (event
->filter
->len
!= key
->filter
->len
||
109 memcmp(event
->filter
->data
, key
->filter
->data
,
110 event
->filter
->len
) != 0) {
115 /* If only one of the exclusions is NULL, fail. */
116 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
120 if (key
->exclusion
&& event
->exclusion
) {
121 /* Both exclusions exist; check count followed by names. */
122 if (event
->exclusion
->count
!= key
->exclusion
->count
||
123 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
124 event
->exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
) != 0) {
136 * Find the channel in the hashtable and return channel pointer. RCU read side
137 * lock MUST be acquired before calling this.
139 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
142 struct lttng_ht_node_str
*node
;
143 struct lttng_ht_iter iter
;
146 * If we receive an empty string for channel name, it means the
147 * default channel name is requested.
150 name
= DEFAULT_CHANNEL_NAME
;
152 lttng_ht_lookup(ht
, (void *)name
, &iter
);
153 node
= lttng_ht_iter_get_node_str(&iter
);
158 DBG2("Trace UST channel %s found by name", name
);
160 return caa_container_of(node
, struct ltt_ust_channel
, node
);
163 DBG2("Trace UST channel %s not found by name", name
);
168 * Find the event in the hashtable and return event pointer. RCU read side lock
169 * MUST be acquired before calling this.
171 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
172 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
,
173 struct lttng_event_exclusion
*exclusion
)
175 struct lttng_ht_node_str
*node
;
176 struct lttng_ht_iter iter
;
177 struct ltt_ust_ht_key key
;
184 key
.loglevel
= loglevel
;
185 key
.exclusion
= exclusion
;
187 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
188 trace_ust_ht_match_event
, &key
, &iter
.iter
);
189 node
= lttng_ht_iter_get_node_str(&iter
);
194 DBG2("Trace UST event %s found", key
.name
);
196 return caa_container_of(node
, struct ltt_ust_event
, node
);
199 DBG2("Trace UST event %s NOT found", key
.name
);
204 * Lookup an agent in the session agents hash table by domain type and return
205 * the object if found else NULL.
207 * RCU read side lock must be acquired before calling and only released
208 * once the agent is no longer in scope or being used.
210 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
211 enum lttng_domain_type domain_type
)
213 struct agent
*agt
= NULL
;
214 struct lttng_ht_node_u64
*node
;
215 struct lttng_ht_iter iter
;
220 DBG3("Trace ust agent lookup for domain %d", domain_type
);
224 lttng_ht_lookup(session
->agents
, &key
, &iter
);
225 node
= lttng_ht_iter_get_node_u64(&iter
);
229 agt
= caa_container_of(node
, struct agent
, node
);
236 * Allocate and initialize a ust session data structure.
238 * Return pointer to structure or NULL.
240 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
242 struct ltt_ust_session
*lus
;
244 /* Allocate a new ltt ust session */
245 lus
= zmalloc(sizeof(struct ltt_ust_session
));
247 PERROR("create ust session zmalloc");
251 /* Init data structure */
252 lus
->id
= session_id
;
255 /* Set default metadata channel attribute. */
256 lus
->metadata_attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
257 lus
->metadata_attr
.subbuf_size
= default_get_metadata_subbuf_size();
258 lus
->metadata_attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
259 lus
->metadata_attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
260 lus
->metadata_attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
261 lus
->metadata_attr
.output
= LTTNG_UST_MMAP
;
264 * Default buffer type. This can be changed through an enable channel
265 * requesting a different type. Note that this can only be changed once
266 * during the session lifetime which is at the first enable channel and
267 * only before start. The flag buffer_type_changed indicates the status.
269 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
270 /* Once set to 1, the buffer_type is immutable for the session. */
271 lus
->buffer_type_changed
= 0;
272 /* Init it in case it get used after allocation. */
273 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
275 /* Alloc UST global domain channels' HT */
276 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
277 /* Alloc agent hash table. */
278 lus
->agents
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
280 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
281 if (lus
->consumer
== NULL
) {
286 * The tmp_consumer stays NULL until a set_consumer_uri command is
287 * executed. At this point, the consumer should be nullify until an
288 * enable_consumer command. This assignment is symbolic since we've zmalloc
291 lus
->tmp_consumer
= NULL
;
293 DBG2("UST trace session create successful");
298 ht_cleanup_push(lus
->domain_global
.channels
);
299 ht_cleanup_push(lus
->agents
);
306 * Allocate and initialize a ust channel data structure.
308 * Return pointer to structure or NULL.
310 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
312 struct ltt_ust_channel
*luc
;
316 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
318 PERROR("ltt_ust_channel zmalloc");
322 /* Copy UST channel attributes */
323 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
324 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
325 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
326 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
327 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
328 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
330 /* Translate to UST output enum */
331 switch (luc
->attr
.output
) {
333 luc
->attr
.output
= LTTNG_UST_MMAP
;
338 * If we receive an empty string for channel name, it means the
339 * default channel name is requested.
341 if (chan
->name
[0] == '\0') {
342 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
344 /* Copy channel name */
345 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
347 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
350 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
351 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
353 /* Alloc hash tables */
354 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
355 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
357 /* On-disk circular buffer parameters */
358 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
359 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
361 DBG2("Trace UST channel %s created", luc
->name
);
368 * Allocate and initialize a ust event. Set name and event type.
369 * We own filter_expression, filter, and exclusion.
371 * Return pointer to structure or NULL.
373 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
374 char *filter_expression
,
375 struct lttng_filter_bytecode
*filter
,
376 struct lttng_event_exclusion
*exclusion
)
378 struct ltt_ust_event
*lue
;
382 lue
= zmalloc(sizeof(struct ltt_ust_event
));
384 PERROR("ust event zmalloc");
389 case LTTNG_EVENT_PROBE
:
390 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
392 case LTTNG_EVENT_FUNCTION
:
393 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
395 case LTTNG_EVENT_FUNCTION_ENTRY
:
396 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
398 case LTTNG_EVENT_TRACEPOINT
:
399 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
402 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
403 goto error_free_event
;
406 /* Copy event name */
407 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
408 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
410 switch (ev
->loglevel_type
) {
411 case LTTNG_EVENT_LOGLEVEL_ALL
:
412 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
413 lue
->attr
.loglevel
= -1; /* Force to -1 */
415 case LTTNG_EVENT_LOGLEVEL_RANGE
:
416 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
417 lue
->attr
.loglevel
= ev
->loglevel
;
419 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
420 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
421 lue
->attr
.loglevel
= ev
->loglevel
;
424 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
425 goto error_free_event
;
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
,
445 free(filter_expression
);
452 int trace_ust_context_type_event_to_ust(enum lttng_event_context_type type
)
457 case LTTNG_EVENT_CONTEXT_VTID
:
458 utype
= LTTNG_UST_CONTEXT_VTID
;
460 case LTTNG_EVENT_CONTEXT_VPID
:
461 utype
= LTTNG_UST_CONTEXT_VPID
;
463 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
464 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
466 case LTTNG_EVENT_CONTEXT_PROCNAME
:
467 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
469 case LTTNG_EVENT_CONTEXT_IP
:
470 utype
= LTTNG_UST_CONTEXT_IP
;
472 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
473 utype
= LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
;
476 ERR("Invalid UST context");
484 * Return 1 if contexts match, 0 otherwise.
486 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
487 struct lttng_event_context
*ctx
)
491 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
495 if (uctx
->ctx
.ctx
!= utype
) {
499 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
500 if (uctx
->ctx
.u
.perf_counter
.type
501 != ctx
->u
.perf_counter
.type
) {
504 if (uctx
->ctx
.u
.perf_counter
.config
505 != ctx
->u
.perf_counter
.config
) {
508 if (strncmp(uctx
->ctx
.u
.perf_counter
.name
,
509 ctx
->u
.perf_counter
.name
,
510 LTTNG_UST_SYM_NAME_LEN
)) {
522 * Allocate and initialize an UST context.
524 * Return pointer to structure or NULL.
526 struct ltt_ust_context
*trace_ust_create_context(
527 struct lttng_event_context
*ctx
)
529 struct ltt_ust_context
*uctx
;
534 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
539 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
541 PERROR("zmalloc ltt_ust_context");
545 uctx
->ctx
.ctx
= (enum lttng_ust_context_type
) utype
;
547 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
548 uctx
->ctx
.u
.perf_counter
.type
= ctx
->u
.perf_counter
.type
;
549 uctx
->ctx
.u
.perf_counter
.config
= ctx
->u
.perf_counter
.config
;
550 strncpy(uctx
->ctx
.u
.perf_counter
.name
, ctx
->u
.perf_counter
.name
,
551 LTTNG_UST_SYM_NAME_LEN
);
552 uctx
->ctx
.u
.perf_counter
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
557 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
566 * RCU safe free context structure.
568 static void destroy_context_rcu(struct rcu_head
*head
)
570 struct lttng_ht_node_ulong
*node
=
571 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
572 struct ltt_ust_context
*ctx
=
573 caa_container_of(node
, struct ltt_ust_context
, node
);
579 * Cleanup UST context hash table.
581 static void destroy_contexts(struct lttng_ht
*ht
)
584 struct lttng_ht_node_ulong
*node
;
585 struct lttng_ht_iter iter
;
586 struct ltt_ust_context
*ctx
;
591 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
592 /* Remove from ordered list. */
593 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
594 cds_list_del(&ctx
->list
);
595 /* Remove from channel's hash table. */
596 ret
= lttng_ht_del(ht
, &iter
);
598 call_rcu(&node
->head
, destroy_context_rcu
);
607 * Cleanup ust event structure.
609 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
613 DBG2("Trace destroy UST event %s", event
->attr
.name
);
614 free(event
->filter_expression
);
616 free(event
->exclusion
);
621 * URCU intermediate call to complete destroy event.
623 static void destroy_event_rcu(struct rcu_head
*head
)
625 struct lttng_ht_node_str
*node
=
626 caa_container_of(head
, struct lttng_ht_node_str
, head
);
627 struct ltt_ust_event
*event
=
628 caa_container_of(node
, struct ltt_ust_event
, node
);
630 trace_ust_destroy_event(event
);
634 * Cleanup UST events hashtable.
636 static void destroy_events(struct lttng_ht
*events
)
639 struct lttng_ht_node_str
*node
;
640 struct lttng_ht_iter iter
;
645 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
646 ret
= lttng_ht_del(events
, &iter
);
648 call_rcu(&node
->head
, destroy_event_rcu
);
652 ht_cleanup_push(events
);
656 * Cleanup ust channel structure.
658 * Should _NOT_ be called with RCU read lock held.
660 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
664 DBG2("Trace destroy UST channel %s", channel
->name
);
666 /* Destroying all events of the channel */
667 destroy_events(channel
->events
);
668 /* Destroying all context of the channel */
669 destroy_contexts(channel
->ctx
);
675 * URCU intermediate call to complete destroy channel.
677 static void destroy_channel_rcu(struct rcu_head
*head
)
679 struct lttng_ht_node_str
*node
=
680 caa_container_of(head
, struct lttng_ht_node_str
, head
);
681 struct ltt_ust_channel
*channel
=
682 caa_container_of(node
, struct ltt_ust_channel
, node
);
684 _trace_ust_destroy_channel(channel
);
687 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
689 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
693 * Remove an UST channel from a channel HT.
695 void trace_ust_delete_channel(struct lttng_ht
*ht
,
696 struct ltt_ust_channel
*channel
)
699 struct lttng_ht_iter iter
;
704 iter
.iter
.node
= &channel
->node
.node
;
705 ret
= lttng_ht_del(ht
, &iter
);
710 * Iterate over a hash table containing channels and cleanup safely.
712 static void destroy_channels(struct lttng_ht
*channels
)
715 struct lttng_ht_node_str
*node
;
716 struct lttng_ht_iter iter
;
722 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
723 ret
= lttng_ht_del(channels
, &iter
);
725 call_rcu(&node
->head
, destroy_channel_rcu
);
729 ht_cleanup_push(channels
);
733 * Cleanup UST global domain.
735 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
739 destroy_channels(dom
->channels
);
743 * Cleanup ust session structure
745 * Should *NOT* be called with RCU read-side lock held.
747 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
750 struct buffer_reg_uid
*reg
, *sreg
;
751 struct lttng_ht_iter iter
;
755 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
757 /* Cleaning up UST domain */
758 destroy_domain_global(&session
->domain_global
);
761 cds_lfht_for_each_entry(session
->agents
->ht
, &iter
.iter
, agt
, node
.node
) {
762 int ret
= lttng_ht_del(session
->agents
, &iter
);
769 ht_cleanup_push(session
->agents
);
771 /* Cleanup UID buffer registry object(s). */
772 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
774 cds_list_del(®
->lnode
);
775 buffer_reg_uid_remove(reg
);
776 buffer_reg_uid_destroy(reg
, session
->consumer
);
779 consumer_destroy_output(session
->consumer
);
780 consumer_destroy_output(session
->tmp_consumer
);