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
)
173 struct lttng_ht_node_str
*node
;
174 struct lttng_ht_iter iter
;
175 struct ltt_ust_ht_key key
;
182 key
.loglevel
= loglevel
;
184 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
185 trace_ust_ht_match_event
, &key
, &iter
.iter
);
186 node
= lttng_ht_iter_get_node_str(&iter
);
191 DBG2("Trace UST event %s found", key
.name
);
193 return caa_container_of(node
, struct ltt_ust_event
, node
);
196 DBG2("Trace UST event %s NOT found", key
.name
);
201 * Allocate and initialize a ust session data structure.
203 * Return pointer to structure or NULL.
205 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
208 struct ltt_ust_session
*lus
;
210 /* Allocate a new ltt ust session */
211 lus
= zmalloc(sizeof(struct ltt_ust_session
));
213 PERROR("create ust session zmalloc");
217 /* Init data structure */
218 lus
->id
= session_id
;
219 lus
->start_trace
= 0;
222 * Default buffer type. This can be changed through an enable channel
223 * requesting a different type. Note that this can only be changed once
224 * during the session lifetime which is at the first enable channel and
225 * only before start. The flag buffer_type_changed indicates the status.
227 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
228 /* Once set to 1, the buffer_type is immutable for the session. */
229 lus
->buffer_type_changed
= 0;
230 /* Init it in case it get used after allocation. */
231 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
233 /* Alloc UST global domain channels' HT */
234 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
235 ret
= jul_init_domain(&lus
->domain_jul
);
240 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
241 if (lus
->consumer
== NULL
) {
246 * The tmp_consumer stays NULL until a set_consumer_uri command is
247 * executed. At this point, the consumer should be nullify until an
248 * enable_consumer command. This assignment is symbolic since we've zmalloc
251 lus
->tmp_consumer
= NULL
;
253 DBG2("UST trace session create successful");
258 ht_cleanup_push(lus
->domain_global
.channels
);
259 jul_destroy_domain(&lus
->domain_jul
);
266 * Allocate and initialize a ust channel data structure.
268 * Return pointer to structure or NULL.
270 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
272 struct ltt_ust_channel
*luc
;
276 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
278 PERROR("ltt_ust_channel zmalloc");
282 /* Copy UST channel attributes */
283 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
284 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
285 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
286 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
287 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
288 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
290 /* Translate to UST output enum */
291 switch (luc
->attr
.output
) {
293 luc
->attr
.output
= LTTNG_UST_MMAP
;
298 * If we receive an empty string for channel name, it means the
299 * default channel name is requested.
301 if (chan
->name
[0] == '\0') {
302 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
304 /* Copy channel name */
305 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
307 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
310 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
311 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
313 /* Alloc hash tables */
314 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
315 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
317 /* On-disk circular buffer parameters */
318 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
319 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
321 DBG2("Trace UST channel %s created", luc
->name
);
328 * Allocate and initialize a ust event. Set name and event type.
330 * Return pointer to structure or NULL.
332 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
333 struct lttng_filter_bytecode
*filter
,
334 struct lttng_event_exclusion
*exclusion
)
336 struct ltt_ust_event
*lue
;
340 lue
= zmalloc(sizeof(struct ltt_ust_event
));
342 PERROR("ust event zmalloc");
347 case LTTNG_EVENT_PROBE
:
348 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
350 case LTTNG_EVENT_FUNCTION
:
351 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
353 case LTTNG_EVENT_FUNCTION_ENTRY
:
354 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
356 case LTTNG_EVENT_TRACEPOINT
:
357 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
360 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
361 goto error_free_event
;
364 /* Copy event name */
365 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
366 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
368 switch (ev
->loglevel_type
) {
369 case LTTNG_EVENT_LOGLEVEL_ALL
:
370 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
371 lue
->attr
.loglevel
= -1; /* Force to -1 */
373 case LTTNG_EVENT_LOGLEVEL_RANGE
:
374 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
375 lue
->attr
.loglevel
= ev
->loglevel
;
377 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
378 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
379 lue
->attr
.loglevel
= ev
->loglevel
;
382 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
383 goto error_free_event
;
387 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
388 lue
->exclusion
= (struct lttng_event_exclusion
*) exclusion
;
391 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
393 DBG2("Trace UST event %s, loglevel (%d,%d) created",
394 lue
->attr
.name
, lue
->attr
.loglevel_type
,
406 * Allocate and initialize a ust metadata.
408 * Return pointer to structure or NULL.
410 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
413 struct ltt_ust_metadata
*lum
;
417 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
419 PERROR("ust metadata zmalloc");
423 /* Set default attributes */
424 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
425 lum
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
426 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
427 lum
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
428 lum
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
429 lum
->attr
.output
= LTTNG_UST_MMAP
;
432 /* Set metadata trace path */
433 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/" DEFAULT_METADATA_NAME
, path
);
435 PERROR("asprintf ust metadata");
436 goto error_free_metadata
;
448 * Allocate and initialize an UST context.
450 * Return pointer to structure or NULL.
452 struct ltt_ust_context
*trace_ust_create_context(
453 struct lttng_event_context
*ctx
)
455 struct ltt_ust_context
*uctx
;
456 enum lttng_ust_context_type utype
;
461 case LTTNG_EVENT_CONTEXT_VTID
:
462 utype
= LTTNG_UST_CONTEXT_VTID
;
464 case LTTNG_EVENT_CONTEXT_VPID
:
465 utype
= LTTNG_UST_CONTEXT_VPID
;
467 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
468 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
470 case LTTNG_EVENT_CONTEXT_PROCNAME
:
471 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
473 case LTTNG_EVENT_CONTEXT_IP
:
474 utype
= LTTNG_UST_CONTEXT_IP
;
477 ERR("Invalid UST context");
481 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
483 PERROR("zmalloc ltt_ust_context");
487 uctx
->ctx
.ctx
= utype
;
488 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
489 CDS_INIT_LIST_HEAD(&uctx
->list
);
498 * RCU safe free context structure.
500 static void destroy_context_rcu(struct rcu_head
*head
)
502 struct lttng_ht_node_ulong
*node
=
503 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
504 struct ltt_ust_context
*ctx
=
505 caa_container_of(node
, struct ltt_ust_context
, node
);
511 * Cleanup UST context hash table.
513 static void destroy_contexts(struct lttng_ht
*ht
)
516 struct lttng_ht_node_ulong
*node
;
517 struct lttng_ht_iter iter
;
518 struct ltt_ust_context
*ctx
;
523 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
524 /* Remove from ordered list. */
525 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
526 cds_list_del(&ctx
->list
);
527 /* Remove from channel's hash table. */
528 ret
= lttng_ht_del(ht
, &iter
);
530 call_rcu(&node
->head
, destroy_context_rcu
);
539 * Cleanup ust event structure.
541 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
545 DBG2("Trace destroy UST event %s", event
->attr
.name
);
551 * URCU intermediate call to complete destroy event.
553 static void destroy_event_rcu(struct rcu_head
*head
)
555 struct lttng_ht_node_str
*node
=
556 caa_container_of(head
, struct lttng_ht_node_str
, head
);
557 struct ltt_ust_event
*event
=
558 caa_container_of(node
, struct ltt_ust_event
, node
);
560 trace_ust_destroy_event(event
);
564 * Cleanup UST events hashtable.
566 static void destroy_events(struct lttng_ht
*events
)
569 struct lttng_ht_node_str
*node
;
570 struct lttng_ht_iter iter
;
575 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
576 ret
= lttng_ht_del(events
, &iter
);
578 call_rcu(&node
->head
, destroy_event_rcu
);
582 ht_cleanup_push(events
);
586 * Cleanup ust channel structure.
588 * Should _NOT_ be called with RCU read lock held.
590 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
594 DBG2("Trace destroy UST channel %s", channel
->name
);
596 /* Destroying all events of the channel */
597 destroy_events(channel
->events
);
598 /* Destroying all context of the channel */
599 destroy_contexts(channel
->ctx
);
605 * URCU intermediate call to complete destroy channel.
607 static void destroy_channel_rcu(struct rcu_head
*head
)
609 struct lttng_ht_node_str
*node
=
610 caa_container_of(head
, struct lttng_ht_node_str
, head
);
611 struct ltt_ust_channel
*channel
=
612 caa_container_of(node
, struct ltt_ust_channel
, node
);
614 _trace_ust_destroy_channel(channel
);
617 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
619 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
623 * Remove an UST channel from a channel HT.
625 void trace_ust_delete_channel(struct lttng_ht
*ht
,
626 struct ltt_ust_channel
*channel
)
629 struct lttng_ht_iter iter
;
634 iter
.iter
.node
= &channel
->node
.node
;
635 ret
= lttng_ht_del(ht
, &iter
);
640 * Cleanup ust metadata structure.
642 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
646 if (!metadata
->handle
) {
649 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
654 * Iterate over a hash table containing channels and cleanup safely.
656 static void destroy_channels(struct lttng_ht
*channels
)
659 struct lttng_ht_node_str
*node
;
660 struct lttng_ht_iter iter
;
666 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
667 ret
= lttng_ht_del(channels
, &iter
);
669 call_rcu(&node
->head
, destroy_channel_rcu
);
673 ht_cleanup_push(channels
);
677 * Cleanup UST global domain.
679 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
683 destroy_channels(dom
->channels
);
687 * Cleanup ust session structure
689 * Should *NOT* be called with RCU read-side lock held.
691 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
693 struct buffer_reg_uid
*reg
, *sreg
;
697 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
699 /* Cleaning up UST domain */
700 destroy_domain_global(&session
->domain_global
);
701 jul_destroy_domain(&session
->domain_jul
);
703 /* Cleanup UID buffer registry object(s). */
704 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
706 cds_list_del(®
->lnode
);
707 buffer_reg_uid_remove(reg
);
708 buffer_reg_uid_destroy(reg
, session
->consumer
);
711 consumer_destroy_output(session
->consumer
);
712 consumer_destroy_output(session
->tmp_consumer
);