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 * Allocate and initialize a ust session data structure.
205 * Return pointer to structure or NULL.
207 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
210 struct ltt_ust_session
*lus
;
212 /* Allocate a new ltt ust session */
213 lus
= zmalloc(sizeof(struct ltt_ust_session
));
215 PERROR("create ust session zmalloc");
219 /* Init data structure */
220 lus
->id
= session_id
;
223 /* Set default metadata channel attribute. */
224 lus
->metadata_attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
225 lus
->metadata_attr
.subbuf_size
= default_get_metadata_subbuf_size();
226 lus
->metadata_attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
227 lus
->metadata_attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
228 lus
->metadata_attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
229 lus
->metadata_attr
.output
= LTTNG_UST_MMAP
;
232 * Default buffer type. This can be changed through an enable channel
233 * requesting a different type. Note that this can only be changed once
234 * during the session lifetime which is at the first enable channel and
235 * only before start. The flag buffer_type_changed indicates the status.
237 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
238 /* Once set to 1, the buffer_type is immutable for the session. */
239 lus
->buffer_type_changed
= 0;
240 /* Init it in case it get used after allocation. */
241 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
243 /* Alloc UST global domain channels' HT */
244 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
245 ret
= jul_init_domain(&lus
->domain_jul
);
250 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
251 if (lus
->consumer
== NULL
) {
256 * The tmp_consumer stays NULL until a set_consumer_uri command is
257 * executed. At this point, the consumer should be nullify until an
258 * enable_consumer command. This assignment is symbolic since we've zmalloc
261 lus
->tmp_consumer
= NULL
;
263 DBG2("UST trace session create successful");
268 ht_cleanup_push(lus
->domain_global
.channels
);
269 jul_destroy_domain(&lus
->domain_jul
);
276 * Allocate and initialize a ust channel data structure.
278 * Return pointer to structure or NULL.
280 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
282 struct ltt_ust_channel
*luc
;
286 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
288 PERROR("ltt_ust_channel zmalloc");
292 /* Copy UST channel attributes */
293 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
294 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
295 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
296 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
297 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
298 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
300 /* Translate to UST output enum */
301 switch (luc
->attr
.output
) {
303 luc
->attr
.output
= LTTNG_UST_MMAP
;
308 * If we receive an empty string for channel name, it means the
309 * default channel name is requested.
311 if (chan
->name
[0] == '\0') {
312 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
314 /* Copy channel name */
315 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
317 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
320 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
321 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
323 /* Alloc hash tables */
324 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
325 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
327 /* On-disk circular buffer parameters */
328 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
329 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
331 DBG2("Trace UST channel %s created", luc
->name
);
338 * Allocate and initialize a ust event. Set name and event type.
340 * Return pointer to structure or NULL.
342 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
343 char *filter_expression
,
344 struct lttng_filter_bytecode
*filter
,
345 struct lttng_event_exclusion
*exclusion
)
347 struct ltt_ust_event
*lue
;
351 lue
= zmalloc(sizeof(struct ltt_ust_event
));
353 PERROR("ust event zmalloc");
358 case LTTNG_EVENT_PROBE
:
359 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
361 case LTTNG_EVENT_FUNCTION
:
362 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
364 case LTTNG_EVENT_FUNCTION_ENTRY
:
365 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
367 case LTTNG_EVENT_TRACEPOINT
:
368 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
371 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
372 goto error_free_event
;
375 /* Copy event name */
376 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
377 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
379 switch (ev
->loglevel_type
) {
380 case LTTNG_EVENT_LOGLEVEL_ALL
:
381 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
382 lue
->attr
.loglevel
= -1; /* Force to -1 */
384 case LTTNG_EVENT_LOGLEVEL_RANGE
:
385 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
386 lue
->attr
.loglevel
= ev
->loglevel
;
388 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
389 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
390 lue
->attr
.loglevel
= ev
->loglevel
;
393 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
394 goto error_free_event
;
398 lue
->filter_expression
= filter_expression
;
399 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
400 lue
->exclusion
= (struct lttng_event_exclusion
*) exclusion
;
403 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
405 DBG2("Trace UST event %s, loglevel (%d,%d) created",
406 lue
->attr
.name
, lue
->attr
.loglevel_type
,
418 int trace_ust_context_type_event_to_ust(enum lttng_event_context_type type
)
423 case LTTNG_EVENT_CONTEXT_VTID
:
424 utype
= LTTNG_UST_CONTEXT_VTID
;
426 case LTTNG_EVENT_CONTEXT_VPID
:
427 utype
= LTTNG_UST_CONTEXT_VPID
;
429 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
430 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
432 case LTTNG_EVENT_CONTEXT_PROCNAME
:
433 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
435 case LTTNG_EVENT_CONTEXT_IP
:
436 utype
= LTTNG_UST_CONTEXT_IP
;
438 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
439 utype
= LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
;
442 ERR("Invalid UST context");
450 * Return 1 if contexts match, 0 otherwise.
452 int trace_ust_match_context(struct ltt_ust_context
*uctx
,
453 struct lttng_event_context
*ctx
)
457 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
461 if (uctx
->ctx
.ctx
!= utype
) {
465 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
466 if (uctx
->ctx
.u
.perf_counter
.type
467 != ctx
->u
.perf_counter
.type
) {
470 if (uctx
->ctx
.u
.perf_counter
.config
471 != ctx
->u
.perf_counter
.config
) {
474 if (strncmp(uctx
->ctx
.u
.perf_counter
.name
,
475 ctx
->u
.perf_counter
.name
,
476 LTTNG_UST_SYM_NAME_LEN
)) {
488 * Allocate and initialize an UST context.
490 * Return pointer to structure or NULL.
492 struct ltt_ust_context
*trace_ust_create_context(
493 struct lttng_event_context
*ctx
)
495 struct ltt_ust_context
*uctx
;
500 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
505 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
507 PERROR("zmalloc ltt_ust_context");
511 uctx
->ctx
.ctx
= (enum lttng_ust_context_type
) utype
;
513 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
514 uctx
->ctx
.u
.perf_counter
.type
= ctx
->u
.perf_counter
.type
;
515 uctx
->ctx
.u
.perf_counter
.config
= ctx
->u
.perf_counter
.config
;
516 strncpy(uctx
->ctx
.u
.perf_counter
.name
, ctx
->u
.perf_counter
.name
,
517 LTTNG_UST_SYM_NAME_LEN
);
518 uctx
->ctx
.u
.perf_counter
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
523 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
532 * RCU safe free context structure.
534 static void destroy_context_rcu(struct rcu_head
*head
)
536 struct lttng_ht_node_ulong
*node
=
537 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
538 struct ltt_ust_context
*ctx
=
539 caa_container_of(node
, struct ltt_ust_context
, node
);
545 * Cleanup UST context hash table.
547 static void destroy_contexts(struct lttng_ht
*ht
)
550 struct lttng_ht_node_ulong
*node
;
551 struct lttng_ht_iter iter
;
552 struct ltt_ust_context
*ctx
;
557 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
558 /* Remove from ordered list. */
559 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
560 cds_list_del(&ctx
->list
);
561 /* Remove from channel's hash table. */
562 ret
= lttng_ht_del(ht
, &iter
);
564 call_rcu(&node
->head
, destroy_context_rcu
);
573 * Cleanup ust event structure.
575 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
579 DBG2("Trace destroy UST event %s", event
->attr
.name
);
580 free(event
->filter_expression
);
582 free(event
->exclusion
);
587 * URCU intermediate call to complete destroy event.
589 static void destroy_event_rcu(struct rcu_head
*head
)
591 struct lttng_ht_node_str
*node
=
592 caa_container_of(head
, struct lttng_ht_node_str
, head
);
593 struct ltt_ust_event
*event
=
594 caa_container_of(node
, struct ltt_ust_event
, node
);
596 trace_ust_destroy_event(event
);
600 * Cleanup UST events hashtable.
602 static void destroy_events(struct lttng_ht
*events
)
605 struct lttng_ht_node_str
*node
;
606 struct lttng_ht_iter iter
;
611 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
612 ret
= lttng_ht_del(events
, &iter
);
614 call_rcu(&node
->head
, destroy_event_rcu
);
618 ht_cleanup_push(events
);
622 * Cleanup ust channel structure.
624 * Should _NOT_ be called with RCU read lock held.
626 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
630 DBG2("Trace destroy UST channel %s", channel
->name
);
632 /* Destroying all events of the channel */
633 destroy_events(channel
->events
);
634 /* Destroying all context of the channel */
635 destroy_contexts(channel
->ctx
);
641 * URCU intermediate call to complete destroy channel.
643 static void destroy_channel_rcu(struct rcu_head
*head
)
645 struct lttng_ht_node_str
*node
=
646 caa_container_of(head
, struct lttng_ht_node_str
, head
);
647 struct ltt_ust_channel
*channel
=
648 caa_container_of(node
, struct ltt_ust_channel
, node
);
650 _trace_ust_destroy_channel(channel
);
653 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
655 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
659 * Remove an UST channel from a channel HT.
661 void trace_ust_delete_channel(struct lttng_ht
*ht
,
662 struct ltt_ust_channel
*channel
)
665 struct lttng_ht_iter iter
;
670 iter
.iter
.node
= &channel
->node
.node
;
671 ret
= lttng_ht_del(ht
, &iter
);
676 * Iterate over a hash table containing channels and cleanup safely.
678 static void destroy_channels(struct lttng_ht
*channels
)
681 struct lttng_ht_node_str
*node
;
682 struct lttng_ht_iter iter
;
688 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
689 ret
= lttng_ht_del(channels
, &iter
);
691 call_rcu(&node
->head
, destroy_channel_rcu
);
695 ht_cleanup_push(channels
);
699 * Cleanup UST global domain.
701 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
705 destroy_channels(dom
->channels
);
709 * Cleanup ust session structure
711 * Should *NOT* be called with RCU read-side lock held.
713 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
715 struct buffer_reg_uid
*reg
, *sreg
;
719 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
721 /* Cleaning up UST domain */
722 destroy_domain_global(&session
->domain_global
);
723 jul_destroy_domain(&session
->domain_jul
);
725 /* Cleanup UID buffer registry object(s). */
726 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
728 cds_list_del(®
->lnode
);
729 buffer_reg_uid_remove(reg
);
730 buffer_reg_uid_destroy(reg
, session
->consumer
);
733 consumer_destroy_output(session
->consumer
);
734 consumer_destroy_output(session
->tmp_consumer
);