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"
46 * Used to keep a unique index for each relayd socket created where this value
47 * is associated with streams on the consumer so it can match the right relayd
48 * to send to. It must be accessed with the relayd_net_seq_idx_lock
51 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 static uint64_t relayd_net_seq_idx
;
54 static int validate_event_name(const char *);
55 static int validate_ust_event_name(const char *);
56 static int cmd_enable_event_internal(struct ltt_session
*session
,
57 struct lttng_domain
*domain
,
58 char *channel_name
, struct lttng_event
*event
,
59 char *filter_expression
,
60 struct lttng_filter_bytecode
*filter
,
61 struct lttng_event_exclusion
*exclusion
,
65 * Create a session path used by list_lttng_sessions for the case that the
66 * session consumer is on the network.
68 static int build_network_session_path(char *dst
, size_t size
,
69 struct ltt_session
*session
)
71 int ret
, kdata_port
, udata_port
;
72 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
73 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
78 memset(tmp_urls
, 0, sizeof(tmp_urls
));
79 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
81 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
83 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
84 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
85 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
88 if (session
->ust_session
&& session
->ust_session
->consumer
) {
89 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
90 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
93 if (uuri
== NULL
&& kuri
== NULL
) {
94 uri
= &session
->consumer
->dst
.net
.control
;
95 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
96 } else if (kuri
&& uuri
) {
97 ret
= uri_compare(kuri
, uuri
);
101 /* Build uuri URL string */
102 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
109 } else if (kuri
&& uuri
== NULL
) {
111 } else if (uuri
&& kuri
== NULL
) {
115 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
121 * Do we have a UST url set. If yes, this means we have both kernel and UST
124 if (*tmp_uurl
!= '\0') {
125 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
126 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
129 if (kuri
|| (!kuri
&& !uuri
)) {
132 /* No kernel URI, use the UST port. */
135 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
143 * Fill lttng_channel array of all channels.
145 static void list_lttng_channels(enum lttng_domain_type domain
,
146 struct ltt_session
*session
, struct lttng_channel
*channels
)
149 struct ltt_kernel_channel
*kchan
;
151 DBG("Listing channels for session %s", session
->name
);
154 case LTTNG_DOMAIN_KERNEL
:
155 /* Kernel channels */
156 if (session
->kernel_session
!= NULL
) {
157 cds_list_for_each_entry(kchan
,
158 &session
->kernel_session
->channel_list
.head
, list
) {
159 /* Copy lttng_channel struct to array */
160 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
161 channels
[i
].enabled
= kchan
->enabled
;
166 case LTTNG_DOMAIN_UST
:
168 struct lttng_ht_iter iter
;
169 struct ltt_ust_channel
*uchan
;
172 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
173 &iter
.iter
, uchan
, node
.node
) {
174 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
175 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
176 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
177 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
178 channels
[i
].attr
.switch_timer_interval
=
179 uchan
->attr
.switch_timer_interval
;
180 channels
[i
].attr
.read_timer_interval
=
181 uchan
->attr
.read_timer_interval
;
182 channels
[i
].enabled
= uchan
->enabled
;
183 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
184 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
185 switch (uchan
->attr
.output
) {
188 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
202 * Create a list of agent domain events.
204 * Return number of events in list on success or else a negative value.
206 static int list_lttng_agent_events(struct agent
*agt
,
207 struct lttng_event
**events
)
210 unsigned int nb_event
= 0;
211 struct agent_event
*event
;
212 struct lttng_event
*tmp_events
;
213 struct lttng_ht_iter iter
;
218 DBG3("Listing agent events");
221 nb_event
= lttng_ht_get_count(agt
->events
);
228 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
230 PERROR("zmalloc agent events session");
231 ret
= -LTTNG_ERR_FATAL
;
236 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
237 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
238 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
239 tmp_events
[i
].enabled
= event
->enabled
;
240 tmp_events
[i
].loglevel
= event
->loglevel
;
241 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
246 *events
= tmp_events
;
250 assert(nb_event
== i
);
255 * Create a list of ust global domain events.
257 static int list_lttng_ust_global_events(char *channel_name
,
258 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
261 unsigned int nb_event
= 0;
262 struct lttng_ht_iter iter
;
263 struct lttng_ht_node_str
*node
;
264 struct ltt_ust_channel
*uchan
;
265 struct ltt_ust_event
*uevent
;
266 struct lttng_event
*tmp
;
268 DBG("Listing UST global events for channel %s", channel_name
);
272 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
273 node
= lttng_ht_iter_get_node_str(&iter
);
275 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
279 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
281 nb_event
= lttng_ht_get_count(uchan
->events
);
287 DBG3("Listing UST global %d events", nb_event
);
289 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
291 ret
= LTTNG_ERR_FATAL
;
295 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
296 if (uevent
->internal
) {
297 /* This event should remain hidden from clients */
301 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
302 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
303 tmp
[i
].enabled
= uevent
->enabled
;
305 switch (uevent
->attr
.instrumentation
) {
306 case LTTNG_UST_TRACEPOINT
:
307 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
309 case LTTNG_UST_PROBE
:
310 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
312 case LTTNG_UST_FUNCTION
:
313 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
317 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
318 switch (uevent
->attr
.loglevel_type
) {
319 case LTTNG_UST_LOGLEVEL_ALL
:
320 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
322 case LTTNG_UST_LOGLEVEL_RANGE
:
323 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
325 case LTTNG_UST_LOGLEVEL_SINGLE
:
326 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
329 if (uevent
->filter
) {
332 if (uevent
->exclusion
) {
333 tmp
[i
].exclusion
= 1;
347 * Fill lttng_event array of all kernel events in the channel.
349 static int list_lttng_kernel_events(char *channel_name
,
350 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
353 unsigned int nb_event
;
354 struct ltt_kernel_event
*event
;
355 struct ltt_kernel_channel
*kchan
;
357 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
359 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
363 nb_event
= kchan
->event_count
;
365 DBG("Listing events for channel %s", kchan
->channel
->name
);
372 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
373 if (*events
== NULL
) {
374 ret
= LTTNG_ERR_FATAL
;
378 /* Kernel channels */
379 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
380 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
381 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
382 (*events
)[i
].enabled
= event
->enabled
;
384 switch (event
->event
->instrumentation
) {
385 case LTTNG_KERNEL_TRACEPOINT
:
386 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
388 case LTTNG_KERNEL_KRETPROBE
:
389 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
390 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
391 sizeof(struct lttng_kernel_kprobe
));
393 case LTTNG_KERNEL_KPROBE
:
394 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
395 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
396 sizeof(struct lttng_kernel_kprobe
));
398 case LTTNG_KERNEL_FUNCTION
:
399 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
400 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
401 sizeof(struct lttng_kernel_function
));
403 case LTTNG_KERNEL_NOOP
:
404 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
406 case LTTNG_KERNEL_SYSCALL
:
407 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
409 case LTTNG_KERNEL_ALL
:
420 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
432 /* Negate the error code to differentiate the size from an error */
437 * Add URI so the consumer output object. Set the correct path depending on the
438 * domain adding the default trace directory.
440 static int add_uri_to_consumer(struct consumer_output
*consumer
,
441 struct lttng_uri
*uri
, enum lttng_domain_type domain
,
442 const char *session_name
)
445 const char *default_trace_dir
;
449 if (consumer
== NULL
) {
450 DBG("No consumer detected. Don't add URI. Stopping.");
451 ret
= LTTNG_ERR_NO_CONSUMER
;
456 case LTTNG_DOMAIN_KERNEL
:
457 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
459 case LTTNG_DOMAIN_UST
:
460 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
464 * This case is possible is we try to add the URI to the global tracing
465 * session consumer object which in this case there is no subdir.
467 default_trace_dir
= "";
470 switch (uri
->dtype
) {
473 DBG2("Setting network URI to consumer");
475 if (consumer
->type
== CONSUMER_DST_NET
) {
476 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
477 consumer
->dst
.net
.control_isset
) ||
478 (uri
->stype
== LTTNG_STREAM_DATA
&&
479 consumer
->dst
.net
.data_isset
)) {
480 ret
= LTTNG_ERR_URL_EXIST
;
484 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
487 consumer
->type
= CONSUMER_DST_NET
;
489 /* Set URI into consumer output object */
490 ret
= consumer_set_network_uri(consumer
, uri
);
494 } else if (ret
== 1) {
496 * URI was the same in the consumer so we do not append the subdir
497 * again so to not duplicate output dir.
503 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
504 ret
= consumer_set_subdir(consumer
, session_name
);
506 ret
= LTTNG_ERR_FATAL
;
511 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
512 /* On a new subdir, reappend the default trace dir. */
513 strncat(consumer
->subdir
, default_trace_dir
,
514 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
515 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
520 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
521 memset(consumer
->dst
.trace_path
, 0,
522 sizeof(consumer
->dst
.trace_path
));
523 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
524 sizeof(consumer
->dst
.trace_path
));
525 /* Append default trace dir */
526 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
527 sizeof(consumer
->dst
.trace_path
) -
528 strlen(consumer
->dst
.trace_path
) - 1);
529 /* Flag consumer as local. */
530 consumer
->type
= CONSUMER_DST_LOCAL
;
541 * Init tracing by creating trace directory and sending fds kernel consumer.
543 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
546 struct lttng_ht_iter iter
;
547 struct consumer_socket
*socket
;
553 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
554 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
556 pthread_mutex_lock(socket
->lock
);
557 ret
= kernel_consumer_send_session(socket
, session
);
558 pthread_mutex_unlock(socket
->lock
);
560 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
572 * Create a socket to the relayd using the URI.
574 * On success, the relayd_sock pointer is set to the created socket.
575 * Else, it's stays untouched and a lttcomm error code is returned.
577 static int create_connect_relayd(struct lttng_uri
*uri
,
578 struct lttcomm_relayd_sock
**relayd_sock
)
581 struct lttcomm_relayd_sock
*rsock
;
583 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
584 RELAYD_VERSION_COMM_MINOR
);
586 ret
= LTTNG_ERR_FATAL
;
591 * Connect to relayd so we can proceed with a session creation. This call
592 * can possibly block for an arbitrary amount of time to set the health
593 * state to be in poll execution.
596 ret
= relayd_connect(rsock
);
599 ERR("Unable to reach lttng-relayd");
600 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
604 /* Create socket for control stream. */
605 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
606 DBG3("Creating relayd stream socket from URI");
608 /* Check relayd version */
609 ret
= relayd_version_check(rsock
);
611 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
614 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
615 DBG3("Creating relayd data socket from URI");
617 /* Command is not valid */
618 ERR("Relayd invalid stream type: %d", uri
->stype
);
619 ret
= LTTNG_ERR_INVALID
;
623 *relayd_sock
= rsock
;
628 /* The returned value is not useful since we are on an error path. */
629 (void) relayd_close(rsock
);
637 * Connect to the relayd using URI and send the socket to the right consumer.
639 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
640 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
641 struct consumer_output
*consumer
,
642 struct consumer_socket
*consumer_sock
,
643 char *session_name
, char *hostname
, int session_live_timer
)
646 struct lttcomm_relayd_sock
*rsock
= NULL
;
648 /* Connect to relayd and make version check if uri is the control. */
649 ret
= create_connect_relayd(relayd_uri
, &rsock
);
650 if (ret
!= LTTNG_OK
) {
655 /* Set the network sequence index if not set. */
656 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
657 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
659 * Increment net_seq_idx because we are about to transfer the
660 * new relayd socket to the consumer.
661 * Assign unique key so the consumer can match streams.
663 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
664 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
667 /* Send relayd socket to consumer. */
668 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
669 relayd_uri
->stype
, session_id
,
670 session_name
, hostname
, session_live_timer
);
672 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
676 /* Flag that the corresponding socket was sent. */
677 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
678 consumer_sock
->control_sock_sent
= 1;
679 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
680 consumer_sock
->data_sock_sent
= 1;
686 * Close socket which was dup on the consumer side. The session daemon does
687 * NOT keep track of the relayd socket(s) once transfer to the consumer.
691 (void) relayd_close(rsock
);
695 if (ret
!= LTTNG_OK
) {
697 * The consumer output for this session should not be used anymore
698 * since the relayd connection failed thus making any tracing or/and
699 * streaming not usable.
701 consumer
->enabled
= 0;
707 * Send both relayd sockets to a specific consumer and domain. This is a
708 * helper function to facilitate sending the information to the consumer for a
711 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
712 unsigned int session_id
, struct consumer_output
*consumer
,
713 struct consumer_socket
*sock
, char *session_name
,
714 char *hostname
, int session_live_timer
)
721 /* Sending control relayd socket. */
722 if (!sock
->control_sock_sent
) {
723 ret
= send_consumer_relayd_socket(domain
, session_id
,
724 &consumer
->dst
.net
.control
, consumer
, sock
,
725 session_name
, hostname
, session_live_timer
);
726 if (ret
!= LTTNG_OK
) {
731 /* Sending data relayd socket. */
732 if (!sock
->data_sock_sent
) {
733 ret
= send_consumer_relayd_socket(domain
, session_id
,
734 &consumer
->dst
.net
.data
, consumer
, sock
,
735 session_name
, hostname
, session_live_timer
);
736 if (ret
!= LTTNG_OK
) {
746 * Setup relayd connections for a tracing session. First creates the socket to
747 * the relayd and send them to the right domain consumer. Consumer type MUST be
750 int cmd_setup_relayd(struct ltt_session
*session
)
753 struct ltt_ust_session
*usess
;
754 struct ltt_kernel_session
*ksess
;
755 struct consumer_socket
*socket
;
756 struct lttng_ht_iter iter
;
760 usess
= session
->ust_session
;
761 ksess
= session
->kernel_session
;
763 DBG("Setting relayd for session %s", session
->name
);
767 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
768 && usess
->consumer
->enabled
) {
769 /* For each consumer socket, send relayd sockets */
770 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
772 pthread_mutex_lock(socket
->lock
);
773 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
774 usess
->consumer
, socket
,
775 session
->name
, session
->hostname
,
776 session
->live_timer
);
777 pthread_mutex_unlock(socket
->lock
);
778 if (ret
!= LTTNG_OK
) {
781 /* Session is now ready for network streaming. */
782 session
->net_handle
= 1;
786 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
787 && ksess
->consumer
->enabled
) {
788 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
790 pthread_mutex_lock(socket
->lock
);
791 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
792 ksess
->consumer
, socket
,
793 session
->name
, session
->hostname
,
794 session
->live_timer
);
795 pthread_mutex_unlock(socket
->lock
);
796 if (ret
!= LTTNG_OK
) {
799 /* Session is now ready for network streaming. */
800 session
->net_handle
= 1;
810 * Start a kernel session by opening all necessary streams.
812 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
815 struct ltt_kernel_channel
*kchan
;
817 /* Open kernel metadata */
818 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
819 ret
= kernel_open_metadata(ksess
);
821 ret
= LTTNG_ERR_KERN_META_FAIL
;
826 /* Open kernel metadata stream */
827 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
828 ret
= kernel_open_metadata_stream(ksess
);
830 ERR("Kernel create metadata stream failed");
831 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
836 /* For each channel */
837 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
838 if (kchan
->stream_count
== 0) {
839 ret
= kernel_open_channel_stream(kchan
);
841 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
844 /* Update the stream global counter */
845 ksess
->stream_count_global
+= ret
;
849 /* Setup kernel consumer socket and send fds to it */
850 ret
= init_kernel_tracing(ksess
);
852 ret
= LTTNG_ERR_KERN_START_FAIL
;
856 /* This start the kernel tracing */
857 ret
= kernel_start_session(ksess
);
859 ret
= LTTNG_ERR_KERN_START_FAIL
;
863 /* Quiescent wait after starting trace */
864 kernel_wait_quiescent(kernel_tracer_fd
);
875 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
877 int cmd_disable_channel(struct ltt_session
*session
,
878 enum lttng_domain_type domain
, char *channel_name
)
881 struct ltt_ust_session
*usess
;
883 usess
= session
->ust_session
;
888 case LTTNG_DOMAIN_KERNEL
:
890 ret
= channel_kernel_disable(session
->kernel_session
,
892 if (ret
!= LTTNG_OK
) {
896 kernel_wait_quiescent(kernel_tracer_fd
);
899 case LTTNG_DOMAIN_UST
:
901 struct ltt_ust_channel
*uchan
;
902 struct lttng_ht
*chan_ht
;
904 chan_ht
= usess
->domain_global
.channels
;
906 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
908 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
912 ret
= channel_ust_disable(usess
, uchan
);
913 if (ret
!= LTTNG_OK
) {
919 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
931 * Command LTTNG_TRACK_PID processed by the client thread.
933 * Called with session lock held.
935 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
943 case LTTNG_DOMAIN_KERNEL
:
945 struct ltt_kernel_session
*ksess
;
947 ksess
= session
->kernel_session
;
949 ret
= kernel_track_pid(ksess
, pid
);
950 if (ret
!= LTTNG_OK
) {
954 kernel_wait_quiescent(kernel_tracer_fd
);
957 case LTTNG_DOMAIN_UST
:
959 struct ltt_ust_session
*usess
;
961 usess
= session
->ust_session
;
963 ret
= trace_ust_track_pid(usess
, pid
);
964 if (ret
!= LTTNG_OK
) {
970 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
982 * Command LTTNG_UNTRACK_PID processed by the client thread.
984 * Called with session lock held.
986 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
994 case LTTNG_DOMAIN_KERNEL
:
996 struct ltt_kernel_session
*ksess
;
998 ksess
= session
->kernel_session
;
1000 ret
= kernel_untrack_pid(ksess
, pid
);
1001 if (ret
!= LTTNG_OK
) {
1005 kernel_wait_quiescent(kernel_tracer_fd
);
1008 case LTTNG_DOMAIN_UST
:
1010 struct ltt_ust_session
*usess
;
1012 usess
= session
->ust_session
;
1014 ret
= trace_ust_untrack_pid(usess
, pid
);
1015 if (ret
!= LTTNG_OK
) {
1021 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1033 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1035 * The wpipe arguments is used as a notifier for the kernel thread.
1037 int cmd_enable_channel(struct ltt_session
*session
,
1038 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1041 struct ltt_ust_session
*usess
= session
->ust_session
;
1042 struct lttng_ht
*chan_ht
;
1049 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1051 /* Validate channel name */
1052 if (attr
->name
[0] == '.' ||
1053 memchr(attr
->name
, '/', len
) != NULL
) {
1054 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1058 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1063 * Don't try to enable a channel if the session has been started at
1064 * some point in time before. The tracer does not allow it.
1066 if (session
->has_been_started
) {
1067 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1072 * If the session is a live session, remove the switch timer, the
1073 * live timer does the same thing but sends also synchronisation
1074 * beacons for inactive streams.
1076 if (session
->live_timer
> 0) {
1077 attr
->attr
.live_timer_interval
= session
->live_timer
;
1078 attr
->attr
.switch_timer_interval
= 0;
1082 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1083 * mode and with less than 2 subbuf so block it right away and send back an
1084 * invalid attribute error.
1086 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1087 ret
= LTTNG_ERR_INVALID
;
1091 switch (domain
->type
) {
1092 case LTTNG_DOMAIN_KERNEL
:
1094 struct ltt_kernel_channel
*kchan
;
1096 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1097 session
->kernel_session
);
1098 if (kchan
== NULL
) {
1099 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1100 if (attr
->name
[0] != '\0') {
1101 session
->kernel_session
->has_non_default_channel
= 1;
1104 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1107 if (ret
!= LTTNG_OK
) {
1111 kernel_wait_quiescent(kernel_tracer_fd
);
1114 case LTTNG_DOMAIN_UST
:
1116 struct ltt_ust_channel
*uchan
;
1118 chan_ht
= usess
->domain_global
.channels
;
1120 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1121 if (uchan
== NULL
) {
1122 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1123 if (attr
->name
[0] != '\0') {
1124 usess
->has_non_default_channel
= 1;
1127 ret
= channel_ust_enable(usess
, uchan
);
1132 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1143 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1145 int cmd_disable_event(struct ltt_session
*session
,
1146 enum lttng_domain_type domain
, char *channel_name
,
1147 struct lttng_event
*event
)
1152 DBG("Disable event command for event \'%s\'", event
->name
);
1154 event_name
= event
->name
;
1155 if (validate_event_name(event_name
)) {
1156 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1160 /* Error out on unhandled search criteria */
1161 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1162 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1163 ret
= LTTNG_ERR_UNK
;
1170 case LTTNG_DOMAIN_KERNEL
:
1172 struct ltt_kernel_channel
*kchan
;
1173 struct ltt_kernel_session
*ksess
;
1175 ksess
= session
->kernel_session
;
1178 * If a non-default channel has been created in the
1179 * session, explicitely require that -c chan_name needs
1182 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1183 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1187 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1188 if (kchan
== NULL
) {
1189 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1193 switch (event
->type
) {
1194 case LTTNG_EVENT_ALL
:
1195 ret
= event_kernel_disable_event_all(kchan
);
1196 if (ret
!= LTTNG_OK
) {
1200 case LTTNG_EVENT_TRACEPOINT
: /* fall-through */
1201 case LTTNG_EVENT_SYSCALL
:
1202 if (!strcmp(event_name
, "*")) {
1203 ret
= event_kernel_disable_event_type(kchan
,
1206 ret
= event_kernel_disable_event(kchan
,
1209 if (ret
!= LTTNG_OK
) {
1213 case LTTNG_EVENT_PROBE
:
1214 case LTTNG_EVENT_FUNCTION
:
1215 case LTTNG_EVENT_FUNCTION_ENTRY
:
1216 ret
= event_kernel_disable_event(kchan
, event_name
);
1217 if (ret
!= LTTNG_OK
) {
1222 ret
= LTTNG_ERR_UNK
;
1226 kernel_wait_quiescent(kernel_tracer_fd
);
1229 case LTTNG_DOMAIN_UST
:
1231 struct ltt_ust_channel
*uchan
;
1232 struct ltt_ust_session
*usess
;
1234 usess
= session
->ust_session
;
1236 if (validate_ust_event_name(event_name
)) {
1237 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1242 * If a non-default channel has been created in the
1243 * session, explicitely require that -c chan_name needs
1246 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1247 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1251 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1253 if (uchan
== NULL
) {
1254 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1258 switch (event
->type
) {
1259 case LTTNG_EVENT_ALL
:
1260 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1261 if (ret
!= LTTNG_OK
) {
1266 ret
= LTTNG_ERR_UNK
;
1270 DBG3("Disable UST event %s in channel %s completed", event_name
,
1274 case LTTNG_DOMAIN_LOG4J
:
1275 case LTTNG_DOMAIN_JUL
:
1276 case LTTNG_DOMAIN_PYTHON
:
1279 struct ltt_ust_session
*usess
= session
->ust_session
;
1283 switch (event
->type
) {
1284 case LTTNG_EVENT_ALL
:
1287 ret
= LTTNG_ERR_UNK
;
1291 agt
= trace_ust_find_agent(usess
, domain
);
1293 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1296 /* The wild card * means that everything should be disabled. */
1297 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1298 ret
= event_agent_disable_all(usess
, agt
);
1300 ret
= event_agent_disable(usess
, agt
, event_name
);
1302 if (ret
!= LTTNG_OK
) {
1309 ret
= LTTNG_ERR_UND
;
1322 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1324 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1325 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1327 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1330 case LTTNG_DOMAIN_KERNEL
:
1331 assert(session
->kernel_session
);
1333 if (session
->kernel_session
->channel_count
== 0) {
1334 /* Create default channel */
1335 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1336 if (ret
!= LTTNG_OK
) {
1339 chan_kern_created
= 1;
1341 /* Add kernel context to kernel tracer */
1342 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1343 if (ret
!= LTTNG_OK
) {
1347 case LTTNG_DOMAIN_UST
:
1349 struct ltt_ust_session
*usess
= session
->ust_session
;
1350 unsigned int chan_count
;
1354 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1355 if (chan_count
== 0) {
1356 struct lttng_channel
*attr
;
1357 /* Create default channel */
1358 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1360 ret
= LTTNG_ERR_FATAL
;
1364 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1365 if (ret
!= LTTNG_OK
) {
1370 chan_ust_created
= 1;
1373 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1374 if (ret
!= LTTNG_OK
) {
1380 ret
= LTTNG_ERR_UND
;
1387 if (chan_kern_created
) {
1388 struct ltt_kernel_channel
*kchan
=
1389 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1390 session
->kernel_session
);
1391 /* Created previously, this should NOT fail. */
1393 kernel_destroy_channel(kchan
);
1396 if (chan_ust_created
) {
1397 struct ltt_ust_channel
*uchan
=
1398 trace_ust_find_channel_by_name(
1399 session
->ust_session
->domain_global
.channels
,
1400 DEFAULT_CHANNEL_NAME
);
1401 /* Created previously, this should NOT fail. */
1403 /* Remove from the channel list of the session. */
1404 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1406 trace_ust_destroy_channel(uchan
);
1411 static int validate_event_name(const char *name
)
1414 const char *c
= name
;
1415 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1416 bool null_terminated
= false;
1419 * Make sure that unescaped wildcards are only used as the last
1420 * character of the event name.
1422 while (c
< event_name_end
) {
1425 null_terminated
= true;
1431 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1432 /* Wildcard is not the last character */
1433 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1442 if (!ret
&& !null_terminated
) {
1443 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1448 static inline bool name_starts_with(const char *name
, const char *prefix
)
1450 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1452 return !strncmp(name
, prefix
, max_cmp_len
);
1455 /* Perform userspace-specific event name validation */
1456 static int validate_ust_event_name(const char *name
)
1466 * Check name against all internal UST event component namespaces used
1469 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1470 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1471 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1480 * Internal version of cmd_enable_event() with a supplemental
1481 * "internal_event" flag which is used to enable internal events which should
1482 * be hidden from clients. Such events are used in the agent implementation to
1483 * enable the events through which all "agent" events are funeled.
1485 static int _cmd_enable_event(struct ltt_session
*session
,
1486 struct lttng_domain
*domain
,
1487 char *channel_name
, struct lttng_event
*event
,
1488 char *filter_expression
,
1489 struct lttng_filter_bytecode
*filter
,
1490 struct lttng_event_exclusion
*exclusion
,
1491 int wpipe
, bool internal_event
)
1493 int ret
, channel_created
= 0;
1494 struct lttng_channel
*attr
;
1498 assert(channel_name
);
1500 DBG("Enable event command for event \'%s\'", event
->name
);
1502 ret
= validate_event_name(event
->name
);
1509 switch (domain
->type
) {
1510 case LTTNG_DOMAIN_KERNEL
:
1512 struct ltt_kernel_channel
*kchan
;
1515 * If a non-default channel has been created in the
1516 * session, explicitely require that -c chan_name needs
1519 if (session
->kernel_session
->has_non_default_channel
1520 && channel_name
[0] == '\0') {
1521 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1525 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1526 session
->kernel_session
);
1527 if (kchan
== NULL
) {
1528 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1529 LTTNG_BUFFER_GLOBAL
);
1531 ret
= LTTNG_ERR_FATAL
;
1534 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1536 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1537 if (ret
!= LTTNG_OK
) {
1543 channel_created
= 1;
1546 /* Get the newly created kernel channel pointer */
1547 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1548 session
->kernel_session
);
1549 if (kchan
== NULL
) {
1550 /* This sould not happen... */
1551 ret
= LTTNG_ERR_FATAL
;
1555 switch (event
->type
) {
1556 case LTTNG_EVENT_ALL
:
1558 char *filter_expression_a
= NULL
;
1559 struct lttng_filter_bytecode
*filter_a
= NULL
;
1562 * We need to duplicate filter_expression and filter,
1563 * because ownership is passed to first enable
1566 if (filter_expression
) {
1567 filter_expression_a
= strdup(filter_expression
);
1568 if (!filter_expression_a
) {
1569 ret
= LTTNG_ERR_FATAL
;
1574 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1576 free(filter_expression_a
);
1577 ret
= LTTNG_ERR_FATAL
;
1580 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1582 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1583 ret
= event_kernel_enable_event(kchan
, event
,
1584 filter_expression
, filter
);
1585 /* We have passed ownership */
1586 filter_expression
= NULL
;
1588 if (ret
!= LTTNG_OK
) {
1589 if (channel_created
) {
1590 /* Let's not leak a useless channel. */
1591 kernel_destroy_channel(kchan
);
1593 free(filter_expression_a
);
1597 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1598 ret
= event_kernel_enable_event(kchan
, event
,
1599 filter_expression_a
, filter_a
);
1600 if (ret
!= LTTNG_OK
) {
1601 free(filter_expression_a
);
1607 case LTTNG_EVENT_PROBE
:
1608 case LTTNG_EVENT_FUNCTION
:
1609 case LTTNG_EVENT_FUNCTION_ENTRY
:
1610 case LTTNG_EVENT_TRACEPOINT
:
1611 ret
= event_kernel_enable_event(kchan
, event
,
1612 filter_expression
, filter
);
1613 /* We have passed ownership */
1614 filter_expression
= NULL
;
1616 if (ret
!= LTTNG_OK
) {
1617 if (channel_created
) {
1618 /* Let's not leak a useless channel. */
1619 kernel_destroy_channel(kchan
);
1624 case LTTNG_EVENT_SYSCALL
:
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
) {
1635 ret
= LTTNG_ERR_UNK
;
1639 kernel_wait_quiescent(kernel_tracer_fd
);
1642 case LTTNG_DOMAIN_UST
:
1644 struct ltt_ust_channel
*uchan
;
1645 struct ltt_ust_session
*usess
= session
->ust_session
;
1650 * If a non-default channel has been created in the
1651 * session, explicitely require that -c chan_name needs
1654 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1655 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1659 /* Get channel from global UST domain */
1660 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1662 if (uchan
== NULL
) {
1663 /* Create default channel */
1664 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1665 usess
->buffer_type
);
1667 ret
= LTTNG_ERR_FATAL
;
1670 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1672 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1673 if (ret
!= LTTNG_OK
) {
1679 /* Get the newly created channel reference back */
1680 uchan
= trace_ust_find_channel_by_name(
1681 usess
->domain_global
.channels
, channel_name
);
1685 if (!internal_event
) {
1687 * Ensure the event name is not reserved for internal
1690 ret
= validate_ust_event_name(event
->name
);
1692 WARN("Userspace event name %s failed validation.",
1694 event
->name
: "NULL");
1695 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1700 /* At this point, the session and channel exist on the tracer */
1701 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1702 filter_expression
, filter
, exclusion
,
1704 /* We have passed ownership */
1705 filter_expression
= NULL
;
1708 if (ret
!= LTTNG_OK
) {
1713 case LTTNG_DOMAIN_LOG4J
:
1714 case LTTNG_DOMAIN_JUL
:
1715 case LTTNG_DOMAIN_PYTHON
:
1717 const char *default_event_name
, *default_chan_name
;
1719 struct lttng_event uevent
;
1720 struct lttng_domain tmp_dom
;
1721 struct ltt_ust_session
*usess
= session
->ust_session
;
1725 agt
= trace_ust_find_agent(usess
, domain
->type
);
1727 agt
= agent_create(domain
->type
);
1729 ret
= -LTTNG_ERR_NOMEM
;
1732 agent_add(agt
, usess
->agents
);
1735 /* Create the default tracepoint. */
1736 memset(&uevent
, 0, sizeof(uevent
));
1737 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1738 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1739 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1740 if (!default_event_name
) {
1741 ret
= -LTTNG_ERR_FATAL
;
1744 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1745 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1748 * The domain type is changed because we are about to enable the
1749 * default channel and event for the JUL domain that are hardcoded.
1750 * This happens in the UST domain.
1752 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1753 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1755 switch (domain
->type
) {
1756 case LTTNG_DOMAIN_LOG4J
:
1757 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1759 case LTTNG_DOMAIN_JUL
:
1760 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1762 case LTTNG_DOMAIN_PYTHON
:
1763 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1766 /* The switch/case we are in makes this impossible */
1771 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1772 char *filter_expression_copy
= NULL
;
1775 filter_copy
= zmalloc(
1776 sizeof(struct lttng_filter_bytecode
)
1782 memcpy(filter_copy
, filter
,
1783 sizeof(struct lttng_filter_bytecode
)
1787 if (filter_expression
) {
1788 filter_expression_copy
=
1789 strdup(filter_expression
);
1790 if (!filter_expression
) {
1791 ret
= LTTNG_ERR_NOMEM
;
1792 goto error_free_copy
;
1796 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1797 (char *) default_chan_name
,
1798 &uevent
, filter_expression_copy
,
1799 filter_copy
, NULL
, wpipe
);
1801 filter_expression_copy
= NULL
;
1804 free(filter_expression_copy
);
1807 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1811 /* The wild card * means that everything should be enabled. */
1812 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1813 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1817 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1821 if (ret
!= LTTNG_OK
) {
1828 ret
= LTTNG_ERR_UND
;
1835 free(filter_expression
);
1843 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1844 * We own filter, exclusion, and filter_expression.
1846 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1847 char *channel_name
, struct lttng_event
*event
,
1848 char *filter_expression
,
1849 struct lttng_filter_bytecode
*filter
,
1850 struct lttng_event_exclusion
*exclusion
,
1853 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1854 filter_expression
, filter
, exclusion
, wpipe
, false);
1858 * Enable an event which is internal to LTTng. An internal should
1859 * never be made visible to clients and are immune to checks such as
1862 static int cmd_enable_event_internal(struct ltt_session
*session
,
1863 struct lttng_domain
*domain
,
1864 char *channel_name
, struct lttng_event
*event
,
1865 char *filter_expression
,
1866 struct lttng_filter_bytecode
*filter
,
1867 struct lttng_event_exclusion
*exclusion
,
1870 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1871 filter_expression
, filter
, exclusion
, wpipe
, true);
1875 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1877 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1878 struct lttng_event
**events
)
1881 ssize_t nb_events
= 0;
1884 case LTTNG_DOMAIN_KERNEL
:
1885 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1886 if (nb_events
< 0) {
1887 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1891 case LTTNG_DOMAIN_UST
:
1892 nb_events
= ust_app_list_events(events
);
1893 if (nb_events
< 0) {
1894 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1898 case LTTNG_DOMAIN_LOG4J
:
1899 case LTTNG_DOMAIN_JUL
:
1900 case LTTNG_DOMAIN_PYTHON
:
1901 nb_events
= agent_list_events(events
, domain
);
1902 if (nb_events
< 0) {
1903 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1908 ret
= LTTNG_ERR_UND
;
1915 /* Return negative value to differentiate return code */
1920 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1922 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
1923 struct lttng_event_field
**fields
)
1926 ssize_t nb_fields
= 0;
1929 case LTTNG_DOMAIN_UST
:
1930 nb_fields
= ust_app_list_event_fields(fields
);
1931 if (nb_fields
< 0) {
1932 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1936 case LTTNG_DOMAIN_KERNEL
:
1937 default: /* fall-through */
1938 ret
= LTTNG_ERR_UND
;
1945 /* Return negative value to differentiate return code */
1949 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1951 return syscall_table_list(events
);
1955 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1957 * Called with session lock held.
1959 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1960 enum lttng_domain_type domain
, int32_t **pids
)
1963 ssize_t nr_pids
= 0;
1966 case LTTNG_DOMAIN_KERNEL
:
1968 struct ltt_kernel_session
*ksess
;
1970 ksess
= session
->kernel_session
;
1971 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1973 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1978 case LTTNG_DOMAIN_UST
:
1980 struct ltt_ust_session
*usess
;
1982 usess
= session
->ust_session
;
1983 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
1985 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1990 case LTTNG_DOMAIN_LOG4J
:
1991 case LTTNG_DOMAIN_JUL
:
1992 case LTTNG_DOMAIN_PYTHON
:
1994 ret
= LTTNG_ERR_UND
;
2001 /* Return negative value to differentiate return code */
2006 * Command LTTNG_START_TRACE processed by the client thread.
2008 * Called with session mutex held.
2010 int cmd_start_trace(struct ltt_session
*session
)
2013 unsigned long nb_chan
= 0;
2014 struct ltt_kernel_session
*ksession
;
2015 struct ltt_ust_session
*usess
;
2019 /* Ease our life a bit ;) */
2020 ksession
= session
->kernel_session
;
2021 usess
= session
->ust_session
;
2023 /* Is the session already started? */
2024 if (session
->active
) {
2025 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2030 * Starting a session without channel is useless since after that it's not
2031 * possible to enable channel thus inform the client.
2033 if (usess
&& usess
->domain_global
.channels
) {
2034 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2037 nb_chan
+= ksession
->channel_count
;
2040 ret
= LTTNG_ERR_NO_CHANNEL
;
2044 /* Kernel tracing */
2045 if (ksession
!= NULL
) {
2046 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2047 if (ret
!= LTTNG_OK
) {
2052 /* Flag session that trace should start automatically */
2055 * Even though the start trace might fail, flag this session active so
2056 * other application coming in are started by default.
2060 ret
= ust_app_start_trace_all(usess
);
2062 ret
= LTTNG_ERR_UST_START_FAIL
;
2067 /* Flag this after a successful start. */
2068 session
->has_been_started
= 1;
2069 session
->active
= 1;
2078 * Command LTTNG_STOP_TRACE processed by the client thread.
2080 int cmd_stop_trace(struct ltt_session
*session
)
2083 struct ltt_kernel_channel
*kchan
;
2084 struct ltt_kernel_session
*ksession
;
2085 struct ltt_ust_session
*usess
;
2090 ksession
= session
->kernel_session
;
2091 usess
= session
->ust_session
;
2093 /* Session is not active. Skip everythong and inform the client. */
2094 if (!session
->active
) {
2095 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2100 if (ksession
&& ksession
->active
) {
2101 DBG("Stop kernel tracing");
2103 /* Flush metadata if exist */
2104 if (ksession
->metadata_stream_fd
>= 0) {
2105 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2107 ERR("Kernel metadata flush failed");
2111 /* Flush all buffers before stopping */
2112 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2113 ret
= kernel_flush_buffer(kchan
);
2115 ERR("Kernel flush buffer error");
2119 ret
= kernel_stop_session(ksession
);
2121 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2125 kernel_wait_quiescent(kernel_tracer_fd
);
2127 ksession
->active
= 0;
2130 if (usess
&& usess
->active
) {
2132 * Even though the stop trace might fail, flag this session inactive so
2133 * other application coming in are not started by default.
2137 ret
= ust_app_stop_trace_all(usess
);
2139 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2144 /* Flag inactive after a successful stop. */
2145 session
->active
= 0;
2153 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2155 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2156 struct lttng_uri
*uris
)
2159 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2160 struct ltt_ust_session
*usess
= session
->ust_session
;
2166 /* Can't set consumer URI if the session is active. */
2167 if (session
->active
) {
2168 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2172 /* Set the "global" consumer URIs */
2173 for (i
= 0; i
< nb_uri
; i
++) {
2174 ret
= add_uri_to_consumer(session
->consumer
,
2175 &uris
[i
], 0, session
->name
);
2176 if (ret
!= LTTNG_OK
) {
2181 /* Set UST session URIs */
2182 if (session
->ust_session
) {
2183 for (i
= 0; i
< nb_uri
; i
++) {
2184 ret
= add_uri_to_consumer(
2185 session
->ust_session
->consumer
,
2186 &uris
[i
], LTTNG_DOMAIN_UST
,
2188 if (ret
!= LTTNG_OK
) {
2194 /* Set kernel session URIs */
2195 if (session
->kernel_session
) {
2196 for (i
= 0; i
< nb_uri
; i
++) {
2197 ret
= add_uri_to_consumer(
2198 session
->kernel_session
->consumer
,
2199 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2201 if (ret
!= LTTNG_OK
) {
2208 * Make sure to set the session in output mode after we set URI since a
2209 * session can be created without URL (thus flagged in no output mode).
2211 session
->output_traces
= 1;
2213 ksess
->output_traces
= 1;
2217 usess
->output_traces
= 1;
2228 * Command LTTNG_CREATE_SESSION processed by the client thread.
2230 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2231 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2234 struct ltt_session
*session
;
2240 * Verify if the session already exist
2242 * XXX: There is no need for the session lock list here since the caller
2243 * (process_client_msg) is holding it. We might want to change that so a
2244 * single command does not lock the entire session list.
2246 session
= session_find_by_name(name
);
2247 if (session
!= NULL
) {
2248 ret
= LTTNG_ERR_EXIST_SESS
;
2252 /* Create tracing session in the registry */
2253 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2254 LTTNG_SOCK_GET_GID_CRED(creds
));
2255 if (ret
!= LTTNG_OK
) {
2260 * Get the newly created session pointer back
2262 * XXX: There is no need for the session lock list here since the caller
2263 * (process_client_msg) is holding it. We might want to change that so a
2264 * single command does not lock the entire session list.
2266 session
= session_find_by_name(name
);
2269 session
->live_timer
= live_timer
;
2270 /* Create default consumer output for the session not yet created. */
2271 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2272 if (session
->consumer
== NULL
) {
2273 ret
= LTTNG_ERR_FATAL
;
2274 goto consumer_error
;
2278 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2279 if (ret
!= LTTNG_OK
) {
2280 goto consumer_error
;
2282 session
->output_traces
= 1;
2284 session
->output_traces
= 0;
2285 DBG2("Session %s created with no output", session
->name
);
2288 session
->consumer
->enabled
= 1;
2293 session_destroy(session
);
2300 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2302 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2303 size_t nb_uri
, lttng_sock_cred
*creds
)
2306 struct ltt_session
*session
;
2307 struct snapshot_output
*new_output
= NULL
;
2313 * Create session in no output mode with URIs set to NULL. The uris we've
2314 * received are for a default snapshot output if one.
2316 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2317 if (ret
!= LTTNG_OK
) {
2321 /* Get the newly created session pointer back. This should NEVER fail. */
2322 session
= session_find_by_name(name
);
2325 /* Flag session for snapshot mode. */
2326 session
->snapshot_mode
= 1;
2328 /* Skip snapshot output creation if no URI is given. */
2333 new_output
= snapshot_output_alloc();
2335 ret
= LTTNG_ERR_NOMEM
;
2336 goto error_snapshot_alloc
;
2339 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2340 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2342 if (ret
== -ENOMEM
) {
2343 ret
= LTTNG_ERR_NOMEM
;
2345 ret
= LTTNG_ERR_INVALID
;
2347 goto error_snapshot
;
2351 snapshot_add_output(&session
->snapshot
, new_output
);
2358 snapshot_output_destroy(new_output
);
2359 error_snapshot_alloc
:
2360 session_destroy(session
);
2366 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2368 * Called with session lock held.
2370 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2373 struct ltt_ust_session
*usess
;
2374 struct ltt_kernel_session
*ksess
;
2379 usess
= session
->ust_session
;
2380 ksess
= session
->kernel_session
;
2382 /* Clean kernel session teardown */
2383 kernel_destroy_session(ksess
);
2385 /* UST session teardown */
2387 /* Close any relayd session */
2388 consumer_output_send_destroy_relayd(usess
->consumer
);
2390 /* Destroy every UST application related to this session. */
2391 ret
= ust_app_destroy_trace_all(usess
);
2393 ERR("Error in ust_app_destroy_trace_all");
2396 /* Clean up the rest. */
2397 trace_ust_destroy_session(usess
);
2401 * Must notify the kernel thread here to update it's poll set in order to
2402 * remove the channel(s)' fd just destroyed.
2404 ret
= notify_thread_pipe(wpipe
);
2406 PERROR("write kernel poll pipe");
2409 ret
= session_destroy(session
);
2415 * Command LTTNG_CALIBRATE processed by the client thread.
2417 int cmd_calibrate(enum lttng_domain_type domain
,
2418 struct lttng_calibrate
*calibrate
)
2423 case LTTNG_DOMAIN_KERNEL
:
2425 struct lttng_kernel_calibrate kcalibrate
;
2427 switch (calibrate
->type
) {
2428 case LTTNG_CALIBRATE_FUNCTION
:
2430 /* Default and only possible calibrate option. */
2431 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2435 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2437 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2442 case LTTNG_DOMAIN_UST
:
2444 struct lttng_ust_calibrate ucalibrate
;
2446 switch (calibrate
->type
) {
2447 case LTTNG_CALIBRATE_FUNCTION
:
2449 /* Default and only possible calibrate option. */
2450 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2454 ret
= ust_app_calibrate_glb(&ucalibrate
);
2456 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2462 ret
= LTTNG_ERR_UND
;
2473 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2475 int cmd_register_consumer(struct ltt_session
*session
,
2476 enum lttng_domain_type domain
, const char *sock_path
,
2477 struct consumer_data
*cdata
)
2480 struct consumer_socket
*socket
= NULL
;
2487 case LTTNG_DOMAIN_KERNEL
:
2489 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2493 /* Can't register a consumer if there is already one */
2494 if (ksess
->consumer_fds_sent
!= 0) {
2495 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2499 sock
= lttcomm_connect_unix_sock(sock_path
);
2501 ret
= LTTNG_ERR_CONNECT_FAIL
;
2504 cdata
->cmd_sock
= sock
;
2506 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2507 if (socket
== NULL
) {
2510 PERROR("close register consumer");
2512 cdata
->cmd_sock
= -1;
2513 ret
= LTTNG_ERR_FATAL
;
2517 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2518 if (socket
->lock
== NULL
) {
2519 PERROR("zmalloc pthread mutex");
2520 ret
= LTTNG_ERR_FATAL
;
2523 pthread_mutex_init(socket
->lock
, NULL
);
2524 socket
->registered
= 1;
2527 consumer_add_socket(socket
, ksess
->consumer
);
2530 pthread_mutex_lock(&cdata
->pid_mutex
);
2532 pthread_mutex_unlock(&cdata
->pid_mutex
);
2537 /* TODO: Userspace tracing */
2538 ret
= LTTNG_ERR_UND
;
2546 consumer_destroy_socket(socket
);
2552 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2554 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2555 struct lttng_domain
**domains
)
2560 struct lttng_ht_iter iter
;
2562 if (session
->kernel_session
!= NULL
) {
2563 DBG3("Listing domains found kernel domain");
2567 if (session
->ust_session
!= NULL
) {
2568 DBG3("Listing domains found UST global domain");
2572 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2574 if (agt
->being_used
) {
2585 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2586 if (*domains
== NULL
) {
2587 ret
= LTTNG_ERR_FATAL
;
2591 if (session
->kernel_session
!= NULL
) {
2592 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2594 /* Kernel session buffer type is always GLOBAL */
2595 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2600 if (session
->ust_session
!= NULL
) {
2601 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2602 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2606 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2608 if (agt
->being_used
) {
2609 (*domains
)[index
].type
= agt
->domain
;
2610 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2620 /* Return negative value to differentiate return code */
2626 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2628 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2629 struct ltt_session
*session
, struct lttng_channel
**channels
)
2632 ssize_t nb_chan
= 0;
2635 case LTTNG_DOMAIN_KERNEL
:
2636 if (session
->kernel_session
!= NULL
) {
2637 nb_chan
= session
->kernel_session
->channel_count
;
2639 DBG3("Number of kernel channels %zd", nb_chan
);
2641 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2644 case LTTNG_DOMAIN_UST
:
2645 if (session
->ust_session
!= NULL
) {
2647 nb_chan
= lttng_ht_get_count(
2648 session
->ust_session
->domain_global
.channels
);
2651 DBG3("Number of UST global channels %zd", nb_chan
);
2653 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2658 ret
= LTTNG_ERR_UND
;
2663 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2664 if (*channels
== NULL
) {
2665 ret
= LTTNG_ERR_FATAL
;
2669 list_lttng_channels(domain
, session
, *channels
);
2675 /* Return negative value to differentiate return code */
2680 * Command LTTNG_LIST_EVENTS processed by the client thread.
2682 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2683 struct ltt_session
*session
, char *channel_name
,
2684 struct lttng_event
**events
)
2687 ssize_t nb_event
= 0;
2690 case LTTNG_DOMAIN_KERNEL
:
2691 if (session
->kernel_session
!= NULL
) {
2692 nb_event
= list_lttng_kernel_events(channel_name
,
2693 session
->kernel_session
, events
);
2696 case LTTNG_DOMAIN_UST
:
2698 if (session
->ust_session
!= NULL
) {
2699 nb_event
= list_lttng_ust_global_events(channel_name
,
2700 &session
->ust_session
->domain_global
, events
);
2704 case LTTNG_DOMAIN_LOG4J
:
2705 case LTTNG_DOMAIN_JUL
:
2706 case LTTNG_DOMAIN_PYTHON
:
2707 if (session
->ust_session
) {
2708 struct lttng_ht_iter iter
;
2712 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2713 &iter
.iter
, agt
, node
.node
) {
2714 nb_event
= list_lttng_agent_events(agt
, events
);
2720 ret
= LTTNG_ERR_UND
;
2727 /* Return negative value to differentiate return code */
2732 * Using the session list, filled a lttng_session array to send back to the
2733 * client for session listing.
2735 * The session list lock MUST be acquired before calling this function. Use
2736 * session_lock_list() and session_unlock_list().
2738 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2743 struct ltt_session
*session
;
2744 struct ltt_session_list
*list
= session_get_list();
2746 DBG("Getting all available session for UID %d GID %d",
2749 * Iterate over session list and append data after the control struct in
2752 cds_list_for_each_entry(session
, &list
->head
, list
) {
2754 * Only list the sessions the user can control.
2756 if (!session_access_ok(session
, uid
, gid
)) {
2760 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2761 struct ltt_ust_session
*usess
= session
->ust_session
;
2763 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2764 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2765 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2766 ret
= build_network_session_path(sessions
[i
].path
,
2767 sizeof(sessions
[i
].path
), session
);
2769 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2770 session
->consumer
->dst
.trace_path
);
2773 PERROR("snprintf session path");
2777 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2778 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2779 sessions
[i
].enabled
= session
->active
;
2780 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2781 sessions
[i
].live_timer_interval
= session
->live_timer
;
2787 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2788 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2790 int cmd_data_pending(struct ltt_session
*session
)
2793 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2794 struct ltt_ust_session
*usess
= session
->ust_session
;
2798 /* Session MUST be stopped to ask for data availability. */
2799 if (session
->active
) {
2800 ret
= LTTNG_ERR_SESSION_STARTED
;
2804 * If stopped, just make sure we've started before else the above call
2805 * will always send that there is data pending.
2807 * The consumer assumes that when the data pending command is received,
2808 * the trace has been started before or else no output data is written
2809 * by the streams which is a condition for data pending. So, this is
2810 * *VERY* important that we don't ask the consumer before a start
2813 if (!session
->has_been_started
) {
2819 if (ksess
&& ksess
->consumer
) {
2820 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2822 /* Data is still being extracted for the kernel. */
2827 if (usess
&& usess
->consumer
) {
2828 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2830 /* Data is still being extracted for the kernel. */
2835 /* Data is ready to be read by a viewer */
2843 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2845 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2847 int cmd_snapshot_add_output(struct ltt_session
*session
,
2848 struct lttng_snapshot_output
*output
, uint32_t *id
)
2851 struct snapshot_output
*new_output
;
2856 DBG("Cmd snapshot add output for session %s", session
->name
);
2859 * Permission denied to create an output if the session is not
2860 * set in no output mode.
2862 if (session
->output_traces
) {
2863 ret
= LTTNG_ERR_EPERM
;
2867 /* Only one output is allowed until we have the "tee" feature. */
2868 if (session
->snapshot
.nb_output
== 1) {
2869 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2873 new_output
= snapshot_output_alloc();
2875 ret
= LTTNG_ERR_NOMEM
;
2879 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2880 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2881 &session
->snapshot
);
2883 if (ret
== -ENOMEM
) {
2884 ret
= LTTNG_ERR_NOMEM
;
2886 ret
= LTTNG_ERR_INVALID
;
2892 snapshot_add_output(&session
->snapshot
, new_output
);
2894 *id
= new_output
->id
;
2901 snapshot_output_destroy(new_output
);
2907 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2909 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2911 int cmd_snapshot_del_output(struct ltt_session
*session
,
2912 struct lttng_snapshot_output
*output
)
2915 struct snapshot_output
*sout
= NULL
;
2923 * Permission denied to create an output if the session is not
2924 * set in no output mode.
2926 if (session
->output_traces
) {
2927 ret
= LTTNG_ERR_EPERM
;
2932 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2934 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2935 } else if (*output
->name
!= '\0') {
2936 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2938 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2941 ret
= LTTNG_ERR_INVALID
;
2945 snapshot_delete_output(&session
->snapshot
, sout
);
2946 snapshot_output_destroy(sout
);
2955 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2957 * If no output is available, outputs is untouched and 0 is returned.
2959 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2961 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2962 struct lttng_snapshot_output
**outputs
)
2965 struct lttng_snapshot_output
*list
= NULL
;
2966 struct lttng_ht_iter iter
;
2967 struct snapshot_output
*output
;
2972 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2975 * Permission denied to create an output if the session is not
2976 * set in no output mode.
2978 if (session
->output_traces
) {
2979 ret
= -LTTNG_ERR_EPERM
;
2983 if (session
->snapshot
.nb_output
== 0) {
2988 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2990 ret
= -LTTNG_ERR_NOMEM
;
2994 /* Copy list from session to the new list object. */
2996 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2997 output
, node
.node
) {
2998 assert(output
->consumer
);
2999 list
[idx
].id
= output
->id
;
3000 list
[idx
].max_size
= output
->max_size
;
3001 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3002 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3003 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3004 sizeof(list
[idx
].ctrl_url
));
3007 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3008 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3010 ret
= -LTTNG_ERR_NOMEM
;
3015 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3016 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3018 ret
= -LTTNG_ERR_NOMEM
;
3027 ret
= session
->snapshot
.nb_output
;
3035 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3036 * snapshot output is *not* set with a remote destination.
3038 * Return 0 on success or a LTTNG_ERR code.
3040 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3041 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3044 struct lttng_ht_iter iter
;
3045 struct consumer_socket
*socket
;
3048 assert(snap_output
);
3051 DBG2("Set relayd object from snapshot output");
3053 /* Ignore if snapshot consumer output is not network. */
3054 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3059 * For each consumer socket, create and send the relayd object of the
3063 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3064 socket
, node
.node
) {
3065 ret
= send_consumer_relayd_sockets(0, session
->id
,
3066 snap_output
->consumer
, socket
,
3067 session
->name
, session
->hostname
,
3068 session
->live_timer
);
3069 if (ret
!= LTTNG_OK
) {
3081 * Record a kernel snapshot.
3083 * Return LTTNG_OK on success or a LTTNG_ERR code.
3085 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3086 struct snapshot_output
*output
, struct ltt_session
*session
,
3087 int wait
, uint64_t nb_packets_per_stream
)
3095 /* Get the datetime for the snapshot output directory. */
3096 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3097 sizeof(output
->datetime
));
3099 ret
= LTTNG_ERR_INVALID
;
3104 * Copy kernel session sockets so we can communicate with the right
3105 * consumer for the snapshot record command.
3107 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3109 ret
= LTTNG_ERR_NOMEM
;
3113 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3114 if (ret
!= LTTNG_OK
) {
3115 goto error_snapshot
;
3118 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3119 if (ret
!= LTTNG_OK
) {
3120 goto error_snapshot
;
3127 /* Clean up copied sockets so this output can use some other later on. */
3128 consumer_destroy_output_sockets(output
->consumer
);
3135 * Record a UST snapshot.
3137 * Return 0 on success or a LTTNG_ERR error code.
3139 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3140 struct snapshot_output
*output
, struct ltt_session
*session
,
3141 int wait
, uint64_t nb_packets_per_stream
)
3149 /* Get the datetime for the snapshot output directory. */
3150 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3151 sizeof(output
->datetime
));
3153 ret
= LTTNG_ERR_INVALID
;
3158 * Copy UST session sockets so we can communicate with the right
3159 * consumer for the snapshot record command.
3161 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3163 ret
= LTTNG_ERR_NOMEM
;
3167 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3168 if (ret
!= LTTNG_OK
) {
3169 goto error_snapshot
;
3172 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3176 ret
= LTTNG_ERR_INVALID
;
3179 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3182 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3185 goto error_snapshot
;
3191 /* Clean up copied sockets so this output can use some other later on. */
3192 consumer_destroy_output_sockets(output
->consumer
);
3198 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3199 uint64_t cur_nr_packets
)
3201 uint64_t tot_size
= 0;
3203 if (session
->kernel_session
) {
3204 struct ltt_kernel_channel
*chan
;
3205 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3207 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3208 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3210 * Don't take channel into account if we
3211 * already grab all its packets.
3215 tot_size
+= chan
->channel
->attr
.subbuf_size
3216 * chan
->stream_count
;
3220 if (session
->ust_session
) {
3221 struct ltt_ust_session
*usess
= session
->ust_session
;
3223 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3231 * Calculate the number of packets we can grab from each stream that
3232 * fits within the overall snapshot max size.
3234 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3235 * the number of packets per stream.
3237 * TODO: this approach is not perfect: we consider the worse case
3238 * (packet filling the sub-buffers) as an upper bound, but we could do
3239 * better if we do this calculation while we actually grab the packet
3240 * content: we would know how much padding we don't actually store into
3243 * This algorithm is currently bounded by the number of packets per
3246 * Since we call this algorithm before actually grabbing the data, it's
3247 * an approximation: for instance, applications could appear/disappear
3248 * in between this call and actually grabbing data.
3251 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3254 uint64_t cur_nb_packets
= 0;
3257 return 0; /* Infinite */
3260 size_left
= max_size
;
3262 uint64_t one_more_packet_tot_size
;
3264 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3266 if (!one_more_packet_tot_size
) {
3267 /* We are already grabbing all packets. */
3270 size_left
-= one_more_packet_tot_size
;
3271 if (size_left
< 0) {
3276 if (!cur_nb_packets
) {
3277 /* Not enough room to grab one packet of each stream, error. */
3280 return cur_nb_packets
;
3284 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3286 * The wait parameter is ignored so this call always wait for the snapshot to
3287 * complete before returning.
3289 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3291 int cmd_snapshot_record(struct ltt_session
*session
,
3292 struct lttng_snapshot_output
*output
, int wait
)
3295 unsigned int use_tmp_output
= 0;
3296 struct snapshot_output tmp_output
;
3297 unsigned int snapshot_success
= 0;
3302 DBG("Cmd snapshot record for session %s", session
->name
);
3305 * Permission denied to create an output if the session is not
3306 * set in no output mode.
3308 if (session
->output_traces
) {
3309 ret
= LTTNG_ERR_EPERM
;
3313 /* The session needs to be started at least once. */
3314 if (!session
->has_been_started
) {
3315 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3319 /* Use temporary output for the session. */
3320 if (*output
->ctrl_url
!= '\0') {
3321 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3322 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3325 if (ret
== -ENOMEM
) {
3326 ret
= LTTNG_ERR_NOMEM
;
3328 ret
= LTTNG_ERR_INVALID
;
3332 /* Use the global session count for the temporary snapshot. */
3333 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3337 if (session
->kernel_session
) {
3338 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3340 if (use_tmp_output
) {
3341 int64_t nb_packets_per_stream
;
3343 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3344 tmp_output
.max_size
);
3345 if (nb_packets_per_stream
< 0) {
3346 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3349 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3350 wait
, nb_packets_per_stream
);
3351 if (ret
!= LTTNG_OK
) {
3354 snapshot_success
= 1;
3356 struct snapshot_output
*sout
;
3357 struct lttng_ht_iter iter
;
3360 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3361 &iter
.iter
, sout
, node
.node
) {
3362 int64_t nb_packets_per_stream
;
3365 * Make a local copy of the output and assign the possible
3366 * temporary value given by the caller.
3368 memset(&tmp_output
, 0, sizeof(tmp_output
));
3369 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3371 if (output
->max_size
!= (uint64_t) -1ULL) {
3372 tmp_output
.max_size
= output
->max_size
;
3375 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3376 tmp_output
.max_size
);
3377 if (nb_packets_per_stream
< 0) {
3378 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3382 /* Use temporary name. */
3383 if (*output
->name
!= '\0') {
3384 strncpy(tmp_output
.name
, output
->name
,
3385 sizeof(tmp_output
.name
));
3388 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3390 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3391 session
, wait
, nb_packets_per_stream
);
3392 if (ret
!= LTTNG_OK
) {
3396 snapshot_success
= 1;
3402 if (session
->ust_session
) {
3403 struct ltt_ust_session
*usess
= session
->ust_session
;
3405 if (use_tmp_output
) {
3406 int64_t nb_packets_per_stream
;
3408 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3409 tmp_output
.max_size
);
3410 if (nb_packets_per_stream
< 0) {
3411 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3414 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3415 wait
, nb_packets_per_stream
);
3416 if (ret
!= LTTNG_OK
) {
3419 snapshot_success
= 1;
3421 struct snapshot_output
*sout
;
3422 struct lttng_ht_iter iter
;
3425 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3426 &iter
.iter
, sout
, node
.node
) {
3427 int64_t nb_packets_per_stream
;
3430 * Make a local copy of the output and assign the possible
3431 * temporary value given by the caller.
3433 memset(&tmp_output
, 0, sizeof(tmp_output
));
3434 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3436 if (output
->max_size
!= (uint64_t) -1ULL) {
3437 tmp_output
.max_size
= output
->max_size
;
3440 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3441 tmp_output
.max_size
);
3442 if (nb_packets_per_stream
< 0) {
3443 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3448 /* Use temporary name. */
3449 if (*output
->name
!= '\0') {
3450 strncpy(tmp_output
.name
, output
->name
,
3451 sizeof(tmp_output
.name
));
3454 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3456 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3457 wait
, nb_packets_per_stream
);
3458 if (ret
!= LTTNG_OK
) {
3462 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");