2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <urcu/list.h>
24 #include <urcu/uatomic.h>
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
35 #include "health-sessiond.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
45 * Used to keep a unique index for each relayd socket created where this value
46 * is associated with streams on the consumer so it can match the right relayd
47 * to send to. It must be accessed with the relayd_net_seq_idx_lock
50 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 static uint64_t relayd_net_seq_idx
;
53 static int validate_event_name(const char *);
54 static int validate_ust_event_name(const char *);
55 static int cmd_enable_event_internal(struct ltt_session
*session
,
56 struct lttng_domain
*domain
,
57 char *channel_name
, struct lttng_event
*event
,
58 char *filter_expression
,
59 struct lttng_filter_bytecode
*filter
,
60 struct lttng_event_exclusion
*exclusion
,
64 * Create a session path used by list_lttng_sessions for the case that the
65 * session consumer is on the network.
67 static int build_network_session_path(char *dst
, size_t size
,
68 struct ltt_session
*session
)
70 int ret
, kdata_port
, udata_port
;
71 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
72 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
77 memset(tmp_urls
, 0, sizeof(tmp_urls
));
78 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
80 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
82 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
83 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
84 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
87 if (session
->ust_session
&& session
->ust_session
->consumer
) {
88 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
89 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
92 if (uuri
== NULL
&& kuri
== NULL
) {
93 uri
= &session
->consumer
->dst
.net
.control
;
94 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
95 } else if (kuri
&& uuri
) {
96 ret
= uri_compare(kuri
, uuri
);
100 /* Build uuri URL string */
101 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
108 } else if (kuri
&& uuri
== NULL
) {
110 } else if (uuri
&& kuri
== NULL
) {
114 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
120 * Do we have a UST url set. If yes, this means we have both kernel and UST
123 if (*tmp_uurl
!= '\0') {
124 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
125 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
128 if (kuri
|| (!kuri
&& !uuri
)) {
131 /* No kernel URI, use the UST port. */
134 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
142 * Fill lttng_channel array of all channels.
144 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
145 struct lttng_channel
*channels
)
148 struct ltt_kernel_channel
*kchan
;
150 DBG("Listing channels for session %s", session
->name
);
153 case LTTNG_DOMAIN_KERNEL
:
154 /* Kernel channels */
155 if (session
->kernel_session
!= NULL
) {
156 cds_list_for_each_entry(kchan
,
157 &session
->kernel_session
->channel_list
.head
, list
) {
158 /* Copy lttng_channel struct to array */
159 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
160 channels
[i
].enabled
= kchan
->enabled
;
165 case LTTNG_DOMAIN_UST
:
167 struct lttng_ht_iter iter
;
168 struct ltt_ust_channel
*uchan
;
171 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
172 &iter
.iter
, uchan
, node
.node
) {
173 if (lttng_strncpy(channels
[i
].name
, uchan
->name
,
174 LTTNG_SYMBOL_NAME_LEN
)) {
177 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
178 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
179 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
180 channels
[i
].attr
.switch_timer_interval
=
181 uchan
->attr
.switch_timer_interval
;
182 channels
[i
].attr
.read_timer_interval
=
183 uchan
->attr
.read_timer_interval
;
184 channels
[i
].enabled
= uchan
->enabled
;
185 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
186 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
187 switch (uchan
->attr
.output
) {
190 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
204 * Create a list of agent domain events.
206 * Return number of events in list on success or else a negative value.
208 static int list_lttng_agent_events(struct agent
*agt
,
209 struct lttng_event
**events
)
212 unsigned int nb_event
= 0;
213 struct agent_event
*event
;
214 struct lttng_event
*tmp_events
;
215 struct lttng_ht_iter iter
;
220 DBG3("Listing agent events");
223 nb_event
= lttng_ht_get_count(agt
->events
);
230 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
232 PERROR("zmalloc agent events session");
233 ret
= -LTTNG_ERR_FATAL
;
238 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
239 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
240 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
241 tmp_events
[i
].enabled
= event
->enabled
;
242 tmp_events
[i
].loglevel
= event
->loglevel_value
;
243 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
248 *events
= tmp_events
;
252 assert(nb_event
== i
);
257 * Create a list of ust global domain events.
259 static int list_lttng_ust_global_events(char *channel_name
,
260 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
263 unsigned int nb_event
= 0;
264 struct lttng_ht_iter iter
;
265 struct lttng_ht_node_str
*node
;
266 struct ltt_ust_channel
*uchan
;
267 struct ltt_ust_event
*uevent
;
268 struct lttng_event
*tmp
;
270 DBG("Listing UST global events for channel %s", channel_name
);
274 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
275 node
= lttng_ht_iter_get_node_str(&iter
);
277 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
281 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
283 nb_event
= lttng_ht_get_count(uchan
->events
);
289 DBG3("Listing UST global %d events", nb_event
);
291 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
293 ret
= LTTNG_ERR_FATAL
;
297 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
298 if (uevent
->internal
) {
299 /* This event should remain hidden from clients */
303 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
304 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
305 tmp
[i
].enabled
= uevent
->enabled
;
307 switch (uevent
->attr
.instrumentation
) {
308 case LTTNG_UST_TRACEPOINT
:
309 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
311 case LTTNG_UST_PROBE
:
312 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
314 case LTTNG_UST_FUNCTION
:
315 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
319 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
320 switch (uevent
->attr
.loglevel_type
) {
321 case LTTNG_UST_LOGLEVEL_ALL
:
322 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
324 case LTTNG_UST_LOGLEVEL_RANGE
:
325 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
327 case LTTNG_UST_LOGLEVEL_SINGLE
:
328 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
331 if (uevent
->filter
) {
334 if (uevent
->exclusion
) {
335 tmp
[i
].exclusion
= 1;
349 * Fill lttng_event array of all kernel events in the channel.
351 static int list_lttng_kernel_events(char *channel_name
,
352 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
355 unsigned int nb_event
;
356 struct ltt_kernel_event
*event
;
357 struct ltt_kernel_channel
*kchan
;
359 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
361 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
365 nb_event
= kchan
->event_count
;
367 DBG("Listing events for channel %s", kchan
->channel
->name
);
374 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
375 if (*events
== NULL
) {
376 ret
= LTTNG_ERR_FATAL
;
380 /* Kernel channels */
381 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
382 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
383 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
384 (*events
)[i
].enabled
= event
->enabled
;
385 (*events
)[i
].filter
=
386 (unsigned char) !!event
->filter_expression
;
388 switch (event
->event
->instrumentation
) {
389 case LTTNG_KERNEL_TRACEPOINT
:
390 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
392 case LTTNG_KERNEL_KRETPROBE
:
393 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
394 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
395 sizeof(struct lttng_kernel_kprobe
));
397 case LTTNG_KERNEL_KPROBE
:
398 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
399 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
400 sizeof(struct lttng_kernel_kprobe
));
402 case LTTNG_KERNEL_FUNCTION
:
403 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
404 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
405 sizeof(struct lttng_kernel_function
));
407 case LTTNG_KERNEL_NOOP
:
408 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
410 case LTTNG_KERNEL_SYSCALL
:
411 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
413 case LTTNG_KERNEL_ALL
:
424 /* Negate the error code to differentiate the size from an error */
429 * Add URI so the consumer output object. Set the correct path depending on the
430 * domain adding the default trace directory.
432 static int add_uri_to_consumer(struct consumer_output
*consumer
,
433 struct lttng_uri
*uri
, int domain
, const char *session_name
)
436 const char *default_trace_dir
;
440 if (consumer
== NULL
) {
441 DBG("No consumer detected. Don't add URI. Stopping.");
442 ret
= LTTNG_ERR_NO_CONSUMER
;
447 case LTTNG_DOMAIN_KERNEL
:
448 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
450 case LTTNG_DOMAIN_UST
:
451 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
455 * This case is possible is we try to add the URI to the global tracing
456 * session consumer object which in this case there is no subdir.
458 default_trace_dir
= "";
461 switch (uri
->dtype
) {
464 DBG2("Setting network URI to consumer");
466 if (consumer
->type
== CONSUMER_DST_NET
) {
467 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
468 consumer
->dst
.net
.control_isset
) ||
469 (uri
->stype
== LTTNG_STREAM_DATA
&&
470 consumer
->dst
.net
.data_isset
)) {
471 ret
= LTTNG_ERR_URL_EXIST
;
475 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
478 consumer
->type
= CONSUMER_DST_NET
;
480 /* Set URI into consumer output object */
481 ret
= consumer_set_network_uri(consumer
, uri
);
485 } else if (ret
== 1) {
487 * URI was the same in the consumer so we do not append the subdir
488 * again so to not duplicate output dir.
494 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
495 ret
= consumer_set_subdir(consumer
, session_name
);
497 ret
= LTTNG_ERR_FATAL
;
502 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
503 /* On a new subdir, reappend the default trace dir. */
504 strncat(consumer
->subdir
, default_trace_dir
,
505 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
506 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
511 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
512 memset(consumer
->dst
.trace_path
, 0,
513 sizeof(consumer
->dst
.trace_path
));
514 /* Explicit length checks for strcpy and strcat. */
515 if (strlen(uri
->dst
.path
) + strlen(default_trace_dir
)
516 >= sizeof(consumer
->dst
.trace_path
)) {
517 ret
= LTTNG_ERR_FATAL
;
520 strcpy(consumer
->dst
.trace_path
, uri
->dst
.path
);
521 /* Append default trace dir */
522 strcat(consumer
->dst
.trace_path
, default_trace_dir
);
523 /* Flag consumer as local. */
524 consumer
->type
= CONSUMER_DST_LOCAL
;
535 * Init tracing by creating trace directory and sending fds kernel consumer.
537 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
540 struct lttng_ht_iter iter
;
541 struct consumer_socket
*socket
;
547 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
548 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
550 pthread_mutex_lock(socket
->lock
);
551 ret
= kernel_consumer_send_session(socket
, session
);
552 pthread_mutex_unlock(socket
->lock
);
554 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
566 * Create a socket to the relayd using the URI.
568 * On success, the relayd_sock pointer is set to the created socket.
569 * Else, it's stays untouched and a lttcomm error code is returned.
571 static int create_connect_relayd(struct lttng_uri
*uri
,
572 struct lttcomm_relayd_sock
**relayd_sock
)
575 struct lttcomm_relayd_sock
*rsock
;
577 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
578 RELAYD_VERSION_COMM_MINOR
);
580 ret
= LTTNG_ERR_FATAL
;
585 * Connect to relayd so we can proceed with a session creation. This call
586 * can possibly block for an arbitrary amount of time to set the health
587 * state to be in poll execution.
590 ret
= relayd_connect(rsock
);
593 ERR("Unable to reach lttng-relayd");
594 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
598 /* Create socket for control stream. */
599 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
600 DBG3("Creating relayd stream socket from URI");
602 /* Check relayd version */
603 ret
= relayd_version_check(rsock
);
605 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
608 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
609 DBG3("Creating relayd data socket from URI");
611 /* Command is not valid */
612 ERR("Relayd invalid stream type: %d", uri
->stype
);
613 ret
= LTTNG_ERR_INVALID
;
617 *relayd_sock
= rsock
;
622 /* The returned value is not useful since we are on an error path. */
623 (void) relayd_close(rsock
);
631 * Connect to the relayd using URI and send the socket to the right consumer.
633 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
634 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
635 struct consumer_socket
*consumer_sock
,
636 char *session_name
, char *hostname
, int session_live_timer
)
639 struct lttcomm_relayd_sock
*rsock
= NULL
;
641 /* Connect to relayd and make version check if uri is the control. */
642 ret
= create_connect_relayd(relayd_uri
, &rsock
);
643 if (ret
!= LTTNG_OK
) {
648 /* Set the network sequence index if not set. */
649 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
650 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
652 * Increment net_seq_idx because we are about to transfer the
653 * new relayd socket to the consumer.
654 * Assign unique key so the consumer can match streams.
656 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
657 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
660 /* Send relayd socket to consumer. */
661 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
662 relayd_uri
->stype
, session_id
,
663 session_name
, hostname
, session_live_timer
);
665 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
669 /* Flag that the corresponding socket was sent. */
670 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
671 consumer_sock
->control_sock_sent
= 1;
672 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
673 consumer_sock
->data_sock_sent
= 1;
679 * Close socket which was dup on the consumer side. The session daemon does
680 * NOT keep track of the relayd socket(s) once transfer to the consumer.
684 (void) relayd_close(rsock
);
688 if (ret
!= LTTNG_OK
) {
690 * The consumer output for this session should not be used anymore
691 * since the relayd connection failed thus making any tracing or/and
692 * streaming not usable.
694 consumer
->enabled
= 0;
700 * Send both relayd sockets to a specific consumer and domain. This is a
701 * helper function to facilitate sending the information to the consumer for a
704 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
705 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
706 char *session_name
, char *hostname
, int session_live_timer
)
713 /* Sending control relayd socket. */
714 if (!sock
->control_sock_sent
) {
715 ret
= send_consumer_relayd_socket(domain
, session_id
,
716 &consumer
->dst
.net
.control
, consumer
, sock
,
717 session_name
, hostname
, session_live_timer
);
718 if (ret
!= LTTNG_OK
) {
723 /* Sending data relayd socket. */
724 if (!sock
->data_sock_sent
) {
725 ret
= send_consumer_relayd_socket(domain
, session_id
,
726 &consumer
->dst
.net
.data
, consumer
, sock
,
727 session_name
, hostname
, session_live_timer
);
728 if (ret
!= LTTNG_OK
) {
738 * Setup relayd connections for a tracing session. First creates the socket to
739 * the relayd and send them to the right domain consumer. Consumer type MUST be
742 int cmd_setup_relayd(struct ltt_session
*session
)
745 struct ltt_ust_session
*usess
;
746 struct ltt_kernel_session
*ksess
;
747 struct consumer_socket
*socket
;
748 struct lttng_ht_iter iter
;
752 usess
= session
->ust_session
;
753 ksess
= session
->kernel_session
;
755 DBG("Setting relayd for session %s", session
->name
);
759 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
760 && usess
->consumer
->enabled
) {
761 /* For each consumer socket, send relayd sockets */
762 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
764 pthread_mutex_lock(socket
->lock
);
765 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
766 usess
->consumer
, socket
,
767 session
->name
, session
->hostname
,
768 session
->live_timer
);
769 pthread_mutex_unlock(socket
->lock
);
770 if (ret
!= LTTNG_OK
) {
773 /* Session is now ready for network streaming. */
774 session
->net_handle
= 1;
778 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
779 && ksess
->consumer
->enabled
) {
780 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
782 pthread_mutex_lock(socket
->lock
);
783 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
784 ksess
->consumer
, socket
,
785 session
->name
, session
->hostname
,
786 session
->live_timer
);
787 pthread_mutex_unlock(socket
->lock
);
788 if (ret
!= LTTNG_OK
) {
791 /* Session is now ready for network streaming. */
792 session
->net_handle
= 1;
802 * Start a kernel session by opening all necessary streams.
804 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
807 struct ltt_kernel_channel
*kchan
;
809 /* Open kernel metadata */
810 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
811 ret
= kernel_open_metadata(ksess
);
813 ret
= LTTNG_ERR_KERN_META_FAIL
;
818 /* Open kernel metadata stream */
819 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
820 ret
= kernel_open_metadata_stream(ksess
);
822 ERR("Kernel create metadata stream failed");
823 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
828 /* For each channel */
829 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
830 if (kchan
->stream_count
== 0) {
831 ret
= kernel_open_channel_stream(kchan
);
833 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
836 /* Update the stream global counter */
837 ksess
->stream_count_global
+= ret
;
841 /* Setup kernel consumer socket and send fds to it */
842 ret
= init_kernel_tracing(ksess
);
844 ret
= LTTNG_ERR_KERN_START_FAIL
;
848 /* This start the kernel tracing */
849 ret
= kernel_start_session(ksess
);
851 ret
= LTTNG_ERR_KERN_START_FAIL
;
855 /* Quiescent wait after starting trace */
856 kernel_wait_quiescent(kernel_tracer_fd
);
867 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
869 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
873 struct ltt_ust_session
*usess
;
875 usess
= session
->ust_session
;
880 case LTTNG_DOMAIN_KERNEL
:
882 ret
= channel_kernel_disable(session
->kernel_session
,
884 if (ret
!= LTTNG_OK
) {
888 kernel_wait_quiescent(kernel_tracer_fd
);
891 case LTTNG_DOMAIN_UST
:
893 struct ltt_ust_channel
*uchan
;
894 struct lttng_ht
*chan_ht
;
896 chan_ht
= usess
->domain_global
.channels
;
898 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
900 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
904 ret
= channel_ust_disable(usess
, uchan
);
905 if (ret
!= LTTNG_OK
) {
911 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
923 * Command LTTNG_TRACK_PID processed by the client thread.
925 * Called with session lock held.
927 int cmd_track_pid(struct ltt_session
*session
, int domain
, int pid
)
934 case LTTNG_DOMAIN_KERNEL
:
936 struct ltt_kernel_session
*ksess
;
938 ksess
= session
->kernel_session
;
940 ret
= kernel_track_pid(ksess
, pid
);
941 if (ret
!= LTTNG_OK
) {
945 kernel_wait_quiescent(kernel_tracer_fd
);
948 case LTTNG_DOMAIN_UST
:
950 struct ltt_ust_session
*usess
;
952 usess
= session
->ust_session
;
954 ret
= trace_ust_track_pid(usess
, pid
);
955 if (ret
!= LTTNG_OK
) {
961 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
973 * Command LTTNG_UNTRACK_PID processed by the client thread.
975 * Called with session lock held.
977 int cmd_untrack_pid(struct ltt_session
*session
, int domain
, int pid
)
984 case LTTNG_DOMAIN_KERNEL
:
986 struct ltt_kernel_session
*ksess
;
988 ksess
= session
->kernel_session
;
990 ret
= kernel_untrack_pid(ksess
, pid
);
991 if (ret
!= LTTNG_OK
) {
995 kernel_wait_quiescent(kernel_tracer_fd
);
998 case LTTNG_DOMAIN_UST
:
1000 struct ltt_ust_session
*usess
;
1002 usess
= session
->ust_session
;
1004 ret
= trace_ust_untrack_pid(usess
, pid
);
1005 if (ret
!= LTTNG_OK
) {
1011 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1023 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1025 * The wpipe arguments is used as a notifier for the kernel thread.
1027 int cmd_enable_channel(struct ltt_session
*session
,
1028 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1031 struct ltt_ust_session
*usess
= session
->ust_session
;
1032 struct lttng_ht
*chan_ht
;
1039 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1041 /* Validate channel name */
1042 if (attr
->name
[0] == '.' ||
1043 memchr(attr
->name
, '/', len
) != NULL
) {
1044 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1048 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1053 * Don't try to enable a channel if the session has been started at
1054 * some point in time before. The tracer does not allow it.
1056 if (session
->has_been_started
) {
1057 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1062 * If the session is a live session, remove the switch timer, the
1063 * live timer does the same thing but sends also synchronisation
1064 * beacons for inactive streams.
1066 if (session
->live_timer
> 0) {
1067 attr
->attr
.live_timer_interval
= session
->live_timer
;
1068 attr
->attr
.switch_timer_interval
= 0;
1071 switch (domain
->type
) {
1072 case LTTNG_DOMAIN_KERNEL
:
1074 struct ltt_kernel_channel
*kchan
;
1076 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1077 session
->kernel_session
);
1078 if (kchan
== NULL
) {
1079 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1080 if (attr
->name
[0] != '\0') {
1081 session
->kernel_session
->has_non_default_channel
= 1;
1084 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1087 if (ret
!= LTTNG_OK
) {
1091 kernel_wait_quiescent(kernel_tracer_fd
);
1094 case LTTNG_DOMAIN_UST
:
1095 case LTTNG_DOMAIN_JUL
:
1096 case LTTNG_DOMAIN_LOG4J
:
1097 case LTTNG_DOMAIN_PYTHON
:
1099 struct ltt_ust_channel
*uchan
;
1104 * Current agent implementation limitations force us to allow
1105 * only one channel at once in "agent" subdomains. Each
1106 * subdomain has a default channel name which must be strictly
1109 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1110 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1111 LTTNG_SYMBOL_NAME_LEN
)) {
1112 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1115 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1116 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1117 LTTNG_SYMBOL_NAME_LEN
)) {
1118 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1121 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1122 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1123 LTTNG_SYMBOL_NAME_LEN
)) {
1124 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1129 chan_ht
= usess
->domain_global
.channels
;
1131 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1132 if (uchan
== NULL
) {
1133 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1134 if (attr
->name
[0] != '\0') {
1135 usess
->has_non_default_channel
= 1;
1138 ret
= channel_ust_enable(usess
, uchan
);
1143 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1154 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1156 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1158 struct lttng_event
*event
)
1163 DBG("Disable event command for event \'%s\'", event
->name
);
1165 event_name
= event
->name
;
1166 if (validate_event_name(event_name
)) {
1167 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1171 /* Error out on unhandled search criteria */
1172 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1173 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1174 ret
= LTTNG_ERR_UNK
;
1181 case LTTNG_DOMAIN_KERNEL
:
1183 struct ltt_kernel_channel
*kchan
;
1184 struct ltt_kernel_session
*ksess
;
1186 ksess
= session
->kernel_session
;
1189 * If a non-default channel has been created in the
1190 * session, explicitely require that -c chan_name needs
1193 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1194 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1198 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1199 if (kchan
== NULL
) {
1200 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1204 switch (event
->type
) {
1205 case LTTNG_EVENT_ALL
:
1206 case LTTNG_EVENT_TRACEPOINT
:
1207 case LTTNG_EVENT_SYSCALL
:
1208 case LTTNG_EVENT_PROBE
:
1209 case LTTNG_EVENT_FUNCTION
:
1210 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1211 if (event_name
[0] == '\0') {
1212 ret
= event_kernel_disable_event(kchan
,
1215 ret
= event_kernel_disable_event(kchan
,
1216 event_name
, event
->type
);
1218 if (ret
!= LTTNG_OK
) {
1223 ret
= LTTNG_ERR_UNK
;
1227 kernel_wait_quiescent(kernel_tracer_fd
);
1230 case LTTNG_DOMAIN_UST
:
1232 struct ltt_ust_channel
*uchan
;
1233 struct ltt_ust_session
*usess
;
1235 usess
= session
->ust_session
;
1237 if (validate_ust_event_name(event_name
)) {
1238 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1243 * If a non-default channel has been created in the
1244 * session, explicitly require that -c chan_name needs
1247 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1248 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1252 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1254 if (uchan
== NULL
) {
1255 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1259 switch (event
->type
) {
1260 case LTTNG_EVENT_ALL
:
1262 * An empty event name means that everything
1263 * should be disabled.
1265 if (event
->name
[0] == '\0') {
1266 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1268 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1271 if (ret
!= LTTNG_OK
) {
1276 ret
= LTTNG_ERR_UNK
;
1280 DBG3("Disable UST event %s in channel %s completed", event_name
,
1284 case LTTNG_DOMAIN_LOG4J
:
1285 case LTTNG_DOMAIN_JUL
:
1286 case LTTNG_DOMAIN_PYTHON
:
1289 struct ltt_ust_session
*usess
= session
->ust_session
;
1293 switch (event
->type
) {
1294 case LTTNG_EVENT_ALL
:
1297 ret
= LTTNG_ERR_UNK
;
1301 agt
= trace_ust_find_agent(usess
, domain
);
1303 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1307 * An empty event name means that everything
1308 * should be disabled.
1310 if (event
->name
[0] == '\0') {
1311 ret
= event_agent_disable_all(usess
, agt
);
1313 ret
= event_agent_disable(usess
, agt
, event_name
);
1315 if (ret
!= LTTNG_OK
) {
1322 ret
= LTTNG_ERR_UND
;
1335 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1337 int cmd_add_context(struct ltt_session
*session
, int domain
,
1338 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1340 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1343 case LTTNG_DOMAIN_KERNEL
:
1344 assert(session
->kernel_session
);
1346 if (session
->kernel_session
->channel_count
== 0) {
1347 /* Create default channel */
1348 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1349 if (ret
!= LTTNG_OK
) {
1352 chan_kern_created
= 1;
1354 /* Add kernel context to kernel tracer */
1355 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1356 if (ret
!= LTTNG_OK
) {
1360 case LTTNG_DOMAIN_UST
:
1362 struct ltt_ust_session
*usess
= session
->ust_session
;
1363 unsigned int chan_count
;
1367 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1368 if (chan_count
== 0) {
1369 struct lttng_channel
*attr
;
1370 /* Create default channel */
1371 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1373 ret
= LTTNG_ERR_FATAL
;
1377 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1378 if (ret
!= LTTNG_OK
) {
1383 chan_ust_created
= 1;
1386 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1387 if (ret
!= LTTNG_OK
) {
1393 ret
= LTTNG_ERR_UND
;
1400 if (chan_kern_created
) {
1401 struct ltt_kernel_channel
*kchan
=
1402 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1403 session
->kernel_session
);
1404 /* Created previously, this should NOT fail. */
1406 kernel_destroy_channel(kchan
);
1409 if (chan_ust_created
) {
1410 struct ltt_ust_channel
*uchan
=
1411 trace_ust_find_channel_by_name(
1412 session
->ust_session
->domain_global
.channels
,
1413 DEFAULT_CHANNEL_NAME
);
1414 /* Created previously, this should NOT fail. */
1416 /* Remove from the channel list of the session. */
1417 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1419 trace_ust_destroy_channel(uchan
);
1424 static int validate_event_name(const char *name
)
1427 const char *c
= name
;
1428 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1431 * Make sure that unescaped wildcards are only used as the last
1432 * character of the event name.
1434 while (c
< event_name_end
) {
1442 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1443 /* Wildcard is not the last character */
1444 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1456 static inline bool name_starts_with(const char *name
, const char *prefix
)
1458 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1460 return !strncmp(name
, prefix
, max_cmp_len
);
1463 /* Perform userspace-specific event name validation */
1464 static int validate_ust_event_name(const char *name
)
1474 * Check name against all internal UST event component namespaces used
1477 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1478 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1479 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1488 * Internal version of cmd_enable_event() with a supplemental
1489 * "internal_event" flag which is used to enable internal events which should
1490 * be hidden from clients. Such events are used in the agent implementation to
1491 * enable the events through which all "agent" events are funeled.
1493 static int _cmd_enable_event(struct ltt_session
*session
,
1494 struct lttng_domain
*domain
,
1495 char *channel_name
, struct lttng_event
*event
,
1496 char *filter_expression
,
1497 struct lttng_filter_bytecode
*filter
,
1498 struct lttng_event_exclusion
*exclusion
,
1499 int wpipe
, bool internal_event
)
1501 int ret
, channel_created
= 0;
1502 struct lttng_channel
*attr
;
1506 assert(channel_name
);
1508 DBG("Enable event command for event \'%s\'", event
->name
);
1512 ret
= validate_event_name(event
->name
);
1517 switch (domain
->type
) {
1518 case LTTNG_DOMAIN_KERNEL
:
1520 struct ltt_kernel_channel
*kchan
;
1523 * If a non-default channel has been created in the
1524 * session, explicitely require that -c chan_name needs
1527 if (session
->kernel_session
->has_non_default_channel
1528 && channel_name
[0] == '\0') {
1529 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1533 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1534 session
->kernel_session
);
1535 if (kchan
== NULL
) {
1536 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1537 LTTNG_BUFFER_GLOBAL
);
1539 ret
= LTTNG_ERR_FATAL
;
1542 if (lttng_strncpy(attr
->name
, channel_name
,
1543 sizeof(attr
->name
))) {
1544 ret
= LTTNG_ERR_INVALID
;
1549 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1550 if (ret
!= LTTNG_OK
) {
1556 channel_created
= 1;
1559 /* Get the newly created kernel channel pointer */
1560 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1561 session
->kernel_session
);
1562 if (kchan
== NULL
) {
1563 /* This sould not happen... */
1564 ret
= LTTNG_ERR_FATAL
;
1568 switch (event
->type
) {
1569 case LTTNG_EVENT_ALL
:
1571 char *filter_expression_a
= NULL
;
1572 struct lttng_filter_bytecode
*filter_a
= NULL
;
1575 * We need to duplicate filter_expression and filter,
1576 * because ownership is passed to first enable
1579 if (filter_expression
) {
1580 filter_expression_a
= strdup(filter_expression
);
1581 if (!filter_expression_a
) {
1582 ret
= LTTNG_ERR_FATAL
;
1587 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1589 free(filter_expression_a
);
1590 ret
= LTTNG_ERR_FATAL
;
1593 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1595 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1596 ret
= event_kernel_enable_event(kchan
, event
,
1597 filter_expression
, filter
);
1598 /* We have passed ownership */
1599 filter_expression
= NULL
;
1601 if (ret
!= LTTNG_OK
) {
1602 if (channel_created
) {
1603 /* Let's not leak a useless channel. */
1604 kernel_destroy_channel(kchan
);
1606 free(filter_expression_a
);
1610 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1611 ret
= event_kernel_enable_event(kchan
, event
,
1612 filter_expression_a
, filter_a
);
1613 /* We have passed ownership */
1614 filter_expression_a
= NULL
;
1616 if (ret
!= LTTNG_OK
) {
1621 case LTTNG_EVENT_PROBE
:
1622 case LTTNG_EVENT_FUNCTION
:
1623 case LTTNG_EVENT_FUNCTION_ENTRY
:
1624 case LTTNG_EVENT_TRACEPOINT
:
1625 ret
= event_kernel_enable_event(kchan
, event
,
1626 filter_expression
, filter
);
1627 /* We have passed ownership */
1628 filter_expression
= NULL
;
1630 if (ret
!= LTTNG_OK
) {
1631 if (channel_created
) {
1632 /* Let's not leak a useless channel. */
1633 kernel_destroy_channel(kchan
);
1638 case LTTNG_EVENT_SYSCALL
:
1639 ret
= event_kernel_enable_event(kchan
, event
,
1640 filter_expression
, filter
);
1641 /* We have passed ownership */
1642 filter_expression
= NULL
;
1644 if (ret
!= LTTNG_OK
) {
1649 ret
= LTTNG_ERR_UNK
;
1653 kernel_wait_quiescent(kernel_tracer_fd
);
1656 case LTTNG_DOMAIN_UST
:
1658 struct ltt_ust_channel
*uchan
;
1659 struct ltt_ust_session
*usess
= session
->ust_session
;
1664 * If a non-default channel has been created in the
1665 * session, explicitely require that -c chan_name needs
1668 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1669 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1673 /* Get channel from global UST domain */
1674 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1676 if (uchan
== NULL
) {
1677 /* Create default channel */
1678 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1679 usess
->buffer_type
);
1681 ret
= LTTNG_ERR_FATAL
;
1684 if (lttng_strncpy(attr
->name
, channel_name
,
1685 sizeof(attr
->name
))) {
1686 ret
= LTTNG_ERR_INVALID
;
1691 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1692 if (ret
!= LTTNG_OK
) {
1698 /* Get the newly created channel reference back */
1699 uchan
= trace_ust_find_channel_by_name(
1700 usess
->domain_global
.channels
, channel_name
);
1704 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1706 * Don't allow users to add UST events to channels which
1707 * are assigned to a userspace subdomain (JUL, Log4J,
1710 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1714 if (!internal_event
) {
1716 * Ensure the event name is not reserved for internal
1719 ret
= validate_ust_event_name(event
->name
);
1721 WARN("Userspace event name %s failed validation.",
1723 event
->name
: "NULL");
1724 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1729 /* At this point, the session and channel exist on the tracer */
1730 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1731 filter_expression
, filter
, exclusion
,
1733 /* We have passed ownership */
1734 filter_expression
= NULL
;
1737 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1738 goto already_enabled
;
1739 } else if (ret
!= LTTNG_OK
) {
1744 case LTTNG_DOMAIN_LOG4J
:
1745 case LTTNG_DOMAIN_JUL
:
1746 case LTTNG_DOMAIN_PYTHON
:
1748 const char *default_event_name
, *default_chan_name
;
1750 struct lttng_event uevent
;
1751 struct lttng_domain tmp_dom
;
1752 struct ltt_ust_session
*usess
= session
->ust_session
;
1756 agt
= trace_ust_find_agent(usess
, domain
->type
);
1758 agt
= agent_create(domain
->type
);
1760 ret
= LTTNG_ERR_NOMEM
;
1763 agent_add(agt
, usess
->agents
);
1766 /* Create the default tracepoint. */
1767 memset(&uevent
, 0, sizeof(uevent
));
1768 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1769 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1770 default_event_name
= event_get_default_agent_ust_name(
1772 if (!default_event_name
) {
1773 ret
= LTTNG_ERR_FATAL
;
1776 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1777 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1780 * The domain type is changed because we are about to enable the
1781 * default channel and event for the JUL domain that are hardcoded.
1782 * This happens in the UST domain.
1784 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1785 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1787 switch (domain
->type
) {
1788 case LTTNG_DOMAIN_LOG4J
:
1789 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1791 case LTTNG_DOMAIN_JUL
:
1792 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1794 case LTTNG_DOMAIN_PYTHON
:
1795 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1798 /* The switch/case we are in should avoid this else big problem */
1803 char *filter_expression_copy
= NULL
;
1804 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1807 const size_t filter_size
= sizeof(
1808 struct lttng_filter_bytecode
)
1811 filter_copy
= zmalloc(filter_size
);
1813 ret
= LTTNG_ERR_NOMEM
;
1816 memcpy(filter_copy
, filter
, filter_size
);
1818 filter_expression_copy
=
1819 strdup(filter_expression
);
1820 if (!filter_expression
) {
1821 ret
= LTTNG_ERR_NOMEM
;
1824 if (!filter_expression_copy
|| !filter_copy
) {
1825 free(filter_expression_copy
);
1831 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1832 (char *) default_chan_name
,
1833 &uevent
, filter_expression_copy
,
1834 filter_copy
, NULL
, wpipe
);
1837 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1838 goto already_enabled
;
1839 } else if (ret
!= LTTNG_OK
) {
1843 /* The wild card * means that everything should be enabled. */
1844 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1845 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1848 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1852 filter_expression
= NULL
;
1853 if (ret
!= LTTNG_OK
) {
1860 ret
= LTTNG_ERR_UND
;
1868 free(filter_expression
);
1876 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1877 * We own filter, exclusion, and filter_expression.
1879 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1880 char *channel_name
, struct lttng_event
*event
,
1881 char *filter_expression
,
1882 struct lttng_filter_bytecode
*filter
,
1883 struct lttng_event_exclusion
*exclusion
,
1886 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1887 filter_expression
, filter
, exclusion
, wpipe
, false);
1891 * Enable an event which is internal to LTTng. An internal should
1892 * never be made visible to clients and are immune to checks such as
1895 static int cmd_enable_event_internal(struct ltt_session
*session
,
1896 struct lttng_domain
*domain
,
1897 char *channel_name
, struct lttng_event
*event
,
1898 char *filter_expression
,
1899 struct lttng_filter_bytecode
*filter
,
1900 struct lttng_event_exclusion
*exclusion
,
1903 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1904 filter_expression
, filter
, exclusion
, wpipe
, true);
1908 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1910 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1913 ssize_t nb_events
= 0;
1916 case LTTNG_DOMAIN_KERNEL
:
1917 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1918 if (nb_events
< 0) {
1919 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1923 case LTTNG_DOMAIN_UST
:
1924 nb_events
= ust_app_list_events(events
);
1925 if (nb_events
< 0) {
1926 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1930 case LTTNG_DOMAIN_LOG4J
:
1931 case LTTNG_DOMAIN_JUL
:
1932 case LTTNG_DOMAIN_PYTHON
:
1933 nb_events
= agent_list_events(events
, domain
);
1934 if (nb_events
< 0) {
1935 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1940 ret
= LTTNG_ERR_UND
;
1947 /* Return negative value to differentiate return code */
1952 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1954 ssize_t
cmd_list_tracepoint_fields(int domain
,
1955 struct lttng_event_field
**fields
)
1958 ssize_t nb_fields
= 0;
1961 case LTTNG_DOMAIN_UST
:
1962 nb_fields
= ust_app_list_event_fields(fields
);
1963 if (nb_fields
< 0) {
1964 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1968 case LTTNG_DOMAIN_KERNEL
:
1969 default: /* fall-through */
1970 ret
= LTTNG_ERR_UND
;
1977 /* Return negative value to differentiate return code */
1981 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1983 return syscall_table_list(events
);
1987 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1989 * Called with session lock held.
1991 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1992 int domain
, int32_t **pids
)
1995 ssize_t nr_pids
= 0;
1998 case LTTNG_DOMAIN_KERNEL
:
2000 struct ltt_kernel_session
*ksess
;
2002 ksess
= session
->kernel_session
;
2003 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2005 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2010 case LTTNG_DOMAIN_UST
:
2012 struct ltt_ust_session
*usess
;
2014 usess
= session
->ust_session
;
2015 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2017 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2022 case LTTNG_DOMAIN_LOG4J
:
2023 case LTTNG_DOMAIN_JUL
:
2024 case LTTNG_DOMAIN_PYTHON
:
2026 ret
= LTTNG_ERR_UND
;
2033 /* Return negative value to differentiate return code */
2038 * Command LTTNG_START_TRACE processed by the client thread.
2040 * Called with session mutex held.
2042 int cmd_start_trace(struct ltt_session
*session
)
2045 unsigned long nb_chan
= 0;
2046 struct ltt_kernel_session
*ksession
;
2047 struct ltt_ust_session
*usess
;
2051 /* Ease our life a bit ;) */
2052 ksession
= session
->kernel_session
;
2053 usess
= session
->ust_session
;
2055 /* Is the session already started? */
2056 if (session
->active
) {
2057 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2062 * Starting a session without channel is useless since after that it's not
2063 * possible to enable channel thus inform the client.
2065 if (usess
&& usess
->domain_global
.channels
) {
2067 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2071 nb_chan
+= ksession
->channel_count
;
2074 ret
= LTTNG_ERR_NO_CHANNEL
;
2078 /* Kernel tracing */
2079 if (ksession
!= NULL
) {
2080 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2081 if (ret
!= LTTNG_OK
) {
2086 /* Flag session that trace should start automatically */
2089 * Even though the start trace might fail, flag this session active so
2090 * other application coming in are started by default.
2094 ret
= ust_app_start_trace_all(usess
);
2096 ret
= LTTNG_ERR_UST_START_FAIL
;
2101 /* Flag this after a successful start. */
2102 session
->has_been_started
= 1;
2103 session
->active
= 1;
2112 * Command LTTNG_STOP_TRACE processed by the client thread.
2114 int cmd_stop_trace(struct ltt_session
*session
)
2117 struct ltt_kernel_channel
*kchan
;
2118 struct ltt_kernel_session
*ksession
;
2119 struct ltt_ust_session
*usess
;
2124 ksession
= session
->kernel_session
;
2125 usess
= session
->ust_session
;
2127 /* Session is not active. Skip everythong and inform the client. */
2128 if (!session
->active
) {
2129 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2134 if (ksession
&& ksession
->active
) {
2135 DBG("Stop kernel tracing");
2137 ret
= kernel_stop_session(ksession
);
2139 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2143 kernel_wait_quiescent(kernel_tracer_fd
);
2145 /* Flush metadata after stopping (if exists) */
2146 if (ksession
->metadata_stream_fd
>= 0) {
2147 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2149 ERR("Kernel metadata flush failed");
2153 /* Flush all buffers after stopping */
2154 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2155 ret
= kernel_flush_buffer(kchan
);
2157 ERR("Kernel flush buffer error");
2161 ksession
->active
= 0;
2164 if (usess
&& usess
->active
) {
2166 * Even though the stop trace might fail, flag this session inactive so
2167 * other application coming in are not started by default.
2171 ret
= ust_app_stop_trace_all(usess
);
2173 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2178 /* Flag inactive after a successful stop. */
2179 session
->active
= 0;
2187 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2189 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2190 struct lttng_uri
*uris
)
2193 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2194 struct ltt_ust_session
*usess
= session
->ust_session
;
2200 /* Can't set consumer URI if the session is active. */
2201 if (session
->active
) {
2202 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2206 /* Set the "global" consumer URIs */
2207 for (i
= 0; i
< nb_uri
; i
++) {
2208 ret
= add_uri_to_consumer(session
->consumer
,
2209 &uris
[i
], 0, session
->name
);
2210 if (ret
!= LTTNG_OK
) {
2215 /* Set UST session URIs */
2216 if (session
->ust_session
) {
2217 for (i
= 0; i
< nb_uri
; i
++) {
2218 ret
= add_uri_to_consumer(
2219 session
->ust_session
->consumer
,
2220 &uris
[i
], LTTNG_DOMAIN_UST
,
2222 if (ret
!= LTTNG_OK
) {
2228 /* Set kernel session URIs */
2229 if (session
->kernel_session
) {
2230 for (i
= 0; i
< nb_uri
; i
++) {
2231 ret
= add_uri_to_consumer(
2232 session
->kernel_session
->consumer
,
2233 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2235 if (ret
!= LTTNG_OK
) {
2242 * Make sure to set the session in output mode after we set URI since a
2243 * session can be created without URL (thus flagged in no output mode).
2245 session
->output_traces
= 1;
2247 ksess
->output_traces
= 1;
2251 usess
->output_traces
= 1;
2262 * Command LTTNG_CREATE_SESSION processed by the client thread.
2264 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2265 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2268 struct ltt_session
*session
;
2274 * Verify if the session already exist
2276 * XXX: There is no need for the session lock list here since the caller
2277 * (process_client_msg) is holding it. We might want to change that so a
2278 * single command does not lock the entire session list.
2280 session
= session_find_by_name(name
);
2281 if (session
!= NULL
) {
2282 ret
= LTTNG_ERR_EXIST_SESS
;
2286 /* Create tracing session in the registry */
2287 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2288 LTTNG_SOCK_GET_GID_CRED(creds
));
2289 if (ret
!= LTTNG_OK
) {
2294 * Get the newly created session pointer back
2296 * XXX: There is no need for the session lock list here since the caller
2297 * (process_client_msg) is holding it. We might want to change that so a
2298 * single command does not lock the entire session list.
2300 session
= session_find_by_name(name
);
2303 session
->live_timer
= live_timer
;
2304 /* Create default consumer output for the session not yet created. */
2305 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2306 if (session
->consumer
== NULL
) {
2307 ret
= LTTNG_ERR_FATAL
;
2308 goto consumer_error
;
2312 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2313 if (ret
!= LTTNG_OK
) {
2314 goto consumer_error
;
2316 session
->output_traces
= 1;
2318 session
->output_traces
= 0;
2319 DBG2("Session %s created with no output", session
->name
);
2322 session
->consumer
->enabled
= 1;
2327 session_destroy(session
);
2334 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2336 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2337 size_t nb_uri
, lttng_sock_cred
*creds
)
2340 struct ltt_session
*session
;
2341 struct snapshot_output
*new_output
= NULL
;
2347 * Create session in no output mode with URIs set to NULL. The uris we've
2348 * received are for a default snapshot output if one.
2350 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2351 if (ret
!= LTTNG_OK
) {
2355 /* Get the newly created session pointer back. This should NEVER fail. */
2356 session
= session_find_by_name(name
);
2359 /* Flag session for snapshot mode. */
2360 session
->snapshot_mode
= 1;
2362 /* Skip snapshot output creation if no URI is given. */
2367 new_output
= snapshot_output_alloc();
2369 ret
= LTTNG_ERR_NOMEM
;
2370 goto error_snapshot_alloc
;
2373 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2374 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2376 if (ret
== -ENOMEM
) {
2377 ret
= LTTNG_ERR_NOMEM
;
2379 ret
= LTTNG_ERR_INVALID
;
2381 goto error_snapshot
;
2385 snapshot_add_output(&session
->snapshot
, new_output
);
2392 snapshot_output_destroy(new_output
);
2393 error_snapshot_alloc
:
2394 session_destroy(session
);
2400 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2402 * Called with session lock held.
2404 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2407 struct ltt_ust_session
*usess
;
2408 struct ltt_kernel_session
*ksess
;
2413 usess
= session
->ust_session
;
2414 ksess
= session
->kernel_session
;
2416 /* Clean kernel session teardown */
2417 kernel_destroy_session(ksess
);
2419 /* UST session teardown */
2421 /* Close any relayd session */
2422 consumer_output_send_destroy_relayd(usess
->consumer
);
2424 /* Destroy every UST application related to this session. */
2425 ret
= ust_app_destroy_trace_all(usess
);
2427 ERR("Error in ust_app_destroy_trace_all");
2430 /* Clean up the rest. */
2431 trace_ust_destroy_session(usess
);
2435 * Must notify the kernel thread here to update it's poll set in order to
2436 * remove the channel(s)' fd just destroyed.
2438 ret
= notify_thread_pipe(wpipe
);
2440 PERROR("write kernel poll pipe");
2443 ret
= session_destroy(session
);
2449 * Command LTTNG_CALIBRATE processed by the client thread.
2451 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2456 case LTTNG_DOMAIN_KERNEL
:
2458 struct lttng_kernel_calibrate kcalibrate
;
2460 switch (calibrate
->type
) {
2461 case LTTNG_CALIBRATE_FUNCTION
:
2463 /* Default and only possible calibrate option. */
2464 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2468 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2470 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2475 case LTTNG_DOMAIN_UST
:
2477 struct lttng_ust_calibrate ucalibrate
;
2479 switch (calibrate
->type
) {
2480 case LTTNG_CALIBRATE_FUNCTION
:
2482 /* Default and only possible calibrate option. */
2483 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2487 ret
= ust_app_calibrate_glb(&ucalibrate
);
2489 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2495 ret
= LTTNG_ERR_UND
;
2506 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2508 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2509 const char *sock_path
, struct consumer_data
*cdata
)
2512 struct consumer_socket
*socket
= NULL
;
2519 case LTTNG_DOMAIN_KERNEL
:
2521 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2525 /* Can't register a consumer if there is already one */
2526 if (ksess
->consumer_fds_sent
!= 0) {
2527 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2531 sock
= lttcomm_connect_unix_sock(sock_path
);
2533 ret
= LTTNG_ERR_CONNECT_FAIL
;
2536 cdata
->cmd_sock
= sock
;
2538 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2539 if (socket
== NULL
) {
2542 PERROR("close register consumer");
2544 cdata
->cmd_sock
= -1;
2545 ret
= LTTNG_ERR_FATAL
;
2549 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2550 if (socket
->lock
== NULL
) {
2551 PERROR("zmalloc pthread mutex");
2552 ret
= LTTNG_ERR_FATAL
;
2555 pthread_mutex_init(socket
->lock
, NULL
);
2556 socket
->registered
= 1;
2559 consumer_add_socket(socket
, ksess
->consumer
);
2562 pthread_mutex_lock(&cdata
->pid_mutex
);
2564 pthread_mutex_unlock(&cdata
->pid_mutex
);
2569 /* TODO: Userspace tracing */
2570 ret
= LTTNG_ERR_UND
;
2578 consumer_destroy_socket(socket
);
2584 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2586 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2587 struct lttng_domain
**domains
)
2592 struct lttng_ht_iter iter
;
2594 if (session
->kernel_session
!= NULL
) {
2595 DBG3("Listing domains found kernel domain");
2599 if (session
->ust_session
!= NULL
) {
2600 DBG3("Listing domains found UST global domain");
2604 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2606 if (agt
->being_used
) {
2617 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2618 if (*domains
== NULL
) {
2619 ret
= LTTNG_ERR_FATAL
;
2623 if (session
->kernel_session
!= NULL
) {
2624 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2626 /* Kernel session buffer type is always GLOBAL */
2627 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2632 if (session
->ust_session
!= NULL
) {
2633 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2634 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2638 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2640 if (agt
->being_used
) {
2641 (*domains
)[index
].type
= agt
->domain
;
2642 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2652 /* Return negative value to differentiate return code */
2658 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2660 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2661 struct lttng_channel
**channels
)
2664 ssize_t nb_chan
= 0;
2667 case LTTNG_DOMAIN_KERNEL
:
2668 if (session
->kernel_session
!= NULL
) {
2669 nb_chan
= session
->kernel_session
->channel_count
;
2671 DBG3("Number of kernel channels %zd", nb_chan
);
2673 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2676 case LTTNG_DOMAIN_UST
:
2677 if (session
->ust_session
!= NULL
) {
2679 nb_chan
= lttng_ht_get_count(
2680 session
->ust_session
->domain_global
.channels
);
2683 DBG3("Number of UST global channels %zd", nb_chan
);
2685 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2690 ret
= LTTNG_ERR_UND
;
2695 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2696 if (*channels
== NULL
) {
2697 ret
= LTTNG_ERR_FATAL
;
2701 list_lttng_channels(domain
, session
, *channels
);
2707 /* Return negative value to differentiate return code */
2712 * Command LTTNG_LIST_EVENTS processed by the client thread.
2714 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2715 char *channel_name
, struct lttng_event
**events
)
2718 ssize_t nb_event
= 0;
2721 case LTTNG_DOMAIN_KERNEL
:
2722 if (session
->kernel_session
!= NULL
) {
2723 nb_event
= list_lttng_kernel_events(channel_name
,
2724 session
->kernel_session
, events
);
2727 case LTTNG_DOMAIN_UST
:
2729 if (session
->ust_session
!= NULL
) {
2730 nb_event
= list_lttng_ust_global_events(channel_name
,
2731 &session
->ust_session
->domain_global
, events
);
2735 case LTTNG_DOMAIN_LOG4J
:
2736 case LTTNG_DOMAIN_JUL
:
2737 case LTTNG_DOMAIN_PYTHON
:
2738 if (session
->ust_session
) {
2739 struct lttng_ht_iter iter
;
2743 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2744 &iter
.iter
, agt
, node
.node
) {
2745 if (agt
->domain
== domain
) {
2746 nb_event
= list_lttng_agent_events(
2755 ret
= LTTNG_ERR_UND
;
2762 /* Return negative value to differentiate return code */
2767 * Using the session list, filled a lttng_session array to send back to the
2768 * client for session listing.
2770 * The session list lock MUST be acquired before calling this function. Use
2771 * session_lock_list() and session_unlock_list().
2773 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2778 struct ltt_session
*session
;
2779 struct ltt_session_list
*list
= session_get_list();
2781 DBG("Getting all available session for UID %d GID %d",
2784 * Iterate over session list and append data after the control struct in
2787 cds_list_for_each_entry(session
, &list
->head
, list
) {
2789 * Only list the sessions the user can control.
2791 if (!session_access_ok(session
, uid
, gid
)) {
2795 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2796 struct ltt_ust_session
*usess
= session
->ust_session
;
2798 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2799 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2800 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2801 ret
= build_network_session_path(sessions
[i
].path
,
2802 sizeof(sessions
[i
].path
), session
);
2804 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2805 session
->consumer
->dst
.trace_path
);
2808 PERROR("snprintf session path");
2812 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2813 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2814 sessions
[i
].enabled
= session
->active
;
2815 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2816 sessions
[i
].live_timer_interval
= session
->live_timer
;
2822 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2823 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2825 int cmd_data_pending(struct ltt_session
*session
)
2828 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2829 struct ltt_ust_session
*usess
= session
->ust_session
;
2833 /* Session MUST be stopped to ask for data availability. */
2834 if (session
->active
) {
2835 ret
= LTTNG_ERR_SESSION_STARTED
;
2839 * If stopped, just make sure we've started before else the above call
2840 * will always send that there is data pending.
2842 * The consumer assumes that when the data pending command is received,
2843 * the trace has been started before or else no output data is written
2844 * by the streams which is a condition for data pending. So, this is
2845 * *VERY* important that we don't ask the consumer before a start
2848 if (!session
->has_been_started
) {
2854 if (ksess
&& ksess
->consumer
) {
2855 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2857 /* Data is still being extracted for the kernel. */
2862 if (usess
&& usess
->consumer
) {
2863 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2865 /* Data is still being extracted for the kernel. */
2870 /* Data is ready to be read by a viewer */
2878 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2880 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2882 int cmd_snapshot_add_output(struct ltt_session
*session
,
2883 struct lttng_snapshot_output
*output
, uint32_t *id
)
2886 struct snapshot_output
*new_output
;
2891 DBG("Cmd snapshot add output for session %s", session
->name
);
2894 * Permission denied to create an output if the session is not
2895 * set in no output mode.
2897 if (session
->output_traces
) {
2898 ret
= LTTNG_ERR_EPERM
;
2902 /* Only one output is allowed until we have the "tee" feature. */
2903 if (session
->snapshot
.nb_output
== 1) {
2904 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2908 new_output
= snapshot_output_alloc();
2910 ret
= LTTNG_ERR_NOMEM
;
2914 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2915 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2916 &session
->snapshot
);
2918 if (ret
== -ENOMEM
) {
2919 ret
= LTTNG_ERR_NOMEM
;
2921 ret
= LTTNG_ERR_INVALID
;
2927 snapshot_add_output(&session
->snapshot
, new_output
);
2929 *id
= new_output
->id
;
2936 snapshot_output_destroy(new_output
);
2942 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2944 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2946 int cmd_snapshot_del_output(struct ltt_session
*session
,
2947 struct lttng_snapshot_output
*output
)
2950 struct snapshot_output
*sout
= NULL
;
2958 * Permission denied to create an output if the session is not
2959 * set in no output mode.
2961 if (session
->output_traces
) {
2962 ret
= LTTNG_ERR_EPERM
;
2967 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2969 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2970 } else if (*output
->name
!= '\0') {
2971 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2973 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2976 ret
= LTTNG_ERR_INVALID
;
2980 snapshot_delete_output(&session
->snapshot
, sout
);
2981 snapshot_output_destroy(sout
);
2990 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2992 * If no output is available, outputs is untouched and 0 is returned.
2994 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2996 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2997 struct lttng_snapshot_output
**outputs
)
3000 struct lttng_snapshot_output
*list
= NULL
;
3001 struct lttng_ht_iter iter
;
3002 struct snapshot_output
*output
;
3007 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3010 * Permission denied to create an output if the session is not
3011 * set in no output mode.
3013 if (session
->output_traces
) {
3014 ret
= -LTTNG_ERR_EPERM
;
3018 if (session
->snapshot
.nb_output
== 0) {
3023 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3025 ret
= -LTTNG_ERR_NOMEM
;
3029 /* Copy list from session to the new list object. */
3031 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3032 output
, node
.node
) {
3033 assert(output
->consumer
);
3034 list
[idx
].id
= output
->id
;
3035 list
[idx
].max_size
= output
->max_size
;
3036 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3037 sizeof(list
[idx
].name
))) {
3038 ret
= -LTTNG_ERR_INVALID
;
3041 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3042 if (lttng_strncpy(list
[idx
].ctrl_url
,
3043 output
->consumer
->dst
.trace_path
,
3044 sizeof(list
[idx
].ctrl_url
))) {
3045 ret
= -LTTNG_ERR_INVALID
;
3050 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3051 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3053 ret
= -LTTNG_ERR_NOMEM
;
3058 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3059 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3061 ret
= -LTTNG_ERR_NOMEM
;
3070 ret
= session
->snapshot
.nb_output
;
3078 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3079 * snapshot output is *not* set with a remote destination.
3081 * Return 0 on success or a LTTNG_ERR code.
3083 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3084 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3087 struct lttng_ht_iter iter
;
3088 struct consumer_socket
*socket
;
3091 assert(snap_output
);
3094 DBG2("Set relayd object from snapshot output");
3096 /* Ignore if snapshot consumer output is not network. */
3097 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3102 * For each consumer socket, create and send the relayd object of the
3106 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3107 socket
, node
.node
) {
3108 ret
= send_consumer_relayd_sockets(0, session
->id
,
3109 snap_output
->consumer
, socket
,
3110 session
->name
, session
->hostname
,
3111 session
->live_timer
);
3112 if (ret
!= LTTNG_OK
) {
3124 * Record a kernel snapshot.
3126 * Return LTTNG_OK on success or a LTTNG_ERR code.
3128 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3129 struct snapshot_output
*output
, struct ltt_session
*session
,
3130 int wait
, uint64_t nb_packets_per_stream
)
3140 * Copy kernel session sockets so we can communicate with the right
3141 * consumer for the snapshot record command.
3143 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3145 ret
= LTTNG_ERR_NOMEM
;
3149 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3150 if (ret
!= LTTNG_OK
) {
3151 goto error_snapshot
;
3154 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3155 if (ret
!= LTTNG_OK
) {
3156 goto error_snapshot
;
3163 /* Clean up copied sockets so this output can use some other later on. */
3164 consumer_destroy_output_sockets(output
->consumer
);
3171 * Record a UST snapshot.
3173 * Return 0 on success or a LTTNG_ERR error code.
3175 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3176 struct snapshot_output
*output
, struct ltt_session
*session
,
3177 int wait
, uint64_t nb_packets_per_stream
)
3186 * Copy UST session sockets so we can communicate with the right
3187 * consumer for the snapshot record command.
3189 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3191 ret
= LTTNG_ERR_NOMEM
;
3195 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3196 if (ret
!= LTTNG_OK
) {
3197 goto error_snapshot
;
3200 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3204 ret
= LTTNG_ERR_INVALID
;
3207 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3210 goto error_snapshot
;
3216 /* Clean up copied sockets so this output can use some other later on. */
3217 consumer_destroy_output_sockets(output
->consumer
);
3223 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3224 uint64_t cur_nr_packets
)
3226 uint64_t tot_size
= 0;
3228 if (session
->kernel_session
) {
3229 struct ltt_kernel_channel
*chan
;
3230 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3232 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3233 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3235 * Don't take channel into account if we
3236 * already grab all its packets.
3240 tot_size
+= chan
->channel
->attr
.subbuf_size
3241 * chan
->stream_count
;
3245 if (session
->ust_session
) {
3246 struct ltt_ust_session
*usess
= session
->ust_session
;
3248 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3256 * Calculate the number of packets we can grab from each stream that
3257 * fits within the overall snapshot max size.
3259 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3260 * the number of packets per stream.
3262 * TODO: this approach is not perfect: we consider the worse case
3263 * (packet filling the sub-buffers) as an upper bound, but we could do
3264 * better if we do this calculation while we actually grab the packet
3265 * content: we would know how much padding we don't actually store into
3268 * This algorithm is currently bounded by the number of packets per
3271 * Since we call this algorithm before actually grabbing the data, it's
3272 * an approximation: for instance, applications could appear/disappear
3273 * in between this call and actually grabbing data.
3276 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3279 uint64_t cur_nb_packets
= 0;
3282 return 0; /* Infinite */
3285 size_left
= max_size
;
3287 uint64_t one_more_packet_tot_size
;
3289 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3291 if (!one_more_packet_tot_size
) {
3292 /* We are already grabbing all packets. */
3295 size_left
-= one_more_packet_tot_size
;
3296 if (size_left
< 0) {
3301 if (!cur_nb_packets
) {
3302 /* Not enough room to grab one packet of each stream, error. */
3305 return cur_nb_packets
;
3309 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3311 * The wait parameter is ignored so this call always wait for the snapshot to
3312 * complete before returning.
3314 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3316 int cmd_snapshot_record(struct ltt_session
*session
,
3317 struct lttng_snapshot_output
*output
, int wait
)
3320 unsigned int use_tmp_output
= 0;
3321 struct snapshot_output tmp_output
;
3322 unsigned int snapshot_success
= 0;
3328 DBG("Cmd snapshot record for session %s", session
->name
);
3330 /* Get the datetime for the snapshot output directory. */
3331 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3334 ret
= LTTNG_ERR_INVALID
;
3339 * Permission denied to create an output if the session is not
3340 * set in no output mode.
3342 if (session
->output_traces
) {
3343 ret
= LTTNG_ERR_EPERM
;
3347 /* The session needs to be started at least once. */
3348 if (!session
->has_been_started
) {
3349 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3353 /* Use temporary output for the session. */
3354 if (*output
->ctrl_url
!= '\0') {
3355 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3356 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3359 if (ret
== -ENOMEM
) {
3360 ret
= LTTNG_ERR_NOMEM
;
3362 ret
= LTTNG_ERR_INVALID
;
3366 /* Use the global session count for the temporary snapshot. */
3367 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3369 /* Use the global datetime */
3370 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3374 if (use_tmp_output
) {
3375 int64_t nb_packets_per_stream
;
3377 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3378 tmp_output
.max_size
);
3379 if (nb_packets_per_stream
< 0) {
3380 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3384 if (session
->kernel_session
) {
3385 ret
= record_kernel_snapshot(session
->kernel_session
,
3386 &tmp_output
, session
,
3387 wait
, nb_packets_per_stream
);
3388 if (ret
!= LTTNG_OK
) {
3393 if (session
->ust_session
) {
3394 ret
= record_ust_snapshot(session
->ust_session
,
3395 &tmp_output
, session
,
3396 wait
, nb_packets_per_stream
);
3397 if (ret
!= LTTNG_OK
) {
3402 snapshot_success
= 1;
3404 struct snapshot_output
*sout
;
3405 struct lttng_ht_iter iter
;
3408 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3409 &iter
.iter
, sout
, node
.node
) {
3410 int64_t nb_packets_per_stream
;
3413 * Make a local copy of the output and assign the possible
3414 * temporary value given by the caller.
3416 memset(&tmp_output
, 0, sizeof(tmp_output
));
3417 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3419 if (output
->max_size
!= (uint64_t) -1ULL) {
3420 tmp_output
.max_size
= output
->max_size
;
3423 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3424 tmp_output
.max_size
);
3425 if (nb_packets_per_stream
< 0) {
3426 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3431 /* Use temporary name. */
3432 if (*output
->name
!= '\0') {
3433 if (lttng_strncpy(tmp_output
.name
, output
->name
,
3434 sizeof(tmp_output
.name
))) {
3435 ret
= LTTNG_ERR_INVALID
;
3441 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3442 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3444 if (session
->kernel_session
) {
3445 ret
= record_kernel_snapshot(session
->kernel_session
,
3446 &tmp_output
, session
,
3447 wait
, nb_packets_per_stream
);
3448 if (ret
!= LTTNG_OK
) {
3454 if (session
->ust_session
) {
3455 ret
= record_ust_snapshot(session
->ust_session
,
3456 &tmp_output
, session
,
3457 wait
, nb_packets_per_stream
);
3458 if (ret
!= LTTNG_OK
) {
3463 snapshot_success
= 1;
3468 if (snapshot_success
) {
3469 session
->snapshot
.nb_snapshot
++;
3471 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3479 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3481 int cmd_set_session_shm_path(struct ltt_session
*session
,
3482 const char *shm_path
)
3488 * Can only set shm path before session is started.
3490 if (session
->has_been_started
) {
3491 return LTTNG_ERR_SESSION_STARTED
;
3494 strncpy(session
->shm_path
, shm_path
,
3495 sizeof(session
->shm_path
));
3496 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3502 * Init command subsystem.
3507 * Set network sequence index to 1 for streams to match a relayd
3508 * socket on the consumer side.
3510 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3511 relayd_net_seq_idx
= 1;
3512 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3514 DBG("Command subsystem initialized");