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
;
131 lttng_ht_lookup(ht
, (void *)name
, &iter
);
132 node
= lttng_ht_iter_get_node_str(&iter
);
137 DBG2("Trace UST channel %s found by name", name
);
139 return caa_container_of(node
, struct ltt_ust_channel
, node
);
142 DBG2("Trace UST channel %s not found by name", name
);
147 * Find the event in the hashtable and return event pointer. RCU read side lock
148 * MUST be acquired before calling this.
150 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
151 char *name
, struct lttng_filter_bytecode
*filter
, int loglevel
)
153 struct lttng_ht_node_str
*node
;
154 struct lttng_ht_iter iter
;
155 struct ltt_ust_ht_key key
;
162 key
.loglevel
= loglevel
;
164 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
165 trace_ust_ht_match_event
, &key
, &iter
.iter
);
166 node
= lttng_ht_iter_get_node_str(&iter
);
171 DBG2("Trace UST event %s found", key
.name
);
173 return caa_container_of(node
, struct ltt_ust_event
, node
);
176 DBG2("Trace UST event %s NOT found", key
.name
);
181 * Allocate and initialize a ust session data structure.
183 * Return pointer to structure or NULL.
185 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
187 struct ltt_ust_session
*lus
;
189 /* Allocate a new ltt ust session */
190 lus
= zmalloc(sizeof(struct ltt_ust_session
));
192 PERROR("create ust session zmalloc");
196 /* Init data structure */
197 lus
->id
= session_id
;
198 lus
->start_trace
= 0;
201 * Default buffer type. This can be changed through an enable channel
202 * requesting a different type. Note that this can only be changed once
203 * during the session lifetime which is at the first enable channel and
204 * only before start. The flag buffer_type_changed indicates the status.
206 lus
->buffer_type
= LTTNG_BUFFER_PER_PID
;
207 /* Once set to 1, the buffer_type is immutable for the session. */
208 lus
->buffer_type_changed
= 0;
209 /* Init it in case it get used after allocation. */
210 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
212 /* Alloc UST global domain channels' HT */
213 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
215 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
216 if (lus
->consumer
== NULL
) {
221 * The tmp_consumer stays NULL until a set_consumer_uri command is
222 * executed. At this point, the consumer should be nullify until an
223 * enable_consumer command. This assignment is symbolic since we've zmalloc
226 lus
->tmp_consumer
= NULL
;
228 DBG2("UST trace session create successful");
233 ht_cleanup_push(lus
->domain_global
.channels
);
240 * Allocate and initialize a ust channel data structure.
242 * Return pointer to structure or NULL.
244 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
)
246 struct ltt_ust_channel
*luc
;
250 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
252 PERROR("ltt_ust_channel zmalloc");
256 /* Copy UST channel attributes */
257 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
258 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
259 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
260 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
261 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
262 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
264 /* Translate to UST output enum */
265 switch (luc
->attr
.output
) {
267 luc
->attr
.output
= LTTNG_UST_MMAP
;
271 /* Copy channel name */
272 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
273 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
276 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
277 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
279 /* Alloc hash tables */
280 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
281 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
283 /* On-disk circular buffer parameters */
284 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
285 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
287 DBG2("Trace UST channel %s created", luc
->name
);
294 * Allocate and initialize a ust event. Set name and event type.
296 * Return pointer to structure or NULL.
298 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
,
299 struct lttng_filter_bytecode
*filter
)
301 struct ltt_ust_event
*lue
;
305 lue
= zmalloc(sizeof(struct ltt_ust_event
));
307 PERROR("ust event zmalloc");
312 case LTTNG_EVENT_PROBE
:
313 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
315 case LTTNG_EVENT_FUNCTION
:
316 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
318 case LTTNG_EVENT_FUNCTION_ENTRY
:
319 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
321 case LTTNG_EVENT_TRACEPOINT
:
322 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
325 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
326 goto error_free_event
;
329 /* Copy event name */
330 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
331 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
333 switch (ev
->loglevel_type
) {
334 case LTTNG_EVENT_LOGLEVEL_ALL
:
335 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
336 lue
->attr
.loglevel
= -1; /* Force to -1 */
338 case LTTNG_EVENT_LOGLEVEL_RANGE
:
339 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
340 lue
->attr
.loglevel
= ev
->loglevel
;
342 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
343 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
344 lue
->attr
.loglevel
= ev
->loglevel
;
347 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
348 goto error_free_event
;
352 lue
->filter
= (struct lttng_ust_filter_bytecode
*) filter
;
355 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
357 DBG2("Trace UST event %s, loglevel (%d,%d) created",
358 lue
->attr
.name
, lue
->attr
.loglevel_type
,
370 * Allocate and initialize a ust metadata.
372 * Return pointer to structure or NULL.
374 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
377 struct ltt_ust_metadata
*lum
;
381 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
383 PERROR("ust metadata zmalloc");
387 /* Set default attributes */
388 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
389 lum
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
390 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
391 lum
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
392 lum
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
393 lum
->attr
.output
= LTTNG_UST_MMAP
;
396 /* Set metadata trace path */
397 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/" DEFAULT_METADATA_NAME
, path
);
399 PERROR("asprintf ust metadata");
400 goto error_free_metadata
;
412 * Allocate and initialize an UST context.
414 * Return pointer to structure or NULL.
416 struct ltt_ust_context
*trace_ust_create_context(
417 struct lttng_event_context
*ctx
)
419 struct ltt_ust_context
*uctx
;
420 enum lttng_ust_context_type utype
;
425 case LTTNG_EVENT_CONTEXT_VTID
:
426 utype
= LTTNG_UST_CONTEXT_VTID
;
428 case LTTNG_EVENT_CONTEXT_VPID
:
429 utype
= LTTNG_UST_CONTEXT_VPID
;
431 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
432 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
434 case LTTNG_EVENT_CONTEXT_PROCNAME
:
435 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
438 ERR("Invalid UST context");
442 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
444 PERROR("zmalloc ltt_ust_context");
448 uctx
->ctx
.ctx
= utype
;
449 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
450 CDS_INIT_LIST_HEAD(&uctx
->list
);
459 * RCU safe free context structure.
461 static void destroy_context_rcu(struct rcu_head
*head
)
463 struct lttng_ht_node_ulong
*node
=
464 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
465 struct ltt_ust_context
*ctx
=
466 caa_container_of(node
, struct ltt_ust_context
, node
);
472 * Cleanup UST context hash table.
474 static void destroy_contexts(struct lttng_ht
*ht
)
477 struct lttng_ht_node_ulong
*node
;
478 struct lttng_ht_iter iter
;
479 struct ltt_ust_context
*ctx
;
484 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
485 /* Remove from ordered list. */
486 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
487 cds_list_del(&ctx
->list
);
488 /* Remove from channel's hash table. */
489 ret
= lttng_ht_del(ht
, &iter
);
491 call_rcu(&node
->head
, destroy_context_rcu
);
500 * Cleanup ust event structure.
502 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
506 DBG2("Trace destroy UST event %s", event
->attr
.name
);
512 * URCU intermediate call to complete destroy event.
514 static void destroy_event_rcu(struct rcu_head
*head
)
516 struct lttng_ht_node_str
*node
=
517 caa_container_of(head
, struct lttng_ht_node_str
, head
);
518 struct ltt_ust_event
*event
=
519 caa_container_of(node
, struct ltt_ust_event
, node
);
521 trace_ust_destroy_event(event
);
525 * Cleanup UST events hashtable.
527 static void destroy_events(struct lttng_ht
*events
)
530 struct lttng_ht_node_str
*node
;
531 struct lttng_ht_iter iter
;
536 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
537 ret
= lttng_ht_del(events
, &iter
);
539 call_rcu(&node
->head
, destroy_event_rcu
);
543 ht_cleanup_push(events
);
547 * Cleanup ust channel structure.
549 * Should _NOT_ be called with RCU read lock held.
551 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
555 DBG2("Trace destroy UST channel %s", channel
->name
);
557 /* Destroying all events of the channel */
558 destroy_events(channel
->events
);
559 /* Destroying all context of the channel */
560 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
);
578 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
580 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
584 * Remove an UST channel from a channel HT.
586 void trace_ust_delete_channel(struct lttng_ht
*ht
,
587 struct ltt_ust_channel
*channel
)
590 struct lttng_ht_iter iter
;
595 iter
.iter
.node
= &channel
->node
.node
;
596 ret
= lttng_ht_del(ht
, &iter
);
601 * Cleanup ust metadata structure.
603 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
607 if (!metadata
->handle
) {
610 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
615 * Iterate over a hash table containing channels and cleanup safely.
617 static void destroy_channels(struct lttng_ht
*channels
)
620 struct lttng_ht_node_str
*node
;
621 struct lttng_ht_iter iter
;
627 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
628 ret
= lttng_ht_del(channels
, &iter
);
630 call_rcu(&node
->head
, destroy_channel_rcu
);
634 ht_cleanup_push(channels
);
638 * Cleanup UST global domain.
640 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
644 destroy_channels(dom
->channels
);
648 * Cleanup ust session structure
650 * Should *NOT* be called with RCU read-side lock held.
652 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
654 struct buffer_reg_uid
*reg
, *sreg
;
658 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
660 /* Cleaning up UST domain */
661 destroy_domain_global(&session
->domain_global
);
663 /* Cleanup UID buffer registry object(s). */
664 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
666 cds_list_del(®
->lnode
);
667 buffer_reg_uid_remove(reg
);
668 buffer_reg_uid_destroy(reg
, session
->consumer
);
671 consumer_destroy_output(session
->consumer
);
672 consumer_destroy_output(session
->tmp_consumer
);