2 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
9 #include "bin/lttng-sessiond/tracker.h"
10 #include "lttng/lttng-error.h"
11 #include "lttng/tracker.h"
15 #include <urcu/list.h>
16 #include <urcu/uatomic.h>
20 #include <common/defaults.h>
21 #include <common/common.h>
22 #include <common/sessiond-comm/sessiond-comm.h>
23 #include <common/relayd/relayd.h>
24 #include <common/utils.h>
25 #include <common/compat/string.h>
26 #include <common/kernel-ctl/kernel-ctl.h>
27 #include <common/dynamic-buffer.h>
28 #include <common/buffer-view.h>
29 #include <common/trace-chunk.h>
30 #include <lttng/location-internal.h>
31 #include <lttng/trigger/trigger-internal.h>
32 #include <lttng/condition/condition.h>
33 #include <lttng/condition/condition-internal.h>
34 #include <lttng/condition/event-rule.h>
35 #include <lttng/condition/event-rule-internal.h>
36 #include <lttng/event-rule/event-rule.h>
37 #include <lttng/event-rule/event-rule-internal.h>
38 #include <lttng/event-rule/uprobe-internal.h>
39 #include <lttng/event-rule/tracepoint.h>
40 #include <lttng/action/action.h>
41 #include <lttng/channel.h>
42 #include <lttng/channel-internal.h>
43 #include <lttng/rotate-internal.h>
44 #include <lttng/location-internal.h>
45 #include <lttng/session-internal.h>
46 #include <lttng/userspace-probe-internal.h>
47 #include <lttng/session-descriptor-internal.h>
48 #include <common/string-utils/string-utils.h>
53 #include "health-sessiond.h"
55 #include "kernel-consumer.h"
56 #include "lttng-sessiond.h"
58 #include "lttng-syscall.h"
60 #include "buffer-registry.h"
61 #include "notification-thread.h"
62 #include "notification-thread-commands.h"
64 #include "rotation-thread.h"
66 #include "agent-thread.h"
70 /* Sleep for 100ms between each check for the shm path's deletion. */
71 #define SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US 100000
73 struct cmd_destroy_session_reply_context
{
75 bool implicit_rotation_on_destroy
;
77 * Indicates whether or not an error occurred while launching the
78 * destruction of a session.
80 enum lttng_error_code destruction_status
;
83 static enum lttng_error_code
wait_on_path(void *path
);
86 * Command completion handler that is used by the destroy command
87 * when a session that has a non-default shm_path is being destroyed.
89 * See comment in cmd_destroy_session() for the rationale.
91 static struct destroy_completion_handler
{
92 struct cmd_completion_handler handler
;
93 char shm_path
[member_sizeof(struct ltt_session
, shm_path
)];
94 } destroy_completion_handler
= {
97 .data
= destroy_completion_handler
.shm_path
102 static struct cmd_completion_handler
*current_completion_handler
;
105 * Used to keep a unique index for each relayd socket created where this value
106 * is associated with streams on the consumer so it can match the right relayd
107 * to send to. It must be accessed with the relayd_net_seq_idx_lock
110 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
111 static uint64_t relayd_net_seq_idx
;
113 static int validate_ust_event_name(const char *);
114 static int cmd_enable_event_internal(struct ltt_session
*session
,
115 const struct lttng_domain
*domain
,
116 char *channel_name
, struct lttng_event
*event
,
117 char *filter_expression
,
118 struct lttng_bytecode
*filter
,
119 struct lttng_event_exclusion
*exclusion
,
123 * Create a session path used by list_lttng_sessions for the case that the
124 * session consumer is on the network.
126 static int build_network_session_path(char *dst
, size_t size
,
127 struct ltt_session
*session
)
129 int ret
, kdata_port
, udata_port
;
130 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
131 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
136 memset(tmp_urls
, 0, sizeof(tmp_urls
));
137 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
139 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
141 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
142 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
143 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
146 if (session
->ust_session
&& session
->ust_session
->consumer
) {
147 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
148 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
151 if (uuri
== NULL
&& kuri
== NULL
) {
152 uri
= &session
->consumer
->dst
.net
.control
;
153 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
154 } else if (kuri
&& uuri
) {
155 ret
= uri_compare(kuri
, uuri
);
159 /* Build uuri URL string */
160 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
167 } else if (kuri
&& uuri
== NULL
) {
169 } else if (uuri
&& kuri
== NULL
) {
173 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
179 * Do we have a UST url set. If yes, this means we have both kernel and UST
182 if (*tmp_uurl
!= '\0') {
183 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
184 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
187 if (kuri
|| (!kuri
&& !uuri
)) {
190 /* No kernel URI, use the UST port. */
193 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
201 * Get run-time attributes if the session has been started (discarded events,
204 static int get_kernel_runtime_stats(struct ltt_session
*session
,
205 struct ltt_kernel_channel
*kchan
, uint64_t *discarded_events
,
206 uint64_t *lost_packets
)
210 if (!session
->has_been_started
) {
212 *discarded_events
= 0;
217 ret
= consumer_get_discarded_events(session
->id
, kchan
->key
,
218 session
->kernel_session
->consumer
,
224 ret
= consumer_get_lost_packets(session
->id
, kchan
->key
,
225 session
->kernel_session
->consumer
,
236 * Get run-time attributes if the session has been started (discarded events,
239 static int get_ust_runtime_stats(struct ltt_session
*session
,
240 struct ltt_ust_channel
*uchan
, uint64_t *discarded_events
,
241 uint64_t *lost_packets
)
244 struct ltt_ust_session
*usess
;
246 if (!discarded_events
|| !lost_packets
) {
251 usess
= session
->ust_session
;
252 assert(discarded_events
);
253 assert(lost_packets
);
255 if (!usess
|| !session
->has_been_started
) {
256 *discarded_events
= 0;
262 if (usess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
263 ret
= ust_app_uid_get_channel_runtime_stats(usess
->id
,
264 &usess
->buffer_reg_uid_list
,
265 usess
->consumer
, uchan
->id
,
266 uchan
->attr
.overwrite
,
269 } else if (usess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
270 ret
= ust_app_pid_get_channel_runtime_stats(usess
,
271 uchan
, usess
->consumer
,
272 uchan
->attr
.overwrite
,
278 *discarded_events
+= uchan
->per_pid_closed_app_discarded
;
279 *lost_packets
+= uchan
->per_pid_closed_app_lost
;
281 ERR("Unsupported buffer type");
292 * Fill lttng_channel array of all channels.
294 static ssize_t
list_lttng_channels(enum lttng_domain_type domain
,
295 struct ltt_session
*session
, struct lttng_channel
*channels
,
296 struct lttng_channel_extended
*chan_exts
)
299 struct ltt_kernel_channel
*kchan
;
301 DBG("Listing channels for session %s", session
->name
);
304 case LTTNG_DOMAIN_KERNEL
:
305 /* Kernel channels */
306 if (session
->kernel_session
!= NULL
) {
307 cds_list_for_each_entry(kchan
,
308 &session
->kernel_session
->channel_list
.head
, list
) {
309 uint64_t discarded_events
, lost_packets
;
310 struct lttng_channel_extended
*extended
;
312 extended
= (struct lttng_channel_extended
*)
313 kchan
->channel
->attr
.extended
.ptr
;
315 ret
= get_kernel_runtime_stats(session
, kchan
,
316 &discarded_events
, &lost_packets
);
320 /* Copy lttng_channel struct to array */
321 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
322 channels
[i
].enabled
= kchan
->enabled
;
323 chan_exts
[i
].discarded_events
=
325 chan_exts
[i
].lost_packets
= lost_packets
;
326 chan_exts
[i
].monitor_timer_interval
=
327 extended
->monitor_timer_interval
;
328 chan_exts
[i
].blocking_timeout
= 0;
333 case LTTNG_DOMAIN_UST
:
335 struct lttng_ht_iter iter
;
336 struct ltt_ust_channel
*uchan
;
339 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
340 &iter
.iter
, uchan
, node
.node
) {
341 uint64_t discarded_events
= 0, lost_packets
= 0;
343 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
344 LTTNG_SYMBOL_NAME_LEN
)) {
347 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
348 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
349 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
350 channels
[i
].attr
.switch_timer_interval
=
351 uchan
->attr
.switch_timer_interval
;
352 channels
[i
].attr
.read_timer_interval
=
353 uchan
->attr
.read_timer_interval
;
354 channels
[i
].enabled
= uchan
->enabled
;
355 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
356 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
359 * Map enum lttng_ust_output to enum lttng_event_output.
361 switch (uchan
->attr
.output
) {
363 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
367 * LTTNG_UST_MMAP is the only supported UST
374 chan_exts
[i
].monitor_timer_interval
=
375 uchan
->monitor_timer_interval
;
376 chan_exts
[i
].blocking_timeout
=
377 uchan
->attr
.u
.s
.blocking_timeout
;
379 ret
= get_ust_runtime_stats(session
, uchan
,
380 &discarded_events
, &lost_packets
);
384 chan_exts
[i
].discarded_events
= discarded_events
;
385 chan_exts
[i
].lost_packets
= lost_packets
;
397 return -LTTNG_ERR_FATAL
;
403 static int increment_extended_len(const char *filter_expression
,
404 struct lttng_event_exclusion
*exclusion
,
405 const struct lttng_userspace_probe_location
*probe_location
,
406 size_t *extended_len
)
410 *extended_len
+= sizeof(struct lttcomm_event_extended_header
);
412 if (filter_expression
) {
413 *extended_len
+= strlen(filter_expression
) + 1;
417 *extended_len
+= exclusion
->count
* LTTNG_SYMBOL_NAME_LEN
;
420 if (probe_location
) {
421 ret
= lttng_userspace_probe_location_serialize(probe_location
,
426 *extended_len
+= ret
;
433 static int append_extended_info(const char *filter_expression
,
434 struct lttng_event_exclusion
*exclusion
,
435 struct lttng_userspace_probe_location
*probe_location
,
439 size_t filter_len
= 0;
440 size_t nb_exclusions
= 0;
441 size_t userspace_probe_location_len
= 0;
442 struct lttng_dynamic_buffer location_buffer
;
443 struct lttcomm_event_extended_header extended_header
;
445 if (filter_expression
) {
446 filter_len
= strlen(filter_expression
) + 1;
450 nb_exclusions
= exclusion
->count
;
453 if (probe_location
) {
454 lttng_dynamic_buffer_init(&location_buffer
);
455 ret
= lttng_userspace_probe_location_serialize(probe_location
,
456 &location_buffer
, NULL
);
461 userspace_probe_location_len
= location_buffer
.size
;
464 /* Set header fields */
465 extended_header
.filter_len
= filter_len
;
466 extended_header
.nb_exclusions
= nb_exclusions
;
467 extended_header
.userspace_probe_location_len
= userspace_probe_location_len
;
470 memcpy(*extended_at
, &extended_header
, sizeof(extended_header
));
471 *extended_at
+= sizeof(extended_header
);
473 /* Copy filter string */
474 if (filter_expression
) {
475 memcpy(*extended_at
, filter_expression
, filter_len
);
476 *extended_at
+= filter_len
;
479 /* Copy exclusion names */
481 size_t len
= nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
483 memcpy(*extended_at
, &exclusion
->names
, len
);
487 if (probe_location
) {
488 memcpy(*extended_at
, location_buffer
.data
, location_buffer
.size
);
489 *extended_at
+= location_buffer
.size
;
490 lttng_dynamic_buffer_reset(&location_buffer
);
498 * Create a list of agent domain events.
500 * Return number of events in list on success or else a negative value.
502 static int list_lttng_agent_events(struct agent
*agt
,
503 struct lttng_event
**events
, size_t *total_size
)
506 unsigned int nb_event
= 0;
507 struct agent_event
*event
;
508 struct lttng_event
*tmp_events
= NULL
;
509 struct lttng_ht_iter iter
;
510 size_t extended_len
= 0;
516 DBG3("Listing agent events");
519 nb_event
= lttng_ht_get_count(agt
->events
);
527 /* Compute required extended infos size */
528 extended_len
= nb_event
* sizeof(struct lttcomm_event_extended_header
);
531 * This is only valid because the commands which add events are
532 * processed in the same thread as the listing.
535 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
536 ret
= increment_extended_len(event
->filter_expression
, NULL
, NULL
,
539 DBG("Error computing the length of extended info message");
540 ret
= -LTTNG_ERR_FATAL
;
546 *total_size
= nb_event
* sizeof(*tmp_events
) + extended_len
;
547 tmp_events
= zmalloc(*total_size
);
549 PERROR("zmalloc agent events session");
550 ret
= -LTTNG_ERR_FATAL
;
554 extended_at
= ((uint8_t *) tmp_events
) +
555 nb_event
* sizeof(struct lttng_event
);
558 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
559 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
560 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
561 tmp_events
[i
].enabled
= event
->enabled
;
562 tmp_events
[i
].loglevel
= event
->loglevel_value
;
563 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
566 /* Append extended info */
567 ret
= append_extended_info(event
->filter_expression
, NULL
, NULL
,
570 DBG("Error appending extended info message");
571 ret
= -LTTNG_ERR_FATAL
;
576 *events
= tmp_events
;
578 assert(nb_event
== i
);
589 * Create a list of ust global domain events.
591 static int list_lttng_ust_global_events(char *channel_name
,
592 struct ltt_ust_domain_global
*ust_global
,
593 struct lttng_event
**events
, size_t *total_size
)
596 unsigned int nb_event
= 0;
597 struct lttng_ht_iter iter
;
598 struct lttng_ht_node_str
*node
;
599 struct ltt_ust_channel
*uchan
;
600 struct ltt_ust_event
*uevent
;
601 struct lttng_event
*tmp
;
602 size_t extended_len
= 0;
605 DBG("Listing UST global events for channel %s", channel_name
);
609 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
610 node
= lttng_ht_iter_get_node_str(&iter
);
612 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
616 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
618 nb_event
= lttng_ht_get_count(uchan
->events
);
625 DBG3("Listing UST global %d events", nb_event
);
627 /* Compute required extended infos size */
628 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
629 if (uevent
->internal
) {
634 ret
= increment_extended_len(uevent
->filter_expression
,
635 uevent
->exclusion
, NULL
, &extended_len
);
637 DBG("Error computing the length of extended info message");
638 ret
= -LTTNG_ERR_FATAL
;
643 /* All events are internal, skip. */
649 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
650 tmp
= zmalloc(*total_size
);
652 ret
= -LTTNG_ERR_FATAL
;
656 extended_at
= ((uint8_t *) tmp
) + nb_event
* sizeof(struct lttng_event
);
658 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
659 if (uevent
->internal
) {
660 /* This event should remain hidden from clients */
663 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
664 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
665 tmp
[i
].enabled
= uevent
->enabled
;
667 switch (uevent
->attr
.instrumentation
) {
668 case LTTNG_UST_TRACEPOINT
:
669 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
671 case LTTNG_UST_PROBE
:
672 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
674 case LTTNG_UST_FUNCTION
:
675 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
679 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
680 switch (uevent
->attr
.loglevel_type
) {
681 case LTTNG_UST_LOGLEVEL_ALL
:
682 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
684 case LTTNG_UST_LOGLEVEL_RANGE
:
685 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
687 case LTTNG_UST_LOGLEVEL_SINGLE
:
688 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
691 if (uevent
->filter
) {
694 if (uevent
->exclusion
) {
695 tmp
[i
].exclusion
= 1;
699 /* Append extended info */
700 ret
= append_extended_info(uevent
->filter_expression
,
701 uevent
->exclusion
, NULL
, &extended_at
);
703 DBG("Error appending extended info message");
704 ret
= -LTTNG_ERR_FATAL
;
717 * Fill lttng_event array of all kernel events in the channel.
719 static int list_lttng_kernel_events(char *channel_name
,
720 struct ltt_kernel_session
*kernel_session
,
721 struct lttng_event
**events
, size_t *total_size
)
724 unsigned int nb_event
;
725 struct ltt_kernel_event
*event
;
726 struct ltt_kernel_channel
*kchan
;
727 size_t extended_len
= 0;
730 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
732 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
736 nb_event
= kchan
->event_count
;
738 DBG("Listing events for channel %s", kchan
->channel
->name
);
746 /* Compute required extended infos size */
747 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
748 ret
= increment_extended_len(event
->filter_expression
, NULL
,
749 event
->userspace_probe_location
,
752 DBG("Error computing the length of extended info message");
753 ret
= -LTTNG_ERR_FATAL
;
758 *total_size
= nb_event
* sizeof(struct lttng_event
) + extended_len
;
759 *events
= zmalloc(*total_size
);
760 if (*events
== NULL
) {
761 ret
= -LTTNG_ERR_FATAL
;
765 extended_at
= ((void *) *events
) +
766 nb_event
* sizeof(struct lttng_event
);
768 /* Kernel channels */
769 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
770 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
771 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
772 (*events
)[i
].enabled
= event
->enabled
;
773 (*events
)[i
].filter
=
774 (unsigned char) !!event
->filter_expression
;
776 switch (event
->event
->instrumentation
) {
777 case LTTNG_KERNEL_TRACEPOINT
:
778 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
780 case LTTNG_KERNEL_KRETPROBE
:
781 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
782 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
783 sizeof(struct lttng_kernel_kprobe
));
785 case LTTNG_KERNEL_KPROBE
:
786 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
787 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
788 sizeof(struct lttng_kernel_kprobe
));
790 case LTTNG_KERNEL_UPROBE
:
791 (*events
)[i
].type
= LTTNG_EVENT_USERSPACE_PROBE
;
793 case LTTNG_KERNEL_FUNCTION
:
794 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
795 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
796 sizeof(struct lttng_kernel_function
));
798 case LTTNG_KERNEL_NOOP
:
799 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
801 case LTTNG_KERNEL_SYSCALL
:
802 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
804 case LTTNG_KERNEL_ALL
:
812 /* Append extended info */
813 ret
= append_extended_info(event
->filter_expression
, NULL
,
814 event
->userspace_probe_location
, &extended_at
);
816 DBG("Error appending extended info message");
817 ret
= -LTTNG_ERR_FATAL
;
826 /* Negate the error code to differentiate the size from an error */
831 * Add URI so the consumer output object. Set the correct path depending on the
832 * domain adding the default trace directory.
834 static enum lttng_error_code
add_uri_to_consumer(
835 const struct ltt_session
*session
,
836 struct consumer_output
*consumer
,
837 struct lttng_uri
*uri
, enum lttng_domain_type domain
)
840 enum lttng_error_code ret_code
= LTTNG_OK
;
844 if (consumer
== NULL
) {
845 DBG("No consumer detected. Don't add URI. Stopping.");
846 ret_code
= LTTNG_ERR_NO_CONSUMER
;
851 case LTTNG_DOMAIN_KERNEL
:
852 ret
= lttng_strncpy(consumer
->domain_subdir
,
853 DEFAULT_KERNEL_TRACE_DIR
,
854 sizeof(consumer
->domain_subdir
));
856 case LTTNG_DOMAIN_UST
:
857 ret
= lttng_strncpy(consumer
->domain_subdir
,
858 DEFAULT_UST_TRACE_DIR
,
859 sizeof(consumer
->domain_subdir
));
863 * This case is possible is we try to add the URI to the global
864 * tracing session consumer object which in this case there is
867 memset(consumer
->domain_subdir
, 0,
868 sizeof(consumer
->domain_subdir
));
872 ERR("Failed to initialize consumer output domain subdirectory");
873 ret_code
= LTTNG_ERR_FATAL
;
877 switch (uri
->dtype
) {
880 DBG2("Setting network URI to consumer");
882 if (consumer
->type
== CONSUMER_DST_NET
) {
883 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
884 consumer
->dst
.net
.control_isset
) ||
885 (uri
->stype
== LTTNG_STREAM_DATA
&&
886 consumer
->dst
.net
.data_isset
)) {
887 ret_code
= LTTNG_ERR_URL_EXIST
;
891 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
894 /* Set URI into consumer output object */
895 ret
= consumer_set_network_uri(session
, consumer
, uri
);
899 } else if (ret
== 1) {
901 * URI was the same in the consumer so we do not append the subdir
902 * again so to not duplicate output dir.
909 if (*uri
->dst
.path
!= '/' || strstr(uri
->dst
.path
, "../")) {
910 ret_code
= LTTNG_ERR_INVALID
;
913 DBG2("Setting trace directory path from URI to %s",
915 memset(&consumer
->dst
, 0, sizeof(consumer
->dst
));
917 ret
= lttng_strncpy(consumer
->dst
.session_root_path
,
919 sizeof(consumer
->dst
.session_root_path
));
921 ret_code
= LTTNG_ERR_FATAL
;
924 consumer
->type
= CONSUMER_DST_LOCAL
;
934 * Init tracing by creating trace directory and sending fds kernel consumer.
936 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
939 struct lttng_ht_iter iter
;
940 struct consumer_socket
*socket
;
946 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
947 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
949 pthread_mutex_lock(socket
->lock
);
950 ret
= kernel_consumer_send_session(socket
, session
);
951 pthread_mutex_unlock(socket
->lock
);
953 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
965 * Create a socket to the relayd using the URI.
967 * On success, the relayd_sock pointer is set to the created socket.
968 * Else, it remains untouched and an LTTng error code is returned.
970 static enum lttng_error_code
create_connect_relayd(struct lttng_uri
*uri
,
971 struct lttcomm_relayd_sock
**relayd_sock
,
972 struct consumer_output
*consumer
)
975 enum lttng_error_code status
= LTTNG_OK
;
976 struct lttcomm_relayd_sock
*rsock
;
978 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
979 RELAYD_VERSION_COMM_MINOR
);
981 status
= LTTNG_ERR_FATAL
;
986 * Connect to relayd so we can proceed with a session creation. This call
987 * can possibly block for an arbitrary amount of time to set the health
988 * state to be in poll execution.
991 ret
= relayd_connect(rsock
);
994 ERR("Unable to reach lttng-relayd");
995 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
999 /* Create socket for control stream. */
1000 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
1001 uint64_t result_flags
;
1003 DBG3("Creating relayd stream socket from URI");
1005 /* Check relayd version */
1006 ret
= relayd_version_check(rsock
);
1007 if (ret
== LTTNG_ERR_RELAYD_VERSION_FAIL
) {
1008 status
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
1010 } else if (ret
< 0) {
1011 ERR("Unable to reach lttng-relayd");
1012 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1015 consumer
->relay_major_version
= rsock
->major
;
1016 consumer
->relay_minor_version
= rsock
->minor
;
1017 ret
= relayd_get_configuration(rsock
, 0,
1020 ERR("Unable to get relayd configuration");
1021 status
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
1024 if (result_flags
& LTTCOMM_RELAYD_CONFIGURATION_FLAG_CLEAR_ALLOWED
) {
1025 consumer
->relay_allows_clear
= true;
1027 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
1028 DBG3("Creating relayd data socket from URI");
1030 /* Command is not valid */
1031 ERR("Relayd invalid stream type: %d", uri
->stype
);
1032 status
= LTTNG_ERR_INVALID
;
1036 *relayd_sock
= rsock
;
1041 /* The returned value is not useful since we are on an error path. */
1042 (void) relayd_close(rsock
);
1050 * Connect to the relayd using URI and send the socket to the right consumer.
1052 * The consumer socket lock must be held by the caller.
1054 * Returns LTTNG_OK on success or an LTTng error code on failure.
1056 static enum lttng_error_code
send_consumer_relayd_socket(
1057 unsigned int session_id
,
1058 struct lttng_uri
*relayd_uri
,
1059 struct consumer_output
*consumer
,
1060 struct consumer_socket
*consumer_sock
,
1061 const char *session_name
, const char *hostname
,
1062 const char *base_path
, int session_live_timer
,
1063 const uint64_t *current_chunk_id
,
1064 time_t session_creation_time
,
1065 bool session_name_contains_creation_time
)
1068 struct lttcomm_relayd_sock
*rsock
= NULL
;
1069 enum lttng_error_code status
;
1071 /* Connect to relayd and make version check if uri is the control. */
1072 status
= create_connect_relayd(relayd_uri
, &rsock
, consumer
);
1073 if (status
!= LTTNG_OK
) {
1074 goto relayd_comm_error
;
1078 /* Set the network sequence index if not set. */
1079 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
1080 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
1082 * Increment net_seq_idx because we are about to transfer the
1083 * new relayd socket to the consumer.
1084 * Assign unique key so the consumer can match streams.
1086 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
1087 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
1090 /* Send relayd socket to consumer. */
1091 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
1092 relayd_uri
->stype
, session_id
,
1093 session_name
, hostname
, base_path
,
1094 session_live_timer
, current_chunk_id
,
1095 session_creation_time
, session_name_contains_creation_time
);
1097 status
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
1101 /* Flag that the corresponding socket was sent. */
1102 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
1103 consumer_sock
->control_sock_sent
= 1;
1104 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
1105 consumer_sock
->data_sock_sent
= 1;
1109 * Close socket which was dup on the consumer side. The session daemon does
1110 * NOT keep track of the relayd socket(s) once transfer to the consumer.
1114 if (status
!= LTTNG_OK
) {
1116 * The consumer output for this session should not be used anymore
1117 * since the relayd connection failed thus making any tracing or/and
1118 * streaming not usable.
1120 consumer
->enabled
= 0;
1122 (void) relayd_close(rsock
);
1130 * Send both relayd sockets to a specific consumer and domain. This is a
1131 * helper function to facilitate sending the information to the consumer for a
1134 * The consumer socket lock must be held by the caller.
1136 * Returns LTTNG_OK, or an LTTng error code on failure.
1138 static enum lttng_error_code
send_consumer_relayd_sockets(
1139 enum lttng_domain_type domain
,
1140 unsigned int session_id
, struct consumer_output
*consumer
,
1141 struct consumer_socket
*sock
, const char *session_name
,
1142 const char *hostname
, const char *base_path
, int session_live_timer
,
1143 const uint64_t *current_chunk_id
, time_t session_creation_time
,
1144 bool session_name_contains_creation_time
)
1146 enum lttng_error_code status
= LTTNG_OK
;
1151 /* Sending control relayd socket. */
1152 if (!sock
->control_sock_sent
) {
1153 status
= send_consumer_relayd_socket(session_id
,
1154 &consumer
->dst
.net
.control
, consumer
, sock
,
1155 session_name
, hostname
, base_path
, session_live_timer
,
1156 current_chunk_id
, session_creation_time
,
1157 session_name_contains_creation_time
);
1158 if (status
!= LTTNG_OK
) {
1163 /* Sending data relayd socket. */
1164 if (!sock
->data_sock_sent
) {
1165 status
= send_consumer_relayd_socket(session_id
,
1166 &consumer
->dst
.net
.data
, consumer
, sock
,
1167 session_name
, hostname
, base_path
, session_live_timer
,
1168 current_chunk_id
, session_creation_time
,
1169 session_name_contains_creation_time
);
1170 if (status
!= LTTNG_OK
) {
1180 * Setup relayd connections for a tracing session. First creates the socket to
1181 * the relayd and send them to the right domain consumer. Consumer type MUST be
1184 int cmd_setup_relayd(struct ltt_session
*session
)
1187 struct ltt_ust_session
*usess
;
1188 struct ltt_kernel_session
*ksess
;
1189 struct consumer_socket
*socket
;
1190 struct lttng_ht_iter iter
;
1191 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
1195 usess
= session
->ust_session
;
1196 ksess
= session
->kernel_session
;
1198 DBG("Setting relayd for session %s", session
->name
);
1201 if (session
->current_trace_chunk
) {
1202 enum lttng_trace_chunk_status status
= lttng_trace_chunk_get_id(
1203 session
->current_trace_chunk
, ¤t_chunk_id
.value
);
1205 if (status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
1206 current_chunk_id
.is_set
= true;
1208 ERR("Failed to get current trace chunk id");
1209 ret
= LTTNG_ERR_UNK
;
1214 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
1215 && usess
->consumer
->enabled
) {
1216 /* For each consumer socket, send relayd sockets */
1217 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
1218 socket
, node
.node
) {
1219 pthread_mutex_lock(socket
->lock
);
1220 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
1221 usess
->consumer
, socket
,
1222 session
->name
, session
->hostname
,
1224 session
->live_timer
,
1225 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1226 session
->creation_time
,
1227 session
->name_contains_creation_time
);
1228 pthread_mutex_unlock(socket
->lock
);
1229 if (ret
!= LTTNG_OK
) {
1232 /* Session is now ready for network streaming. */
1233 session
->net_handle
= 1;
1235 session
->consumer
->relay_major_version
=
1236 usess
->consumer
->relay_major_version
;
1237 session
->consumer
->relay_minor_version
=
1238 usess
->consumer
->relay_minor_version
;
1239 session
->consumer
->relay_allows_clear
=
1240 usess
->consumer
->relay_allows_clear
;
1243 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
1244 && ksess
->consumer
->enabled
) {
1245 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
1246 socket
, node
.node
) {
1247 pthread_mutex_lock(socket
->lock
);
1248 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
1249 ksess
->consumer
, socket
,
1250 session
->name
, session
->hostname
,
1252 session
->live_timer
,
1253 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
1254 session
->creation_time
,
1255 session
->name_contains_creation_time
);
1256 pthread_mutex_unlock(socket
->lock
);
1257 if (ret
!= LTTNG_OK
) {
1260 /* Session is now ready for network streaming. */
1261 session
->net_handle
= 1;
1263 session
->consumer
->relay_major_version
=
1264 ksess
->consumer
->relay_major_version
;
1265 session
->consumer
->relay_minor_version
=
1266 ksess
->consumer
->relay_minor_version
;
1267 session
->consumer
->relay_allows_clear
=
1268 ksess
->consumer
->relay_allows_clear
;
1277 * Start a kernel session by opening all necessary streams.
1279 int start_kernel_session(struct ltt_kernel_session
*ksess
)
1282 struct ltt_kernel_channel
*kchan
;
1284 /* Open kernel metadata */
1285 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
1286 ret
= kernel_open_metadata(ksess
);
1288 ret
= LTTNG_ERR_KERN_META_FAIL
;
1293 /* Open kernel metadata stream */
1294 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
1295 ret
= kernel_open_metadata_stream(ksess
);
1297 ERR("Kernel create metadata stream failed");
1298 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1303 /* For each channel */
1304 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1305 if (kchan
->stream_count
== 0) {
1306 ret
= kernel_open_channel_stream(kchan
);
1308 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
1311 /* Update the stream global counter */
1312 ksess
->stream_count_global
+= ret
;
1316 /* Setup kernel consumer socket and send fds to it */
1317 ret
= init_kernel_tracing(ksess
);
1319 ret
= LTTNG_ERR_KERN_START_FAIL
;
1323 /* This start the kernel tracing */
1324 ret
= kernel_start_session(ksess
);
1326 ret
= LTTNG_ERR_KERN_START_FAIL
;
1330 /* Quiescent wait after starting trace */
1331 kernel_wait_quiescent();
1341 int stop_kernel_session(struct ltt_kernel_session
*ksess
)
1343 struct ltt_kernel_channel
*kchan
;
1344 bool error_occurred
= false;
1347 if (!ksess
|| !ksess
->active
) {
1350 DBG("Stopping kernel tracing");
1352 ret
= kernel_stop_session(ksess
);
1354 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1358 kernel_wait_quiescent();
1360 /* Flush metadata after stopping (if exists) */
1361 if (ksess
->metadata_stream_fd
>= 0) {
1362 ret
= kernel_metadata_flush_buffer(ksess
->metadata_stream_fd
);
1364 ERR("Kernel metadata flush failed");
1365 error_occurred
= true;
1369 /* Flush all buffers after stopping */
1370 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
1371 ret
= kernel_flush_buffer(kchan
);
1373 ERR("Kernel flush buffer error");
1374 error_occurred
= true;
1379 if (error_occurred
) {
1380 ret
= LTTNG_ERR_UNK
;
1389 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1391 int cmd_disable_channel(struct ltt_session
*session
,
1392 enum lttng_domain_type domain
, char *channel_name
)
1395 struct ltt_ust_session
*usess
;
1397 usess
= session
->ust_session
;
1402 case LTTNG_DOMAIN_KERNEL
:
1404 ret
= channel_kernel_disable(session
->kernel_session
,
1406 if (ret
!= LTTNG_OK
) {
1410 kernel_wait_quiescent();
1413 case LTTNG_DOMAIN_UST
:
1415 struct ltt_ust_channel
*uchan
;
1416 struct lttng_ht
*chan_ht
;
1418 chan_ht
= usess
->domain_global
.channels
;
1420 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
1421 if (uchan
== NULL
) {
1422 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1426 ret
= channel_ust_disable(usess
, uchan
);
1427 if (ret
!= LTTNG_OK
) {
1433 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1445 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1447 * The wpipe arguments is used as a notifier for the kernel thread.
1449 int cmd_enable_channel(struct ltt_session
*session
,
1450 const struct lttng_domain
*domain
, const struct lttng_channel
*_attr
, int wpipe
)
1453 struct ltt_ust_session
*usess
= session
->ust_session
;
1454 struct lttng_ht
*chan_ht
;
1456 struct lttng_channel attr
;
1463 len
= lttng_strnlen(attr
.name
, sizeof(attr
.name
));
1465 /* Validate channel name */
1466 if (attr
.name
[0] == '.' ||
1467 memchr(attr
.name
, '/', len
) != NULL
) {
1468 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1472 DBG("Enabling channel %s for session %s", attr
.name
, session
->name
);
1477 * Don't try to enable a channel if the session has been started at
1478 * some point in time before. The tracer does not allow it.
1480 if (session
->has_been_started
) {
1481 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1486 * If the session is a live session, remove the switch timer, the
1487 * live timer does the same thing but sends also synchronisation
1488 * beacons for inactive streams.
1490 if (session
->live_timer
> 0) {
1491 attr
.attr
.live_timer_interval
= session
->live_timer
;
1492 attr
.attr
.switch_timer_interval
= 0;
1495 /* Check for feature support */
1496 switch (domain
->type
) {
1497 case LTTNG_DOMAIN_KERNEL
:
1499 if (kernel_supports_ring_buffer_snapshot_sample_positions() != 1) {
1500 /* Sampling position of buffer is not supported */
1501 WARN("Kernel tracer does not support buffer monitoring. "
1502 "Setting the monitor interval timer to 0 "
1503 "(disabled) for channel '%s' of session '%s'",
1504 attr
.name
, session
->name
);
1505 lttng_channel_set_monitor_timer_interval(&attr
, 0);
1509 case LTTNG_DOMAIN_UST
:
1511 case LTTNG_DOMAIN_JUL
:
1512 case LTTNG_DOMAIN_LOG4J
:
1513 case LTTNG_DOMAIN_PYTHON
:
1514 if (!agent_tracing_is_enabled()) {
1515 DBG("Attempted to enable a channel in an agent domain but the agent thread is not running");
1516 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
1521 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1525 switch (domain
->type
) {
1526 case LTTNG_DOMAIN_KERNEL
:
1528 struct ltt_kernel_channel
*kchan
;
1530 kchan
= trace_kernel_get_channel_by_name(attr
.name
,
1531 session
->kernel_session
);
1532 if (kchan
== NULL
) {
1533 if (session
->snapshot
.nb_output
> 0 ||
1534 session
->snapshot_mode
) {
1535 /* Enforce mmap output for snapshot sessions. */
1536 attr
.attr
.output
= LTTNG_EVENT_MMAP
;
1538 ret
= channel_kernel_create(session
->kernel_session
, &attr
, wpipe
);
1539 if (attr
.name
[0] != '\0') {
1540 session
->kernel_session
->has_non_default_channel
= 1;
1543 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1546 if (ret
!= LTTNG_OK
) {
1550 kernel_wait_quiescent();
1553 case LTTNG_DOMAIN_UST
:
1554 case LTTNG_DOMAIN_JUL
:
1555 case LTTNG_DOMAIN_LOG4J
:
1556 case LTTNG_DOMAIN_PYTHON
:
1558 struct ltt_ust_channel
*uchan
;
1563 * Current agent implementation limitations force us to allow
1564 * only one channel at once in "agent" subdomains. Each
1565 * subdomain has a default channel name which must be strictly
1568 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1569 if (strncmp(attr
.name
, DEFAULT_JUL_CHANNEL_NAME
,
1570 LTTNG_SYMBOL_NAME_LEN
)) {
1571 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1574 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1575 if (strncmp(attr
.name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1576 LTTNG_SYMBOL_NAME_LEN
)) {
1577 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1580 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1581 if (strncmp(attr
.name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1582 LTTNG_SYMBOL_NAME_LEN
)) {
1583 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1588 chan_ht
= usess
->domain_global
.channels
;
1590 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
.name
);
1591 if (uchan
== NULL
) {
1592 ret
= channel_ust_create(usess
, &attr
, domain
->buf_type
);
1593 if (attr
.name
[0] != '\0') {
1594 usess
->has_non_default_channel
= 1;
1597 ret
= channel_ust_enable(usess
, uchan
);
1602 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1606 if (ret
== LTTNG_OK
&& attr
.attr
.output
!= LTTNG_EVENT_MMAP
) {
1607 session
->has_non_mmap_channel
= true;
1615 enum lttng_error_code
cmd_process_attr_tracker_get_tracking_policy(
1616 struct ltt_session
*session
,
1617 enum lttng_domain_type domain
,
1618 enum lttng_process_attr process_attr
,
1619 enum lttng_tracking_policy
*policy
)
1621 enum lttng_error_code ret_code
= LTTNG_OK
;
1622 const struct process_attr_tracker
*tracker
;
1625 case LTTNG_DOMAIN_KERNEL
:
1626 if (!session
->kernel_session
) {
1627 ret_code
= LTTNG_ERR_INVALID
;
1630 tracker
= kernel_get_process_attr_tracker(
1631 session
->kernel_session
, process_attr
);
1633 case LTTNG_DOMAIN_UST
:
1634 if (!session
->ust_session
) {
1635 ret_code
= LTTNG_ERR_INVALID
;
1638 tracker
= trace_ust_get_process_attr_tracker(
1639 session
->ust_session
, process_attr
);
1642 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1646 *policy
= process_attr_tracker_get_tracking_policy(tracker
);
1648 ret_code
= LTTNG_ERR_INVALID
;
1654 enum lttng_error_code
cmd_process_attr_tracker_set_tracking_policy(
1655 struct ltt_session
*session
,
1656 enum lttng_domain_type domain
,
1657 enum lttng_process_attr process_attr
,
1658 enum lttng_tracking_policy policy
)
1660 enum lttng_error_code ret_code
= LTTNG_OK
;
1663 case LTTNG_TRACKING_POLICY_INCLUDE_SET
:
1664 case LTTNG_TRACKING_POLICY_EXCLUDE_ALL
:
1665 case LTTNG_TRACKING_POLICY_INCLUDE_ALL
:
1668 ret_code
= LTTNG_ERR_INVALID
;
1673 case LTTNG_DOMAIN_KERNEL
:
1674 if (!session
->kernel_session
) {
1675 ret_code
= LTTNG_ERR_INVALID
;
1678 ret_code
= kernel_process_attr_tracker_set_tracking_policy(
1679 session
->kernel_session
, process_attr
, policy
);
1681 case LTTNG_DOMAIN_UST
:
1682 if (!session
->ust_session
) {
1683 ret_code
= LTTNG_ERR_INVALID
;
1686 ret_code
= trace_ust_process_attr_tracker_set_tracking_policy(
1687 session
->ust_session
, process_attr
, policy
);
1690 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1697 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_add_value(
1698 struct ltt_session
*session
,
1699 enum lttng_domain_type domain
,
1700 enum lttng_process_attr process_attr
,
1701 const struct process_attr_value
*value
)
1703 enum lttng_error_code ret_code
= LTTNG_OK
;
1706 case LTTNG_DOMAIN_KERNEL
:
1707 if (!session
->kernel_session
) {
1708 ret_code
= LTTNG_ERR_INVALID
;
1711 ret_code
= kernel_process_attr_tracker_inclusion_set_add_value(
1712 session
->kernel_session
, process_attr
, value
);
1714 case LTTNG_DOMAIN_UST
:
1715 if (!session
->ust_session
) {
1716 ret_code
= LTTNG_ERR_INVALID
;
1719 ret_code
= trace_ust_process_attr_tracker_inclusion_set_add_value(
1720 session
->ust_session
, process_attr
, value
);
1723 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1730 enum lttng_error_code
cmd_process_attr_tracker_inclusion_set_remove_value(
1731 struct ltt_session
*session
,
1732 enum lttng_domain_type domain
,
1733 enum lttng_process_attr process_attr
,
1734 const struct process_attr_value
*value
)
1736 enum lttng_error_code ret_code
= LTTNG_OK
;
1739 case LTTNG_DOMAIN_KERNEL
:
1740 if (!session
->kernel_session
) {
1741 ret_code
= LTTNG_ERR_INVALID
;
1744 ret_code
= kernel_process_attr_tracker_inclusion_set_remove_value(
1745 session
->kernel_session
, process_attr
, value
);
1747 case LTTNG_DOMAIN_UST
:
1748 if (!session
->ust_session
) {
1749 ret_code
= LTTNG_ERR_INVALID
;
1752 ret_code
= trace_ust_process_attr_tracker_inclusion_set_remove_value(
1753 session
->ust_session
, process_attr
, value
);
1756 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1763 enum lttng_error_code
cmd_process_attr_tracker_get_inclusion_set(
1764 struct ltt_session
*session
,
1765 enum lttng_domain_type domain
,
1766 enum lttng_process_attr process_attr
,
1767 struct lttng_process_attr_values
**values
)
1769 enum lttng_error_code ret_code
= LTTNG_OK
;
1770 const struct process_attr_tracker
*tracker
;
1771 enum process_attr_tracker_status status
;
1774 case LTTNG_DOMAIN_KERNEL
:
1775 if (!session
->kernel_session
) {
1776 ret_code
= LTTNG_ERR_INVALID
;
1779 tracker
= kernel_get_process_attr_tracker(
1780 session
->kernel_session
, process_attr
);
1782 case LTTNG_DOMAIN_UST
:
1783 if (!session
->ust_session
) {
1784 ret_code
= LTTNG_ERR_INVALID
;
1787 tracker
= trace_ust_get_process_attr_tracker(
1788 session
->ust_session
, process_attr
);
1791 ret_code
= LTTNG_ERR_UNSUPPORTED_DOMAIN
;
1796 ret_code
= LTTNG_ERR_INVALID
;
1800 status
= process_attr_tracker_get_inclusion_set(tracker
, values
);
1802 case PROCESS_ATTR_TRACKER_STATUS_OK
:
1803 ret_code
= LTTNG_OK
;
1805 case PROCESS_ATTR_TRACKER_STATUS_INVALID_TRACKING_POLICY
:
1806 ret_code
= LTTNG_ERR_PROCESS_ATTR_TRACKER_INVALID_TRACKING_POLICY
;
1808 case PROCESS_ATTR_TRACKER_STATUS_ERROR
:
1809 ret_code
= LTTNG_ERR_NOMEM
;
1812 ret_code
= LTTNG_ERR_UNK
;
1821 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1823 int cmd_disable_event(struct ltt_session
*session
,
1824 enum lttng_domain_type domain
, const char *channel_name
,
1825 const struct lttng_event
*event
)
1828 const char *event_name
;
1830 DBG("Disable event command for event \'%s\'", event
->name
);
1832 event_name
= event
->name
;
1834 /* Error out on unhandled search criteria */
1835 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1836 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1837 ret
= LTTNG_ERR_UNK
;
1844 case LTTNG_DOMAIN_KERNEL
:
1846 struct ltt_kernel_channel
*kchan
;
1847 struct ltt_kernel_session
*ksess
;
1849 ksess
= session
->kernel_session
;
1852 * If a non-default channel has been created in the
1853 * session, explicitely require that -c chan_name needs
1856 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1857 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1861 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1862 if (kchan
== NULL
) {
1863 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1867 switch (event
->type
) {
1868 case LTTNG_EVENT_ALL
:
1869 case LTTNG_EVENT_TRACEPOINT
:
1870 case LTTNG_EVENT_SYSCALL
:
1871 case LTTNG_EVENT_PROBE
:
1872 case LTTNG_EVENT_FUNCTION
:
1873 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1874 if (event_name
[0] == '\0') {
1875 ret
= event_kernel_disable_event(kchan
,
1878 ret
= event_kernel_disable_event(kchan
,
1879 event_name
, event
->type
);
1881 if (ret
!= LTTNG_OK
) {
1886 ret
= LTTNG_ERR_UNK
;
1890 kernel_wait_quiescent();
1893 case LTTNG_DOMAIN_UST
:
1895 struct ltt_ust_channel
*uchan
;
1896 struct ltt_ust_session
*usess
;
1898 usess
= session
->ust_session
;
1900 if (validate_ust_event_name(event_name
)) {
1901 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1906 * If a non-default channel has been created in the
1907 * session, explicitly require that -c chan_name needs
1910 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1911 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1915 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1917 if (uchan
== NULL
) {
1918 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1922 switch (event
->type
) {
1923 case LTTNG_EVENT_ALL
:
1925 * An empty event name means that everything
1926 * should be disabled.
1928 if (event
->name
[0] == '\0') {
1929 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1931 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1934 if (ret
!= LTTNG_OK
) {
1939 ret
= LTTNG_ERR_UNK
;
1943 DBG3("Disable UST event %s in channel %s completed", event_name
,
1947 case LTTNG_DOMAIN_LOG4J
:
1948 case LTTNG_DOMAIN_JUL
:
1949 case LTTNG_DOMAIN_PYTHON
:
1952 struct ltt_ust_session
*usess
= session
->ust_session
;
1956 switch (event
->type
) {
1957 case LTTNG_EVENT_ALL
:
1960 ret
= LTTNG_ERR_UNK
;
1964 agt
= trace_ust_find_agent(usess
, domain
);
1966 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1970 * An empty event name means that everything
1971 * should be disabled.
1973 if (event
->name
[0] == '\0') {
1974 ret
= event_agent_disable_all(usess
, agt
);
1976 ret
= event_agent_disable(usess
, agt
, event_name
);
1978 if (ret
!= LTTNG_OK
) {
1985 ret
= LTTNG_ERR_UND
;
1998 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2000 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
2001 char *channel_name
, const struct lttng_event_context
*ctx
, int kwpipe
)
2003 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
2004 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
2007 * Don't try to add a context if the session has been started at
2008 * some point in time before. The tracer does not allow it and would
2009 * result in a corrupted trace.
2011 if (session
->has_been_started
) {
2012 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2016 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
2017 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
2018 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
2022 case LTTNG_DOMAIN_KERNEL
:
2023 assert(session
->kernel_session
);
2025 if (session
->kernel_session
->channel_count
== 0) {
2026 /* Create default channel */
2027 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
2028 if (ret
!= LTTNG_OK
) {
2031 chan_kern_created
= 1;
2033 /* Add kernel context to kernel tracer */
2034 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
2035 if (ret
!= LTTNG_OK
) {
2039 case LTTNG_DOMAIN_JUL
:
2040 case LTTNG_DOMAIN_LOG4J
:
2043 * Validate channel name.
2044 * If no channel name is given and the domain is JUL or LOG4J,
2045 * set it to the appropriate domain-specific channel name. If
2046 * a name is provided but does not match the expexted channel
2047 * name, return an error.
2049 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
2050 strcmp(channel_name
,
2051 DEFAULT_JUL_CHANNEL_NAME
)) {
2052 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2054 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
2055 strcmp(channel_name
,
2056 DEFAULT_LOG4J_CHANNEL_NAME
)) {
2057 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2060 /* break is _not_ missing here. */
2062 case LTTNG_DOMAIN_UST
:
2064 struct ltt_ust_session
*usess
= session
->ust_session
;
2065 unsigned int chan_count
;
2069 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
2070 if (chan_count
== 0) {
2071 struct lttng_channel
*attr
;
2072 /* Create default channel */
2073 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
2075 ret
= LTTNG_ERR_FATAL
;
2079 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
2080 if (ret
!= LTTNG_OK
) {
2084 channel_attr_destroy(attr
);
2085 chan_ust_created
= 1;
2088 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
2089 free(app_ctx_provider_name
);
2091 app_ctx_name
= NULL
;
2092 app_ctx_provider_name
= NULL
;
2093 if (ret
!= LTTNG_OK
) {
2099 ret
= LTTNG_ERR_UND
;
2107 if (chan_kern_created
) {
2108 struct ltt_kernel_channel
*kchan
=
2109 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
2110 session
->kernel_session
);
2111 /* Created previously, this should NOT fail. */
2113 kernel_destroy_channel(kchan
);
2116 if (chan_ust_created
) {
2117 struct ltt_ust_channel
*uchan
=
2118 trace_ust_find_channel_by_name(
2119 session
->ust_session
->domain_global
.channels
,
2120 DEFAULT_CHANNEL_NAME
);
2121 /* Created previously, this should NOT fail. */
2123 /* Remove from the channel list of the session. */
2124 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
2126 trace_ust_destroy_channel(uchan
);
2129 free(app_ctx_provider_name
);
2134 static inline bool name_starts_with(const char *name
, const char *prefix
)
2136 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
2138 return !strncmp(name
, prefix
, max_cmp_len
);
2141 /* Perform userspace-specific event name validation */
2142 static int validate_ust_event_name(const char *name
)
2152 * Check name against all internal UST event component namespaces used
2155 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
2156 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
2157 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
2166 * Internal version of cmd_enable_event() with a supplemental
2167 * "internal_event" flag which is used to enable internal events which should
2168 * be hidden from clients. Such events are used in the agent implementation to
2169 * enable the events through which all "agent" events are funeled.
2171 static int _cmd_enable_event(struct ltt_session
*session
,
2172 const struct lttng_domain
*domain
,
2173 char *channel_name
, struct lttng_event
*event
,
2174 char *filter_expression
,
2175 struct lttng_bytecode
*filter
,
2176 struct lttng_event_exclusion
*exclusion
,
2177 int wpipe
, bool internal_event
)
2179 int ret
= 0, channel_created
= 0;
2180 struct lttng_channel
*attr
= NULL
;
2184 assert(channel_name
);
2186 /* If we have a filter, we must have its filter expression */
2187 assert(!(!!filter_expression
^ !!filter
));
2189 /* Normalize event name as a globbing pattern */
2190 strutils_normalize_star_glob_pattern(event
->name
);
2192 /* Normalize exclusion names as globbing patterns */
2196 for (i
= 0; i
< exclusion
->count
; i
++) {
2197 char *name
= LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion
, i
);
2199 strutils_normalize_star_glob_pattern(name
);
2203 DBG("Enable event command for event \'%s\'", event
->name
);
2207 switch (domain
->type
) {
2208 case LTTNG_DOMAIN_KERNEL
:
2210 struct ltt_kernel_channel
*kchan
;
2213 * If a non-default channel has been created in the
2214 * session, explicitely require that -c chan_name needs
2217 if (session
->kernel_session
->has_non_default_channel
2218 && channel_name
[0] == '\0') {
2219 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2223 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2224 session
->kernel_session
);
2225 if (kchan
== NULL
) {
2226 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
2227 LTTNG_BUFFER_GLOBAL
);
2229 ret
= LTTNG_ERR_FATAL
;
2232 if (lttng_strncpy(attr
->name
, channel_name
,
2233 sizeof(attr
->name
))) {
2234 ret
= LTTNG_ERR_INVALID
;
2238 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2239 if (ret
!= LTTNG_OK
) {
2242 channel_created
= 1;
2245 /* Get the newly created kernel channel pointer */
2246 kchan
= trace_kernel_get_channel_by_name(channel_name
,
2247 session
->kernel_session
);
2248 if (kchan
== NULL
) {
2249 /* This sould not happen... */
2250 ret
= LTTNG_ERR_FATAL
;
2254 switch (event
->type
) {
2255 case LTTNG_EVENT_ALL
:
2257 char *filter_expression_a
= NULL
;
2258 struct lttng_bytecode
*filter_a
= NULL
;
2261 * We need to duplicate filter_expression and filter,
2262 * because ownership is passed to first enable
2265 if (filter_expression
) {
2266 filter_expression_a
= strdup(filter_expression
);
2267 if (!filter_expression_a
) {
2268 ret
= LTTNG_ERR_FATAL
;
2273 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
2275 free(filter_expression_a
);
2276 ret
= LTTNG_ERR_FATAL
;
2279 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
2281 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
2282 ret
= event_kernel_enable_event(kchan
, event
,
2283 filter_expression
, filter
);
2284 /* We have passed ownership */
2285 filter_expression
= NULL
;
2287 if (ret
!= LTTNG_OK
) {
2288 if (channel_created
) {
2289 /* Let's not leak a useless channel. */
2290 kernel_destroy_channel(kchan
);
2292 free(filter_expression_a
);
2296 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
2297 ret
= event_kernel_enable_event(kchan
, event
,
2298 filter_expression_a
, filter_a
);
2299 /* We have passed ownership */
2300 filter_expression_a
= NULL
;
2302 if (ret
!= LTTNG_OK
) {
2307 case LTTNG_EVENT_PROBE
:
2308 case LTTNG_EVENT_USERSPACE_PROBE
:
2309 case LTTNG_EVENT_FUNCTION
:
2310 case LTTNG_EVENT_FUNCTION_ENTRY
:
2311 case LTTNG_EVENT_TRACEPOINT
:
2312 ret
= event_kernel_enable_event(kchan
, event
,
2313 filter_expression
, filter
);
2314 /* We have passed ownership */
2315 filter_expression
= NULL
;
2317 if (ret
!= LTTNG_OK
) {
2318 if (channel_created
) {
2319 /* Let's not leak a useless channel. */
2320 kernel_destroy_channel(kchan
);
2325 case LTTNG_EVENT_SYSCALL
:
2326 ret
= event_kernel_enable_event(kchan
, event
,
2327 filter_expression
, filter
);
2328 /* We have passed ownership */
2329 filter_expression
= NULL
;
2331 if (ret
!= LTTNG_OK
) {
2336 ret
= LTTNG_ERR_UNK
;
2340 kernel_wait_quiescent();
2343 case LTTNG_DOMAIN_UST
:
2345 struct ltt_ust_channel
*uchan
;
2346 struct ltt_ust_session
*usess
= session
->ust_session
;
2351 * If a non-default channel has been created in the
2352 * session, explicitely require that -c chan_name needs
2355 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
2356 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
2360 /* Get channel from global UST domain */
2361 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
2363 if (uchan
== NULL
) {
2364 /* Create default channel */
2365 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
2366 usess
->buffer_type
);
2368 ret
= LTTNG_ERR_FATAL
;
2371 if (lttng_strncpy(attr
->name
, channel_name
,
2372 sizeof(attr
->name
))) {
2373 ret
= LTTNG_ERR_INVALID
;
2377 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
2378 if (ret
!= LTTNG_OK
) {
2382 /* Get the newly created channel reference back */
2383 uchan
= trace_ust_find_channel_by_name(
2384 usess
->domain_global
.channels
, channel_name
);
2388 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
2390 * Don't allow users to add UST events to channels which
2391 * are assigned to a userspace subdomain (JUL, Log4J,
2394 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
2398 if (!internal_event
) {
2400 * Ensure the event name is not reserved for internal
2403 ret
= validate_ust_event_name(event
->name
);
2405 WARN("Userspace event name %s failed validation.",
2407 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
2412 /* At this point, the session and channel exist on the tracer */
2413 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
2414 filter_expression
, filter
, exclusion
,
2416 /* We have passed ownership */
2417 filter_expression
= NULL
;
2420 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2421 goto already_enabled
;
2422 } else if (ret
!= LTTNG_OK
) {
2427 case LTTNG_DOMAIN_LOG4J
:
2428 case LTTNG_DOMAIN_JUL
:
2429 case LTTNG_DOMAIN_PYTHON
:
2431 const char *default_event_name
, *default_chan_name
;
2433 struct lttng_event uevent
;
2434 struct lttng_domain tmp_dom
;
2435 struct ltt_ust_session
*usess
= session
->ust_session
;
2439 if (!agent_tracing_is_enabled()) {
2440 DBG("Attempted to enable an event in an agent domain but the agent thread is not running");
2441 ret
= LTTNG_ERR_AGENT_TRACING_DISABLED
;
2445 agt
= trace_ust_find_agent(usess
, domain
->type
);
2447 agt
= agent_create(domain
->type
);
2449 ret
= LTTNG_ERR_NOMEM
;
2452 agent_add(agt
, usess
->agents
);
2455 /* Create the default tracepoint. */
2456 memset(&uevent
, 0, sizeof(uevent
));
2457 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
2458 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
2459 default_event_name
= event_get_default_agent_ust_name(
2461 if (!default_event_name
) {
2462 ret
= LTTNG_ERR_FATAL
;
2465 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
2466 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
2469 * The domain type is changed because we are about to enable the
2470 * default channel and event for the JUL domain that are hardcoded.
2471 * This happens in the UST domain.
2473 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
2474 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
2476 switch (domain
->type
) {
2477 case LTTNG_DOMAIN_LOG4J
:
2478 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
2480 case LTTNG_DOMAIN_JUL
:
2481 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
2483 case LTTNG_DOMAIN_PYTHON
:
2484 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
2487 /* The switch/case we are in makes this impossible */
2492 char *filter_expression_copy
= NULL
;
2493 struct lttng_bytecode
*filter_copy
= NULL
;
2496 const size_t filter_size
= sizeof(
2497 struct lttng_bytecode
)
2500 filter_copy
= zmalloc(filter_size
);
2502 ret
= LTTNG_ERR_NOMEM
;
2505 memcpy(filter_copy
, filter
, filter_size
);
2507 filter_expression_copy
=
2508 strdup(filter_expression
);
2509 if (!filter_expression
) {
2510 ret
= LTTNG_ERR_NOMEM
;
2513 if (!filter_expression_copy
|| !filter_copy
) {
2514 free(filter_expression_copy
);
2520 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
2521 (char *) default_chan_name
,
2522 &uevent
, filter_expression_copy
,
2523 filter_copy
, NULL
, wpipe
);
2526 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
2527 goto already_enabled
;
2528 } else if (ret
!= LTTNG_OK
) {
2532 /* The wild card * means that everything should be enabled. */
2533 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
2534 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
2537 ret
= event_agent_enable(usess
, agt
, event
, filter
,
2541 filter_expression
= NULL
;
2542 if (ret
!= LTTNG_OK
) {
2549 ret
= LTTNG_ERR_UND
;
2557 free(filter_expression
);
2560 channel_attr_destroy(attr
);
2566 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2567 * We own filter, exclusion, and filter_expression.
2569 int cmd_enable_event(struct ltt_session
*session
,
2570 const struct lttng_domain
*domain
,
2571 char *channel_name
, struct lttng_event
*event
,
2572 char *filter_expression
,
2573 struct lttng_bytecode
*filter
,
2574 struct lttng_event_exclusion
*exclusion
,
2577 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2578 filter_expression
, filter
, exclusion
, wpipe
, false);
2582 * Enable an event which is internal to LTTng. An internal should
2583 * never be made visible to clients and are immune to checks such as
2586 static int cmd_enable_event_internal(struct ltt_session
*session
,
2587 const struct lttng_domain
*domain
,
2588 char *channel_name
, struct lttng_event
*event
,
2589 char *filter_expression
,
2590 struct lttng_bytecode
*filter
,
2591 struct lttng_event_exclusion
*exclusion
,
2594 return _cmd_enable_event(session
, domain
, channel_name
, event
,
2595 filter_expression
, filter
, exclusion
, wpipe
, true);
2599 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2601 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
2602 struct lttng_event
**events
)
2605 ssize_t nb_events
= 0;
2608 case LTTNG_DOMAIN_KERNEL
:
2609 nb_events
= kernel_list_events(events
);
2610 if (nb_events
< 0) {
2611 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2615 case LTTNG_DOMAIN_UST
:
2616 nb_events
= ust_app_list_events(events
);
2617 if (nb_events
< 0) {
2618 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2622 case LTTNG_DOMAIN_LOG4J
:
2623 case LTTNG_DOMAIN_JUL
:
2624 case LTTNG_DOMAIN_PYTHON
:
2625 nb_events
= agent_list_events(events
, domain
);
2626 if (nb_events
< 0) {
2627 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2632 ret
= LTTNG_ERR_UND
;
2639 /* Return negative value to differentiate return code */
2644 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2646 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2647 struct lttng_event_field
**fields
)
2650 ssize_t nb_fields
= 0;
2653 case LTTNG_DOMAIN_UST
:
2654 nb_fields
= ust_app_list_event_fields(fields
);
2655 if (nb_fields
< 0) {
2656 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2660 case LTTNG_DOMAIN_KERNEL
:
2661 default: /* fall-through */
2662 ret
= LTTNG_ERR_UND
;
2669 /* Return negative value to differentiate return code */
2673 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2675 return syscall_table_list(events
);
2679 * Command LTTNG_START_TRACE processed by the client thread.
2681 * Called with session mutex held.
2683 int cmd_start_trace(struct ltt_session
*session
)
2685 enum lttng_error_code ret
;
2686 unsigned long nb_chan
= 0;
2687 struct ltt_kernel_session
*ksession
;
2688 struct ltt_ust_session
*usess
;
2689 const bool session_rotated_after_last_stop
=
2690 session
->rotated_after_last_stop
;
2691 const bool session_cleared_after_last_stop
=
2692 session
->cleared_after_last_stop
;
2696 /* Ease our life a bit ;) */
2697 ksession
= session
->kernel_session
;
2698 usess
= session
->ust_session
;
2700 /* Is the session already started? */
2701 if (session
->active
) {
2702 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2703 /* Perform nothing */
2707 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
&&
2708 !session
->current_trace_chunk
) {
2710 * A rotation was launched while the session was stopped and
2711 * it has not been completed yet. It is not possible to start
2712 * the session since starting the session here would require a
2713 * rotation from "NULL" to a new trace chunk. That rotation
2714 * would overlap with the ongoing rotation, which is not
2717 WARN("Refusing to start session \"%s\" as a rotation launched after the last \"stop\" is still ongoing",
2719 ret
= LTTNG_ERR_ROTATION_PENDING
;
2724 * Starting a session without channel is useless since after that it's not
2725 * possible to enable channel thus inform the client.
2727 if (usess
&& usess
->domain_global
.channels
) {
2728 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2731 nb_chan
+= ksession
->channel_count
;
2734 ret
= LTTNG_ERR_NO_CHANNEL
;
2738 session
->active
= 1;
2739 session
->rotated_after_last_stop
= false;
2740 session
->cleared_after_last_stop
= false;
2741 if (session
->output_traces
&& !session
->current_trace_chunk
) {
2742 if (!session
->has_been_started
) {
2743 struct lttng_trace_chunk
*trace_chunk
;
2745 DBG("Creating initial trace chunk of session \"%s\"",
2747 trace_chunk
= session_create_new_trace_chunk(
2748 session
, NULL
, NULL
, NULL
);
2750 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
2753 assert(!session
->current_trace_chunk
);
2754 ret
= session_set_trace_chunk(session
, trace_chunk
,
2756 lttng_trace_chunk_put(trace_chunk
);
2758 ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
2762 DBG("Rotating session \"%s\" from its current \"NULL\" trace chunk to a new chunk",
2765 * Rotate existing streams into the new chunk.
2766 * This is a "quiet" rotation has no client has
2767 * explicitly requested this operation.
2769 * There is also no need to wait for the rotation
2770 * to complete as it will happen immediately. No data
2771 * was produced as the session was stopped, so the
2772 * rotation should happen on reception of the command.
2774 ret
= cmd_rotate_session(session
, NULL
, true,
2775 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
2776 if (ret
!= LTTNG_OK
) {
2782 /* Kernel tracing */
2783 if (ksession
!= NULL
) {
2784 DBG("Start kernel tracing session %s", session
->name
);
2785 ret
= start_kernel_session(ksession
);
2786 if (ret
!= LTTNG_OK
) {
2791 /* Flag session that trace should start automatically */
2793 int int_ret
= ust_app_start_trace_all(usess
);
2796 ret
= LTTNG_ERR_UST_START_FAIL
;
2802 * Clear the flag that indicates that a rotation was done while the
2803 * session was stopped.
2805 session
->rotated_after_last_stop
= false;
2807 if (session
->rotate_timer_period
) {
2808 int int_ret
= timer_session_rotation_schedule_timer_start(
2809 session
, session
->rotate_timer_period
);
2812 ERR("Failed to enable rotate timer");
2813 ret
= LTTNG_ERR_UNK
;
2821 if (ret
== LTTNG_OK
) {
2822 /* Flag this after a successful start. */
2823 session
->has_been_started
|= 1;
2825 session
->active
= 0;
2826 /* Restore initial state on error. */
2827 session
->rotated_after_last_stop
=
2828 session_rotated_after_last_stop
;
2829 session
->cleared_after_last_stop
=
2830 session_cleared_after_last_stop
;
2837 * Command LTTNG_STOP_TRACE processed by the client thread.
2839 int cmd_stop_trace(struct ltt_session
*session
)
2842 struct ltt_kernel_session
*ksession
;
2843 struct ltt_ust_session
*usess
;
2847 DBG("Begin stop session \"%s\" (id %" PRIu64
")", session
->name
, session
->id
);
2849 ksession
= session
->kernel_session
;
2850 usess
= session
->ust_session
;
2852 /* Session is not active. Skip everythong and inform the client. */
2853 if (!session
->active
) {
2854 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2858 ret
= stop_kernel_session(ksession
);
2859 if (ret
!= LTTNG_OK
) {
2863 if (usess
&& usess
->active
) {
2864 ret
= ust_app_stop_trace_all(usess
);
2866 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2871 DBG("Completed stop session \"%s\" (id %" PRIu64
")", session
->name
,
2873 /* Flag inactive after a successful stop. */
2874 session
->active
= 0;
2882 * Set the base_path of the session only if subdir of a control uris is set.
2883 * Return LTTNG_OK on success, otherwise LTTNG_ERR_*.
2885 static int set_session_base_path_from_uris(struct ltt_session
*session
,
2887 struct lttng_uri
*uris
)
2892 for (i
= 0; i
< nb_uri
; i
++) {
2893 if (uris
[i
].stype
!= LTTNG_STREAM_CONTROL
||
2894 uris
[i
].subdir
[0] == '\0') {
2895 /* Not interested in these URIs */
2899 if (session
->base_path
!= NULL
) {
2900 free(session
->base_path
);
2901 session
->base_path
= NULL
;
2904 /* Set session base_path */
2905 session
->base_path
= strdup(uris
[i
].subdir
);
2906 if (!session
->base_path
) {
2907 PERROR("Failed to copy base path \"%s\" to session \"%s\"",
2908 uris
[i
].subdir
, session
->name
);
2909 ret
= LTTNG_ERR_NOMEM
;
2912 DBG2("Setting base path \"%s\" for session \"%s\"",
2913 session
->base_path
, session
->name
);
2921 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2923 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2924 struct lttng_uri
*uris
)
2927 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2928 struct ltt_ust_session
*usess
= session
->ust_session
;
2934 /* Can't set consumer URI if the session is active. */
2935 if (session
->active
) {
2936 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2941 * Set the session base path if any. This is done inside
2942 * cmd_set_consumer_uri to preserve backward compatibility of the
2943 * previous session creation api vs the session descriptor api.
2945 ret
= set_session_base_path_from_uris(session
, nb_uri
, uris
);
2946 if (ret
!= LTTNG_OK
) {
2950 /* Set the "global" consumer URIs */
2951 for (i
= 0; i
< nb_uri
; i
++) {
2952 ret
= add_uri_to_consumer(session
, session
->consumer
, &uris
[i
],
2954 if (ret
!= LTTNG_OK
) {
2959 /* Set UST session URIs */
2960 if (session
->ust_session
) {
2961 for (i
= 0; i
< nb_uri
; i
++) {
2962 ret
= add_uri_to_consumer(session
,
2963 session
->ust_session
->consumer
,
2964 &uris
[i
], LTTNG_DOMAIN_UST
);
2965 if (ret
!= LTTNG_OK
) {
2971 /* Set kernel session URIs */
2972 if (session
->kernel_session
) {
2973 for (i
= 0; i
< nb_uri
; i
++) {
2974 ret
= add_uri_to_consumer(session
,
2975 session
->kernel_session
->consumer
,
2976 &uris
[i
], LTTNG_DOMAIN_KERNEL
);
2977 if (ret
!= LTTNG_OK
) {
2984 * Make sure to set the session in output mode after we set URI since a
2985 * session can be created without URL (thus flagged in no output mode).
2987 session
->output_traces
= 1;
2989 ksess
->output_traces
= 1;
2993 usess
->output_traces
= 1;
3004 enum lttng_error_code
set_session_output_from_descriptor(
3005 struct ltt_session
*session
,
3006 const struct lttng_session_descriptor
*descriptor
)
3009 enum lttng_error_code ret_code
= LTTNG_OK
;
3010 enum lttng_session_descriptor_type session_type
=
3011 lttng_session_descriptor_get_type(descriptor
);
3012 enum lttng_session_descriptor_output_type output_type
=
3013 lttng_session_descriptor_get_output_type(descriptor
);
3014 struct lttng_uri uris
[2] = {};
3015 size_t uri_count
= 0;
3017 switch (output_type
) {
3018 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NONE
:
3020 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_LOCAL
:
3021 lttng_session_descriptor_get_local_output_uri(descriptor
,
3025 case LTTNG_SESSION_DESCRIPTOR_OUTPUT_TYPE_NETWORK
:
3026 lttng_session_descriptor_get_network_output_uris(descriptor
,
3027 &uris
[0], &uris
[1]);
3031 ret_code
= LTTNG_ERR_INVALID
;
3035 switch (session_type
) {
3036 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3038 struct snapshot_output
*new_output
= NULL
;
3040 new_output
= snapshot_output_alloc();
3042 ret_code
= LTTNG_ERR_NOMEM
;
3046 ret
= snapshot_output_init_with_uri(session
,
3047 DEFAULT_SNAPSHOT_MAX_SIZE
,
3048 NULL
, uris
, uri_count
, session
->consumer
,
3049 new_output
, &session
->snapshot
);
3051 ret_code
= (ret
== -ENOMEM
) ?
3052 LTTNG_ERR_NOMEM
: LTTNG_ERR_INVALID
;
3053 snapshot_output_destroy(new_output
);
3056 snapshot_add_output(&session
->snapshot
, new_output
);
3059 case LTTNG_SESSION_DESCRIPTOR_TYPE_REGULAR
:
3060 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3062 ret_code
= cmd_set_consumer_uri(session
, uri_count
, uris
);
3066 ret_code
= LTTNG_ERR_INVALID
;
3074 enum lttng_error_code
cmd_create_session_from_descriptor(
3075 struct lttng_session_descriptor
*descriptor
,
3076 const lttng_sock_cred
*creds
,
3077 const char *home_path
)
3080 enum lttng_error_code ret_code
;
3081 const char *session_name
;
3082 struct ltt_session
*new_session
= NULL
;
3083 enum lttng_session_descriptor_status descriptor_status
;
3085 session_lock_list();
3087 if (*home_path
!= '/') {
3088 ERR("Home path provided by client is not absolute");
3089 ret_code
= LTTNG_ERR_INVALID
;
3094 descriptor_status
= lttng_session_descriptor_get_session_name(
3095 descriptor
, &session_name
);
3096 switch (descriptor_status
) {
3097 case LTTNG_SESSION_DESCRIPTOR_STATUS_OK
:
3099 case LTTNG_SESSION_DESCRIPTOR_STATUS_UNSET
:
3100 session_name
= NULL
;
3103 ret_code
= LTTNG_ERR_INVALID
;
3107 ret_code
= session_create(session_name
, creds
->uid
, creds
->gid
,
3109 if (ret_code
!= LTTNG_OK
) {
3113 if (!session_name
) {
3114 ret
= lttng_session_descriptor_set_session_name(descriptor
,
3117 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3122 if (!lttng_session_descriptor_is_output_destination_initialized(
3125 * Only include the session's creation time in the output
3126 * destination if the name of the session itself was
3127 * not auto-generated.
3129 ret_code
= lttng_session_descriptor_set_default_output(
3131 session_name
? &new_session
->creation_time
: NULL
,
3133 if (ret_code
!= LTTNG_OK
) {
3137 new_session
->has_user_specified_directory
=
3138 lttng_session_descriptor_has_output_directory(
3142 switch (lttng_session_descriptor_get_type(descriptor
)) {
3143 case LTTNG_SESSION_DESCRIPTOR_TYPE_SNAPSHOT
:
3144 new_session
->snapshot_mode
= 1;
3146 case LTTNG_SESSION_DESCRIPTOR_TYPE_LIVE
:
3147 new_session
->live_timer
=
3148 lttng_session_descriptor_live_get_timer_interval(
3155 ret_code
= set_session_output_from_descriptor(new_session
, descriptor
);
3156 if (ret_code
!= LTTNG_OK
) {
3159 new_session
->consumer
->enabled
= 1;
3160 ret_code
= LTTNG_OK
;
3162 /* Release reference provided by the session_create function. */
3163 session_put(new_session
);
3164 if (ret_code
!= LTTNG_OK
&& new_session
) {
3165 /* Release the global reference on error. */
3166 session_destroy(new_session
);
3168 session_unlock_list();
3172 enum lttng_error_code
cmd_create_session(struct command_ctx
*cmd_ctx
, int sock
,
3173 struct lttng_session_descriptor
**return_descriptor
)
3176 size_t payload_size
;
3177 struct lttng_dynamic_buffer payload
;
3178 struct lttng_buffer_view home_dir_view
;
3179 struct lttng_buffer_view session_descriptor_view
;
3180 struct lttng_session_descriptor
*session_descriptor
= NULL
;
3181 enum lttng_error_code ret_code
;
3183 lttng_dynamic_buffer_init(&payload
);
3184 if (cmd_ctx
->lsm
->u
.create_session
.home_dir_size
>=
3186 ret_code
= LTTNG_ERR_INVALID
;
3189 if (cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
>
3190 LTTNG_SESSION_DESCRIPTOR_MAX_LEN
) {
3191 ret_code
= LTTNG_ERR_INVALID
;
3195 payload_size
= cmd_ctx
->lsm
->u
.create_session
.home_dir_size
+
3196 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
;
3197 ret
= lttng_dynamic_buffer_set_size(&payload
, payload_size
);
3199 ret_code
= LTTNG_ERR_NOMEM
;
3203 ret
= lttcomm_recv_unix_sock(sock
, payload
.data
, payload
.size
);
3205 ERR("Reception of session descriptor failed, aborting.");
3206 ret_code
= LTTNG_ERR_SESSION_FAIL
;
3210 home_dir_view
= lttng_buffer_view_from_dynamic_buffer(
3213 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
);
3214 session_descriptor_view
= lttng_buffer_view_from_dynamic_buffer(
3216 cmd_ctx
->lsm
->u
.create_session
.home_dir_size
,
3217 cmd_ctx
->lsm
->u
.create_session
.session_descriptor_size
);
3219 ret
= lttng_session_descriptor_create_from_buffer(
3220 &session_descriptor_view
, &session_descriptor
);
3222 ERR("Failed to create session descriptor from payload of \"create session\" command");
3223 ret_code
= LTTNG_ERR_INVALID
;
3228 * Sets the descriptor's auto-generated properties (name, output) if
3231 ret_code
= cmd_create_session_from_descriptor(session_descriptor
,
3233 home_dir_view
.size
? home_dir_view
.data
: NULL
);
3234 if (ret_code
!= LTTNG_OK
) {
3238 ret_code
= LTTNG_OK
;
3239 *return_descriptor
= session_descriptor
;
3240 session_descriptor
= NULL
;
3242 lttng_dynamic_buffer_reset(&payload
);
3243 lttng_session_descriptor_destroy(session_descriptor
);
3248 void cmd_destroy_session_reply(const struct ltt_session
*session
,
3249 void *_reply_context
)
3253 const struct cmd_destroy_session_reply_context
*reply_context
=
3255 struct lttng_dynamic_buffer payload
;
3256 struct lttcomm_session_destroy_command_header cmd_header
;
3257 struct lttng_trace_archive_location
*location
= NULL
;
3258 struct lttcomm_lttng_msg llm
= {
3259 .cmd_type
= LTTNG_DESTROY_SESSION
,
3260 .ret_code
= reply_context
->destruction_status
,
3263 sizeof(struct lttcomm_session_destroy_command_header
),
3266 size_t payload_size_before_location
;
3268 lttng_dynamic_buffer_init(&payload
);
3270 ret
= lttng_dynamic_buffer_append(&payload
, &llm
, sizeof(llm
));
3272 ERR("Failed to append session destruction message");
3276 cmd_header
.rotation_state
=
3277 (int32_t) (reply_context
->implicit_rotation_on_destroy
?
3278 session
->rotation_state
:
3279 LTTNG_ROTATION_STATE_NO_ROTATION
);
3280 ret
= lttng_dynamic_buffer_append(&payload
, &cmd_header
,
3281 sizeof(cmd_header
));
3283 ERR("Failed to append session destruction command header");
3287 if (!reply_context
->implicit_rotation_on_destroy
) {
3288 DBG("No implicit rotation performed during the destruction of session \"%s\", sending reply",
3292 if (session
->rotation_state
!= LTTNG_ROTATION_STATE_COMPLETED
) {
3293 DBG("Rotation state of session \"%s\" is not \"completed\", sending session destruction reply",
3298 location
= session_get_trace_archive_location(session
);
3300 ERR("Failed to get the location of the trace archive produced during the destruction of session \"%s\"",
3305 payload_size_before_location
= payload
.size
;
3306 comm_ret
= lttng_trace_archive_location_serialize(location
,
3309 ERR("Failed to serialize the location of the trace archive produced during the destruction of session \"%s\"",
3313 /* Update the message to indicate the location's length. */
3314 ((struct lttcomm_lttng_msg
*) payload
.data
)->data_size
=
3315 payload
.size
- payload_size_before_location
;
3317 comm_ret
= lttcomm_send_unix_sock(reply_context
->reply_sock_fd
,
3318 payload
.data
, payload
.size
);
3319 if (comm_ret
!= (ssize_t
) payload
.size
) {
3320 ERR("Failed to send result of the destruction of session \"%s\" to client",
3324 ret
= close(reply_context
->reply_sock_fd
);
3326 PERROR("Failed to close client socket in deferred session destroy reply");
3328 lttng_dynamic_buffer_reset(&payload
);
3329 free(_reply_context
);
3333 * Command LTTNG_DESTROY_SESSION processed by the client thread.
3335 * Called with session lock held.
3337 int cmd_destroy_session(struct ltt_session
*session
,
3338 struct notification_thread_handle
*notification_thread_handle
,
3342 enum lttng_error_code destruction_last_error
= LTTNG_OK
;
3343 struct cmd_destroy_session_reply_context
*reply_context
= NULL
;
3346 reply_context
= zmalloc(sizeof(*reply_context
));
3347 if (!reply_context
) {
3348 ret
= LTTNG_ERR_NOMEM
;
3351 reply_context
->reply_sock_fd
= *sock_fd
;
3357 DBG("Begin destroy session %s (id %" PRIu64
")", session
->name
,
3359 if (session
->active
) {
3360 DBG("Session \"%s\" is active, attempting to stop it before destroying it",
3362 ret
= cmd_stop_trace(session
);
3363 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
3364 /* Carry on with the destruction of the session. */
3365 ERR("Failed to stop session \"%s\" as part of its destruction: %s",
3366 session
->name
, lttng_strerror(-ret
));
3367 destruction_last_error
= ret
;
3371 if (session
->rotation_schedule_timer_enabled
) {
3372 if (timer_session_rotation_schedule_timer_stop(
3374 ERR("Failed to stop the \"rotation schedule\" timer of session %s",
3376 destruction_last_error
= LTTNG_ERR_TIMER_STOP_ERROR
;
3380 if (session
->rotate_size
) {
3381 unsubscribe_session_consumed_size_rotation(session
, notification_thread_handle
);
3382 session
->rotate_size
= 0;
3385 if (session
->rotated
&& session
->current_trace_chunk
&& session
->output_traces
) {
3387 * Perform a last rotation on destruction if rotations have
3388 * occurred during the session's lifetime.
3390 ret
= cmd_rotate_session(session
, NULL
, false,
3391 LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED
);
3392 if (ret
!= LTTNG_OK
) {
3393 ERR("Failed to perform an implicit rotation as part of the destruction of session \"%s\": %s",
3394 session
->name
, lttng_strerror(-ret
));
3395 destruction_last_error
= -ret
;
3397 if (reply_context
) {
3398 reply_context
->implicit_rotation_on_destroy
= true;
3400 } else if (session
->has_been_started
&& session
->current_trace_chunk
) {
3402 * The user has not triggered a session rotation. However, to
3403 * ensure all data has been consumed, the session is rotated
3404 * to a 'null' trace chunk before it is destroyed.
3406 * This is a "quiet" rotation meaning that no notification is
3407 * emitted and no renaming of the current trace chunk takes
3410 ret
= cmd_rotate_session(session
, NULL
, true,
3411 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
);
3413 * Rotation operations may not be supported by the kernel
3414 * tracer. Hence, do not consider this implicit rotation as
3415 * a session destruction error. The library has already stopped
3416 * the session and waited for pending data; there is nothing
3417 * left to do but complete the destruction of the session.
3419 if (ret
!= LTTNG_OK
&&
3420 ret
!= -LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
) {
3421 ERR("Failed to perform a quiet rotation as part of the destruction of session \"%s\": %s",
3422 session
->name
, lttng_strerror(ret
));
3423 destruction_last_error
= -ret
;
3427 if (session
->shm_path
[0]) {
3429 * When a session is created with an explicit shm_path,
3430 * the consumer daemon will create its shared memory files
3431 * at that location and will *not* unlink them. This is normal
3432 * as the intention of that feature is to make it possible
3433 * to retrieve the content of those files should a crash occur.
3435 * To ensure the content of those files can be used, the
3436 * sessiond daemon will replicate the content of the metadata
3437 * cache in a metadata file.
3439 * On clean-up, it is expected that the consumer daemon will
3440 * unlink the shared memory files and that the session daemon
3441 * will unlink the metadata file. Then, the session's directory
3442 * in the shm path can be removed.
3444 * Unfortunately, a flaw in the design of the sessiond's and
3445 * consumerd's tear down of channels makes it impossible to
3446 * determine when the sessiond _and_ the consumerd have both
3447 * destroyed their representation of a channel. For one, the
3448 * unlinking, close, and rmdir happen in deferred 'call_rcu'
3449 * callbacks in both daemons.
3451 * However, it is also impossible for the sessiond to know when
3452 * the consumer daemon is done destroying its channel(s) since
3453 * it occurs as a reaction to the closing of the channel's file
3454 * descriptor. There is no resulting communication initiated
3455 * from the consumerd to the sessiond to confirm that the
3456 * operation is completed (and was successful).
3458 * Until this is all fixed, the session daemon checks for the
3459 * removal of the session's shm path which makes it possible
3460 * to safely advertise a session as having been destroyed.
3462 * Prior to this fix, it was not possible to reliably save
3463 * a session making use of the --shm-path option, destroy it,
3464 * and load it again. This is because the creation of the
3465 * session would fail upon seeing the session's shm path
3466 * already in existence.
3468 * Note that none of the error paths in the check for the
3469 * directory's existence return an error. This is normal
3470 * as there isn't much that can be done. The session will
3471 * be destroyed properly, except that we can't offer the
3472 * guarantee that the same session can be re-created.
3474 current_completion_handler
= &destroy_completion_handler
.handler
;
3475 ret
= lttng_strncpy(destroy_completion_handler
.shm_path
,
3477 sizeof(destroy_completion_handler
.shm_path
));
3482 * The session is destroyed. However, note that the command context
3483 * still holds a reference to the session, thus delaying its destruction
3484 * _at least_ up to the point when that reference is released.
3486 session_destroy(session
);
3487 if (reply_context
) {
3488 reply_context
->destruction_status
= destruction_last_error
;
3489 ret
= session_add_destroy_notifier(session
,
3490 cmd_destroy_session_reply
,
3491 (void *) reply_context
);
3493 ret
= LTTNG_ERR_FATAL
;
3505 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
3507 int cmd_register_consumer(struct ltt_session
*session
,
3508 enum lttng_domain_type domain
, const char *sock_path
,
3509 struct consumer_data
*cdata
)
3512 struct consumer_socket
*socket
= NULL
;
3519 case LTTNG_DOMAIN_KERNEL
:
3521 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3525 /* Can't register a consumer if there is already one */
3526 if (ksess
->consumer_fds_sent
!= 0) {
3527 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
3531 sock
= lttcomm_connect_unix_sock(sock_path
);
3533 ret
= LTTNG_ERR_CONNECT_FAIL
;
3536 cdata
->cmd_sock
= sock
;
3538 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
3539 if (socket
== NULL
) {
3542 PERROR("close register consumer");
3544 cdata
->cmd_sock
= -1;
3545 ret
= LTTNG_ERR_FATAL
;
3549 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
3550 if (socket
->lock
== NULL
) {
3551 PERROR("zmalloc pthread mutex");
3552 ret
= LTTNG_ERR_FATAL
;
3555 pthread_mutex_init(socket
->lock
, NULL
);
3556 socket
->registered
= 1;
3559 consumer_add_socket(socket
, ksess
->consumer
);
3562 pthread_mutex_lock(&cdata
->pid_mutex
);
3564 pthread_mutex_unlock(&cdata
->pid_mutex
);
3569 /* TODO: Userspace tracing */
3570 ret
= LTTNG_ERR_UND
;
3578 consumer_destroy_socket(socket
);
3584 * Command LTTNG_LIST_DOMAINS processed by the client thread.
3586 ssize_t
cmd_list_domains(struct ltt_session
*session
,
3587 struct lttng_domain
**domains
)
3592 struct lttng_ht_iter iter
;
3594 if (session
->kernel_session
!= NULL
) {
3595 DBG3("Listing domains found kernel domain");
3599 if (session
->ust_session
!= NULL
) {
3600 DBG3("Listing domains found UST global domain");
3604 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3606 if (agt
->being_used
) {
3617 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
3618 if (*domains
== NULL
) {
3619 ret
= LTTNG_ERR_FATAL
;
3623 if (session
->kernel_session
!= NULL
) {
3624 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
3626 /* Kernel session buffer type is always GLOBAL */
3627 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
3632 if (session
->ust_session
!= NULL
) {
3633 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
3634 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3638 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
3640 if (agt
->being_used
) {
3641 (*domains
)[index
].type
= agt
->domain
;
3642 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
3652 /* Return negative value to differentiate return code */
3658 * Command LTTNG_LIST_CHANNELS processed by the client thread.
3660 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
3661 struct ltt_session
*session
, struct lttng_channel
**channels
)
3663 ssize_t nb_chan
= 0, payload_size
= 0, ret
;
3666 case LTTNG_DOMAIN_KERNEL
:
3667 if (session
->kernel_session
!= NULL
) {
3668 nb_chan
= session
->kernel_session
->channel_count
;
3670 DBG3("Number of kernel channels %zd", nb_chan
);
3672 ret
= -LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
3676 case LTTNG_DOMAIN_UST
:
3677 if (session
->ust_session
!= NULL
) {
3679 nb_chan
= lttng_ht_get_count(
3680 session
->ust_session
->domain_global
.channels
);
3683 DBG3("Number of UST global channels %zd", nb_chan
);
3685 ret
= -LTTNG_ERR_UST_CHAN_NOT_FOUND
;
3690 ret
= -LTTNG_ERR_UND
;
3695 const size_t channel_size
= sizeof(struct lttng_channel
) +
3696 sizeof(struct lttng_channel_extended
);
3697 struct lttng_channel_extended
*channel_exts
;
3699 payload_size
= nb_chan
* channel_size
;
3700 *channels
= zmalloc(payload_size
);
3701 if (*channels
== NULL
) {
3702 ret
= -LTTNG_ERR_FATAL
;
3706 channel_exts
= ((void *) *channels
) +
3707 (nb_chan
* sizeof(struct lttng_channel
));
3708 ret
= list_lttng_channels(domain
, session
, *channels
, channel_exts
);
3709 if (ret
!= LTTNG_OK
) {
3724 * Command LTTNG_LIST_EVENTS processed by the client thread.
3726 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
3727 struct ltt_session
*session
, char *channel_name
,
3728 struct lttng_event
**events
, size_t *total_size
)
3731 ssize_t nb_event
= 0;
3734 case LTTNG_DOMAIN_KERNEL
:
3735 if (session
->kernel_session
!= NULL
) {
3736 nb_event
= list_lttng_kernel_events(channel_name
,
3737 session
->kernel_session
, events
,
3741 case LTTNG_DOMAIN_UST
:
3743 if (session
->ust_session
!= NULL
) {
3744 nb_event
= list_lttng_ust_global_events(channel_name
,
3745 &session
->ust_session
->domain_global
, events
,
3750 case LTTNG_DOMAIN_LOG4J
:
3751 case LTTNG_DOMAIN_JUL
:
3752 case LTTNG_DOMAIN_PYTHON
:
3753 if (session
->ust_session
) {
3754 struct lttng_ht_iter iter
;
3758 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
3759 &iter
.iter
, agt
, node
.node
) {
3760 if (agt
->domain
== domain
) {
3761 nb_event
= list_lttng_agent_events(
3771 ret
= LTTNG_ERR_UND
;
3778 /* Return negative value to differentiate return code */
3783 * Using the session list, filled a lttng_session array to send back to the
3784 * client for session listing.
3786 * The session list lock MUST be acquired before calling this function. Use
3787 * session_lock_list() and session_unlock_list().
3789 void cmd_list_lttng_sessions(struct lttng_session
*sessions
,
3790 size_t session_count
, uid_t uid
, gid_t gid
)
3794 struct ltt_session
*session
;
3795 struct ltt_session_list
*list
= session_get_list();
3796 struct lttng_session_extended
*extended
=
3797 (typeof(extended
)) (&sessions
[session_count
]);
3799 DBG("Getting all available session for UID %d GID %d",
3802 * Iterate over session list and append data after the control struct in
3805 cds_list_for_each_entry(session
, &list
->head
, list
) {
3806 if (!session_get(session
)) {
3810 * Only list the sessions the user can control.
3812 if (!session_access_ok(session
, uid
, gid
) ||
3813 session
->destroyed
) {
3814 session_put(session
);
3818 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3819 struct ltt_ust_session
*usess
= session
->ust_session
;
3821 if (session
->consumer
->type
== CONSUMER_DST_NET
||
3822 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
3823 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
3824 ret
= build_network_session_path(sessions
[i
].path
,
3825 sizeof(sessions
[i
].path
), session
);
3827 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
3828 session
->consumer
->dst
.session_root_path
);
3831 PERROR("snprintf session path");
3832 session_put(session
);
3836 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
3837 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
3838 sessions
[i
].enabled
= session
->active
;
3839 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
3840 sessions
[i
].live_timer_interval
= session
->live_timer
;
3841 extended
[i
].creation_time
.value
= (uint64_t) session
->creation_time
;
3842 extended
[i
].creation_time
.is_set
= 1;
3844 session_put(session
);
3849 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3850 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3852 int cmd_data_pending(struct ltt_session
*session
)
3855 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3856 struct ltt_ust_session
*usess
= session
->ust_session
;
3860 DBG("Data pending for session %s", session
->name
);
3862 /* Session MUST be stopped to ask for data availability. */
3863 if (session
->active
) {
3864 ret
= LTTNG_ERR_SESSION_STARTED
;
3868 * If stopped, just make sure we've started before else the above call
3869 * will always send that there is data pending.
3871 * The consumer assumes that when the data pending command is received,
3872 * the trace has been started before or else no output data is written
3873 * by the streams which is a condition for data pending. So, this is
3874 * *VERY* important that we don't ask the consumer before a start
3877 if (!session
->has_been_started
) {
3883 /* A rotation is still pending, we have to wait. */
3884 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
3885 DBG("Rotate still pending for session %s", session
->name
);
3890 if (ksess
&& ksess
->consumer
) {
3891 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
3893 /* Data is still being extracted for the kernel. */
3898 if (usess
&& usess
->consumer
) {
3899 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
3901 /* Data is still being extracted for the kernel. */
3906 /* Data is ready to be read by a viewer */
3914 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3916 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3918 int cmd_snapshot_add_output(struct ltt_session
*session
,
3919 const struct lttng_snapshot_output
*output
, uint32_t *id
)
3922 struct snapshot_output
*new_output
;
3927 DBG("Cmd snapshot add output for session %s", session
->name
);
3930 * Can't create an output if the session is not set in no-output mode.
3932 if (session
->output_traces
) {
3933 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
3937 if (session
->has_non_mmap_channel
) {
3938 ret
= LTTNG_ERR_SNAPSHOT_UNSUPPORTED
;
3942 /* Only one output is allowed until we have the "tee" feature. */
3943 if (session
->snapshot
.nb_output
== 1) {
3944 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
3948 new_output
= snapshot_output_alloc();
3950 ret
= LTTNG_ERR_NOMEM
;
3954 ret
= snapshot_output_init(session
, output
->max_size
, output
->name
,
3955 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
3956 &session
->snapshot
);
3958 if (ret
== -ENOMEM
) {
3959 ret
= LTTNG_ERR_NOMEM
;
3961 ret
= LTTNG_ERR_INVALID
;
3967 snapshot_add_output(&session
->snapshot
, new_output
);
3969 *id
= new_output
->id
;
3976 snapshot_output_destroy(new_output
);
3982 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3984 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3986 int cmd_snapshot_del_output(struct ltt_session
*session
,
3987 const struct lttng_snapshot_output
*output
)
3990 struct snapshot_output
*sout
= NULL
;
3998 * Permission denied to create an output if the session is not
3999 * set in no output mode.
4001 if (session
->output_traces
) {
4002 ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4007 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
4009 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
4010 } else if (*output
->name
!= '\0') {
4011 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
4013 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
4016 ret
= LTTNG_ERR_INVALID
;
4020 snapshot_delete_output(&session
->snapshot
, sout
);
4021 snapshot_output_destroy(sout
);
4030 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
4032 * If no output is available, outputs is untouched and 0 is returned.
4034 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
4036 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
4037 struct lttng_snapshot_output
**outputs
)
4040 struct lttng_snapshot_output
*list
= NULL
;
4041 struct lttng_ht_iter iter
;
4042 struct snapshot_output
*output
;
4047 DBG("Cmd snapshot list outputs for session %s", session
->name
);
4050 * Permission denied to create an output if the session is not
4051 * set in no output mode.
4053 if (session
->output_traces
) {
4054 ret
= -LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
4058 if (session
->snapshot
.nb_output
== 0) {
4063 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
4065 ret
= -LTTNG_ERR_NOMEM
;
4069 /* Copy list from session to the new list object. */
4071 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
4072 output
, node
.node
) {
4073 assert(output
->consumer
);
4074 list
[idx
].id
= output
->id
;
4075 list
[idx
].max_size
= output
->max_size
;
4076 if (lttng_strncpy(list
[idx
].name
, output
->name
,
4077 sizeof(list
[idx
].name
))) {
4078 ret
= -LTTNG_ERR_INVALID
;
4081 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
4082 if (lttng_strncpy(list
[idx
].ctrl_url
,
4083 output
->consumer
->dst
.session_root_path
,
4084 sizeof(list
[idx
].ctrl_url
))) {
4085 ret
= -LTTNG_ERR_INVALID
;
4090 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
4091 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
4093 ret
= -LTTNG_ERR_NOMEM
;
4098 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
4099 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
4101 ret
= -LTTNG_ERR_NOMEM
;
4110 ret
= session
->snapshot
.nb_output
;
4119 * Check if we can regenerate the metadata for this session.
4120 * Only kernel, UST per-uid and non-live sessions are supported.
4122 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
4125 int check_regenerate_metadata_support(struct ltt_session
*session
)
4131 if (session
->live_timer
!= 0) {
4132 ret
= LTTNG_ERR_LIVE_SESSION
;
4135 if (!session
->active
) {
4136 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4139 if (session
->ust_session
) {
4140 switch (session
->ust_session
->buffer_type
) {
4141 case LTTNG_BUFFER_PER_UID
:
4143 case LTTNG_BUFFER_PER_PID
:
4144 ret
= LTTNG_ERR_PER_PID_SESSION
;
4148 ret
= LTTNG_ERR_UNK
;
4152 if (session
->consumer
->type
== CONSUMER_DST_NET
&&
4153 session
->consumer
->relay_minor_version
< 8) {
4154 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
4164 int clear_metadata_file(int fd
)
4169 lseek_ret
= lseek(fd
, 0, SEEK_SET
);
4170 if (lseek_ret
< 0) {
4176 ret
= ftruncate(fd
, 0);
4178 PERROR("ftruncate");
4187 int ust_regenerate_metadata(struct ltt_ust_session
*usess
)
4190 struct buffer_reg_uid
*uid_reg
= NULL
;
4191 struct buffer_reg_session
*session_reg
= NULL
;
4194 cds_list_for_each_entry(uid_reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4195 struct ust_registry_session
*registry
;
4196 struct ust_registry_channel
*chan
;
4197 struct lttng_ht_iter iter_chan
;
4199 session_reg
= uid_reg
->registry
;
4200 registry
= session_reg
->reg
.ust
;
4202 pthread_mutex_lock(®istry
->lock
);
4203 registry
->metadata_len_sent
= 0;
4204 memset(registry
->metadata
, 0, registry
->metadata_alloc_len
);
4205 registry
->metadata_len
= 0;
4206 registry
->metadata_version
++;
4207 if (registry
->metadata_fd
> 0) {
4208 /* Clear the metadata file's content. */
4209 ret
= clear_metadata_file(registry
->metadata_fd
);
4211 pthread_mutex_unlock(®istry
->lock
);
4216 ret
= ust_metadata_session_statedump(registry
, NULL
,
4217 registry
->major
, registry
->minor
);
4219 pthread_mutex_unlock(®istry
->lock
);
4220 ERR("Failed to generate session metadata (err = %d)",
4224 cds_lfht_for_each_entry(registry
->channels
->ht
, &iter_chan
.iter
,
4226 struct ust_registry_event
*event
;
4227 struct lttng_ht_iter iter_event
;
4229 ret
= ust_metadata_channel_statedump(registry
, chan
);
4231 pthread_mutex_unlock(®istry
->lock
);
4232 ERR("Failed to generate channel metadata "
4236 cds_lfht_for_each_entry(chan
->ht
->ht
, &iter_event
.iter
,
4238 ret
= ust_metadata_event_statedump(registry
,
4241 pthread_mutex_unlock(®istry
->lock
);
4242 ERR("Failed to generate event metadata "
4248 pthread_mutex_unlock(®istry
->lock
);
4257 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
4259 * Ask the consumer to truncate the existing metadata file(s) and
4260 * then regenerate the metadata. Live and per-pid sessions are not
4261 * supported and return an error.
4263 * Return 0 on success or else a LTTNG_ERR code.
4265 int cmd_regenerate_metadata(struct ltt_session
*session
)
4271 ret
= check_regenerate_metadata_support(session
);
4276 if (session
->kernel_session
) {
4277 ret
= kernctl_session_regenerate_metadata(
4278 session
->kernel_session
->fd
);
4280 ERR("Failed to regenerate the kernel metadata");
4285 if (session
->ust_session
) {
4286 ret
= ust_regenerate_metadata(session
->ust_session
);
4288 ERR("Failed to regenerate the UST metadata");
4292 DBG("Cmd metadata regenerate for session %s", session
->name
);
4300 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
4302 * Ask the tracer to regenerate a new statedump.
4304 * Return 0 on success or else a LTTNG_ERR code.
4306 int cmd_regenerate_statedump(struct ltt_session
*session
)
4312 if (!session
->active
) {
4313 ret
= LTTNG_ERR_SESSION_NOT_STARTED
;
4317 if (session
->kernel_session
) {
4318 ret
= kernctl_session_regenerate_statedump(
4319 session
->kernel_session
->fd
);
4321 * Currently, the statedump in kernel can only fail if out
4325 if (ret
== -ENOMEM
) {
4326 ret
= LTTNG_ERR_REGEN_STATEDUMP_NOMEM
;
4328 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4330 ERR("Failed to regenerate the kernel statedump");
4335 if (session
->ust_session
) {
4336 ret
= ust_app_regenerate_statedump_all(session
->ust_session
);
4338 * Currently, the statedump in UST always returns 0.
4341 ret
= LTTNG_ERR_REGEN_STATEDUMP_FAIL
;
4342 ERR("Failed to regenerate the UST statedump");
4346 DBG("Cmd regenerate statedump for session %s", session
->name
);
4353 /* TODO: is this the best place to perform this? (code wise) */
4355 * Set sock to -1 if reception of more information is not necessary e.g on
4356 * unregister. TODO find a better way.
4358 * On success LTTNG_OK. On error, returns lttng_error code.
4360 static enum lttng_error_code
prepare_trigger_object(struct lttng_trigger
*trigger
, int sock
)
4362 enum lttng_error_code ret
;
4363 /* Internal object of the trigger might have to "generate" and
4364 * "populate" internal field e.g filter bytecode
4366 struct lttng_condition
*condition
= NULL
;
4368 condition
= lttng_trigger_get_condition(trigger
);
4370 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4374 switch (lttng_condition_get_type(condition
)) {
4375 case LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
:
4377 struct lttng_event_rule
*event_rule
;
4378 const struct lttng_credentials
*credential
= lttng_trigger_get_credentials(trigger
);
4379 lttng_condition_event_rule_get_rule_no_const(
4380 condition
, &event_rule
);
4381 ret
= lttng_event_rule_populate(event_rule
, credential
->uid
, credential
->gid
);
4382 if (ret
!= LTTNG_OK
) {
4386 switch (lttng_event_rule_get_type(event_rule
)) {
4387 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
4390 struct lttng_userspace_probe_location
*location
= lttng_event_rule_uprobe_get_location_no_const(event_rule
);
4393 /* Nothing to receive */
4397 * Receive the file descriptor to the target binary from
4400 DBG("Receiving userspace probe target FD from client ...");
4401 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
4403 DBG("Nothing recv() from client userspace probe fd... continuing");
4404 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
4409 * Set the file descriptor received from the client
4410 * through the unix socket in the probe location.
4412 ret
= lttng_userspace_probe_location_set_binary_fd(
4415 ret
= LTTNG_ERR_PROBE_LOCATION_INVAL
;
4426 /* Generate the capture bytecode set */
4427 ret
= lttng_condition_event_rule_generate_capture_descriptor_bytecode_set(
4428 condition
, &trigger
->capture_bytecode_set
);
4443 /* Caller must call lttng_destroy_trigger on the returned trigger object */
4444 int cmd_register_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4445 struct notification_thread_handle
*notification_thread
,
4446 struct lttng_trigger
**return_trigger
)
4450 ssize_t sock_recv_len
;
4451 struct lttng_trigger
*trigger
= NULL
;
4452 struct lttng_buffer_view view
;
4453 struct lttng_dynamic_buffer trigger_buffer
;
4455 lttng_dynamic_buffer_init(&trigger_buffer
);
4456 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4457 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4459 ret
= LTTNG_ERR_NOMEM
;
4463 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4465 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4466 ERR("Failed to receive \"register trigger\" command payload");
4467 /* TODO: should this be a new error enum ? */
4468 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4472 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4473 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4475 ERR("Invalid trigger payload received in \"register trigger\" command");
4476 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4481 * Since we return the trigger object, take a reference to it
4482 * Caller is responsible for calling lttng_destroy_trigger on it.
4483 * This thread does not OWN the trigger.
4485 lttng_trigger_get(trigger
);
4487 /* Set the trigger credential */
4488 lttng_trigger_set_credentials(trigger
, cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
4490 /* Prepare internal trigger object if needed on reception.
4491 * Handles also special treatment for certain internal object of the
4492 * trigger (e.g uprobe event rule binary fd.
4494 ret
= prepare_trigger_object(trigger
, sock
);
4495 if (ret
!= LTTNG_OK
) {
4499 /* Inform the notification thread */
4500 ret
= notification_thread_command_register_trigger(notification_thread
,
4502 if (ret
!= LTTNG_OK
) {
4506 /* Synchronize tracers, only if needed */
4507 /* TODO: maybe extract somewhere else */
4509 struct lttng_condition
*condition
= NULL
;
4510 condition
= lttng_trigger_get_condition(trigger
);
4512 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4516 if (lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
) {
4517 const struct lttng_event_rule
*rule
= NULL
;
4518 (void) lttng_condition_event_rule_get_rule(condition
, &rule
);
4520 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4523 if (lttng_event_rule_get_domain_type(rule
) == LTTNG_DOMAIN_KERNEL
) {
4524 /* TODO: get the token value from the
4525 * notification thread and only perform an
4526 * enable and a disable.... This is NOT
4529 kernel_update_tokens();
4531 /* TODO: get the token value from the
4532 * notification thread and only perform an
4533 * enable and a disable.... This is NOT
4536 ust_app_global_update_all_tokens();
4537 /* Agent handling */
4538 if (lttng_event_rule_is_agent(rule
)) {
4540 const char *pattern
;
4541 enum lttng_domain_type domain_type
;
4542 domain_type
= lttng_event_rule_get_domain_type(
4544 (void) lttng_event_rule_tracepoint_get_pattern(
4546 agt
= trigger_find_agent(domain_type
);
4548 agt
= agent_create(domain_type
);
4550 ret
= LTTNG_ERR_NOMEM
;
4553 agent_add(agt
, trigger_agents_ht_by_domain
);
4556 ret
= trigger_agent_enable(
4558 if (ret
!= LTTNG_OK
) {
4566 /* Return an image of the updated object to the client */
4567 *return_trigger
= trigger
;
4568 /* Ownership of trigger was transferred to caller. */
4571 lttng_trigger_destroy(trigger
);
4572 lttng_dynamic_buffer_reset(&trigger_buffer
);
4576 int cmd_unregister_trigger(struct command_ctx
*cmd_ctx
, int sock
,
4577 struct notification_thread_handle
*notification_thread
)
4581 ssize_t sock_recv_len
;
4582 struct lttng_trigger
*trigger
= NULL
;
4583 struct lttng_buffer_view view
;
4584 struct lttng_dynamic_buffer trigger_buffer
;
4586 lttng_dynamic_buffer_init(&trigger_buffer
);
4587 trigger_len
= (size_t) cmd_ctx
->lsm
->u
.trigger
.length
;
4588 ret
= lttng_dynamic_buffer_set_size(&trigger_buffer
, trigger_len
);
4590 ret
= LTTNG_ERR_NOMEM
;
4594 sock_recv_len
= lttcomm_recv_unix_sock(sock
, trigger_buffer
.data
,
4596 if (sock_recv_len
< 0 || sock_recv_len
!= trigger_len
) {
4597 ERR("Failed to receive \"unregister trigger\" command payload");
4598 /* TODO: should this be a new error enum ? */
4599 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4603 view
= lttng_buffer_view_from_dynamic_buffer(&trigger_buffer
, 0, -1);
4604 if (lttng_trigger_create_from_buffer(&view
, &trigger
) !=
4606 ERR("Invalid trigger payload received in \"unregister trigger\" command");
4607 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4611 lttng_trigger_set_credentials(trigger
, cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
);
4613 ret
= prepare_trigger_object(trigger
, -1);
4614 if (ret
!= LTTNG_OK
) {
4618 ret
= notification_thread_command_unregister_trigger(notification_thread
,
4621 /* Synchronize tracers, only if needed */
4622 /* TODO: maybe extract somewhere else */
4624 struct lttng_condition
*condition
= NULL
;
4625 condition
= lttng_trigger_get_condition(trigger
);
4627 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4631 if (lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
) {
4632 const struct lttng_event_rule
*rule
= NULL
;
4633 (void) lttng_condition_event_rule_get_rule(condition
, &rule
);
4635 ret
= LTTNG_ERR_INVALID_TRIGGER
;
4638 if (lttng_event_rule_get_domain_type(rule
) == LTTNG_DOMAIN_KERNEL
) {
4639 /* TODO: get the token value from the
4640 * notification thread and only perform an
4641 * enable and a disable.... This is NOT
4644 kernel_update_tokens();
4646 /* TODO: get the token value from the
4647 * notification thread and only perform an
4648 * enable and a disable.... This is NOT
4651 ust_app_global_update_all_tokens();
4652 if (lttng_event_rule_is_agent(rule
)) {
4654 const char *pattern
;
4655 enum lttng_domain_type domain_type
;
4657 domain_type
= lttng_event_rule_get_domain_type(
4659 (void) lttng_event_rule_tracepoint_get_pattern(
4662 agt
= trigger_find_agent(domain_type
);
4664 ret
= LTTNG_ERR_UST_EVENT_NOT_FOUND
;
4667 ret
= trigger_agent_disable(
4669 if (ret
!= LTTNG_OK
) {
4678 lttng_trigger_destroy(trigger
);
4679 lttng_dynamic_buffer_reset(&trigger_buffer
);
4683 int cmd_list_triggers(struct command_ctx
*cmd_ctx
, int sock
,
4684 struct notification_thread_handle
*notification_thread
,
4685 struct lttng_triggers
**return_triggers
)
4688 enum lttng_error_code ret_code
;
4689 struct lttng_triggers
*triggers
= NULL
;
4691 /* Get list of token trigger from the notification thread here */
4692 ret_code
= notification_thread_command_list_triggers(notification_thread_handle
, cmd_ctx
->creds
.uid
, cmd_ctx
->creds
.gid
, &triggers
);
4693 if (ret_code
!= LTTNG_OK
) {
4698 /* Return a "view" of the current triggers */
4699 *return_triggers
= triggers
;
4703 lttng_triggers_destroy(triggers
);
4707 * Send relayd sockets from snapshot output to consumer. Ignore request if the
4708 * snapshot output is *not* set with a remote destination.
4710 * Return LTTNG_OK on success or a LTTNG_ERR code.
4712 static enum lttng_error_code
set_relayd_for_snapshot(
4713 struct consumer_output
*output
,
4714 const struct ltt_session
*session
)
4716 enum lttng_error_code status
= LTTNG_OK
;
4717 struct lttng_ht_iter iter
;
4718 struct consumer_socket
*socket
;
4719 LTTNG_OPTIONAL(uint64_t) current_chunk_id
= {};
4720 const char *base_path
;
4725 DBG2("Set relayd object from snapshot output");
4727 if (session
->current_trace_chunk
) {
4728 enum lttng_trace_chunk_status chunk_status
=
4729 lttng_trace_chunk_get_id(
4730 session
->current_trace_chunk
,
4731 ¤t_chunk_id
.value
);
4733 if (chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
) {
4734 current_chunk_id
.is_set
= true;
4736 ERR("Failed to get current trace chunk id");
4737 status
= LTTNG_ERR_UNK
;
4742 /* Ignore if snapshot consumer output is not network. */
4743 if (output
->type
!= CONSUMER_DST_NET
) {
4748 * The snapshot record URI base path overrides the session
4751 if (output
->dst
.net
.control
.subdir
[0] != '\0') {
4752 base_path
= output
->dst
.net
.control
.subdir
;
4754 base_path
= session
->base_path
;
4758 * For each consumer socket, create and send the relayd object of the
4762 cds_lfht_for_each_entry(output
->socks
->ht
, &iter
.iter
,
4763 socket
, node
.node
) {
4764 pthread_mutex_lock(socket
->lock
);
4765 status
= send_consumer_relayd_sockets(0, session
->id
,
4767 session
->name
, session
->hostname
,
4769 session
->live_timer
,
4770 current_chunk_id
.is_set
? ¤t_chunk_id
.value
: NULL
,
4771 session
->creation_time
,
4772 session
->name_contains_creation_time
);
4773 pthread_mutex_unlock(socket
->lock
);
4774 if (status
!= LTTNG_OK
) {
4786 * Record a kernel snapshot.
4788 * Return LTTNG_OK on success or a LTTNG_ERR code.
4790 static enum lttng_error_code
record_kernel_snapshot(
4791 struct ltt_kernel_session
*ksess
,
4792 const struct consumer_output
*output
,
4793 const struct ltt_session
*session
,
4794 int wait
, uint64_t nb_packets_per_stream
)
4796 enum lttng_error_code status
;
4802 status
= kernel_snapshot_record(
4803 ksess
, output
, wait
, nb_packets_per_stream
);
4808 * Record a UST snapshot.
4810 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
4812 static enum lttng_error_code
record_ust_snapshot(struct ltt_ust_session
*usess
,
4813 const struct consumer_output
*output
,
4814 const struct ltt_session
*session
,
4815 int wait
, uint64_t nb_packets_per_stream
)
4817 enum lttng_error_code status
;
4823 status
= ust_app_snapshot_record(
4824 usess
, output
, wait
, nb_packets_per_stream
);
4829 uint64_t get_session_size_one_more_packet_per_stream(
4830 const struct ltt_session
*session
, uint64_t cur_nr_packets
)
4832 uint64_t tot_size
= 0;
4834 if (session
->kernel_session
) {
4835 struct ltt_kernel_channel
*chan
;
4836 const struct ltt_kernel_session
*ksess
=
4837 session
->kernel_session
;
4839 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
4840 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
4842 * Don't take channel into account if we
4843 * already grab all its packets.
4847 tot_size
+= chan
->channel
->attr
.subbuf_size
4848 * chan
->stream_count
;
4852 if (session
->ust_session
) {
4853 const struct ltt_ust_session
*usess
= session
->ust_session
;
4855 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
4863 * Calculate the number of packets we can grab from each stream that
4864 * fits within the overall snapshot max size.
4866 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
4867 * the number of packets per stream.
4869 * TODO: this approach is not perfect: we consider the worse case
4870 * (packet filling the sub-buffers) as an upper bound, but we could do
4871 * better if we do this calculation while we actually grab the packet
4872 * content: we would know how much padding we don't actually store into
4875 * This algorithm is currently bounded by the number of packets per
4878 * Since we call this algorithm before actually grabbing the data, it's
4879 * an approximation: for instance, applications could appear/disappear
4880 * in between this call and actually grabbing data.
4883 int64_t get_session_nb_packets_per_stream(const struct ltt_session
*session
,
4887 uint64_t cur_nb_packets
= 0;
4890 return 0; /* Infinite */
4893 size_left
= max_size
;
4895 uint64_t one_more_packet_tot_size
;
4897 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(
4898 session
, cur_nb_packets
);
4899 if (!one_more_packet_tot_size
) {
4900 /* We are already grabbing all packets. */
4903 size_left
-= one_more_packet_tot_size
;
4904 if (size_left
< 0) {
4909 if (!cur_nb_packets
&& size_left
!= max_size
) {
4910 /* Not enough room to grab one packet of each stream, error. */
4913 return cur_nb_packets
;
4917 enum lttng_error_code
snapshot_record(struct ltt_session
*session
,
4918 const struct snapshot_output
*snapshot_output
, int wait
)
4920 int64_t nb_packets_per_stream
;
4921 char snapshot_chunk_name
[LTTNG_NAME_MAX
];
4923 enum lttng_error_code ret_code
= LTTNG_OK
;
4924 struct lttng_trace_chunk
*snapshot_trace_chunk
;
4925 struct consumer_output
*original_ust_consumer_output
= NULL
;
4926 struct consumer_output
*original_kernel_consumer_output
= NULL
;
4927 struct consumer_output
*snapshot_ust_consumer_output
= NULL
;
4928 struct consumer_output
*snapshot_kernel_consumer_output
= NULL
;
4930 ret
= snprintf(snapshot_chunk_name
, sizeof(snapshot_chunk_name
),
4932 snapshot_output
->name
,
4933 snapshot_output
->datetime
,
4934 snapshot_output
->nb_snapshot
);
4935 if (ret
< 0 || ret
>= sizeof(snapshot_chunk_name
)) {
4936 ERR("Failed to format snapshot name");
4937 ret_code
= LTTNG_ERR_INVALID
;
4940 DBG("Recording snapshot \"%s\" for session \"%s\" with chunk name \"%s\"",
4941 snapshot_output
->name
, session
->name
,
4942 snapshot_chunk_name
);
4943 if (!session
->kernel_session
&& !session
->ust_session
) {
4944 ERR("Failed to record snapshot as no channels exist");
4945 ret_code
= LTTNG_ERR_NO_CHANNEL
;
4949 if (session
->kernel_session
) {
4950 original_kernel_consumer_output
=
4951 session
->kernel_session
->consumer
;
4952 snapshot_kernel_consumer_output
=
4953 consumer_copy_output(snapshot_output
->consumer
);
4954 strcpy(snapshot_kernel_consumer_output
->chunk_path
,
4955 snapshot_chunk_name
);
4956 ret
= consumer_copy_sockets(snapshot_kernel_consumer_output
,
4957 original_kernel_consumer_output
);
4959 ERR("Failed to copy consumer sockets from snapshot output configuration");
4960 ret_code
= LTTNG_ERR_NOMEM
;
4963 ret_code
= set_relayd_for_snapshot(
4964 snapshot_kernel_consumer_output
, session
);
4965 if (ret_code
!= LTTNG_OK
) {
4966 ERR("Failed to setup relay daemon for kernel tracer snapshot");
4969 session
->kernel_session
->consumer
=
4970 snapshot_kernel_consumer_output
;
4972 if (session
->ust_session
) {
4973 original_ust_consumer_output
= session
->ust_session
->consumer
;
4974 snapshot_ust_consumer_output
=
4975 consumer_copy_output(snapshot_output
->consumer
);
4976 strcpy(snapshot_ust_consumer_output
->chunk_path
,
4977 snapshot_chunk_name
);
4978 ret
= consumer_copy_sockets(snapshot_ust_consumer_output
,
4979 original_ust_consumer_output
);
4981 ERR("Failed to copy consumer sockets from snapshot output configuration");
4982 ret_code
= LTTNG_ERR_NOMEM
;
4985 ret_code
= set_relayd_for_snapshot(
4986 snapshot_ust_consumer_output
, session
);
4987 if (ret_code
!= LTTNG_OK
) {
4988 ERR("Failed to setup relay daemon for userspace tracer snapshot");
4991 session
->ust_session
->consumer
=
4992 snapshot_ust_consumer_output
;
4995 snapshot_trace_chunk
= session_create_new_trace_chunk(session
,
4996 snapshot_kernel_consumer_output
?:
4997 snapshot_ust_consumer_output
,
4998 consumer_output_get_base_path(
4999 snapshot_output
->consumer
),
5000 snapshot_chunk_name
);
5001 if (!snapshot_trace_chunk
) {
5002 ERR("Failed to create temporary trace chunk to record a snapshot of session \"%s\"",
5004 ret_code
= LTTNG_ERR_CREATE_DIR_FAIL
;
5007 assert(!session
->current_trace_chunk
);
5008 ret
= session_set_trace_chunk(session
, snapshot_trace_chunk
, NULL
);
5009 lttng_trace_chunk_put(snapshot_trace_chunk
);
5010 snapshot_trace_chunk
= NULL
;
5012 ERR("Failed to set temporary trace chunk to record a snapshot of session \"%s\"",
5014 ret_code
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5018 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
5019 snapshot_output
->max_size
);
5020 if (nb_packets_per_stream
< 0) {
5021 ret_code
= LTTNG_ERR_MAX_SIZE_INVALID
;
5022 goto error_close_trace_chunk
;
5025 if (session
->kernel_session
) {
5026 ret_code
= record_kernel_snapshot(session
->kernel_session
,
5027 snapshot_kernel_consumer_output
, session
,
5028 wait
, nb_packets_per_stream
);
5029 if (ret_code
!= LTTNG_OK
) {
5030 goto error_close_trace_chunk
;
5034 if (session
->ust_session
) {
5035 ret_code
= record_ust_snapshot(session
->ust_session
,
5036 snapshot_ust_consumer_output
, session
,
5037 wait
, nb_packets_per_stream
);
5038 if (ret_code
!= LTTNG_OK
) {
5039 goto error_close_trace_chunk
;
5043 error_close_trace_chunk
:
5044 if (session_set_trace_chunk(session
, NULL
, &snapshot_trace_chunk
)) {
5045 ERR("Failed to release the current trace chunk of session \"%s\"",
5047 ret_code
= LTTNG_ERR_UNK
;
5050 if (session_close_trace_chunk(session
, snapshot_trace_chunk
,
5051 LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION
, NULL
)) {
5053 * Don't goto end; make sure the chunk is closed for the session
5054 * to allow future snapshots.
5056 ERR("Failed to close snapshot trace chunk of session \"%s\"",
5058 ret_code
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5061 if (original_ust_consumer_output
) {
5062 session
->ust_session
->consumer
= original_ust_consumer_output
;
5064 if (original_kernel_consumer_output
) {
5065 session
->kernel_session
->consumer
=
5066 original_kernel_consumer_output
;
5068 consumer_output_put(snapshot_ust_consumer_output
);
5069 consumer_output_put(snapshot_kernel_consumer_output
);
5074 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
5076 * The wait parameter is ignored so this call always wait for the snapshot to
5077 * complete before returning.
5079 * Return LTTNG_OK on success or else a LTTNG_ERR code.
5081 int cmd_snapshot_record(struct ltt_session
*session
,
5082 const struct lttng_snapshot_output
*output
, int wait
)
5084 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5086 unsigned int snapshot_success
= 0;
5088 struct snapshot_output
*tmp_output
= NULL
;
5093 DBG("Cmd snapshot record for session %s", session
->name
);
5095 /* Get the datetime for the snapshot output directory. */
5096 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
5099 cmd_ret
= LTTNG_ERR_INVALID
;
5104 * Permission denied to create an output if the session is not
5105 * set in no output mode.
5107 if (session
->output_traces
) {
5108 cmd_ret
= LTTNG_ERR_NOT_SNAPSHOT_SESSION
;
5112 /* The session needs to be started at least once. */
5113 if (!session
->has_been_started
) {
5114 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5118 /* Use temporary output for the session. */
5119 if (*output
->ctrl_url
!= '\0') {
5120 tmp_output
= snapshot_output_alloc();
5122 cmd_ret
= LTTNG_ERR_NOMEM
;
5126 ret
= snapshot_output_init(session
, output
->max_size
,
5128 output
->ctrl_url
, output
->data_url
,
5132 if (ret
== -ENOMEM
) {
5133 cmd_ret
= LTTNG_ERR_NOMEM
;
5135 cmd_ret
= LTTNG_ERR_INVALID
;
5139 /* Use the global session count for the temporary snapshot. */
5140 tmp_output
->nb_snapshot
= session
->snapshot
.nb_snapshot
;
5142 /* Use the global datetime */
5143 memcpy(tmp_output
->datetime
, datetime
, sizeof(datetime
));
5144 cmd_ret
= snapshot_record(session
, tmp_output
, wait
);
5145 if (cmd_ret
!= LTTNG_OK
) {
5148 snapshot_success
= 1;
5150 struct snapshot_output
*sout
;
5151 struct lttng_ht_iter iter
;
5154 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
5155 &iter
.iter
, sout
, node
.node
) {
5156 struct snapshot_output output_copy
;
5159 * Make a local copy of the output and override output
5160 * parameters with those provided as part of the
5163 memcpy(&output_copy
, sout
, sizeof(output_copy
));
5165 if (output
->max_size
!= (uint64_t) -1ULL) {
5166 output_copy
.max_size
= output
->max_size
;
5169 output_copy
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
5170 memcpy(output_copy
.datetime
, datetime
,
5173 /* Use temporary name. */
5174 if (*output
->name
!= '\0') {
5175 if (lttng_strncpy(output_copy
.name
,
5177 sizeof(output_copy
.name
))) {
5178 cmd_ret
= LTTNG_ERR_INVALID
;
5184 cmd_ret
= snapshot_record(session
, &output_copy
, wait
);
5185 if (cmd_ret
!= LTTNG_OK
) {
5189 snapshot_success
= 1;
5194 if (snapshot_success
) {
5195 session
->snapshot
.nb_snapshot
++;
5197 cmd_ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
5202 snapshot_output_destroy(tmp_output
);
5208 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
5210 int cmd_set_session_shm_path(struct ltt_session
*session
,
5211 const char *shm_path
)
5217 * Can only set shm path before session is started.
5219 if (session
->has_been_started
) {
5220 return LTTNG_ERR_SESSION_STARTED
;
5223 strncpy(session
->shm_path
, shm_path
,
5224 sizeof(session
->shm_path
));
5225 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
5231 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
5233 * Ask the consumer to rotate the session output directory.
5234 * The session lock must be held.
5236 * Returns LTTNG_OK on success or else a negative LTTng error code.
5238 int cmd_rotate_session(struct ltt_session
*session
,
5239 struct lttng_rotate_session_return
*rotate_return
,
5240 bool quiet_rotation
,
5241 enum lttng_trace_chunk_command_type command
)
5244 uint64_t ongoing_rotation_chunk_id
;
5245 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5246 struct lttng_trace_chunk
*chunk_being_archived
= NULL
;
5247 struct lttng_trace_chunk
*new_trace_chunk
= NULL
;
5248 enum lttng_trace_chunk_status chunk_status
;
5249 bool failed_to_rotate
= false;
5250 enum lttng_error_code rotation_fail_code
= LTTNG_OK
;
5254 if (!session
->has_been_started
) {
5255 cmd_ret
= LTTNG_ERR_START_SESSION_ONCE
;
5260 * Explicit rotation is not supported for live sessions.
5261 * However, live sessions can perform a quiet rotation on
5263 * Rotation is not supported for snapshot traces (no output).
5265 if ((!quiet_rotation
&& session
->live_timer
) ||
5266 !session
->output_traces
) {
5267 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5271 /* Unsupported feature in lttng-relayd before 2.11. */
5272 if (!quiet_rotation
&& session
->consumer
->type
== CONSUMER_DST_NET
&&
5273 (session
->consumer
->relay_major_version
== 2 &&
5274 session
->consumer
->relay_minor_version
< 11)) {
5275 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_RELAY
;
5279 /* Unsupported feature in lttng-modules before 2.8 (lack of sequence number). */
5280 if (session
->kernel_session
&& !kernel_supports_ring_buffer_packet_sequence_number()) {
5281 cmd_ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE_KERNEL
;
5285 if (session
->rotation_state
== LTTNG_ROTATION_STATE_ONGOING
) {
5286 DBG("Refusing to launch a rotation; a rotation is already in progress for session %s",
5288 cmd_ret
= LTTNG_ERR_ROTATION_PENDING
;
5293 * After a stop, we only allow one rotation to occur, the other ones are
5294 * useless until a new start.
5296 if (session
->rotated_after_last_stop
) {
5297 DBG("Session \"%s\" was already rotated after stop, refusing rotation",
5299 cmd_ret
= LTTNG_ERR_ROTATION_MULTIPLE_AFTER_STOP
;
5304 * After a stop followed by a clear, disallow following rotations a they would
5305 * generate empty chunks.
5307 if (session
->cleared_after_last_stop
) {
5308 DBG("Session \"%s\" was already cleared after stop, refusing rotation",
5310 cmd_ret
= LTTNG_ERR_ROTATION_AFTER_STOP_CLEAR
;
5314 if (session
->active
) {
5315 new_trace_chunk
= session_create_new_trace_chunk(session
, NULL
,
5317 if (!new_trace_chunk
) {
5318 cmd_ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
5324 * The current trace chunk becomes the chunk being archived.
5326 * After this point, "chunk_being_archived" must absolutely
5327 * be closed on the consumer(s), otherwise it will never be
5328 * cleaned-up, which will result in a leak.
5330 ret
= session_set_trace_chunk(session
, new_trace_chunk
,
5331 &chunk_being_archived
);
5333 cmd_ret
= LTTNG_ERR_CREATE_TRACE_CHUNK_FAIL_CONSUMER
;
5337 if (session
->kernel_session
) {
5338 cmd_ret
= kernel_rotate_session(session
);
5339 if (cmd_ret
!= LTTNG_OK
) {
5340 failed_to_rotate
= true;
5341 rotation_fail_code
= cmd_ret
;
5344 if (session
->ust_session
) {
5345 cmd_ret
= ust_app_rotate_session(session
);
5346 if (cmd_ret
!= LTTNG_OK
) {
5347 failed_to_rotate
= true;
5348 rotation_fail_code
= cmd_ret
;
5352 if (!session
->active
) {
5353 session
->rotated_after_last_stop
= true;
5356 if (!chunk_being_archived
) {
5357 DBG("Rotating session \"%s\" from a \"NULL\" trace chunk to a new trace chunk, skipping completion check",
5359 if (failed_to_rotate
) {
5360 cmd_ret
= rotation_fail_code
;
5367 session
->rotation_state
= LTTNG_ROTATION_STATE_ONGOING
;
5368 chunk_status
= lttng_trace_chunk_get_id(chunk_being_archived
,
5369 &ongoing_rotation_chunk_id
);
5370 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5372 ret
= session_close_trace_chunk(session
, chunk_being_archived
,
5373 command
, session
->last_chunk_path
);
5375 cmd_ret
= LTTNG_ERR_CLOSE_TRACE_CHUNK_FAIL_CONSUMER
;
5379 if (failed_to_rotate
) {
5380 cmd_ret
= rotation_fail_code
;
5384 session
->quiet_rotation
= quiet_rotation
;
5385 ret
= timer_session_rotation_pending_check_start(session
,
5386 DEFAULT_ROTATE_PENDING_TIMER
);
5388 cmd_ret
= LTTNG_ERR_UNK
;
5392 if (rotate_return
) {
5393 rotate_return
->rotation_id
= ongoing_rotation_chunk_id
;
5396 session
->chunk_being_archived
= chunk_being_archived
;
5397 chunk_being_archived
= NULL
;
5398 if (!quiet_rotation
) {
5399 ret
= notification_thread_command_session_rotation_ongoing(
5400 notification_thread_handle
,
5401 session
->name
, session
->uid
, session
->gid
,
5402 ongoing_rotation_chunk_id
);
5403 if (ret
!= LTTNG_OK
) {
5404 ERR("Failed to notify notification thread that a session rotation is ongoing for session %s",
5410 DBG("Cmd rotate session %s, archive_id %" PRIu64
" sent",
5411 session
->name
, ongoing_rotation_chunk_id
);
5413 lttng_trace_chunk_put(new_trace_chunk
);
5414 lttng_trace_chunk_put(chunk_being_archived
);
5415 ret
= (cmd_ret
== LTTNG_OK
) ? cmd_ret
: -((int) cmd_ret
);
5418 if (session_reset_rotation_state(session
,
5419 LTTNG_ROTATION_STATE_ERROR
)) {
5420 ERR("Failed to reset rotation state of session \"%s\"",
5427 * Command LTTNG_ROTATION_GET_INFO from the lttng-ctl library.
5429 * Check if the session has finished its rotation.
5431 * Return LTTNG_OK on success or else an LTTNG_ERR code.
5433 int cmd_rotate_get_info(struct ltt_session
*session
,
5434 struct lttng_rotation_get_info_return
*info_return
,
5435 uint64_t rotation_id
)
5437 enum lttng_error_code cmd_ret
= LTTNG_OK
;
5438 enum lttng_rotation_state rotation_state
;
5440 DBG("Cmd rotate_get_info session %s, rotation id %" PRIu64
, session
->name
,
5441 session
->most_recent_chunk_id
.value
);
5443 if (session
->chunk_being_archived
) {
5444 enum lttng_trace_chunk_status chunk_status
;
5447 chunk_status
= lttng_trace_chunk_get_id(
5448 session
->chunk_being_archived
,
5450 assert(chunk_status
== LTTNG_TRACE_CHUNK_STATUS_OK
);
5452 rotation_state
= rotation_id
== chunk_id
?
5453 LTTNG_ROTATION_STATE_ONGOING
:
5454 LTTNG_ROTATION_STATE_EXPIRED
;
5456 if (session
->last_archived_chunk_id
.is_set
&&
5457 rotation_id
!= session
->last_archived_chunk_id
.value
) {
5458 rotation_state
= LTTNG_ROTATION_STATE_EXPIRED
;
5460 rotation_state
= session
->rotation_state
;
5464 switch (rotation_state
) {
5465 case LTTNG_ROTATION_STATE_NO_ROTATION
:
5466 DBG("Reporting that no rotation has occurred within the lifetime of session \"%s\"",
5469 case LTTNG_ROTATION_STATE_EXPIRED
:
5470 DBG("Reporting that the rotation state of rotation id %" PRIu64
" of session \"%s\" has expired",
5471 rotation_id
, session
->name
);
5473 case LTTNG_ROTATION_STATE_ONGOING
:
5474 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is still pending",
5475 rotation_id
, session
->name
);
5477 case LTTNG_ROTATION_STATE_COMPLETED
:
5481 char *current_tracing_path_reply
;
5482 size_t current_tracing_path_reply_len
;
5484 DBG("Reporting that rotation id %" PRIu64
" of session \"%s\" is completed",
5485 rotation_id
, session
->name
);
5487 switch (session_get_consumer_destination_type(session
)) {
5488 case CONSUMER_DST_LOCAL
:
5489 current_tracing_path_reply
=
5490 info_return
->location
.local
.absolute_path
;
5491 current_tracing_path_reply_len
=
5492 sizeof(info_return
->location
.local
.absolute_path
);
5493 info_return
->location_type
=
5494 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL
;
5495 fmt_ret
= asprintf(&chunk_path
,
5496 "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY
"/%s",
5497 session_get_base_path(session
),
5498 session
->last_archived_chunk_name
);
5499 if (fmt_ret
== -1) {
5500 PERROR("Failed to format the path of the last archived trace chunk");
5501 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5502 cmd_ret
= LTTNG_ERR_UNK
;
5506 case CONSUMER_DST_NET
:
5508 uint16_t ctrl_port
, data_port
;
5510 current_tracing_path_reply
=
5511 info_return
->location
.relay
.relative_path
;
5512 current_tracing_path_reply_len
=
5513 sizeof(info_return
->location
.relay
.relative_path
);
5514 /* Currently the only supported relay protocol. */
5515 info_return
->location
.relay
.protocol
=
5516 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP
;
5518 fmt_ret
= lttng_strncpy(info_return
->location
.relay
.host
,
5519 session_get_net_consumer_hostname(session
),
5520 sizeof(info_return
->location
.relay
.host
));
5522 ERR("Failed to copy host name to rotate_get_info reply");
5523 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5524 cmd_ret
= LTTNG_ERR_SET_URL
;
5528 session_get_net_consumer_ports(session
, &ctrl_port
, &data_port
);
5529 info_return
->location
.relay
.ports
.control
= ctrl_port
;
5530 info_return
->location
.relay
.ports
.data
= data_port
;
5531 info_return
->location_type
=
5532 (int8_t) LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY
;
5533 chunk_path
= strdup(session
->last_chunk_path
);
5535 ERR("Failed to allocate the path of the last archived trace chunk");
5536 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5537 cmd_ret
= LTTNG_ERR_UNK
;
5546 fmt_ret
= lttng_strncpy(current_tracing_path_reply
,
5547 chunk_path
, current_tracing_path_reply_len
);
5550 ERR("Failed to copy path of the last archived trace chunk to rotate_get_info reply");
5551 info_return
->status
= LTTNG_ROTATION_STATUS_ERROR
;
5552 cmd_ret
= LTTNG_ERR_UNK
;
5558 case LTTNG_ROTATION_STATE_ERROR
:
5559 DBG("Reporting that an error occurred during rotation %" PRIu64
" of session \"%s\"",
5560 rotation_id
, session
->name
);
5568 info_return
->status
= (int32_t) rotation_state
;
5573 * Command LTTNG_ROTATION_SET_SCHEDULE from the lttng-ctl library.
5575 * Configure the automatic rotation parameters.
5576 * 'activate' to true means activate the rotation schedule type with 'new_value'.
5577 * 'activate' to false means deactivate the rotation schedule and validate that
5578 * 'new_value' has the same value as the currently active value.
5580 * Return 0 on success or else a positive LTTNG_ERR code.
5582 int cmd_rotation_set_schedule(struct ltt_session
*session
,
5583 bool activate
, enum lttng_rotation_schedule_type schedule_type
,
5585 struct notification_thread_handle
*notification_thread_handle
)
5588 uint64_t *parameter_value
;
5592 DBG("Cmd rotate set schedule session %s", session
->name
);
5594 if (session
->live_timer
|| !session
->output_traces
) {
5595 DBG("Failing ROTATION_SET_SCHEDULE command as the rotation feature is not available for this session");
5596 ret
= LTTNG_ERR_ROTATION_NOT_AVAILABLE
;
5600 switch (schedule_type
) {
5601 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5602 parameter_value
= &session
->rotate_size
;
5604 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5605 parameter_value
= &session
->rotate_timer_period
;
5606 if (new_value
>= UINT_MAX
) {
5607 DBG("Failing ROTATION_SET_SCHEDULE command as the value requested for a periodic rotation schedule is invalid: %" PRIu64
" > %u (UINT_MAX)",
5608 new_value
, UINT_MAX
);
5609 ret
= LTTNG_ERR_INVALID
;
5614 WARN("Failing ROTATION_SET_SCHEDULE command on unknown schedule type");
5615 ret
= LTTNG_ERR_INVALID
;
5619 /* Improper use of the API. */
5620 if (new_value
== -1ULL) {
5621 WARN("Failing ROTATION_SET_SCHEDULE command as the value requested is -1");
5622 ret
= LTTNG_ERR_INVALID
;
5627 * As indicated in struct ltt_session's comments, a value of == 0 means
5628 * this schedule rotation type is not in use.
5630 * Reject the command if we were asked to activate a schedule that was
5633 if (activate
&& *parameter_value
!= 0) {
5634 DBG("Failing ROTATION_SET_SCHEDULE (activate) command as the schedule is already active");
5635 ret
= LTTNG_ERR_ROTATION_SCHEDULE_SET
;
5640 * Reject the command if we were asked to deactivate a schedule that was
5643 if (!activate
&& *parameter_value
== 0) {
5644 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as the schedule is already inactive");
5645 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5650 * Reject the command if we were asked to deactivate a schedule that
5653 if (!activate
&& *parameter_value
!= new_value
) {
5654 DBG("Failing ROTATION_SET_SCHEDULE (deactivate) command as an inexistant schedule was provided");
5655 ret
= LTTNG_ERR_ROTATION_SCHEDULE_NOT_SET
;
5659 *parameter_value
= activate
? new_value
: 0;
5661 switch (schedule_type
) {
5662 case LTTNG_ROTATION_SCHEDULE_TYPE_PERIODIC
:
5663 if (activate
&& session
->active
) {
5665 * Only start the timer if the session is active,
5666 * otherwise it will be started when the session starts.
5668 ret
= timer_session_rotation_schedule_timer_start(
5669 session
, new_value
);
5671 ERR("Failed to enable session rotation timer in ROTATION_SET_SCHEDULE command");
5672 ret
= LTTNG_ERR_UNK
;
5676 ret
= timer_session_rotation_schedule_timer_stop(
5679 ERR("Failed to disable session rotation timer in ROTATION_SET_SCHEDULE command");
5680 ret
= LTTNG_ERR_UNK
;
5685 case LTTNG_ROTATION_SCHEDULE_TYPE_SIZE_THRESHOLD
:
5687 ret
= subscribe_session_consumed_size_rotation(session
,
5688 new_value
, notification_thread_handle
);
5690 ERR("Failed to enable consumed-size notification in ROTATION_SET_SCHEDULE command");
5691 ret
= LTTNG_ERR_UNK
;
5695 ret
= unsubscribe_session_consumed_size_rotation(session
,
5696 notification_thread_handle
);
5698 ERR("Failed to disable consumed-size notification in ROTATION_SET_SCHEDULE command");
5699 ret
= LTTNG_ERR_UNK
;
5706 /* Would have been caught before. */
5718 /* Wait for a given path to be removed before continuing. */
5719 static enum lttng_error_code
wait_on_path(void *path_data
)
5721 const char *shm_path
= path_data
;
5723 DBG("Waiting for the shm path at %s to be removed before completing session destruction",
5729 ret
= stat(shm_path
, &st
);
5731 if (errno
!= ENOENT
) {
5732 PERROR("stat() returned an error while checking for the existence of the shm path");
5734 DBG("shm path no longer exists, completing the destruction of session");
5738 if (!S_ISDIR(st
.st_mode
)) {
5739 ERR("The type of shm path %s returned by stat() is not a directory; aborting the wait for shm path removal",
5744 usleep(SESSION_DESTROY_SHM_PATH_CHECK_DELAY_US
);
5750 * Returns a pointer to a handler to run on completion of a command.
5751 * Returns NULL if no handler has to be run for the last command executed.
5753 const struct cmd_completion_handler
*cmd_pop_completion_handler(void)
5755 struct cmd_completion_handler
*handler
= current_completion_handler
;
5757 current_completion_handler
= NULL
;
5762 * Init command subsystem.
5767 * Set network sequence index to 1 for streams to match a relayd
5768 * socket on the consumer side.
5770 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
5771 relayd_net_seq_idx
= 1;
5772 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
5774 DBG("Command subsystem initialized");