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;
1072 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1073 * mode and with less than 2 subbuf so block it right away and send back an
1074 * invalid attribute error.
1076 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1077 ret
= LTTNG_ERR_INVALID
;
1081 switch (domain
->type
) {
1082 case LTTNG_DOMAIN_KERNEL
:
1084 struct ltt_kernel_channel
*kchan
;
1086 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1087 session
->kernel_session
);
1088 if (kchan
== NULL
) {
1089 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1090 if (attr
->name
[0] != '\0') {
1091 session
->kernel_session
->has_non_default_channel
= 1;
1094 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1097 if (ret
!= LTTNG_OK
) {
1101 kernel_wait_quiescent(kernel_tracer_fd
);
1104 case LTTNG_DOMAIN_UST
:
1105 case LTTNG_DOMAIN_JUL
:
1106 case LTTNG_DOMAIN_LOG4J
:
1107 case LTTNG_DOMAIN_PYTHON
:
1109 struct ltt_ust_channel
*uchan
;
1114 * Current agent implementation limitations force us to allow
1115 * only one channel at once in "agent" subdomains. Each
1116 * subdomain has a default channel name which must be strictly
1119 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1120 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1121 LTTNG_SYMBOL_NAME_LEN
)) {
1122 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1125 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1126 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1127 LTTNG_SYMBOL_NAME_LEN
)) {
1128 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1131 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1132 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1133 LTTNG_SYMBOL_NAME_LEN
)) {
1134 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1139 chan_ht
= usess
->domain_global
.channels
;
1141 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1142 if (uchan
== NULL
) {
1143 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1144 if (attr
->name
[0] != '\0') {
1145 usess
->has_non_default_channel
= 1;
1148 ret
= channel_ust_enable(usess
, uchan
);
1153 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1164 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1166 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1168 struct lttng_event
*event
)
1173 DBG("Disable event command for event \'%s\'", event
->name
);
1175 event_name
= event
->name
;
1176 if (validate_event_name(event_name
)) {
1177 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1181 /* Error out on unhandled search criteria */
1182 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1183 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1184 ret
= LTTNG_ERR_UNK
;
1191 case LTTNG_DOMAIN_KERNEL
:
1193 struct ltt_kernel_channel
*kchan
;
1194 struct ltt_kernel_session
*ksess
;
1196 ksess
= session
->kernel_session
;
1199 * If a non-default channel has been created in the
1200 * session, explicitely require that -c chan_name needs
1203 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1204 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1208 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1209 if (kchan
== NULL
) {
1210 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1214 switch (event
->type
) {
1215 case LTTNG_EVENT_ALL
:
1216 case LTTNG_EVENT_TRACEPOINT
:
1217 case LTTNG_EVENT_SYSCALL
:
1218 case LTTNG_EVENT_PROBE
:
1219 case LTTNG_EVENT_FUNCTION
:
1220 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1221 if (event_name
[0] == '\0') {
1222 ret
= event_kernel_disable_event(kchan
,
1225 ret
= event_kernel_disable_event(kchan
,
1226 event_name
, event
->type
);
1228 if (ret
!= LTTNG_OK
) {
1233 ret
= LTTNG_ERR_UNK
;
1237 kernel_wait_quiescent(kernel_tracer_fd
);
1240 case LTTNG_DOMAIN_UST
:
1242 struct ltt_ust_channel
*uchan
;
1243 struct ltt_ust_session
*usess
;
1245 usess
= session
->ust_session
;
1247 if (validate_ust_event_name(event_name
)) {
1248 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1253 * If a non-default channel has been created in the
1254 * session, explicitly require that -c chan_name needs
1257 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1258 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1262 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1264 if (uchan
== NULL
) {
1265 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1269 switch (event
->type
) {
1270 case LTTNG_EVENT_ALL
:
1272 * An empty event name means that everything
1273 * should be disabled.
1275 if (event
->name
[0] == '\0') {
1276 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1278 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1281 if (ret
!= LTTNG_OK
) {
1286 ret
= LTTNG_ERR_UNK
;
1290 DBG3("Disable UST event %s in channel %s completed", event_name
,
1294 case LTTNG_DOMAIN_LOG4J
:
1295 case LTTNG_DOMAIN_JUL
:
1296 case LTTNG_DOMAIN_PYTHON
:
1299 struct ltt_ust_session
*usess
= session
->ust_session
;
1303 switch (event
->type
) {
1304 case LTTNG_EVENT_ALL
:
1307 ret
= LTTNG_ERR_UNK
;
1311 agt
= trace_ust_find_agent(usess
, domain
);
1313 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1317 * An empty event name means that everything
1318 * should be disabled.
1320 if (event
->name
[0] == '\0') {
1321 ret
= event_agent_disable_all(usess
, agt
);
1323 ret
= event_agent_disable(usess
, agt
, event_name
);
1325 if (ret
!= LTTNG_OK
) {
1332 ret
= LTTNG_ERR_UND
;
1345 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1347 int cmd_add_context(struct ltt_session
*session
, int domain
,
1348 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1350 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1353 case LTTNG_DOMAIN_KERNEL
:
1354 assert(session
->kernel_session
);
1356 if (session
->kernel_session
->channel_count
== 0) {
1357 /* Create default channel */
1358 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1359 if (ret
!= LTTNG_OK
) {
1362 chan_kern_created
= 1;
1364 /* Add kernel context to kernel tracer */
1365 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1366 if (ret
!= LTTNG_OK
) {
1370 case LTTNG_DOMAIN_UST
:
1372 struct ltt_ust_session
*usess
= session
->ust_session
;
1373 unsigned int chan_count
;
1377 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1378 if (chan_count
== 0) {
1379 struct lttng_channel
*attr
;
1380 /* Create default channel */
1381 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1383 ret
= LTTNG_ERR_FATAL
;
1387 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1388 if (ret
!= LTTNG_OK
) {
1393 chan_ust_created
= 1;
1396 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1397 if (ret
!= LTTNG_OK
) {
1403 ret
= LTTNG_ERR_UND
;
1410 if (chan_kern_created
) {
1411 struct ltt_kernel_channel
*kchan
=
1412 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1413 session
->kernel_session
);
1414 /* Created previously, this should NOT fail. */
1416 kernel_destroy_channel(kchan
);
1419 if (chan_ust_created
) {
1420 struct ltt_ust_channel
*uchan
=
1421 trace_ust_find_channel_by_name(
1422 session
->ust_session
->domain_global
.channels
,
1423 DEFAULT_CHANNEL_NAME
);
1424 /* Created previously, this should NOT fail. */
1426 /* Remove from the channel list of the session. */
1427 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1429 trace_ust_destroy_channel(uchan
);
1434 static int validate_event_name(const char *name
)
1437 const char *c
= name
;
1438 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1441 * Make sure that unescaped wildcards are only used as the last
1442 * character of the event name.
1444 while (c
< event_name_end
) {
1452 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1453 /* Wildcard is not the last character */
1454 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1466 static inline bool name_starts_with(const char *name
, const char *prefix
)
1468 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1470 return !strncmp(name
, prefix
, max_cmp_len
);
1473 /* Perform userspace-specific event name validation */
1474 static int validate_ust_event_name(const char *name
)
1484 * Check name against all internal UST event component namespaces used
1487 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1488 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1489 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1498 * Internal version of cmd_enable_event() with a supplemental
1499 * "internal_event" flag which is used to enable internal events which should
1500 * be hidden from clients. Such events are used in the agent implementation to
1501 * enable the events through which all "agent" events are funeled.
1503 static int _cmd_enable_event(struct ltt_session
*session
,
1504 struct lttng_domain
*domain
,
1505 char *channel_name
, struct lttng_event
*event
,
1506 char *filter_expression
,
1507 struct lttng_filter_bytecode
*filter
,
1508 struct lttng_event_exclusion
*exclusion
,
1509 int wpipe
, bool internal_event
)
1511 int ret
, channel_created
= 0;
1512 struct lttng_channel
*attr
;
1516 assert(channel_name
);
1518 DBG("Enable event command for event \'%s\'", event
->name
);
1522 ret
= validate_event_name(event
->name
);
1527 switch (domain
->type
) {
1528 case LTTNG_DOMAIN_KERNEL
:
1530 struct ltt_kernel_channel
*kchan
;
1533 * If a non-default channel has been created in the
1534 * session, explicitely require that -c chan_name needs
1537 if (session
->kernel_session
->has_non_default_channel
1538 && channel_name
[0] == '\0') {
1539 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1543 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1544 session
->kernel_session
);
1545 if (kchan
== NULL
) {
1546 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1547 LTTNG_BUFFER_GLOBAL
);
1549 ret
= LTTNG_ERR_FATAL
;
1552 if (lttng_strncpy(attr
->name
, channel_name
,
1553 sizeof(attr
->name
))) {
1554 ret
= LTTNG_ERR_INVALID
;
1559 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1560 if (ret
!= LTTNG_OK
) {
1566 channel_created
= 1;
1569 /* Get the newly created kernel channel pointer */
1570 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1571 session
->kernel_session
);
1572 if (kchan
== NULL
) {
1573 /* This sould not happen... */
1574 ret
= LTTNG_ERR_FATAL
;
1578 switch (event
->type
) {
1579 case LTTNG_EVENT_ALL
:
1581 char *filter_expression_a
= NULL
;
1582 struct lttng_filter_bytecode
*filter_a
= NULL
;
1585 * We need to duplicate filter_expression and filter,
1586 * because ownership is passed to first enable
1589 if (filter_expression
) {
1590 filter_expression_a
= strdup(filter_expression
);
1591 if (!filter_expression_a
) {
1592 ret
= LTTNG_ERR_FATAL
;
1597 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1599 free(filter_expression_a
);
1600 ret
= LTTNG_ERR_FATAL
;
1603 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1605 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1606 ret
= event_kernel_enable_event(kchan
, event
,
1607 filter_expression
, filter
);
1608 /* We have passed ownership */
1609 filter_expression
= NULL
;
1611 if (ret
!= LTTNG_OK
) {
1612 if (channel_created
) {
1613 /* Let's not leak a useless channel. */
1614 kernel_destroy_channel(kchan
);
1616 free(filter_expression_a
);
1620 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1621 ret
= event_kernel_enable_event(kchan
, event
,
1622 filter_expression_a
, filter_a
);
1623 /* We have passed ownership */
1624 filter_expression_a
= NULL
;
1626 if (ret
!= LTTNG_OK
) {
1631 case LTTNG_EVENT_PROBE
:
1632 case LTTNG_EVENT_FUNCTION
:
1633 case LTTNG_EVENT_FUNCTION_ENTRY
:
1634 case LTTNG_EVENT_TRACEPOINT
:
1635 ret
= event_kernel_enable_event(kchan
, event
,
1636 filter_expression
, filter
);
1637 /* We have passed ownership */
1638 filter_expression
= NULL
;
1640 if (ret
!= LTTNG_OK
) {
1641 if (channel_created
) {
1642 /* Let's not leak a useless channel. */
1643 kernel_destroy_channel(kchan
);
1648 case LTTNG_EVENT_SYSCALL
:
1649 ret
= event_kernel_enable_event(kchan
, event
,
1650 filter_expression
, filter
);
1651 /* We have passed ownership */
1652 filter_expression
= NULL
;
1654 if (ret
!= LTTNG_OK
) {
1659 ret
= LTTNG_ERR_UNK
;
1663 kernel_wait_quiescent(kernel_tracer_fd
);
1666 case LTTNG_DOMAIN_UST
:
1668 struct ltt_ust_channel
*uchan
;
1669 struct ltt_ust_session
*usess
= session
->ust_session
;
1674 * If a non-default channel has been created in the
1675 * session, explicitely require that -c chan_name needs
1678 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1679 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1683 /* Get channel from global UST domain */
1684 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1686 if (uchan
== NULL
) {
1687 /* Create default channel */
1688 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1689 usess
->buffer_type
);
1691 ret
= LTTNG_ERR_FATAL
;
1694 if (lttng_strncpy(attr
->name
, channel_name
,
1695 sizeof(attr
->name
))) {
1696 ret
= LTTNG_ERR_INVALID
;
1701 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1702 if (ret
!= LTTNG_OK
) {
1708 /* Get the newly created channel reference back */
1709 uchan
= trace_ust_find_channel_by_name(
1710 usess
->domain_global
.channels
, channel_name
);
1714 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1716 * Don't allow users to add UST events to channels which
1717 * are assigned to a userspace subdomain (JUL, Log4J,
1720 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1724 if (!internal_event
) {
1726 * Ensure the event name is not reserved for internal
1729 ret
= validate_ust_event_name(event
->name
);
1731 WARN("Userspace event name %s failed validation.",
1733 event
->name
: "NULL");
1734 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1739 /* At this point, the session and channel exist on the tracer */
1740 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1741 filter_expression
, filter
, exclusion
,
1743 /* We have passed ownership */
1744 filter_expression
= NULL
;
1747 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1748 goto already_enabled
;
1749 } else if (ret
!= LTTNG_OK
) {
1754 case LTTNG_DOMAIN_LOG4J
:
1755 case LTTNG_DOMAIN_JUL
:
1756 case LTTNG_DOMAIN_PYTHON
:
1758 const char *default_event_name
, *default_chan_name
;
1760 struct lttng_event uevent
;
1761 struct lttng_domain tmp_dom
;
1762 struct ltt_ust_session
*usess
= session
->ust_session
;
1766 agt
= trace_ust_find_agent(usess
, domain
->type
);
1768 agt
= agent_create(domain
->type
);
1770 ret
= LTTNG_ERR_NOMEM
;
1773 agent_add(agt
, usess
->agents
);
1776 /* Create the default tracepoint. */
1777 memset(&uevent
, 0, sizeof(uevent
));
1778 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1779 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1780 default_event_name
= event_get_default_agent_ust_name(
1782 if (!default_event_name
) {
1783 ret
= LTTNG_ERR_FATAL
;
1786 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1787 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1790 * The domain type is changed because we are about to enable the
1791 * default channel and event for the JUL domain that are hardcoded.
1792 * This happens in the UST domain.
1794 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1795 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1797 switch (domain
->type
) {
1798 case LTTNG_DOMAIN_LOG4J
:
1799 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1801 case LTTNG_DOMAIN_JUL
:
1802 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1804 case LTTNG_DOMAIN_PYTHON
:
1805 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1808 /* The switch/case we are in should avoid this else big problem */
1813 char *filter_expression_copy
= NULL
;
1814 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1817 const size_t filter_size
= sizeof(
1818 struct lttng_filter_bytecode
)
1821 filter_copy
= zmalloc(filter_size
);
1823 ret
= LTTNG_ERR_NOMEM
;
1826 memcpy(filter_copy
, filter
, filter_size
);
1828 filter_expression_copy
=
1829 strdup(filter_expression
);
1830 if (!filter_expression
) {
1831 ret
= LTTNG_ERR_NOMEM
;
1834 if (!filter_expression_copy
|| !filter_copy
) {
1835 free(filter_expression_copy
);
1841 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1842 (char *) default_chan_name
,
1843 &uevent
, filter_expression_copy
,
1844 filter_copy
, NULL
, wpipe
);
1847 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1848 goto already_enabled
;
1849 } else if (ret
!= LTTNG_OK
) {
1853 /* The wild card * means that everything should be enabled. */
1854 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1855 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1858 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1862 filter_expression
= NULL
;
1863 if (ret
!= LTTNG_OK
) {
1870 ret
= LTTNG_ERR_UND
;
1878 free(filter_expression
);
1886 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1887 * We own filter, exclusion, and filter_expression.
1889 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1890 char *channel_name
, struct lttng_event
*event
,
1891 char *filter_expression
,
1892 struct lttng_filter_bytecode
*filter
,
1893 struct lttng_event_exclusion
*exclusion
,
1896 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1897 filter_expression
, filter
, exclusion
, wpipe
, false);
1901 * Enable an event which is internal to LTTng. An internal should
1902 * never be made visible to clients and are immune to checks such as
1905 static int cmd_enable_event_internal(struct ltt_session
*session
,
1906 struct lttng_domain
*domain
,
1907 char *channel_name
, struct lttng_event
*event
,
1908 char *filter_expression
,
1909 struct lttng_filter_bytecode
*filter
,
1910 struct lttng_event_exclusion
*exclusion
,
1913 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1914 filter_expression
, filter
, exclusion
, wpipe
, true);
1918 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1920 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1923 ssize_t nb_events
= 0;
1926 case LTTNG_DOMAIN_KERNEL
:
1927 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1928 if (nb_events
< 0) {
1929 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1933 case LTTNG_DOMAIN_UST
:
1934 nb_events
= ust_app_list_events(events
);
1935 if (nb_events
< 0) {
1936 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1940 case LTTNG_DOMAIN_LOG4J
:
1941 case LTTNG_DOMAIN_JUL
:
1942 case LTTNG_DOMAIN_PYTHON
:
1943 nb_events
= agent_list_events(events
, domain
);
1944 if (nb_events
< 0) {
1945 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1950 ret
= LTTNG_ERR_UND
;
1957 /* Return negative value to differentiate return code */
1962 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1964 ssize_t
cmd_list_tracepoint_fields(int domain
,
1965 struct lttng_event_field
**fields
)
1968 ssize_t nb_fields
= 0;
1971 case LTTNG_DOMAIN_UST
:
1972 nb_fields
= ust_app_list_event_fields(fields
);
1973 if (nb_fields
< 0) {
1974 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1978 case LTTNG_DOMAIN_KERNEL
:
1979 default: /* fall-through */
1980 ret
= LTTNG_ERR_UND
;
1987 /* Return negative value to differentiate return code */
1991 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1993 return syscall_table_list(events
);
1997 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1999 * Called with session lock held.
2001 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2002 int domain
, int32_t **pids
)
2005 ssize_t nr_pids
= 0;
2008 case LTTNG_DOMAIN_KERNEL
:
2010 struct ltt_kernel_session
*ksess
;
2012 ksess
= session
->kernel_session
;
2013 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2015 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2020 case LTTNG_DOMAIN_UST
:
2022 struct ltt_ust_session
*usess
;
2024 usess
= session
->ust_session
;
2025 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2027 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2032 case LTTNG_DOMAIN_LOG4J
:
2033 case LTTNG_DOMAIN_JUL
:
2034 case LTTNG_DOMAIN_PYTHON
:
2036 ret
= LTTNG_ERR_UND
;
2043 /* Return negative value to differentiate return code */
2048 * Command LTTNG_START_TRACE processed by the client thread.
2050 * Called with session mutex held.
2052 int cmd_start_trace(struct ltt_session
*session
)
2055 unsigned long nb_chan
= 0;
2056 struct ltt_kernel_session
*ksession
;
2057 struct ltt_ust_session
*usess
;
2061 /* Ease our life a bit ;) */
2062 ksession
= session
->kernel_session
;
2063 usess
= session
->ust_session
;
2065 /* Is the session already started? */
2066 if (session
->active
) {
2067 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2072 * Starting a session without channel is useless since after that it's not
2073 * possible to enable channel thus inform the client.
2075 if (usess
&& usess
->domain_global
.channels
) {
2077 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2081 nb_chan
+= ksession
->channel_count
;
2084 ret
= LTTNG_ERR_NO_CHANNEL
;
2088 /* Kernel tracing */
2089 if (ksession
!= NULL
) {
2090 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2091 if (ret
!= LTTNG_OK
) {
2096 /* Flag session that trace should start automatically */
2099 * Even though the start trace might fail, flag this session active so
2100 * other application coming in are started by default.
2104 ret
= ust_app_start_trace_all(usess
);
2106 ret
= LTTNG_ERR_UST_START_FAIL
;
2111 /* Flag this after a successful start. */
2112 session
->has_been_started
= 1;
2113 session
->active
= 1;
2122 * Command LTTNG_STOP_TRACE processed by the client thread.
2124 int cmd_stop_trace(struct ltt_session
*session
)
2127 struct ltt_kernel_channel
*kchan
;
2128 struct ltt_kernel_session
*ksession
;
2129 struct ltt_ust_session
*usess
;
2134 ksession
= session
->kernel_session
;
2135 usess
= session
->ust_session
;
2137 /* Session is not active. Skip everythong and inform the client. */
2138 if (!session
->active
) {
2139 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2144 if (ksession
&& ksession
->active
) {
2145 DBG("Stop kernel tracing");
2147 /* Flush metadata if exist */
2148 if (ksession
->metadata_stream_fd
>= 0) {
2149 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2151 ERR("Kernel metadata flush failed");
2155 /* Flush all buffers before stopping */
2156 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2157 ret
= kernel_flush_buffer(kchan
);
2159 ERR("Kernel flush buffer error");
2163 ret
= kernel_stop_session(ksession
);
2165 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2169 kernel_wait_quiescent(kernel_tracer_fd
);
2171 ksession
->active
= 0;
2174 if (usess
&& usess
->active
) {
2176 * Even though the stop trace might fail, flag this session inactive so
2177 * other application coming in are not started by default.
2181 ret
= ust_app_stop_trace_all(usess
);
2183 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2188 /* Flag inactive after a successful stop. */
2189 session
->active
= 0;
2197 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2199 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2200 struct lttng_uri
*uris
)
2203 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2204 struct ltt_ust_session
*usess
= session
->ust_session
;
2210 /* Can't set consumer URI if the session is active. */
2211 if (session
->active
) {
2212 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2216 /* Set the "global" consumer URIs */
2217 for (i
= 0; i
< nb_uri
; i
++) {
2218 ret
= add_uri_to_consumer(session
->consumer
,
2219 &uris
[i
], 0, session
->name
);
2220 if (ret
!= LTTNG_OK
) {
2225 /* Set UST session URIs */
2226 if (session
->ust_session
) {
2227 for (i
= 0; i
< nb_uri
; i
++) {
2228 ret
= add_uri_to_consumer(
2229 session
->ust_session
->consumer
,
2230 &uris
[i
], LTTNG_DOMAIN_UST
,
2232 if (ret
!= LTTNG_OK
) {
2238 /* Set kernel session URIs */
2239 if (session
->kernel_session
) {
2240 for (i
= 0; i
< nb_uri
; i
++) {
2241 ret
= add_uri_to_consumer(
2242 session
->kernel_session
->consumer
,
2243 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2245 if (ret
!= LTTNG_OK
) {
2252 * Make sure to set the session in output mode after we set URI since a
2253 * session can be created without URL (thus flagged in no output mode).
2255 session
->output_traces
= 1;
2257 ksess
->output_traces
= 1;
2261 usess
->output_traces
= 1;
2272 * Command LTTNG_CREATE_SESSION processed by the client thread.
2274 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2275 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2278 struct ltt_session
*session
;
2284 * Verify if the session already exist
2286 * XXX: There is no need for the session lock list here since the caller
2287 * (process_client_msg) is holding it. We might want to change that so a
2288 * single command does not lock the entire session list.
2290 session
= session_find_by_name(name
);
2291 if (session
!= NULL
) {
2292 ret
= LTTNG_ERR_EXIST_SESS
;
2296 /* Create tracing session in the registry */
2297 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2298 LTTNG_SOCK_GET_GID_CRED(creds
));
2299 if (ret
!= LTTNG_OK
) {
2304 * Get the newly created session pointer back
2306 * XXX: There is no need for the session lock list here since the caller
2307 * (process_client_msg) is holding it. We might want to change that so a
2308 * single command does not lock the entire session list.
2310 session
= session_find_by_name(name
);
2313 session
->live_timer
= live_timer
;
2314 /* Create default consumer output for the session not yet created. */
2315 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2316 if (session
->consumer
== NULL
) {
2317 ret
= LTTNG_ERR_FATAL
;
2318 goto consumer_error
;
2322 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2323 if (ret
!= LTTNG_OK
) {
2324 goto consumer_error
;
2326 session
->output_traces
= 1;
2328 session
->output_traces
= 0;
2329 DBG2("Session %s created with no output", session
->name
);
2332 session
->consumer
->enabled
= 1;
2337 session_destroy(session
);
2344 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2346 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2347 size_t nb_uri
, lttng_sock_cred
*creds
)
2350 struct ltt_session
*session
;
2351 struct snapshot_output
*new_output
= NULL
;
2357 * Create session in no output mode with URIs set to NULL. The uris we've
2358 * received are for a default snapshot output if one.
2360 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2361 if (ret
!= LTTNG_OK
) {
2365 /* Get the newly created session pointer back. This should NEVER fail. */
2366 session
= session_find_by_name(name
);
2369 /* Flag session for snapshot mode. */
2370 session
->snapshot_mode
= 1;
2372 /* Skip snapshot output creation if no URI is given. */
2377 new_output
= snapshot_output_alloc();
2379 ret
= LTTNG_ERR_NOMEM
;
2380 goto error_snapshot_alloc
;
2383 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2384 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2386 if (ret
== -ENOMEM
) {
2387 ret
= LTTNG_ERR_NOMEM
;
2389 ret
= LTTNG_ERR_INVALID
;
2391 goto error_snapshot
;
2395 snapshot_add_output(&session
->snapshot
, new_output
);
2402 snapshot_output_destroy(new_output
);
2403 error_snapshot_alloc
:
2404 session_destroy(session
);
2410 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2412 * Called with session lock held.
2414 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2417 struct ltt_ust_session
*usess
;
2418 struct ltt_kernel_session
*ksess
;
2423 usess
= session
->ust_session
;
2424 ksess
= session
->kernel_session
;
2426 /* Clean kernel session teardown */
2427 kernel_destroy_session(ksess
);
2429 /* UST session teardown */
2431 /* Close any relayd session */
2432 consumer_output_send_destroy_relayd(usess
->consumer
);
2434 /* Destroy every UST application related to this session. */
2435 ret
= ust_app_destroy_trace_all(usess
);
2437 ERR("Error in ust_app_destroy_trace_all");
2440 /* Clean up the rest. */
2441 trace_ust_destroy_session(usess
);
2445 * Must notify the kernel thread here to update it's poll set in order to
2446 * remove the channel(s)' fd just destroyed.
2448 ret
= notify_thread_pipe(wpipe
);
2450 PERROR("write kernel poll pipe");
2453 ret
= session_destroy(session
);
2459 * Command LTTNG_CALIBRATE processed by the client thread.
2461 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2466 case LTTNG_DOMAIN_KERNEL
:
2468 struct lttng_kernel_calibrate kcalibrate
;
2470 switch (calibrate
->type
) {
2471 case LTTNG_CALIBRATE_FUNCTION
:
2473 /* Default and only possible calibrate option. */
2474 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2478 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2480 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2485 case LTTNG_DOMAIN_UST
:
2487 struct lttng_ust_calibrate ucalibrate
;
2489 switch (calibrate
->type
) {
2490 case LTTNG_CALIBRATE_FUNCTION
:
2492 /* Default and only possible calibrate option. */
2493 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2497 ret
= ust_app_calibrate_glb(&ucalibrate
);
2499 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2505 ret
= LTTNG_ERR_UND
;
2516 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2518 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2519 const char *sock_path
, struct consumer_data
*cdata
)
2522 struct consumer_socket
*socket
= NULL
;
2529 case LTTNG_DOMAIN_KERNEL
:
2531 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2535 /* Can't register a consumer if there is already one */
2536 if (ksess
->consumer_fds_sent
!= 0) {
2537 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2541 sock
= lttcomm_connect_unix_sock(sock_path
);
2543 ret
= LTTNG_ERR_CONNECT_FAIL
;
2546 cdata
->cmd_sock
= sock
;
2548 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2549 if (socket
== NULL
) {
2552 PERROR("close register consumer");
2554 cdata
->cmd_sock
= -1;
2555 ret
= LTTNG_ERR_FATAL
;
2559 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2560 if (socket
->lock
== NULL
) {
2561 PERROR("zmalloc pthread mutex");
2562 ret
= LTTNG_ERR_FATAL
;
2565 pthread_mutex_init(socket
->lock
, NULL
);
2566 socket
->registered
= 1;
2569 consumer_add_socket(socket
, ksess
->consumer
);
2572 pthread_mutex_lock(&cdata
->pid_mutex
);
2574 pthread_mutex_unlock(&cdata
->pid_mutex
);
2579 /* TODO: Userspace tracing */
2580 ret
= LTTNG_ERR_UND
;
2588 consumer_destroy_socket(socket
);
2594 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2596 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2597 struct lttng_domain
**domains
)
2602 struct lttng_ht_iter iter
;
2604 if (session
->kernel_session
!= NULL
) {
2605 DBG3("Listing domains found kernel domain");
2609 if (session
->ust_session
!= NULL
) {
2610 DBG3("Listing domains found UST global domain");
2614 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2616 if (agt
->being_used
) {
2627 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2628 if (*domains
== NULL
) {
2629 ret
= LTTNG_ERR_FATAL
;
2633 if (session
->kernel_session
!= NULL
) {
2634 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2636 /* Kernel session buffer type is always GLOBAL */
2637 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2642 if (session
->ust_session
!= NULL
) {
2643 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2644 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2648 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2650 if (agt
->being_used
) {
2651 (*domains
)[index
].type
= agt
->domain
;
2652 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2662 /* Return negative value to differentiate return code */
2668 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2670 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2671 struct lttng_channel
**channels
)
2674 ssize_t nb_chan
= 0;
2677 case LTTNG_DOMAIN_KERNEL
:
2678 if (session
->kernel_session
!= NULL
) {
2679 nb_chan
= session
->kernel_session
->channel_count
;
2681 DBG3("Number of kernel channels %zd", nb_chan
);
2683 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2686 case LTTNG_DOMAIN_UST
:
2687 if (session
->ust_session
!= NULL
) {
2689 nb_chan
= lttng_ht_get_count(
2690 session
->ust_session
->domain_global
.channels
);
2693 DBG3("Number of UST global channels %zd", nb_chan
);
2695 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2700 ret
= LTTNG_ERR_UND
;
2705 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2706 if (*channels
== NULL
) {
2707 ret
= LTTNG_ERR_FATAL
;
2711 list_lttng_channels(domain
, session
, *channels
);
2717 /* Return negative value to differentiate return code */
2722 * Command LTTNG_LIST_EVENTS processed by the client thread.
2724 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2725 char *channel_name
, struct lttng_event
**events
)
2728 ssize_t nb_event
= 0;
2731 case LTTNG_DOMAIN_KERNEL
:
2732 if (session
->kernel_session
!= NULL
) {
2733 nb_event
= list_lttng_kernel_events(channel_name
,
2734 session
->kernel_session
, events
);
2737 case LTTNG_DOMAIN_UST
:
2739 if (session
->ust_session
!= NULL
) {
2740 nb_event
= list_lttng_ust_global_events(channel_name
,
2741 &session
->ust_session
->domain_global
, events
);
2745 case LTTNG_DOMAIN_LOG4J
:
2746 case LTTNG_DOMAIN_JUL
:
2747 case LTTNG_DOMAIN_PYTHON
:
2748 if (session
->ust_session
) {
2749 struct lttng_ht_iter iter
;
2753 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2754 &iter
.iter
, agt
, node
.node
) {
2755 if (agt
->domain
== domain
) {
2756 nb_event
= list_lttng_agent_events(
2765 ret
= LTTNG_ERR_UND
;
2772 /* Return negative value to differentiate return code */
2777 * Using the session list, filled a lttng_session array to send back to the
2778 * client for session listing.
2780 * The session list lock MUST be acquired before calling this function. Use
2781 * session_lock_list() and session_unlock_list().
2783 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2788 struct ltt_session
*session
;
2789 struct ltt_session_list
*list
= session_get_list();
2791 DBG("Getting all available session for UID %d GID %d",
2794 * Iterate over session list and append data after the control struct in
2797 cds_list_for_each_entry(session
, &list
->head
, list
) {
2799 * Only list the sessions the user can control.
2801 if (!session_access_ok(session
, uid
, gid
)) {
2805 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2806 struct ltt_ust_session
*usess
= session
->ust_session
;
2808 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2809 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2810 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2811 ret
= build_network_session_path(sessions
[i
].path
,
2812 sizeof(sessions
[i
].path
), session
);
2814 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2815 session
->consumer
->dst
.trace_path
);
2818 PERROR("snprintf session path");
2822 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2823 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2824 sessions
[i
].enabled
= session
->active
;
2825 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2826 sessions
[i
].live_timer_interval
= session
->live_timer
;
2832 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2833 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2835 int cmd_data_pending(struct ltt_session
*session
)
2838 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2839 struct ltt_ust_session
*usess
= session
->ust_session
;
2843 /* Session MUST be stopped to ask for data availability. */
2844 if (session
->active
) {
2845 ret
= LTTNG_ERR_SESSION_STARTED
;
2849 * If stopped, just make sure we've started before else the above call
2850 * will always send that there is data pending.
2852 * The consumer assumes that when the data pending command is received,
2853 * the trace has been started before or else no output data is written
2854 * by the streams which is a condition for data pending. So, this is
2855 * *VERY* important that we don't ask the consumer before a start
2858 if (!session
->has_been_started
) {
2864 if (ksess
&& ksess
->consumer
) {
2865 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2867 /* Data is still being extracted for the kernel. */
2872 if (usess
&& usess
->consumer
) {
2873 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2875 /* Data is still being extracted for the kernel. */
2880 /* Data is ready to be read by a viewer */
2888 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2890 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2892 int cmd_snapshot_add_output(struct ltt_session
*session
,
2893 struct lttng_snapshot_output
*output
, uint32_t *id
)
2896 struct snapshot_output
*new_output
;
2901 DBG("Cmd snapshot add output for session %s", session
->name
);
2904 * Permission denied to create an output if the session is not
2905 * set in no output mode.
2907 if (session
->output_traces
) {
2908 ret
= LTTNG_ERR_EPERM
;
2912 /* Only one output is allowed until we have the "tee" feature. */
2913 if (session
->snapshot
.nb_output
== 1) {
2914 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2918 new_output
= snapshot_output_alloc();
2920 ret
= LTTNG_ERR_NOMEM
;
2924 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2925 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2926 &session
->snapshot
);
2928 if (ret
== -ENOMEM
) {
2929 ret
= LTTNG_ERR_NOMEM
;
2931 ret
= LTTNG_ERR_INVALID
;
2937 snapshot_add_output(&session
->snapshot
, new_output
);
2939 *id
= new_output
->id
;
2946 snapshot_output_destroy(new_output
);
2952 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2954 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2956 int cmd_snapshot_del_output(struct ltt_session
*session
,
2957 struct lttng_snapshot_output
*output
)
2960 struct snapshot_output
*sout
= NULL
;
2968 * Permission denied to create an output if the session is not
2969 * set in no output mode.
2971 if (session
->output_traces
) {
2972 ret
= LTTNG_ERR_EPERM
;
2977 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2979 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2980 } else if (*output
->name
!= '\0') {
2981 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2983 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2986 ret
= LTTNG_ERR_INVALID
;
2990 snapshot_delete_output(&session
->snapshot
, sout
);
2991 snapshot_output_destroy(sout
);
3000 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3002 * If no output is available, outputs is untouched and 0 is returned.
3004 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3006 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3007 struct lttng_snapshot_output
**outputs
)
3010 struct lttng_snapshot_output
*list
= NULL
;
3011 struct lttng_ht_iter iter
;
3012 struct snapshot_output
*output
;
3017 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3020 * Permission denied to create an output if the session is not
3021 * set in no output mode.
3023 if (session
->output_traces
) {
3024 ret
= -LTTNG_ERR_EPERM
;
3028 if (session
->snapshot
.nb_output
== 0) {
3033 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3035 ret
= -LTTNG_ERR_NOMEM
;
3039 /* Copy list from session to the new list object. */
3041 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3042 output
, node
.node
) {
3043 assert(output
->consumer
);
3044 list
[idx
].id
= output
->id
;
3045 list
[idx
].max_size
= output
->max_size
;
3046 if (lttng_strncpy(list
[idx
].name
, output
->name
,
3047 sizeof(list
[idx
].name
))) {
3048 ret
= -LTTNG_ERR_INVALID
;
3051 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3052 if (lttng_strncpy(list
[idx
].ctrl_url
,
3053 output
->consumer
->dst
.trace_path
,
3054 sizeof(list
[idx
].ctrl_url
))) {
3055 ret
= -LTTNG_ERR_INVALID
;
3060 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3061 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3063 ret
= -LTTNG_ERR_NOMEM
;
3068 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3069 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3071 ret
= -LTTNG_ERR_NOMEM
;
3080 ret
= session
->snapshot
.nb_output
;
3088 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3089 * snapshot output is *not* set with a remote destination.
3091 * Return 0 on success or a LTTNG_ERR code.
3093 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3094 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3097 struct lttng_ht_iter iter
;
3098 struct consumer_socket
*socket
;
3101 assert(snap_output
);
3104 DBG2("Set relayd object from snapshot output");
3106 /* Ignore if snapshot consumer output is not network. */
3107 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3112 * For each consumer socket, create and send the relayd object of the
3116 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3117 socket
, node
.node
) {
3118 ret
= send_consumer_relayd_sockets(0, session
->id
,
3119 snap_output
->consumer
, socket
,
3120 session
->name
, session
->hostname
,
3121 session
->live_timer
);
3122 if (ret
!= LTTNG_OK
) {
3134 * Record a kernel snapshot.
3136 * Return LTTNG_OK on success or a LTTNG_ERR code.
3138 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3139 struct snapshot_output
*output
, struct ltt_session
*session
,
3140 int wait
, uint64_t nb_packets_per_stream
)
3150 * Copy kernel session sockets so we can communicate with the right
3151 * consumer for the snapshot record command.
3153 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3155 ret
= LTTNG_ERR_NOMEM
;
3159 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3160 if (ret
!= LTTNG_OK
) {
3161 goto error_snapshot
;
3164 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3165 if (ret
!= LTTNG_OK
) {
3166 goto error_snapshot
;
3173 /* Clean up copied sockets so this output can use some other later on. */
3174 consumer_destroy_output_sockets(output
->consumer
);
3181 * Record a UST snapshot.
3183 * Return 0 on success or a LTTNG_ERR error code.
3185 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3186 struct snapshot_output
*output
, struct ltt_session
*session
,
3187 int wait
, uint64_t nb_packets_per_stream
)
3196 * Copy UST session sockets so we can communicate with the right
3197 * consumer for the snapshot record command.
3199 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3201 ret
= LTTNG_ERR_NOMEM
;
3205 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3206 if (ret
!= LTTNG_OK
) {
3207 goto error_snapshot
;
3210 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3214 ret
= LTTNG_ERR_INVALID
;
3217 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3220 goto error_snapshot
;
3226 /* Clean up copied sockets so this output can use some other later on. */
3227 consumer_destroy_output_sockets(output
->consumer
);
3233 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3234 uint64_t cur_nr_packets
)
3236 uint64_t tot_size
= 0;
3238 if (session
->kernel_session
) {
3239 struct ltt_kernel_channel
*chan
;
3240 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3242 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3243 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3245 * Don't take channel into account if we
3246 * already grab all its packets.
3250 tot_size
+= chan
->channel
->attr
.subbuf_size
3251 * chan
->stream_count
;
3255 if (session
->ust_session
) {
3256 struct ltt_ust_session
*usess
= session
->ust_session
;
3258 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3266 * Calculate the number of packets we can grab from each stream that
3267 * fits within the overall snapshot max size.
3269 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3270 * the number of packets per stream.
3272 * TODO: this approach is not perfect: we consider the worse case
3273 * (packet filling the sub-buffers) as an upper bound, but we could do
3274 * better if we do this calculation while we actually grab the packet
3275 * content: we would know how much padding we don't actually store into
3278 * This algorithm is currently bounded by the number of packets per
3281 * Since we call this algorithm before actually grabbing the data, it's
3282 * an approximation: for instance, applications could appear/disappear
3283 * in between this call and actually grabbing data.
3286 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3289 uint64_t cur_nb_packets
= 0;
3292 return 0; /* Infinite */
3295 size_left
= max_size
;
3297 uint64_t one_more_packet_tot_size
;
3299 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3301 if (!one_more_packet_tot_size
) {
3302 /* We are already grabbing all packets. */
3305 size_left
-= one_more_packet_tot_size
;
3306 if (size_left
< 0) {
3311 if (!cur_nb_packets
) {
3312 /* Not enough room to grab one packet of each stream, error. */
3315 return cur_nb_packets
;
3319 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3321 * The wait parameter is ignored so this call always wait for the snapshot to
3322 * complete before returning.
3324 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3326 int cmd_snapshot_record(struct ltt_session
*session
,
3327 struct lttng_snapshot_output
*output
, int wait
)
3330 unsigned int use_tmp_output
= 0;
3331 struct snapshot_output tmp_output
;
3332 unsigned int snapshot_success
= 0;
3338 DBG("Cmd snapshot record for session %s", session
->name
);
3340 /* Get the datetime for the snapshot output directory. */
3341 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3344 ret
= LTTNG_ERR_INVALID
;
3349 * Permission denied to create an output if the session is not
3350 * set in no output mode.
3352 if (session
->output_traces
) {
3353 ret
= LTTNG_ERR_EPERM
;
3357 /* The session needs to be started at least once. */
3358 if (!session
->has_been_started
) {
3359 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3363 /* Use temporary output for the session. */
3364 if (*output
->ctrl_url
!= '\0') {
3365 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3366 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3369 if (ret
== -ENOMEM
) {
3370 ret
= LTTNG_ERR_NOMEM
;
3372 ret
= LTTNG_ERR_INVALID
;
3376 /* Use the global session count for the temporary snapshot. */
3377 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3379 /* Use the global datetime */
3380 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3384 if (use_tmp_output
) {
3385 int64_t nb_packets_per_stream
;
3387 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3388 tmp_output
.max_size
);
3389 if (nb_packets_per_stream
< 0) {
3390 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3394 if (session
->kernel_session
) {
3395 ret
= record_kernel_snapshot(session
->kernel_session
,
3396 &tmp_output
, session
,
3397 wait
, nb_packets_per_stream
);
3398 if (ret
!= LTTNG_OK
) {
3403 if (session
->ust_session
) {
3404 ret
= record_ust_snapshot(session
->ust_session
,
3405 &tmp_output
, session
,
3406 wait
, nb_packets_per_stream
);
3407 if (ret
!= LTTNG_OK
) {
3412 snapshot_success
= 1;
3414 struct snapshot_output
*sout
;
3415 struct lttng_ht_iter iter
;
3418 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3419 &iter
.iter
, sout
, node
.node
) {
3420 int64_t nb_packets_per_stream
;
3423 * Make a local copy of the output and assign the possible
3424 * temporary value given by the caller.
3426 memset(&tmp_output
, 0, sizeof(tmp_output
));
3427 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3429 if (output
->max_size
!= (uint64_t) -1ULL) {
3430 tmp_output
.max_size
= output
->max_size
;
3433 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3434 tmp_output
.max_size
);
3435 if (nb_packets_per_stream
< 0) {
3436 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3441 /* Use temporary name. */
3442 if (*output
->name
!= '\0') {
3443 if (lttng_strncpy(tmp_output
.name
, output
->name
,
3444 sizeof(tmp_output
.name
))) {
3445 ret
= LTTNG_ERR_INVALID
;
3451 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3452 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3454 if (session
->kernel_session
) {
3455 ret
= record_kernel_snapshot(session
->kernel_session
,
3456 &tmp_output
, session
,
3457 wait
, nb_packets_per_stream
);
3458 if (ret
!= LTTNG_OK
) {
3464 if (session
->ust_session
) {
3465 ret
= record_ust_snapshot(session
->ust_session
,
3466 &tmp_output
, session
,
3467 wait
, nb_packets_per_stream
);
3468 if (ret
!= LTTNG_OK
) {
3473 snapshot_success
= 1;
3478 if (snapshot_success
) {
3479 session
->snapshot
.nb_snapshot
++;
3481 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3489 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3491 int cmd_set_session_shm_path(struct ltt_session
*session
,
3492 const char *shm_path
)
3498 * Can only set shm path before session is started.
3500 if (session
->has_been_started
) {
3501 return LTTNG_ERR_SESSION_STARTED
;
3504 strncpy(session
->shm_path
, shm_path
,
3505 sizeof(session
->shm_path
));
3506 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3512 * Init command subsystem.
3517 * Set network sequence index to 1 for streams to match a relayd
3518 * socket on the consumer side.
3520 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3521 relayd_net_seq_idx
= 1;
3522 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3524 DBG("Command subsystem initialized");