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 3 elements of the key: name, filter and loglevel. */
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) {
122 * Find the channel in the hashtable and return channel pointer. RCU read side
123 * lock MUST be acquired before calling this.
125 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
128 struct lttng_ht_node_str
*node
;
129 struct lttng_ht_iter iter
;
132 * If we receive an empty string for channel name, it means the
133 * default channel name is requested.
136 name
= DEFAULT_CHANNEL_NAME
;
138 lttng_ht_lookup(ht
, (void *)name
, &iter
);
139 node
= lttng_ht_iter_get_node_str(&iter
);
144 DBG2("Trace UST channel %s found by name", name
);
146 return caa_container_of(node
, struct ltt_ust_channel
, node
);
149 DBG2("Trace UST channel %s not found by name", name
);
154 * Find the event in the hashtable and return event pointer. RCU read side lock
155 * MUST be acquired before calling this.
157 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
158 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
)
160 struct lttng_ht_node_str
*node
;
161 struct lttng_ht_iter iter
;
162 struct ltt_ust_ht_key key
;
169 key
.loglevel
= loglevel
;
171 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
172 trace_ust_ht_match_event
, &key
, &iter
.iter
);
173 node
= lttng_ht_iter_get_node_str(&iter
);
178 DBG2("Trace UST event %s found", key
.name
);
180 return caa_container_of(node
, struct ltt_ust_event
, node
);
183 DBG2("Trace UST event %s NOT found", key
.name
);
188 * Allocate and initialize a ust session data structure.
190 * Return pointer to structure or NULL.
192 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
194 struct ltt_ust_session
*lus
;
196 /* Allocate a new ltt ust session */
197 lus
= zmalloc(sizeof(struct ltt_ust_session
));
199 PERROR("create ust session zmalloc");
203 /* Init data structure */
204 lus
->id
= session_id
;
205 lus
->start_trace
= 0;
208 * Default buffer type. This can be changed through an enable channel
209 * requesting a different type. Note that this can only be changed once
210 * during the session lifetime which is at the first enable channel and
211 * only before start. The flag buffer_type_changed indicates the status.
213 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
214 /* Once set to 1, the buffer_type is immutable for the session. */
215 lus
->buffer_type_changed
= 0;
216 /* Init it in case it get used after allocation. */
217 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
219 /* Alloc UST global domain channels' HT */
220 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
222 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
223 if (lus
->consumer
== NULL
) {
228 * The tmp_consumer stays NULL until a set_consumer_uri command is
229 * executed. At this point, the consumer should be nullify until an
230 * enable_consumer command. This assignment is symbolic since we've zmalloc
233 lus
->tmp_consumer
= NULL
;
235 DBG2("UST trace session create successful");
240 ht_cleanup_push(lus
->domain_global
.channels
);
247 * Allocate and initialize a ust channel data structure.
249 * Return pointer to structure or NULL.
251 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
253 struct ltt_ust_channel
*luc
;
257 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
259 PERROR("ltt_ust_channel zmalloc");
263 /* Copy UST channel attributes */
264 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
265 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
266 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
267 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
268 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
269 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
271 /* Translate to UST output enum */
272 switch (luc
->attr
.output
) {
274 luc
->attr
.output
= LTTNG_UST_MMAP
;
279 * If we receive an empty string for channel name, it means the
280 * default channel name is requested.
282 if (chan
->name
[0] == '\0') {
283 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
285 /* Copy channel name */
286 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
288 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
291 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
292 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
294 /* Alloc hash tables */
295 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
296 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
298 /* On-disk circular buffer parameters */
299 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
300 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
302 DBG2("Trace UST channel %s created", luc
->name
);
309 * Allocate and initialize a ust event. Set name and event type.
311 * Return pointer to structure or NULL.
313 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
314 struct lttng_filter_bytecode
*filter
)
316 struct ltt_ust_event
*lue
;
320 lue
= zmalloc(sizeof(struct ltt_ust_event
));
322 PERROR("ust event zmalloc");
327 case LTTNG_EVENT_PROBE
:
328 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
330 case LTTNG_EVENT_FUNCTION
:
331 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
333 case LTTNG_EVENT_FUNCTION_ENTRY
:
334 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
336 case LTTNG_EVENT_TRACEPOINT
:
337 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
340 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
341 goto error_free_event
;
344 /* Copy event name */
345 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
346 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
348 switch (ev
->loglevel_type
) {
349 case LTTNG_EVENT_LOGLEVEL_ALL
:
350 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
351 lue
->attr
.loglevel
= -1; /* Force to -1 */
353 case LTTNG_EVENT_LOGLEVEL_RANGE
:
354 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
355 lue
->attr
.loglevel
= ev
->loglevel
;
357 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
358 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
359 lue
->attr
.loglevel
= ev
->loglevel
;
362 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
363 goto error_free_event
;
367 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
370 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
372 DBG2("Trace UST event %s, loglevel (%d,%d) created",
373 lue
->attr
.name
, lue
->attr
.loglevel_type
,
385 * Allocate and initialize a ust metadata.
387 * Return pointer to structure or NULL.
389 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
392 struct ltt_ust_metadata
*lum
;
396 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
398 PERROR("ust metadata zmalloc");
402 /* Set default attributes */
403 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
404 lum
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
405 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
406 lum
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
407 lum
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
408 lum
->attr
.output
= LTTNG_UST_MMAP
;
411 /* Set metadata trace path */
412 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/" DEFAULT_METADATA_NAME
, path
);
414 PERROR("asprintf ust metadata");
415 goto error_free_metadata
;
427 * Allocate and initialize an UST context.
429 * Return pointer to structure or NULL.
431 struct ltt_ust_context
*trace_ust_create_context(
432 struct lttng_event_context
*ctx
)
434 struct ltt_ust_context
*uctx
;
435 enum lttng_ust_context_type utype
;
440 case LTTNG_EVENT_CONTEXT_VTID
:
441 utype
= LTTNG_UST_CONTEXT_VTID
;
443 case LTTNG_EVENT_CONTEXT_VPID
:
444 utype
= LTTNG_UST_CONTEXT_VPID
;
446 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
447 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
449 case LTTNG_EVENT_CONTEXT_PROCNAME
:
450 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
452 case LTTNG_EVENT_CONTEXT_IP
:
453 utype
= LTTNG_UST_CONTEXT_IP
;
456 ERR("Invalid UST context");
460 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
462 PERROR("zmalloc ltt_ust_context");
466 uctx
->ctx
.ctx
= utype
;
467 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
468 CDS_INIT_LIST_HEAD(&uctx
->list
);
477 * RCU safe free context structure.
479 static void destroy_context_rcu(struct rcu_head
*head
)
481 struct lttng_ht_node_ulong
*node
=
482 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
483 struct ltt_ust_context
*ctx
=
484 caa_container_of(node
, struct ltt_ust_context
, node
);
490 * Cleanup UST context hash table.
492 static void destroy_contexts(struct lttng_ht
*ht
)
495 struct lttng_ht_node_ulong
*node
;
496 struct lttng_ht_iter iter
;
497 struct ltt_ust_context
*ctx
;
502 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
503 /* Remove from ordered list. */
504 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
505 cds_list_del(&ctx
->list
);
506 /* Remove from channel's hash table. */
507 ret
= lttng_ht_del(ht
, &iter
);
509 call_rcu(&node
->head
, destroy_context_rcu
);
518 * Cleanup ust event structure.
520 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
524 DBG2("Trace destroy UST event %s", event
->attr
.name
);
530 * URCU intermediate call to complete destroy event.
532 static void destroy_event_rcu(struct rcu_head
*head
)
534 struct lttng_ht_node_str
*node
=
535 caa_container_of(head
, struct lttng_ht_node_str
, head
);
536 struct ltt_ust_event
*event
=
537 caa_container_of(node
, struct ltt_ust_event
, node
);
539 trace_ust_destroy_event(event
);
543 * Cleanup UST events hashtable.
545 static void destroy_events(struct lttng_ht
*events
)
548 struct lttng_ht_node_str
*node
;
549 struct lttng_ht_iter iter
;
554 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
555 ret
= lttng_ht_del(events
, &iter
);
557 call_rcu(&node
->head
, destroy_event_rcu
);
561 ht_cleanup_push(events
);
565 * Cleanup ust channel structure.
567 * Should _NOT_ be called with RCU read lock held.
569 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
573 DBG2("Trace destroy UST channel %s", channel
->name
);
575 /* Destroying all events of the channel */
576 destroy_events(channel
->events
);
577 /* Destroying all context of the channel */
578 destroy_contexts(channel
->ctx
);
584 * URCU intermediate call to complete destroy channel.
586 static void destroy_channel_rcu(struct rcu_head
*head
)
588 struct lttng_ht_node_str
*node
=
589 caa_container_of(head
, struct lttng_ht_node_str
, head
);
590 struct ltt_ust_channel
*channel
=
591 caa_container_of(node
, struct ltt_ust_channel
, node
);
593 _trace_ust_destroy_channel(channel
);
596 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
598 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
602 * Remove an UST channel from a channel HT.
604 void trace_ust_delete_channel(struct lttng_ht
*ht
,
605 struct ltt_ust_channel
*channel
)
608 struct lttng_ht_iter iter
;
613 iter
.iter
.node
= &channel
->node
.node
;
614 ret
= lttng_ht_del(ht
, &iter
);
619 * Cleanup ust metadata structure.
621 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
625 if (!metadata
->handle
) {
628 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
633 * Iterate over a hash table containing channels and cleanup safely.
635 static void destroy_channels(struct lttng_ht
*channels
)
638 struct lttng_ht_node_str
*node
;
639 struct lttng_ht_iter iter
;
645 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
646 ret
= lttng_ht_del(channels
, &iter
);
648 call_rcu(&node
->head
, destroy_channel_rcu
);
652 ht_cleanup_push(channels
);
656 * Cleanup UST global domain.
658 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
662 destroy_channels(dom
->channels
);
666 * Cleanup ust session structure
668 * Should *NOT* be called with RCU read-side lock held.
670 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
672 struct buffer_reg_uid
*reg
, *sreg
;
676 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
678 /* Cleaning up UST domain */
679 destroy_domain_global(&session
->domain_global
);
681 /* Cleanup UID buffer registry object(s). */
682 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
684 cds_list_del(®
->lnode
);
685 buffer_reg_uid_remove(reg
);
686 buffer_reg_uid_destroy(reg
, session
->consumer
);
689 consumer_destroy_output(session
->consumer
);
690 consumer_destroy_output(session
->tmp_consumer
);