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
;
221 lus
->start_trace
= 0;
224 * Default buffer type. This can be changed through an enable channel
225 * requesting a different type. Note that this can only be changed once
226 * during the session lifetime which is at the first enable channel and
227 * only before start. The flag buffer_type_changed indicates the status.
229 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
230 /* Once set to 1, the buffer_type is immutable for the session. */
231 lus
->buffer_type_changed
= 0;
232 /* Init it in case it get used after allocation. */
233 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
235 /* Alloc UST global domain channels' HT */
236 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
237 ret
= jul_init_domain(&lus
->domain_jul
);
242 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
243 if (lus
->consumer
== NULL
) {
248 * The tmp_consumer stays NULL until a set_consumer_uri command is
249 * executed. At this point, the consumer should be nullify until an
250 * enable_consumer command. This assignment is symbolic since we've zmalloc
253 lus
->tmp_consumer
= NULL
;
255 DBG2("UST trace session create successful");
260 ht_cleanup_push(lus
->domain_global
.channels
);
261 jul_destroy_domain(&lus
->domain_jul
);
268 * Allocate and initialize a ust channel data structure.
270 * Return pointer to structure or NULL.
272 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
274 struct ltt_ust_channel
*luc
;
278 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
280 PERROR("ltt_ust_channel zmalloc");
284 /* Copy UST channel attributes */
285 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
286 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
287 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
288 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
289 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
290 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
292 /* Translate to UST output enum */
293 switch (luc
->attr
.output
) {
295 luc
->attr
.output
= LTTNG_UST_MMAP
;
300 * If we receive an empty string for channel name, it means the
301 * default channel name is requested.
303 if (chan
->name
[0] == '\0') {
304 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
306 /* Copy channel name */
307 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
309 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
312 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
313 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
315 /* Alloc hash tables */
316 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
317 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
319 /* On-disk circular buffer parameters */
320 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
321 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
323 DBG2("Trace UST channel %s created", luc
->name
);
330 * Allocate and initialize a ust event. Set name and event type.
332 * Return pointer to structure or NULL.
334 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
335 struct lttng_filter_bytecode
*filter
,
336 struct lttng_event_exclusion
*exclusion
)
338 struct ltt_ust_event
*lue
;
342 lue
= zmalloc(sizeof(struct ltt_ust_event
));
344 PERROR("ust event zmalloc");
349 case LTTNG_EVENT_PROBE
:
350 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
352 case LTTNG_EVENT_FUNCTION
:
353 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
355 case LTTNG_EVENT_FUNCTION_ENTRY
:
356 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
358 case LTTNG_EVENT_TRACEPOINT
:
359 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
362 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
363 goto error_free_event
;
366 /* Copy event name */
367 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
368 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
370 switch (ev
->loglevel_type
) {
371 case LTTNG_EVENT_LOGLEVEL_ALL
:
372 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
373 lue
->attr
.loglevel
= -1; /* Force to -1 */
375 case LTTNG_EVENT_LOGLEVEL_RANGE
:
376 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
377 lue
->attr
.loglevel
= ev
->loglevel
;
379 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
380 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
381 lue
->attr
.loglevel
= ev
->loglevel
;
384 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
385 goto error_free_event
;
389 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
390 lue
->exclusion
= (struct lttng_event_exclusion
*) exclusion
;
393 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
395 DBG2("Trace UST event %s, loglevel (%d,%d) created",
396 lue
->attr
.name
, lue
->attr
.loglevel_type
,
408 * Allocate and initialize a ust metadata.
410 * Return pointer to structure or NULL.
412 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
415 struct ltt_ust_metadata
*lum
;
419 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
421 PERROR("ust metadata zmalloc");
425 /* Set default attributes */
426 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
427 lum
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
428 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
429 lum
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
430 lum
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
431 lum
->attr
.output
= LTTNG_UST_MMAP
;
434 /* Set metadata trace path */
435 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/" DEFAULT_METADATA_NAME
, path
);
437 PERROR("asprintf ust metadata");
438 goto error_free_metadata
;
450 * Allocate and initialize an UST context.
452 * Return pointer to structure or NULL.
454 struct ltt_ust_context
*trace_ust_create_context(
455 struct lttng_event_context
*ctx
)
457 struct ltt_ust_context
*uctx
;
458 enum lttng_ust_context_type utype
;
463 case LTTNG_EVENT_CONTEXT_VTID
:
464 utype
= LTTNG_UST_CONTEXT_VTID
;
466 case LTTNG_EVENT_CONTEXT_VPID
:
467 utype
= LTTNG_UST_CONTEXT_VPID
;
469 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
470 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
472 case LTTNG_EVENT_CONTEXT_PROCNAME
:
473 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
475 case LTTNG_EVENT_CONTEXT_IP
:
476 utype
= LTTNG_UST_CONTEXT_IP
;
479 ERR("Invalid UST context");
483 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
485 PERROR("zmalloc ltt_ust_context");
489 uctx
->ctx
.ctx
= utype
;
490 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
491 CDS_INIT_LIST_HEAD(&uctx
->list
);
500 * RCU safe free context structure.
502 static void destroy_context_rcu(struct rcu_head
*head
)
504 struct lttng_ht_node_ulong
*node
=
505 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
506 struct ltt_ust_context
*ctx
=
507 caa_container_of(node
, struct ltt_ust_context
, node
);
513 * Cleanup UST context hash table.
515 static void destroy_contexts(struct lttng_ht
*ht
)
518 struct lttng_ht_node_ulong
*node
;
519 struct lttng_ht_iter iter
;
520 struct ltt_ust_context
*ctx
;
525 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
526 /* Remove from ordered list. */
527 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
528 cds_list_del(&ctx
->list
);
529 /* Remove from channel's hash table. */
530 ret
= lttng_ht_del(ht
, &iter
);
532 call_rcu(&node
->head
, destroy_context_rcu
);
541 * Cleanup ust event structure.
543 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
547 DBG2("Trace destroy UST event %s", event
->attr
.name
);
553 * URCU intermediate call to complete destroy event.
555 static void destroy_event_rcu(struct rcu_head
*head
)
557 struct lttng_ht_node_str
*node
=
558 caa_container_of(head
, struct lttng_ht_node_str
, head
);
559 struct ltt_ust_event
*event
=
560 caa_container_of(node
, struct ltt_ust_event
, node
);
562 trace_ust_destroy_event(event
);
566 * Cleanup UST events hashtable.
568 static void destroy_events(struct lttng_ht
*events
)
571 struct lttng_ht_node_str
*node
;
572 struct lttng_ht_iter iter
;
577 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
578 ret
= lttng_ht_del(events
, &iter
);
580 call_rcu(&node
->head
, destroy_event_rcu
);
584 ht_cleanup_push(events
);
588 * Cleanup ust channel structure.
590 * Should _NOT_ be called with RCU read lock held.
592 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
596 DBG2("Trace destroy UST channel %s", channel
->name
);
598 /* Destroying all events of the channel */
599 destroy_events(channel
->events
);
600 /* Destroying all context of the channel */
601 destroy_contexts(channel
->ctx
);
607 * URCU intermediate call to complete destroy channel.
609 static void destroy_channel_rcu(struct rcu_head
*head
)
611 struct lttng_ht_node_str
*node
=
612 caa_container_of(head
, struct lttng_ht_node_str
, head
);
613 struct ltt_ust_channel
*channel
=
614 caa_container_of(node
, struct ltt_ust_channel
, node
);
616 _trace_ust_destroy_channel(channel
);
619 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
621 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
625 * Remove an UST channel from a channel HT.
627 void trace_ust_delete_channel(struct lttng_ht
*ht
,
628 struct ltt_ust_channel
*channel
)
631 struct lttng_ht_iter iter
;
636 iter
.iter
.node
= &channel
->node
.node
;
637 ret
= lttng_ht_del(ht
, &iter
);
642 * Cleanup ust metadata structure.
644 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
648 if (!metadata
->handle
) {
651 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
656 * Iterate over a hash table containing channels and cleanup safely.
658 static void destroy_channels(struct lttng_ht
*channels
)
661 struct lttng_ht_node_str
*node
;
662 struct lttng_ht_iter iter
;
668 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
669 ret
= lttng_ht_del(channels
, &iter
);
671 call_rcu(&node
->head
, destroy_channel_rcu
);
675 ht_cleanup_push(channels
);
679 * Cleanup UST global domain.
681 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
685 destroy_channels(dom
->channels
);
689 * Cleanup ust session structure
691 * Should *NOT* be called with RCU read-side lock held.
693 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
695 struct buffer_reg_uid
*reg
, *sreg
;
699 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
701 /* Cleaning up UST domain */
702 destroy_domain_global(&session
->domain_global
);
703 jul_destroy_domain(&session
->domain_jul
);
705 /* Cleanup UID buffer registry object(s). */
706 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
708 cds_list_del(®
->lnode
);
709 buffer_reg_uid_remove(reg
);
710 buffer_reg_uid_destroy(reg
, session
->consumer
);
713 consumer_destroy_output(session
->consumer
);
714 consumer_destroy_output(session
->tmp_consumer
);