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 "buffer-registry.h"
28 #include "trace-ust.h"
32 * Match function for the events hash table lookup.
34 * Matches by name only. Used by the disable command.
36 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
39 struct ltt_ust_event
*event
;
45 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
49 if (strncmp(event
->attr
.name
, name
, sizeof(event
->attr
.name
)) != 0) {
61 * Match function for the hash table lookup.
63 * It matches an ust event based on three attributes which are the event name,
64 * the filter bytecode and the loglevel.
66 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
)
68 struct ltt_ust_event
*event
;
69 const struct ltt_ust_ht_key
*key
;
74 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
77 /* Match the 3 elements of the key: name, filter and loglevel. */
80 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
85 if (event
->attr
.loglevel
!= key
->loglevel
) {
86 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
87 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
89 * Match is accepted. This is because on event creation, the
90 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
91 * -1 are accepted for this loglevel type since 0 is the one set by
92 * the API when receiving an enable event.
99 /* Only one of the filters is NULL, fail. */
100 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
104 if (key
->filter
&& event
->filter
) {
105 /* Both filters exists, check length followed by the bytecode. */
106 if (event
->filter
->len
!= key
->filter
->len
||
107 memcmp(event
->filter
->data
, key
->filter
->data
,
108 event
->filter
->len
) != 0) {
121 * Find the channel in the hashtable and return channel pointer. RCU read side
122 * lock MUST be acquired before calling this.
124 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
127 struct lttng_ht_node_str
*node
;
128 struct lttng_ht_iter iter
;
130 lttng_ht_lookup(ht
, (void *)name
, &iter
);
131 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 and return event pointer. RCU read side lock
147 * MUST be acquired before calling this.
149 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
150 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
)
152 struct lttng_ht_node_str
*node
;
153 struct lttng_ht_iter iter
;
154 struct ltt_ust_ht_key key
;
161 key
.loglevel
= loglevel
;
163 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
164 trace_ust_ht_match_event
, &key
, &iter
.iter
);
165 node
= lttng_ht_iter_get_node_str(&iter
);
170 DBG2("Trace UST event %s found", key
.name
);
172 return caa_container_of(node
, struct ltt_ust_event
, node
);
175 DBG2("Trace UST event %s NOT found", key
.name
);
180 * Allocate and initialize a ust session data structure.
182 * Return pointer to structure or NULL.
184 struct ltt_ust_session
*trace_ust_create_session(unsigned int session_id
)
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;
200 * Default buffer type. This can be changed through an enable channel
201 * requesting a different type. Note that this can only be changed once
202 * during the session lifetime which is at the first enable channel and
203 * only before start. The flag buffer_type_changed indicates the status.
205 lus
->buffer_type
= LTTNG_BUFFER_PER_PID
;
206 /* Once set to 1, the buffer_type is immutable for the session. */
207 lus
->buffer_type_changed
= 0;
208 /* Init it in case it get used after allocation. */
209 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
211 /* Alloc UST global domain channels' HT */
212 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
214 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
215 if (lus
->consumer
== NULL
) {
220 * The tmp_consumer stays NULL until a set_consumer_uri command is
221 * executed. At this point, the consumer should be nullify until an
222 * enable_consumer command. This assignment is symbolic since we've zmalloc
225 lus
->tmp_consumer
= NULL
;
227 DBG2("UST trace session create successful");
232 ht_cleanup_push(lus
->domain_global
.channels
);
239 * Allocate and initialize a ust channel data structure.
241 * Return pointer to structure or NULL.
243 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
245 struct ltt_ust_channel
*luc
;
249 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
251 PERROR("ltt_ust_channel zmalloc");
255 /* Copy UST channel attributes */
256 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
257 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
258 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
259 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
260 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
261 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
263 /* Translate to UST output enum */
264 switch (luc
->attr
.output
) {
266 luc
->attr
.output
= LTTNG_UST_MMAP
;
270 /* Copy channel name */
271 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
272 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
275 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
276 /* Alloc hash tables */
277 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
278 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
280 /* On-disk circular buffer parameters */
281 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
282 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
284 DBG2("Trace UST channel %s created", luc
->name
);
291 * Allocate and initialize a ust event. Set name and event type.
293 * Return pointer to structure or NULL.
295 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
296 struct lttng_filter_bytecode
*filter
)
298 struct ltt_ust_event
*lue
;
302 lue
= zmalloc(sizeof(struct ltt_ust_event
));
304 PERROR("ust event zmalloc");
309 case LTTNG_EVENT_PROBE
:
310 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
312 case LTTNG_EVENT_FUNCTION
:
313 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
315 case LTTNG_EVENT_FUNCTION_ENTRY
:
316 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
318 case LTTNG_EVENT_TRACEPOINT
:
319 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
322 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
323 goto error_free_event
;
326 /* Copy event name */
327 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
328 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
330 switch (ev
->loglevel_type
) {
331 case LTTNG_EVENT_LOGLEVEL_ALL
:
332 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
333 lue
->attr
.loglevel
= -1; /* Force to -1 */
335 case LTTNG_EVENT_LOGLEVEL_RANGE
:
336 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
337 lue
->attr
.loglevel
= ev
->loglevel
;
339 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
340 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
341 lue
->attr
.loglevel
= ev
->loglevel
;
344 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
345 goto error_free_event
;
349 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
352 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
354 DBG2("Trace UST event %s, loglevel (%d,%d) created",
355 lue
->attr
.name
, lue
->attr
.loglevel_type
,
367 * Allocate and initialize a ust metadata.
369 * Return pointer to structure or NULL.
371 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
374 struct ltt_ust_metadata
*lum
;
378 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
380 PERROR("ust metadata zmalloc");
384 /* Set default attributes */
385 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
386 lum
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
387 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
388 lum
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
389 lum
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
390 lum
->attr
.output
= LTTNG_UST_MMAP
;
393 /* Set metadata trace path */
394 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/" DEFAULT_METADATA_NAME
, path
);
396 PERROR("asprintf ust metadata");
397 goto error_free_metadata
;
409 * Allocate and initialize an UST context.
411 * Return pointer to structure or NULL.
413 struct ltt_ust_context
*trace_ust_create_context(
414 struct lttng_event_context
*ctx
)
416 struct ltt_ust_context
*uctx
;
417 enum lttng_ust_context_type utype
;
422 case LTTNG_EVENT_CONTEXT_VTID
:
423 utype
= LTTNG_UST_CONTEXT_VTID
;
425 case LTTNG_EVENT_CONTEXT_VPID
:
426 utype
= LTTNG_UST_CONTEXT_VPID
;
428 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
429 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
431 case LTTNG_EVENT_CONTEXT_PROCNAME
:
432 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
435 ERR("Invalid UST context");
439 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
441 PERROR("zmalloc ltt_ust_context");
445 uctx
->ctx
.ctx
= utype
;
446 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
455 * RCU safe free context structure.
457 static void destroy_context_rcu(struct rcu_head
*head
)
459 struct lttng_ht_node_ulong
*node
=
460 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
461 struct ltt_ust_context
*ctx
=
462 caa_container_of(node
, struct ltt_ust_context
, node
);
468 * Cleanup UST context hash table.
470 static void destroy_contexts(struct lttng_ht
*ht
)
473 struct lttng_ht_node_ulong
*node
;
474 struct lttng_ht_iter iter
;
479 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
480 ret
= lttng_ht_del(ht
, &iter
);
482 call_rcu(&node
->head
, destroy_context_rcu
);
491 * Cleanup ust event structure.
493 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
497 DBG2("Trace destroy UST event %s", event
->attr
.name
);
503 * URCU intermediate call to complete destroy event.
505 static void destroy_event_rcu(struct rcu_head
*head
)
507 struct lttng_ht_node_str
*node
=
508 caa_container_of(head
, struct lttng_ht_node_str
, head
);
509 struct ltt_ust_event
*event
=
510 caa_container_of(node
, struct ltt_ust_event
, node
);
512 trace_ust_destroy_event(event
);
516 * Cleanup UST events hashtable.
518 static void destroy_events(struct lttng_ht
*events
)
521 struct lttng_ht_node_str
*node
;
522 struct lttng_ht_iter iter
;
527 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
528 ret
= lttng_ht_del(events
, &iter
);
530 call_rcu(&node
->head
, destroy_event_rcu
);
534 ht_cleanup_push(events
);
538 * Cleanup ust channel structure.
540 * Should _NOT_ be called with RCU read lock held.
542 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
546 DBG2("Trace destroy UST channel %s", channel
->name
);
548 /* Destroying all events of the channel */
549 destroy_events(channel
->events
);
550 /* Destroying all context of the channel */
551 destroy_contexts(channel
->ctx
);
557 * URCU intermediate call to complete destroy channel.
559 static void destroy_channel_rcu(struct rcu_head
*head
)
561 struct lttng_ht_node_str
*node
=
562 caa_container_of(head
, struct lttng_ht_node_str
, head
);
563 struct ltt_ust_channel
*channel
=
564 caa_container_of(node
, struct ltt_ust_channel
, node
);
566 _trace_ust_destroy_channel(channel
);
569 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
571 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
575 * Remove an UST channel from a channel HT.
577 void trace_ust_delete_channel(struct lttng_ht
*ht
,
578 struct ltt_ust_channel
*channel
)
581 struct lttng_ht_iter iter
;
586 iter
.iter
.node
= &channel
->node
.node
;
587 ret
= lttng_ht_del(ht
, &iter
);
592 * Cleanup ust metadata structure.
594 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
598 if (!metadata
->handle
) {
601 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
606 * Iterate over a hash table containing channels and cleanup safely.
608 static void destroy_channels(struct lttng_ht
*channels
)
611 struct lttng_ht_node_str
*node
;
612 struct lttng_ht_iter iter
;
618 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
619 ret
= lttng_ht_del(channels
, &iter
);
621 call_rcu(&node
->head
, destroy_channel_rcu
);
625 ht_cleanup_push(channels
);
629 * Cleanup UST global domain.
631 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
635 destroy_channels(dom
->channels
);
639 * Cleanup ust session structure
641 * Should *NOT* be called with RCU read-side lock held.
643 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
645 struct buffer_reg_uid
*reg
, *sreg
;
649 DBG2("Trace UST destroy session %u", session
->id
);
651 /* Cleaning up UST domain */
652 destroy_domain_global(&session
->domain_global
);
654 /* Cleanup UID buffer registry object(s). */
655 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
657 cds_list_del(®
->lnode
);
658 buffer_reg_uid_remove(reg
);
659 buffer_reg_uid_destroy(reg
, session
->consumer
);
662 consumer_destroy_output(session
->consumer
);
663 consumer_destroy_output(session
->tmp_consumer
);