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.
24 #include <common/common.h>
25 #include <common/defaults.h>
27 #include "trace-ust.h"
30 * Match function for the events hash table lookup.
32 * Matches by name only. Used by the disable command.
34 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
37 struct ltt_ust_event
*event
;
43 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
47 if (strncmp(event
->attr
.name
, name
, sizeof(event
->attr
.name
)) != 0) {
59 * Match function for the hash table lookup.
61 * It matches an ust event based on three attributes which are the event name,
62 * the filter bytecode and the loglevel.
64 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
)
66 struct ltt_ust_event
*event
;
67 const struct ltt_ust_ht_key
*key
;
72 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
75 /* Match the 3 elements of the key: name, filter and loglevel. */
78 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
83 if (event
->attr
.loglevel
!= key
->loglevel
) {
84 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
85 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
87 * Match is accepted. This is because on event creation, the
88 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
89 * -1 are accepted for this loglevel type since 0 is the one set by
90 * the API when receiving an enable event.
97 /* Only one of the filters is NULL, fail. */
98 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
102 if (key
->filter
&& event
->filter
) {
103 /* Both filters exists, check length followed by the bytecode. */
104 if (event
->filter
->len
!= key
->filter
->len
||
105 memcmp(event
->filter
->data
, key
->filter
->data
,
106 event
->filter
->len
) != 0) {
119 * Find the channel in the hashtable.
121 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
124 struct lttng_ht_node_str
*node
;
125 struct lttng_ht_iter iter
;
128 lttng_ht_lookup(ht
, (void *)name
, &iter
);
129 node
= lttng_ht_iter_get_node_str(&iter
);
136 DBG2("Trace UST channel %s found by name", name
);
138 return caa_container_of(node
, struct ltt_ust_channel
, node
);
141 DBG2("Trace UST channel %s not found by name", name
);
146 * Find the event in the hashtable.
148 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
149 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
)
151 struct lttng_ht_node_str
*node
;
152 struct lttng_ht_iter iter
;
153 struct ltt_ust_ht_key key
;
160 key
.loglevel
= loglevel
;
162 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
163 trace_ust_ht_match_event
, &key
, &iter
.iter
);
164 node
= lttng_ht_iter_get_node_str(&iter
);
169 DBG2("Trace UST event %s found", key
.name
);
171 return caa_container_of(node
, struct ltt_ust_event
, node
);
174 DBG2("Trace UST event %s NOT found", key
.name
);
179 * Allocate and initialize a ust session data structure.
181 * Return pointer to structure or NULL.
183 struct ltt_ust_session
*trace_ust_create_session(char *path
,
184 unsigned int session_id
, struct lttng_domain
*domain
)
186 struct ltt_ust_session
*lus
;
188 /* Allocate a new ltt ust session */
189 lus
= zmalloc(sizeof(struct ltt_ust_session
));
191 PERROR("create ust session zmalloc");
195 /* Init data structure */
196 lus
->id
= session_id
;
197 lus
->start_trace
= 0;
199 /* Alloc UST domain hash tables */
200 lus
->domain_pid
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
201 lus
->domain_exec
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
203 /* Alloc UST global domain channels' HT */
204 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
206 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
207 if (lus
->consumer
== NULL
) {
212 * The tmp_consumer stays NULL until a set_consumer_uri command is
213 * executed. At this point, the consumer should be nullify until an
214 * enable_consumer command. This assignment is symbolic since we've zmalloc
217 lus
->tmp_consumer
= NULL
;
219 /* Use the default consumer output which is the tracing session path. */
220 if (path
&& strlen(path
) > 0) {
223 ret
= snprintf(lus
->consumer
->dst
.trace_path
, PATH_MAX
,
224 "%s" DEFAULT_UST_TRACE_DIR
, path
);
226 PERROR("snprintf UST consumer trace path");
230 /* Set session path */
231 ret
= snprintf(lus
->pathname
, PATH_MAX
, "%s" DEFAULT_UST_TRACE_DIR
,
234 PERROR("snprintf kernel traces path");
239 DBG2("UST trace session create successful");
244 consumer_destroy_output(lus
->consumer
);
246 lttng_ht_destroy(lus
->domain_global
.channels
);
247 lttng_ht_destroy(lus
->domain_exec
);
248 lttng_ht_destroy(lus
->domain_pid
);
255 * Allocate and initialize a ust channel data structure.
257 * Return pointer to structure or NULL.
259 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
,
263 struct ltt_ust_channel
*luc
;
265 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
267 PERROR("ltt_ust_channel zmalloc");
271 /* Copy UST channel attributes */
272 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
273 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
274 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
275 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
276 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
277 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
279 /* Translate to UST output enum */
280 switch (luc
->attr
.output
) {
282 luc
->attr
.output
= LTTNG_UST_MMAP
;
286 /* Copy channel name */
287 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 /* Alloc hash tables */
293 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
294 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
296 /* Set trace output path */
297 ret
= snprintf(luc
->pathname
, PATH_MAX
, "%s", path
);
299 PERROR("asprintf ust create channel");
300 goto error_free_channel
;
303 DBG2("Trace UST channel %s created", luc
->name
);
308 lttng_ht_destroy(luc
->ctx
);
309 lttng_ht_destroy(luc
->events
);
316 * Allocate and initialize a ust event. Set name and event type.
318 * Return pointer to structure or NULL.
320 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
321 struct lttng_filter_bytecode
*filter
)
323 struct ltt_ust_event
*lue
;
325 lue
= zmalloc(sizeof(struct ltt_ust_event
));
327 PERROR("ust event zmalloc");
332 case LTTNG_EVENT_PROBE
:
333 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
335 case LTTNG_EVENT_FUNCTION
:
336 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
338 case LTTNG_EVENT_FUNCTION_ENTRY
:
339 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
341 case LTTNG_EVENT_TRACEPOINT
:
342 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
345 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
346 goto error_free_event
;
349 /* Copy event name */
350 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
351 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
353 switch (ev
->loglevel_type
) {
354 case LTTNG_EVENT_LOGLEVEL_ALL
:
355 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
356 lue
->attr
.loglevel
= -1; /* Force to -1 */
358 case LTTNG_EVENT_LOGLEVEL_RANGE
:
359 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
360 lue
->attr
.loglevel
= ev
->loglevel
;
362 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
363 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
364 lue
->attr
.loglevel
= ev
->loglevel
;
367 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
368 goto error_free_event
;
372 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
375 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
377 DBG2("Trace UST event %s, loglevel (%d,%d) created",
378 lue
->attr
.name
, lue
->attr
.loglevel_type
,
390 * Allocate and initialize a ust metadata.
392 * Return pointer to structure or NULL.
394 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
397 struct ltt_ust_metadata
*lum
;
399 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
401 PERROR("ust metadata zmalloc");
405 /* Set default attributes */
406 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
407 lum
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
408 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
409 lum
->attr
.switch_timer_interval
= DEFAULT_CHANNEL_SWITCH_TIMER
;
410 lum
->attr
.read_timer_interval
= DEFAULT_CHANNEL_READ_TIMER
;
411 lum
->attr
.output
= LTTNG_UST_MMAP
;
414 /* Set metadata trace path */
415 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/metadata", path
);
417 PERROR("asprintf ust metadata");
418 goto error_free_metadata
;
430 * Allocate and initialize an UST context.
432 * Return pointer to structure or NULL.
434 struct ltt_ust_context
*trace_ust_create_context(
435 struct lttng_event_context
*ctx
)
437 struct ltt_ust_context
*uctx
;
438 enum lttng_ust_context_type utype
;
441 case LTTNG_EVENT_CONTEXT_VTID
:
442 utype
= LTTNG_UST_CONTEXT_VTID
;
444 case LTTNG_EVENT_CONTEXT_VPID
:
445 utype
= LTTNG_UST_CONTEXT_VPID
;
447 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
448 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
450 case LTTNG_EVENT_CONTEXT_PROCNAME
:
451 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
454 ERR("Invalid UST context");
458 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
460 PERROR("zmalloc ltt_ust_context");
464 uctx
->ctx
.ctx
= utype
;
465 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
474 * RCU safe free context structure.
476 static void destroy_context_rcu(struct rcu_head
*head
)
478 struct lttng_ht_node_ulong
*node
=
479 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
480 struct ltt_ust_context
*ctx
=
481 caa_container_of(node
, struct ltt_ust_context
, node
);
487 * Cleanup UST context hash table.
489 static void destroy_contexts(struct lttng_ht
*ht
)
492 struct lttng_ht_node_ulong
*node
;
493 struct lttng_ht_iter iter
;
495 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
496 ret
= lttng_ht_del(ht
, &iter
);
498 call_rcu(&node
->head
, destroy_context_rcu
);
502 lttng_ht_destroy(ht
);
506 * Cleanup ust event structure.
508 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
510 DBG2("Trace destroy UST event %s", event
->attr
.name
);
516 * URCU intermediate call to complete destroy event.
518 static void destroy_event_rcu(struct rcu_head
*head
)
520 struct lttng_ht_node_str
*node
=
521 caa_container_of(head
, struct lttng_ht_node_str
, head
);
522 struct ltt_ust_event
*event
=
523 caa_container_of(node
, struct ltt_ust_event
, node
);
525 trace_ust_destroy_event(event
);
529 * Cleanup UST events hashtable.
531 static void destroy_events(struct lttng_ht
*events
)
534 struct lttng_ht_node_str
*node
;
535 struct lttng_ht_iter iter
;
537 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
538 ret
= lttng_ht_del(events
, &iter
);
540 call_rcu(&node
->head
, destroy_event_rcu
);
543 lttng_ht_destroy(events
);
547 * Cleanup ust channel structure.
549 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
551 DBG2("Trace destroy UST channel %s", channel
->name
);
555 /* Destroying all events of the channel */
556 destroy_events(channel
->events
);
557 /* Destroying all context of the channel */
558 destroy_contexts(channel
->ctx
);
566 * URCU intermediate call to complete destroy channel.
568 static void destroy_channel_rcu(struct rcu_head
*head
)
570 struct lttng_ht_node_str
*node
=
571 caa_container_of(head
, struct lttng_ht_node_str
, head
);
572 struct ltt_ust_channel
*channel
=
573 caa_container_of(node
, struct ltt_ust_channel
, node
);
575 trace_ust_destroy_channel(channel
);
579 * Cleanup ust metadata structure.
581 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
583 if (!metadata
->handle
) {
586 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
591 * Iterate over a hash table containing channels and cleanup safely.
593 static void destroy_channels(struct lttng_ht
*channels
)
596 struct lttng_ht_node_str
*node
;
597 struct lttng_ht_iter iter
;
601 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
602 ret
= lttng_ht_del(channels
, &iter
);
604 call_rcu(&node
->head
, destroy_channel_rcu
);
607 lttng_ht_destroy(channels
);
613 * Cleanup UST pid domain.
615 static void destroy_domain_pid(struct lttng_ht
*ht
)
618 struct lttng_ht_iter iter
;
619 struct ltt_ust_domain_pid
*dpid
;
621 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, dpid
, node
.node
) {
622 ret
= lttng_ht_del(ht
, &iter
);
624 destroy_channels(dpid
->channels
);
627 lttng_ht_destroy(ht
);
631 * Cleanup UST exec name domain.
633 static void destroy_domain_exec(struct lttng_ht
*ht
)
636 struct lttng_ht_iter iter
;
637 struct ltt_ust_domain_exec
*dexec
;
639 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, dexec
, node
.node
) {
640 ret
= lttng_ht_del(ht
, &iter
);
642 destroy_channels(dexec
->channels
);
645 lttng_ht_destroy(ht
);
649 * Cleanup UST global domain.
651 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
653 destroy_channels(dom
->channels
);
657 * Cleanup ust session structure
659 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
661 /* Extra protection */
662 if (session
== NULL
) {
668 DBG2("Trace UST destroy session %u", session
->id
);
670 /* Cleaning up UST domain */
671 destroy_domain_global(&session
->domain_global
);
672 destroy_domain_pid(session
->domain_pid
);
673 destroy_domain_exec(session
->domain_exec
);
675 consumer_destroy_output(session
->consumer
);
676 consumer_destroy_output(session
->tmp_consumer
);