2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
16 #include <common/common.h>
17 #include <common/defaults.h>
18 #include <common/trace-chunk.h>
19 #include <common/utils.h>
21 #include "buffer-registry.h"
22 #include "trace-ust.h"
28 * Match function for the events hash table lookup.
30 * Matches by name only. Used by the disable command.
32 int trace_ust_ht_match_event_by_name(struct cds_lfht_node
*node
,
35 struct ltt_ust_event
*event
;
41 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
45 if (strncmp(event
->attr
.name
, name
, sizeof(event
->attr
.name
)) != 0) {
57 * Match function for the hash table lookup.
59 * It matches an ust event based on three attributes which are the event name,
60 * the filter bytecode and the loglevel.
62 int trace_ust_ht_match_event(struct cds_lfht_node
*node
, const void *_key
)
64 struct ltt_ust_event
*event
;
65 const struct ltt_ust_ht_key
*key
;
66 int ev_loglevel_value
;
72 event
= caa_container_of(node
, struct ltt_ust_event
, node
.node
);
74 ev_loglevel_value
= event
->attr
.loglevel
;
76 /* Match the 4 elements of the key: name, filter, loglevel, exclusions. */
79 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
83 /* Event loglevel value and type. */
84 ll_match
= loglevels_match(event
->attr
.loglevel_type
,
85 ev_loglevel_value
, key
->loglevel_type
,
86 key
->loglevel_value
, LTTNG_UST_LOGLEVEL_ALL
);
92 /* Only one of the filters is NULL, fail. */
93 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
97 if (key
->filter
&& event
->filter
) {
98 /* Both filters exists, check length followed by the bytecode. */
99 if (event
->filter
->len
!= key
->filter
->len
||
100 memcmp(event
->filter
->data
, key
->filter
->data
,
101 event
->filter
->len
) != 0) {
106 /* If only one of the exclusions is NULL, fail. */
107 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
111 if (key
->exclusion
&& event
->exclusion
) {
114 /* Check exclusion counts first. */
115 if (event
->exclusion
->count
!= key
->exclusion
->count
) {
119 /* Compare names individually. */
120 for (i
= 0; i
< event
->exclusion
->count
; ++i
) {
123 const char *name_ev
=
124 LTTNG_EVENT_EXCLUSION_NAME_AT(
125 event
->exclusion
, i
);
128 * Compare this exclusion name to all the key's
131 for (j
= 0; j
< key
->exclusion
->count
; ++j
) {
132 const char *name_key
=
133 LTTNG_EVENT_EXCLUSION_NAME_AT(
136 if (!strncmp(name_ev
, name_key
,
137 LTTNG_SYMBOL_NAME_LEN
)) {
145 * If the current exclusion name was not found amongst
146 * the key's exclusion names, then there's no match.
161 * Find the channel in the hashtable and return channel pointer. RCU read side
162 * lock MUST be acquired before calling this.
164 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
167 struct lttng_ht_node_str
*node
;
168 struct lttng_ht_iter iter
;
171 * If we receive an empty string for channel name, it means the
172 * default channel name is requested.
175 name
= DEFAULT_CHANNEL_NAME
;
177 lttng_ht_lookup(ht
, (void *)name
, &iter
);
178 node
= lttng_ht_iter_get_node_str(&iter
);
183 DBG2("Trace UST channel %s found by name", name
);
185 return caa_container_of(node
, struct ltt_ust_channel
, node
);
188 DBG2("Trace UST channel %s not found by name", name
);
193 * Find the event in the hashtable and return event pointer. RCU read side lock
194 * MUST be acquired before calling this.
196 struct ltt_ust_event
*trace_ust_find_event(struct lttng_ht
*ht
,
197 char *name
, struct lttng_filter_bytecode
*filter
,
198 enum lttng_ust_loglevel_type loglevel_type
, int loglevel_value
,
199 struct lttng_event_exclusion
*exclusion
)
201 struct lttng_ht_node_str
*node
;
202 struct lttng_ht_iter iter
;
203 struct ltt_ust_ht_key key
;
210 key
.loglevel_type
= loglevel_type
;
211 key
.loglevel_value
= loglevel_value
;
212 key
.exclusion
= exclusion
;
214 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
215 trace_ust_ht_match_event
, &key
, &iter
.iter
);
216 node
= lttng_ht_iter_get_node_str(&iter
);
221 DBG2("Trace UST event %s found", key
.name
);
223 return caa_container_of(node
, struct ltt_ust_event
, node
);
226 DBG2("Trace UST event %s NOT found", key
.name
);
231 * Lookup an agent in the session agents hash table by domain type and return
232 * the object if found else NULL.
234 * RCU read side lock must be acquired before calling and only released
235 * once the agent is no longer in scope or being used.
237 struct agent
*trace_ust_find_agent(struct ltt_ust_session
*session
,
238 enum lttng_domain_type domain_type
)
240 struct agent
*agt
= NULL
;
241 struct lttng_ht_node_u64
*node
;
242 struct lttng_ht_iter iter
;
247 DBG3("Trace ust agent lookup for domain %d", domain_type
);
251 lttng_ht_lookup(session
->agents
, &key
, &iter
);
252 node
= lttng_ht_iter_get_node_u64(&iter
);
256 agt
= caa_container_of(node
, struct agent
, node
);
263 * Allocate and initialize a ust session data structure.
265 * Return pointer to structure or NULL.
267 struct ltt_ust_session
*trace_ust_create_session(uint64_t session_id
)
269 struct ltt_ust_session
*lus
;
271 /* Allocate a new ltt ust session */
272 lus
= zmalloc(sizeof(struct ltt_ust_session
));
274 PERROR("create ust session zmalloc");
278 /* Init data structure */
279 lus
->id
= session_id
;
282 /* Set default metadata channel attribute. */
283 lus
->metadata_attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
284 lus
->metadata_attr
.subbuf_size
= default_get_metadata_subbuf_size();
285 lus
->metadata_attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
286 lus
->metadata_attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
287 lus
->metadata_attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
288 lus
->metadata_attr
.output
= LTTNG_UST_MMAP
;
291 * Default buffer type. This can be changed through an enable channel
292 * requesting a different type. Note that this can only be changed once
293 * during the session lifetime which is at the first enable channel and
294 * only before start. The flag buffer_type_changed indicates the status.
296 lus
->buffer_type
= LTTNG_BUFFER_PER_UID
;
297 /* Once set to 1, the buffer_type is immutable for the session. */
298 lus
->buffer_type_changed
= 0;
299 /* Init it in case it get used after allocation. */
300 CDS_INIT_LIST_HEAD(&lus
->buffer_reg_uid_list
);
302 /* Alloc UST global domain channels' HT */
303 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
304 /* Alloc agent hash table. */
305 lus
->agents
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
307 lus
->tracker_vpid
= process_attr_tracker_create();
308 if (!lus
->tracker_vpid
) {
311 lus
->tracker_vuid
= process_attr_tracker_create();
312 if (!lus
->tracker_vuid
) {
315 lus
->tracker_vgid
= process_attr_tracker_create();
316 if (!lus
->tracker_vgid
) {
319 lus
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
320 if (lus
->consumer
== NULL
) {
324 DBG2("UST trace session create successful");
329 process_attr_tracker_destroy(lus
->tracker_vpid
);
330 process_attr_tracker_destroy(lus
->tracker_vuid
);
331 process_attr_tracker_destroy(lus
->tracker_vgid
);
332 ht_cleanup_push(lus
->domain_global
.channels
);
333 ht_cleanup_push(lus
->agents
);
340 * Allocate and initialize a ust channel data structure.
342 * Return pointer to structure or NULL.
344 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
,
345 enum lttng_domain_type domain
)
347 struct ltt_ust_channel
*luc
;
351 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
353 PERROR("ltt_ust_channel zmalloc");
357 luc
->domain
= domain
;
359 /* Copy UST channel attributes */
360 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
361 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
362 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
363 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
364 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
365 luc
->attr
.output
= (enum lttng_ust_output
) chan
->attr
.output
;
366 luc
->monitor_timer_interval
= ((struct lttng_channel_extended
*)
367 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
368 luc
->attr
.u
.s
.blocking_timeout
= ((struct lttng_channel_extended
*)
369 chan
->attr
.extended
.ptr
)->blocking_timeout
;
371 /* Translate to UST output enum */
372 switch (luc
->attr
.output
) {
374 luc
->attr
.output
= LTTNG_UST_MMAP
;
379 * If we receive an empty string for channel name, it means the
380 * default channel name is requested.
382 if (chan
->name
[0] == '\0') {
383 strncpy(luc
->name
, DEFAULT_CHANNEL_NAME
, sizeof(luc
->name
));
385 /* Copy channel name */
386 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
388 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
391 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
392 CDS_INIT_LIST_HEAD(&luc
->ctx_list
);
394 /* Alloc hash tables */
395 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
396 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
398 /* On-disk circular buffer parameters */
399 luc
->tracefile_size
= chan
->attr
.tracefile_size
;
400 luc
->tracefile_count
= chan
->attr
.tracefile_count
;
402 DBG2("Trace UST channel %s created", luc
->name
);
409 * Validates an exclusion list.
411 * Returns 0 if valid, negative value if invalid.
413 static int validate_exclusion(struct lttng_event_exclusion
*exclusion
)
420 for (i
= 0; i
< exclusion
->count
; ++i
) {
423 LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
425 for (j
= 0; j
< i
; ++j
) {
427 LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, j
);
429 if (!strncmp(name_a
, name_b
, LTTNG_SYMBOL_NAME_LEN
)) {
442 * Allocate and initialize a ust event. Set name and event type.
443 * We own filter_expression, filter, and exclusion.
445 * Return an lttng_error_code
447 enum lttng_error_code
trace_ust_create_event(struct lttng_event
*ev
,
448 char *filter_expression
,
449 struct lttng_filter_bytecode
*filter
,
450 struct lttng_event_exclusion
*exclusion
,
452 struct ltt_ust_event
**ust_event
)
454 struct ltt_ust_event
*local_ust_event
;
455 enum lttng_error_code ret
= LTTNG_OK
;
459 if (exclusion
&& validate_exclusion(exclusion
)) {
460 ret
= LTTNG_ERR_INVALID
;
464 local_ust_event
= zmalloc(sizeof(struct ltt_ust_event
));
465 if (local_ust_event
== NULL
) {
466 PERROR("ust event zmalloc");
467 ret
= LTTNG_ERR_NOMEM
;
471 local_ust_event
->internal
= internal_event
;
474 case LTTNG_EVENT_PROBE
:
475 local_ust_event
->attr
.instrumentation
= LTTNG_UST_PROBE
;
477 case LTTNG_EVENT_FUNCTION
:
478 local_ust_event
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
480 case LTTNG_EVENT_FUNCTION_ENTRY
:
481 local_ust_event
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
483 case LTTNG_EVENT_TRACEPOINT
:
484 local_ust_event
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
487 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
488 ret
= LTTNG_ERR_INVALID
;
489 goto error_free_event
;
492 /* Copy event name */
493 strncpy(local_ust_event
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
494 local_ust_event
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
496 switch (ev
->loglevel_type
) {
497 case LTTNG_EVENT_LOGLEVEL_ALL
:
498 local_ust_event
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
499 local_ust_event
->attr
.loglevel
= -1; /* Force to -1 */
501 case LTTNG_EVENT_LOGLEVEL_RANGE
:
502 local_ust_event
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
503 local_ust_event
->attr
.loglevel
= ev
->loglevel
;
505 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
506 local_ust_event
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
507 local_ust_event
->attr
.loglevel
= ev
->loglevel
;
510 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
511 ret
= LTTNG_ERR_INVALID
;
512 goto error_free_event
;
516 local_ust_event
->filter_expression
= filter_expression
;
517 local_ust_event
->filter
= filter
;
518 local_ust_event
->exclusion
= exclusion
;
521 lttng_ht_node_init_str(&local_ust_event
->node
, local_ust_event
->attr
.name
);
523 DBG2("Trace UST event %s, loglevel (%d,%d) created",
524 local_ust_event
->attr
.name
, local_ust_event
->attr
.loglevel_type
,
525 local_ust_event
->attr
.loglevel
);
527 *ust_event
= local_ust_event
;
532 free(local_ust_event
);
534 free(filter_expression
);
541 int trace_ust_context_type_event_to_ust(
542 enum lttng_event_context_type type
)
547 case LTTNG_EVENT_CONTEXT_VTID
:
548 utype
= LTTNG_UST_CONTEXT_VTID
;
550 case LTTNG_EVENT_CONTEXT_VPID
:
551 utype
= LTTNG_UST_CONTEXT_VPID
;
553 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
554 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
556 case LTTNG_EVENT_CONTEXT_PROCNAME
:
557 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
559 case LTTNG_EVENT_CONTEXT_IP
:
560 utype
= LTTNG_UST_CONTEXT_IP
;
562 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
563 if (!ustctl_has_perf_counters()) {
565 WARN("Perf counters not implemented in UST");
567 utype
= LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
;
570 case LTTNG_EVENT_CONTEXT_APP_CONTEXT
:
571 utype
= LTTNG_UST_CONTEXT_APP_CONTEXT
;
573 case LTTNG_EVENT_CONTEXT_CGROUP_NS
:
574 utype
= LTTNG_UST_CONTEXT_CGROUP_NS
;
576 case LTTNG_EVENT_CONTEXT_IPC_NS
:
577 utype
= LTTNG_UST_CONTEXT_IPC_NS
;
579 case LTTNG_EVENT_CONTEXT_MNT_NS
:
580 utype
= LTTNG_UST_CONTEXT_MNT_NS
;
582 case LTTNG_EVENT_CONTEXT_NET_NS
:
583 utype
= LTTNG_UST_CONTEXT_NET_NS
;
585 case LTTNG_EVENT_CONTEXT_PID_NS
:
586 utype
= LTTNG_UST_CONTEXT_PID_NS
;
588 case LTTNG_EVENT_CONTEXT_USER_NS
:
589 utype
= LTTNG_UST_CONTEXT_USER_NS
;
591 case LTTNG_EVENT_CONTEXT_UTS_NS
:
592 utype
= LTTNG_UST_CONTEXT_UTS_NS
;
594 case LTTNG_EVENT_CONTEXT_VUID
:
595 utype
= LTTNG_UST_CONTEXT_VUID
;
597 case LTTNG_EVENT_CONTEXT_VEUID
:
598 utype
= LTTNG_UST_CONTEXT_VEUID
;
600 case LTTNG_EVENT_CONTEXT_VSUID
:
601 utype
= LTTNG_UST_CONTEXT_VSUID
;
603 case LTTNG_EVENT_CONTEXT_VGID
:
604 utype
= LTTNG_UST_CONTEXT_VGID
;
606 case LTTNG_EVENT_CONTEXT_VEGID
:
607 utype
= LTTNG_UST_CONTEXT_VEGID
;
609 case LTTNG_EVENT_CONTEXT_VSGID
:
610 utype
= LTTNG_UST_CONTEXT_VSGID
;
620 * Return 1 if contexts match, 0 otherwise.
622 int trace_ust_match_context(const struct ltt_ust_context
*uctx
,
623 const struct lttng_event_context
*ctx
)
627 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
631 if (uctx
->ctx
.ctx
!= utype
) {
635 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
636 if (uctx
->ctx
.u
.perf_counter
.type
637 != ctx
->u
.perf_counter
.type
) {
640 if (uctx
->ctx
.u
.perf_counter
.config
641 != ctx
->u
.perf_counter
.config
) {
644 if (strncmp(uctx
->ctx
.u
.perf_counter
.name
,
645 ctx
->u
.perf_counter
.name
,
646 LTTNG_UST_SYM_NAME_LEN
)) {
650 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
651 assert(uctx
->ctx
.u
.app_ctx
.provider_name
);
652 assert(uctx
->ctx
.u
.app_ctx
.ctx_name
);
653 if (strcmp(uctx
->ctx
.u
.app_ctx
.provider_name
,
654 ctx
->u
.app_ctx
.provider_name
) ||
655 strcmp(uctx
->ctx
.u
.app_ctx
.ctx_name
,
656 ctx
->u
.app_ctx
.ctx_name
)) {
667 * Allocate and initialize an UST context.
669 * Return pointer to structure or NULL.
671 struct ltt_ust_context
*trace_ust_create_context(
672 const struct lttng_event_context
*ctx
)
674 struct ltt_ust_context
*uctx
= NULL
;
679 utype
= trace_ust_context_type_event_to_ust(ctx
->ctx
);
681 ERR("Invalid UST context");
685 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
687 PERROR("zmalloc ltt_ust_context");
691 uctx
->ctx
.ctx
= (enum lttng_ust_context_type
) utype
;
693 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
694 uctx
->ctx
.u
.perf_counter
.type
= ctx
->u
.perf_counter
.type
;
695 uctx
->ctx
.u
.perf_counter
.config
= ctx
->u
.perf_counter
.config
;
696 strncpy(uctx
->ctx
.u
.perf_counter
.name
, ctx
->u
.perf_counter
.name
,
697 LTTNG_UST_SYM_NAME_LEN
);
698 uctx
->ctx
.u
.perf_counter
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
700 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
702 char *provider_name
= NULL
, *ctx_name
= NULL
;
704 provider_name
= strdup(ctx
->u
.app_ctx
.provider_name
);
705 if (!provider_name
) {
708 uctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
710 ctx_name
= strdup(ctx
->u
.app_ctx
.ctx_name
);
714 uctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
720 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
724 trace_ust_destroy_context(uctx
);
728 static void destroy_id_tracker_node_rcu(struct rcu_head
*head
)
730 struct ust_id_tracker_node
*tracker_node
= caa_container_of(
731 head
, struct ust_id_tracker_node
, node
.head
);
735 static void destroy_id_tracker_node(struct ust_id_tracker_node
*tracker_node
)
737 call_rcu(&tracker_node
->node
.head
, destroy_id_tracker_node_rcu
);
740 static int init_id_tracker(struct ust_id_tracker
*id_tracker
)
744 id_tracker
->ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
745 if (!id_tracker
->ht
) {
746 ret
= LTTNG_ERR_NOMEM
;
755 * Teardown id tracker content, but don't free id_tracker object.
757 static void fini_id_tracker(struct ust_id_tracker
*id_tracker
)
759 struct ust_id_tracker_node
*tracker_node
;
760 struct lttng_ht_iter iter
;
762 if (!id_tracker
->ht
) {
766 cds_lfht_for_each_entry (id_tracker
->ht
->ht
, &iter
.iter
, tracker_node
,
768 int ret
= lttng_ht_del(id_tracker
->ht
, &iter
);
771 destroy_id_tracker_node(tracker_node
);
774 ht_cleanup_push(id_tracker
->ht
);
775 id_tracker
->ht
= NULL
;
778 static struct ust_id_tracker_node
*id_tracker_lookup(
779 struct ust_id_tracker
*id_tracker
,
781 struct lttng_ht_iter
*iter
)
783 unsigned long _id
= (unsigned long) id
;
784 struct lttng_ht_node_ulong
*node
;
786 lttng_ht_lookup(id_tracker
->ht
, (void *) _id
, iter
);
787 node
= lttng_ht_iter_get_node_ulong(iter
);
789 return caa_container_of(node
, struct ust_id_tracker_node
, node
);
795 static int id_tracker_add_id(struct ust_id_tracker
*id_tracker
, int id
)
797 int retval
= LTTNG_OK
;
798 struct ust_id_tracker_node
*tracker_node
;
799 struct lttng_ht_iter iter
;
802 retval
= LTTNG_ERR_INVALID
;
805 tracker_node
= id_tracker_lookup(id_tracker
, id
, &iter
);
807 /* Already exists. */
808 retval
= LTTNG_ERR_PROCESS_ATTR_EXISTS
;
811 tracker_node
= zmalloc(sizeof(*tracker_node
));
813 retval
= LTTNG_ERR_NOMEM
;
816 lttng_ht_node_init_ulong(&tracker_node
->node
, (unsigned long) id
);
817 lttng_ht_add_unique_ulong(id_tracker
->ht
, &tracker_node
->node
);
822 static int id_tracker_del_id(struct ust_id_tracker
*id_tracker
, int id
)
824 int retval
= LTTNG_OK
, ret
;
825 struct ust_id_tracker_node
*tracker_node
;
826 struct lttng_ht_iter iter
;
829 retval
= LTTNG_ERR_INVALID
;
832 tracker_node
= id_tracker_lookup(id_tracker
, id
, &iter
);
835 retval
= LTTNG_ERR_PROCESS_ATTR_MISSING
;
838 ret
= lttng_ht_del(id_tracker
->ht
, &iter
);
841 destroy_id_tracker_node(tracker_node
);
846 static struct ust_id_tracker
*get_id_tracker(struct ltt_ust_session
*session
,
847 enum lttng_process_attr process_attr
)
849 switch (process_attr
) {
850 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
851 return &session
->vpid_tracker
;
852 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
853 return &session
->vuid_tracker
;
854 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
855 return &session
->vgid_tracker
;
861 static struct process_attr_tracker
*_trace_ust_get_process_attr_tracker(
862 struct ltt_ust_session
*session
,
863 enum lttng_process_attr process_attr
)
865 switch (process_attr
) {
866 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
867 return session
->tracker_vpid
;
868 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
869 return session
->tracker_vuid
;
870 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
871 return session
->tracker_vgid
;
877 const struct process_attr_tracker
*trace_ust_get_process_attr_tracker(
878 struct ltt_ust_session
*session
,
879 enum lttng_process_attr process_attr
)
881 return (const struct process_attr_tracker
*)
882 _trace_ust_get_process_attr_tracker(
883 session
, process_attr
);
887 * The session lock is held when calling this function.
889 int trace_ust_id_tracker_lookup(enum lttng_process_attr process_attr
,
890 struct ltt_ust_session
*session
,
893 struct lttng_ht_iter iter
;
894 struct ust_id_tracker
*id_tracker
;
896 id_tracker
= get_id_tracker(session
, process_attr
);
900 if (!id_tracker
->ht
) {
903 if (id_tracker_lookup(id_tracker
, id
, &iter
)) {
910 * Called with the session lock held.
912 enum lttng_error_code
trace_ust_process_attr_tracker_set_tracking_policy(
913 struct ltt_ust_session
*session
,
914 enum lttng_process_attr process_attr
,
915 enum lttng_tracking_policy policy
)
918 enum lttng_error_code ret_code
= LTTNG_OK
;
919 struct ust_id_tracker
*id_tracker
=
920 get_id_tracker(session
, process_attr
);
921 struct process_attr_tracker
*tracker
=
922 _trace_ust_get_process_attr_tracker(
923 session
, process_attr
);
924 bool should_update_apps
= false;
925 enum lttng_tracking_policy previous_policy
;
928 ret_code
= LTTNG_ERR_INVALID
;
932 previous_policy
= process_attr_tracker_get_tracking_policy(tracker
);
933 ret
= process_attr_tracker_set_tracking_policy(tracker
, policy
);
935 ret_code
= LTTNG_ERR_UNK
;
939 if (previous_policy
== policy
) {
944 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
945 /* Track all values: destroy tracker if exists. */
946 if (id_tracker
->ht
) {
947 fini_id_tracker(id_tracker
);
948 /* Ensure all apps have session. */
949 should_update_apps
= true;
952 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
953 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
955 fini_id_tracker(id_tracker
);
956 ret_code
= init_id_tracker(id_tracker
);
957 if (ret_code
!= LTTNG_OK
) {
958 ERR("Error initializing ID tracker");
961 /* Remove all apps from session. */
962 should_update_apps
= true;
967 if (should_update_apps
&& session
->active
) {
968 ust_app_global_update_all(session
);
974 /* Called with the session lock held. */
975 enum lttng_error_code
trace_ust_process_attr_tracker_inclusion_set_add_value(
976 struct ltt_ust_session
*session
,
977 enum lttng_process_attr process_attr
,
978 const struct process_attr_value
*value
)
980 enum lttng_error_code ret_code
= LTTNG_OK
;
981 bool should_update_apps
= false;
982 struct ust_id_tracker
*id_tracker
=
983 get_id_tracker(session
, process_attr
);
984 struct process_attr_tracker
*tracker
;
986 enum process_attr_tracker_status status
;
990 * Convert process attribute tracker value to the integral
991 * representation required by the kern-ctl API.
993 switch (process_attr
) {
994 case LTTNG_PROCESS_ATTR_PROCESS_ID
:
995 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
996 integral_value
= (int) value
->value
.pid
;
998 case LTTNG_PROCESS_ATTR_USER_ID
:
999 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
1000 if (value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
) {
1003 ret_code
= utils_user_id_from_name(
1004 value
->value
.user_name
, &uid
);
1005 if (ret_code
!= LTTNG_OK
) {
1008 integral_value
= (int) uid
;
1010 integral_value
= (int) value
->value
.uid
;
1013 case LTTNG_PROCESS_ATTR_GROUP_ID
:
1014 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
1015 if (value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
) {
1018 ret_code
= utils_group_id_from_name(
1019 value
->value
.group_name
, &gid
);
1020 if (ret_code
!= LTTNG_OK
) {
1023 integral_value
= (int) gid
;
1025 integral_value
= (int) value
->value
.gid
;
1029 ret_code
= LTTNG_ERR_INVALID
;
1033 tracker
= _trace_ust_get_process_attr_tracker(session
, process_attr
);
1035 ret_code
= LTTNG_ERR_INVALID
;
1039 status
= process_attr_tracker_inclusion_set_add_value(tracker
, value
);
1040 if (status
!= PROCESS_ATTR_TRACKER_STATUS_OK
) {
1042 case PROCESS_ATTR_TRACKER_STATUS_EXISTS
:
1043 ret_code
= LTTNG_ERR_PROCESS_ATTR_EXISTS
;
1045 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1046 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1048 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1050 ret_code
= LTTNG_ERR_UNK
;
1056 DBG("User space track %s %d for session id %" PRIu64
,
1057 lttng_process_attr_to_string(process_attr
),
1058 integral_value
, session
->id
);
1060 ret_code
= id_tracker_add_id(id_tracker
, integral_value
);
1061 if (ret_code
!= LTTNG_OK
) {
1064 /* Add session to application */
1065 switch (process_attr
) {
1066 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
1067 app
= ust_app_find_by_pid(integral_value
);
1069 should_update_apps
= true;
1073 should_update_apps
= true;
1076 if (should_update_apps
&& session
->active
) {
1077 ust_app_global_update_all(session
);
1083 /* Called with the session lock held. */
1084 enum lttng_error_code
trace_ust_process_attr_tracker_inclusion_set_remove_value(
1085 struct ltt_ust_session
*session
,
1086 enum lttng_process_attr process_attr
,
1087 const struct process_attr_value
*value
)
1089 enum lttng_error_code ret_code
= LTTNG_OK
;
1090 bool should_update_apps
= false;
1091 struct ust_id_tracker
*id_tracker
=
1092 get_id_tracker(session
, process_attr
);
1093 struct process_attr_tracker
*tracker
;
1095 enum process_attr_tracker_status status
;
1096 struct ust_app
*app
;
1099 * Convert process attribute tracker value to the integral
1100 * representation required by the kern-ctl API.
1102 switch (process_attr
) {
1103 case LTTNG_PROCESS_ATTR_PROCESS_ID
:
1104 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
1105 integral_value
= (int) value
->value
.pid
;
1107 case LTTNG_PROCESS_ATTR_USER_ID
:
1108 case LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
:
1109 if (value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_USER_NAME
) {
1112 ret_code
= utils_user_id_from_name(
1113 value
->value
.user_name
, &uid
);
1114 if (ret_code
!= LTTNG_OK
) {
1117 integral_value
= (int) uid
;
1119 integral_value
= (int) value
->value
.uid
;
1122 case LTTNG_PROCESS_ATTR_GROUP_ID
:
1123 case LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
:
1124 if (value
->type
== LTTNG_PROCESS_ATTR_VALUE_TYPE_GROUP_NAME
) {
1127 ret_code
= utils_group_id_from_name(
1128 value
->value
.group_name
, &gid
);
1129 if (ret_code
!= LTTNG_OK
) {
1132 integral_value
= (int) gid
;
1134 integral_value
= (int) value
->value
.gid
;
1138 ret_code
= LTTNG_ERR_INVALID
;
1142 tracker
= _trace_ust_get_process_attr_tracker(session
, process_attr
);
1144 ret_code
= LTTNG_ERR_INVALID
;
1148 status
= process_attr_tracker_inclusion_set_remove_value(
1150 if (status
!= PROCESS_ATTR_TRACKER_STATUS_OK
) {
1152 case PROCESS_ATTR_TRACKER_STATUS_MISSING
:
1153 ret_code
= LTTNG_ERR_PROCESS_ATTR_MISSING
;
1155 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1156 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1158 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1160 ret_code
= LTTNG_ERR_UNK
;
1166 DBG("User space untrack %s %d for session id %" PRIu64
,
1167 lttng_process_attr_to_string(process_attr
),
1168 integral_value
, session
->id
);
1170 ret_code
= id_tracker_del_id(id_tracker
, integral_value
);
1171 if (ret_code
!= LTTNG_OK
) {
1174 /* Add session to application */
1175 switch (process_attr
) {
1176 case LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
:
1177 app
= ust_app_find_by_pid(integral_value
);
1179 should_update_apps
= true;
1183 should_update_apps
= true;
1186 if (should_update_apps
&& session
->active
) {
1187 ust_app_global_update_all(session
);
1194 * RCU safe free context structure.
1196 static void destroy_context_rcu(struct rcu_head
*head
)
1198 struct lttng_ht_node_ulong
*node
=
1199 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
1200 struct ltt_ust_context
*ctx
=
1201 caa_container_of(node
, struct ltt_ust_context
, node
);
1203 trace_ust_destroy_context(ctx
);
1207 * Cleanup UST context hash table.
1209 static void destroy_contexts(struct lttng_ht
*ht
)
1212 struct lttng_ht_node_ulong
*node
;
1213 struct lttng_ht_iter iter
;
1214 struct ltt_ust_context
*ctx
;
1219 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
1220 /* Remove from ordered list. */
1221 ctx
= caa_container_of(node
, struct ltt_ust_context
, node
);
1222 cds_list_del(&ctx
->list
);
1223 /* Remove from channel's hash table. */
1224 ret
= lttng_ht_del(ht
, &iter
);
1226 call_rcu(&node
->head
, destroy_context_rcu
);
1231 ht_cleanup_push(ht
);
1235 * Cleanup ust event structure.
1237 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
1241 DBG2("Trace destroy UST event %s", event
->attr
.name
);
1242 free(event
->filter_expression
);
1243 free(event
->filter
);
1244 free(event
->exclusion
);
1249 * Cleanup ust context structure.
1251 void trace_ust_destroy_context(struct ltt_ust_context
*ctx
)
1255 if (ctx
->ctx
.ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1256 free(ctx
->ctx
.u
.app_ctx
.provider_name
);
1257 free(ctx
->ctx
.u
.app_ctx
.ctx_name
);
1263 * URCU intermediate call to complete destroy event.
1265 static void destroy_event_rcu(struct rcu_head
*head
)
1267 struct lttng_ht_node_str
*node
=
1268 caa_container_of(head
, struct lttng_ht_node_str
, head
);
1269 struct ltt_ust_event
*event
=
1270 caa_container_of(node
, struct ltt_ust_event
, node
);
1272 trace_ust_destroy_event(event
);
1276 * Cleanup UST events hashtable.
1278 static void destroy_events(struct lttng_ht
*events
)
1281 struct lttng_ht_node_str
*node
;
1282 struct lttng_ht_iter iter
;
1287 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
1288 ret
= lttng_ht_del(events
, &iter
);
1290 call_rcu(&node
->head
, destroy_event_rcu
);
1294 ht_cleanup_push(events
);
1298 * Cleanup ust channel structure.
1300 * Should _NOT_ be called with RCU read lock held.
1302 static void _trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
1306 DBG2("Trace destroy UST channel %s", channel
->name
);
1312 * URCU intermediate call to complete destroy channel.
1314 static void destroy_channel_rcu(struct rcu_head
*head
)
1316 struct lttng_ht_node_str
*node
=
1317 caa_container_of(head
, struct lttng_ht_node_str
, head
);
1318 struct ltt_ust_channel
*channel
=
1319 caa_container_of(node
, struct ltt_ust_channel
, node
);
1321 _trace_ust_destroy_channel(channel
);
1324 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
1326 /* Destroying all events of the channel */
1327 destroy_events(channel
->events
);
1328 /* Destroying all context of the channel */
1329 destroy_contexts(channel
->ctx
);
1331 call_rcu(&channel
->node
.head
, destroy_channel_rcu
);
1335 * Remove an UST channel from a channel HT.
1337 void trace_ust_delete_channel(struct lttng_ht
*ht
,
1338 struct ltt_ust_channel
*channel
)
1341 struct lttng_ht_iter iter
;
1346 iter
.iter
.node
= &channel
->node
.node
;
1347 ret
= lttng_ht_del(ht
, &iter
);
1352 * Iterate over a hash table containing channels and cleanup safely.
1354 static void destroy_channels(struct lttng_ht
*channels
)
1356 struct lttng_ht_node_str
*node
;
1357 struct lttng_ht_iter iter
;
1362 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
1363 struct ltt_ust_channel
*chan
=
1364 caa_container_of(node
, struct ltt_ust_channel
, node
);
1366 trace_ust_delete_channel(channels
, chan
);
1367 trace_ust_destroy_channel(chan
);
1371 ht_cleanup_push(channels
);
1375 * Cleanup UST global domain.
1377 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
1381 destroy_channels(dom
->channels
);
1385 * Cleanup ust session structure, keeping data required by
1388 * Should *NOT* be called with RCU read-side lock held.
1390 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
1393 struct buffer_reg_uid
*reg
, *sreg
;
1394 struct lttng_ht_iter iter
;
1398 DBG2("Trace UST destroy session %" PRIu64
, session
->id
);
1400 /* Cleaning up UST domain */
1401 destroy_domain_global(&session
->domain_global
);
1404 cds_lfht_for_each_entry(session
->agents
->ht
, &iter
.iter
, agt
, node
.node
) {
1405 int ret
= lttng_ht_del(session
->agents
, &iter
);
1412 ht_cleanup_push(session
->agents
);
1414 /* Cleanup UID buffer registry object(s). */
1415 cds_list_for_each_entry_safe(reg
, sreg
, &session
->buffer_reg_uid_list
,
1417 cds_list_del(®
->lnode
);
1418 buffer_reg_uid_remove(reg
);
1419 buffer_reg_uid_destroy(reg
, session
->consumer
);
1422 process_attr_tracker_destroy(session
->tracker_vpid
);
1423 process_attr_tracker_destroy(session
->tracker_vuid
);
1424 process_attr_tracker_destroy(session
->tracker_vgid
);
1426 fini_id_tracker(&session
->vpid_tracker
);
1427 fini_id_tracker(&session
->vuid_tracker
);
1428 fini_id_tracker(&session
->vgid_tracker
);
1429 lttng_trace_chunk_put(session
->current_trace_chunk
);
1432 /* Free elements needed by destroy notifiers. */
1433 void trace_ust_free_session(struct ltt_ust_session
*session
)
1435 consumer_output_put(session
->consumer
);