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 /* If we have a filter, we must have its filter expression */
1501 assert(!(!!filter_expression
^ !!filter
));
1503 DBG("Enable event command for event \'%s\'", event
->name
);
1505 ret
= validate_event_name(event
->name
);
1512 switch (domain
->type
) {
1513 case LTTNG_DOMAIN_KERNEL
:
1515 struct ltt_kernel_channel
*kchan
;
1518 * If a non-default channel has been created in the
1519 * session, explicitely require that -c chan_name needs
1522 if (session
->kernel_session
->has_non_default_channel
1523 && channel_name
[0] == '\0') {
1524 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1528 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1529 session
->kernel_session
);
1530 if (kchan
== NULL
) {
1531 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1532 LTTNG_BUFFER_GLOBAL
);
1534 ret
= LTTNG_ERR_FATAL
;
1537 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1539 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1540 if (ret
!= LTTNG_OK
) {
1546 channel_created
= 1;
1549 /* Get the newly created kernel channel pointer */
1550 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1551 session
->kernel_session
);
1552 if (kchan
== NULL
) {
1553 /* This sould not happen... */
1554 ret
= LTTNG_ERR_FATAL
;
1558 switch (event
->type
) {
1559 case LTTNG_EVENT_ALL
:
1561 char *filter_expression_a
= NULL
;
1562 struct lttng_filter_bytecode
*filter_a
= NULL
;
1565 * We need to duplicate filter_expression and filter,
1566 * because ownership is passed to first enable
1569 if (filter_expression
) {
1570 filter_expression_a
= strdup(filter_expression
);
1571 if (!filter_expression_a
) {
1572 ret
= LTTNG_ERR_FATAL
;
1577 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1579 free(filter_expression_a
);
1580 ret
= LTTNG_ERR_FATAL
;
1583 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1585 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1586 ret
= event_kernel_enable_event(kchan
, event
,
1587 filter_expression
, filter
);
1588 /* We have passed ownership */
1589 filter_expression
= NULL
;
1591 if (ret
!= LTTNG_OK
) {
1592 if (channel_created
) {
1593 /* Let's not leak a useless channel. */
1594 kernel_destroy_channel(kchan
);
1596 free(filter_expression_a
);
1600 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1601 ret
= event_kernel_enable_event(kchan
, event
,
1602 filter_expression_a
, filter_a
);
1603 if (ret
!= LTTNG_OK
) {
1604 free(filter_expression_a
);
1610 case LTTNG_EVENT_PROBE
:
1611 case LTTNG_EVENT_FUNCTION
:
1612 case LTTNG_EVENT_FUNCTION_ENTRY
:
1613 case LTTNG_EVENT_TRACEPOINT
:
1614 ret
= event_kernel_enable_event(kchan
, event
,
1615 filter_expression
, filter
);
1616 /* We have passed ownership */
1617 filter_expression
= NULL
;
1619 if (ret
!= LTTNG_OK
) {
1620 if (channel_created
) {
1621 /* Let's not leak a useless channel. */
1622 kernel_destroy_channel(kchan
);
1627 case LTTNG_EVENT_SYSCALL
:
1628 ret
= event_kernel_enable_event(kchan
, event
,
1629 filter_expression
, filter
);
1630 /* We have passed ownership */
1631 filter_expression
= NULL
;
1633 if (ret
!= LTTNG_OK
) {
1638 ret
= LTTNG_ERR_UNK
;
1642 kernel_wait_quiescent(kernel_tracer_fd
);
1645 case LTTNG_DOMAIN_UST
:
1647 struct ltt_ust_channel
*uchan
;
1648 struct ltt_ust_session
*usess
= session
->ust_session
;
1653 * If a non-default channel has been created in the
1654 * session, explicitely require that -c chan_name needs
1657 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1658 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1662 /* Get channel from global UST domain */
1663 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1665 if (uchan
== NULL
) {
1666 /* Create default channel */
1667 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1668 usess
->buffer_type
);
1670 ret
= LTTNG_ERR_FATAL
;
1673 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1675 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1676 if (ret
!= LTTNG_OK
) {
1682 /* Get the newly created channel reference back */
1683 uchan
= trace_ust_find_channel_by_name(
1684 usess
->domain_global
.channels
, channel_name
);
1688 if (!internal_event
) {
1690 * Ensure the event name is not reserved for internal
1693 ret
= validate_ust_event_name(event
->name
);
1695 WARN("Userspace event name %s failed validation.",
1697 event
->name
: "NULL");
1698 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1703 /* At this point, the session and channel exist on the tracer */
1704 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1705 filter_expression
, filter
, exclusion
,
1707 /* We have passed ownership */
1708 filter_expression
= NULL
;
1711 if (ret
!= LTTNG_OK
) {
1716 case LTTNG_DOMAIN_LOG4J
:
1717 case LTTNG_DOMAIN_JUL
:
1718 case LTTNG_DOMAIN_PYTHON
:
1720 const char *default_event_name
, *default_chan_name
;
1722 struct lttng_event uevent
;
1723 struct lttng_domain tmp_dom
;
1724 struct ltt_ust_session
*usess
= session
->ust_session
;
1728 agt
= trace_ust_find_agent(usess
, domain
->type
);
1730 agt
= agent_create(domain
->type
);
1732 ret
= -LTTNG_ERR_NOMEM
;
1735 agent_add(agt
, usess
->agents
);
1738 /* Create the default tracepoint. */
1739 memset(&uevent
, 0, sizeof(uevent
));
1740 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1741 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1742 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1743 if (!default_event_name
) {
1744 ret
= -LTTNG_ERR_FATAL
;
1747 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1748 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1751 * The domain type is changed because we are about to enable the
1752 * default channel and event for the JUL domain that are hardcoded.
1753 * This happens in the UST domain.
1755 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1756 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1758 switch (domain
->type
) {
1759 case LTTNG_DOMAIN_LOG4J
:
1760 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1762 case LTTNG_DOMAIN_JUL
:
1763 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1765 case LTTNG_DOMAIN_PYTHON
:
1766 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1769 /* The switch/case we are in makes this impossible */
1774 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1775 char *filter_expression_copy
= NULL
;
1778 filter_copy
= zmalloc(
1779 sizeof(struct lttng_filter_bytecode
)
1785 memcpy(filter_copy
, filter
,
1786 sizeof(struct lttng_filter_bytecode
)
1790 if (filter_expression
) {
1791 filter_expression_copy
=
1792 strdup(filter_expression
);
1793 if (!filter_expression
) {
1794 ret
= LTTNG_ERR_NOMEM
;
1795 goto error_free_copy
;
1799 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1800 (char *) default_chan_name
,
1801 &uevent
, filter_expression_copy
,
1802 filter_copy
, NULL
, wpipe
);
1804 filter_expression_copy
= NULL
;
1807 free(filter_expression_copy
);
1810 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1814 /* The wild card * means that everything should be enabled. */
1815 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1816 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1820 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1824 if (ret
!= LTTNG_OK
) {
1831 ret
= LTTNG_ERR_UND
;
1838 free(filter_expression
);
1846 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1847 * We own filter, exclusion, and filter_expression.
1849 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1850 char *channel_name
, struct lttng_event
*event
,
1851 char *filter_expression
,
1852 struct lttng_filter_bytecode
*filter
,
1853 struct lttng_event_exclusion
*exclusion
,
1856 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1857 filter_expression
, filter
, exclusion
, wpipe
, false);
1861 * Enable an event which is internal to LTTng. An internal should
1862 * never be made visible to clients and are immune to checks such as
1865 static int cmd_enable_event_internal(struct ltt_session
*session
,
1866 struct lttng_domain
*domain
,
1867 char *channel_name
, struct lttng_event
*event
,
1868 char *filter_expression
,
1869 struct lttng_filter_bytecode
*filter
,
1870 struct lttng_event_exclusion
*exclusion
,
1873 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1874 filter_expression
, filter
, exclusion
, wpipe
, true);
1878 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1880 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1881 struct lttng_event
**events
)
1884 ssize_t nb_events
= 0;
1887 case LTTNG_DOMAIN_KERNEL
:
1888 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1889 if (nb_events
< 0) {
1890 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1894 case LTTNG_DOMAIN_UST
:
1895 nb_events
= ust_app_list_events(events
);
1896 if (nb_events
< 0) {
1897 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1901 case LTTNG_DOMAIN_LOG4J
:
1902 case LTTNG_DOMAIN_JUL
:
1903 case LTTNG_DOMAIN_PYTHON
:
1904 nb_events
= agent_list_events(events
, domain
);
1905 if (nb_events
< 0) {
1906 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1911 ret
= LTTNG_ERR_UND
;
1918 /* Return negative value to differentiate return code */
1923 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1925 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
1926 struct lttng_event_field
**fields
)
1929 ssize_t nb_fields
= 0;
1932 case LTTNG_DOMAIN_UST
:
1933 nb_fields
= ust_app_list_event_fields(fields
);
1934 if (nb_fields
< 0) {
1935 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1939 case LTTNG_DOMAIN_KERNEL
:
1940 default: /* fall-through */
1941 ret
= LTTNG_ERR_UND
;
1948 /* Return negative value to differentiate return code */
1952 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1954 return syscall_table_list(events
);
1958 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1960 * Called with session lock held.
1962 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1963 enum lttng_domain_type domain
, int32_t **pids
)
1966 ssize_t nr_pids
= 0;
1969 case LTTNG_DOMAIN_KERNEL
:
1971 struct ltt_kernel_session
*ksess
;
1973 ksess
= session
->kernel_session
;
1974 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1976 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1981 case LTTNG_DOMAIN_UST
:
1983 struct ltt_ust_session
*usess
;
1985 usess
= session
->ust_session
;
1986 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
1988 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1993 case LTTNG_DOMAIN_LOG4J
:
1994 case LTTNG_DOMAIN_JUL
:
1995 case LTTNG_DOMAIN_PYTHON
:
1997 ret
= LTTNG_ERR_UND
;
2004 /* Return negative value to differentiate return code */
2009 * Command LTTNG_START_TRACE processed by the client thread.
2011 * Called with session mutex held.
2013 int cmd_start_trace(struct ltt_session
*session
)
2016 unsigned long nb_chan
= 0;
2017 struct ltt_kernel_session
*ksession
;
2018 struct ltt_ust_session
*usess
;
2022 /* Ease our life a bit ;) */
2023 ksession
= session
->kernel_session
;
2024 usess
= session
->ust_session
;
2026 /* Is the session already started? */
2027 if (session
->active
) {
2028 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2033 * Starting a session without channel is useless since after that it's not
2034 * possible to enable channel thus inform the client.
2036 if (usess
&& usess
->domain_global
.channels
) {
2037 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2040 nb_chan
+= ksession
->channel_count
;
2043 ret
= LTTNG_ERR_NO_CHANNEL
;
2047 /* Kernel tracing */
2048 if (ksession
!= NULL
) {
2049 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2050 if (ret
!= LTTNG_OK
) {
2055 /* Flag session that trace should start automatically */
2058 * Even though the start trace might fail, flag this session active so
2059 * other application coming in are started by default.
2063 ret
= ust_app_start_trace_all(usess
);
2065 ret
= LTTNG_ERR_UST_START_FAIL
;
2070 /* Flag this after a successful start. */
2071 session
->has_been_started
= 1;
2072 session
->active
= 1;
2081 * Command LTTNG_STOP_TRACE processed by the client thread.
2083 int cmd_stop_trace(struct ltt_session
*session
)
2086 struct ltt_kernel_channel
*kchan
;
2087 struct ltt_kernel_session
*ksession
;
2088 struct ltt_ust_session
*usess
;
2093 ksession
= session
->kernel_session
;
2094 usess
= session
->ust_session
;
2096 /* Session is not active. Skip everythong and inform the client. */
2097 if (!session
->active
) {
2098 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2103 if (ksession
&& ksession
->active
) {
2104 DBG("Stop kernel tracing");
2106 /* Flush metadata if exist */
2107 if (ksession
->metadata_stream_fd
>= 0) {
2108 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2110 ERR("Kernel metadata flush failed");
2114 /* Flush all buffers before stopping */
2115 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2116 ret
= kernel_flush_buffer(kchan
);
2118 ERR("Kernel flush buffer error");
2122 ret
= kernel_stop_session(ksession
);
2124 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2128 kernel_wait_quiescent(kernel_tracer_fd
);
2130 ksession
->active
= 0;
2133 if (usess
&& usess
->active
) {
2135 * Even though the stop trace might fail, flag this session inactive so
2136 * other application coming in are not started by default.
2140 ret
= ust_app_stop_trace_all(usess
);
2142 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2147 /* Flag inactive after a successful stop. */
2148 session
->active
= 0;
2156 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2158 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2159 struct lttng_uri
*uris
)
2162 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2163 struct ltt_ust_session
*usess
= session
->ust_session
;
2169 /* Can't set consumer URI if the session is active. */
2170 if (session
->active
) {
2171 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2175 /* Set the "global" consumer URIs */
2176 for (i
= 0; i
< nb_uri
; i
++) {
2177 ret
= add_uri_to_consumer(session
->consumer
,
2178 &uris
[i
], 0, session
->name
);
2179 if (ret
!= LTTNG_OK
) {
2184 /* Set UST session URIs */
2185 if (session
->ust_session
) {
2186 for (i
= 0; i
< nb_uri
; i
++) {
2187 ret
= add_uri_to_consumer(
2188 session
->ust_session
->consumer
,
2189 &uris
[i
], LTTNG_DOMAIN_UST
,
2191 if (ret
!= LTTNG_OK
) {
2197 /* Set kernel session URIs */
2198 if (session
->kernel_session
) {
2199 for (i
= 0; i
< nb_uri
; i
++) {
2200 ret
= add_uri_to_consumer(
2201 session
->kernel_session
->consumer
,
2202 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2204 if (ret
!= LTTNG_OK
) {
2211 * Make sure to set the session in output mode after we set URI since a
2212 * session can be created without URL (thus flagged in no output mode).
2214 session
->output_traces
= 1;
2216 ksess
->output_traces
= 1;
2220 usess
->output_traces
= 1;
2231 * Command LTTNG_CREATE_SESSION processed by the client thread.
2233 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2234 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2237 struct ltt_session
*session
;
2243 * Verify if the session already exist
2245 * XXX: There is no need for the session lock list here since the caller
2246 * (process_client_msg) is holding it. We might want to change that so a
2247 * single command does not lock the entire session list.
2249 session
= session_find_by_name(name
);
2250 if (session
!= NULL
) {
2251 ret
= LTTNG_ERR_EXIST_SESS
;
2255 /* Create tracing session in the registry */
2256 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2257 LTTNG_SOCK_GET_GID_CRED(creds
));
2258 if (ret
!= LTTNG_OK
) {
2263 * Get the newly created session pointer back
2265 * XXX: There is no need for the session lock list here since the caller
2266 * (process_client_msg) is holding it. We might want to change that so a
2267 * single command does not lock the entire session list.
2269 session
= session_find_by_name(name
);
2272 session
->live_timer
= live_timer
;
2273 /* Create default consumer output for the session not yet created. */
2274 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2275 if (session
->consumer
== NULL
) {
2276 ret
= LTTNG_ERR_FATAL
;
2277 goto consumer_error
;
2281 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2282 if (ret
!= LTTNG_OK
) {
2283 goto consumer_error
;
2285 session
->output_traces
= 1;
2287 session
->output_traces
= 0;
2288 DBG2("Session %s created with no output", session
->name
);
2291 session
->consumer
->enabled
= 1;
2296 session_destroy(session
);
2303 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2305 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2306 size_t nb_uri
, lttng_sock_cred
*creds
)
2309 struct ltt_session
*session
;
2310 struct snapshot_output
*new_output
= NULL
;
2316 * Create session in no output mode with URIs set to NULL. The uris we've
2317 * received are for a default snapshot output if one.
2319 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2320 if (ret
!= LTTNG_OK
) {
2324 /* Get the newly created session pointer back. This should NEVER fail. */
2325 session
= session_find_by_name(name
);
2328 /* Flag session for snapshot mode. */
2329 session
->snapshot_mode
= 1;
2331 /* Skip snapshot output creation if no URI is given. */
2336 new_output
= snapshot_output_alloc();
2338 ret
= LTTNG_ERR_NOMEM
;
2339 goto error_snapshot_alloc
;
2342 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2343 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2345 if (ret
== -ENOMEM
) {
2346 ret
= LTTNG_ERR_NOMEM
;
2348 ret
= LTTNG_ERR_INVALID
;
2350 goto error_snapshot
;
2354 snapshot_add_output(&session
->snapshot
, new_output
);
2361 snapshot_output_destroy(new_output
);
2362 error_snapshot_alloc
:
2363 session_destroy(session
);
2369 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2371 * Called with session lock held.
2373 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2376 struct ltt_ust_session
*usess
;
2377 struct ltt_kernel_session
*ksess
;
2382 usess
= session
->ust_session
;
2383 ksess
= session
->kernel_session
;
2385 /* Clean kernel session teardown */
2386 kernel_destroy_session(ksess
);
2388 /* UST session teardown */
2390 /* Close any relayd session */
2391 consumer_output_send_destroy_relayd(usess
->consumer
);
2393 /* Destroy every UST application related to this session. */
2394 ret
= ust_app_destroy_trace_all(usess
);
2396 ERR("Error in ust_app_destroy_trace_all");
2399 /* Clean up the rest. */
2400 trace_ust_destroy_session(usess
);
2404 * Must notify the kernel thread here to update it's poll set in order to
2405 * remove the channel(s)' fd just destroyed.
2407 ret
= notify_thread_pipe(wpipe
);
2409 PERROR("write kernel poll pipe");
2412 ret
= session_destroy(session
);
2418 * Command LTTNG_CALIBRATE processed by the client thread.
2420 int cmd_calibrate(enum lttng_domain_type domain
,
2421 struct lttng_calibrate
*calibrate
)
2426 case LTTNG_DOMAIN_KERNEL
:
2428 struct lttng_kernel_calibrate kcalibrate
;
2430 switch (calibrate
->type
) {
2431 case LTTNG_CALIBRATE_FUNCTION
:
2433 /* Default and only possible calibrate option. */
2434 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2438 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2440 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2445 case LTTNG_DOMAIN_UST
:
2447 struct lttng_ust_calibrate ucalibrate
;
2449 switch (calibrate
->type
) {
2450 case LTTNG_CALIBRATE_FUNCTION
:
2452 /* Default and only possible calibrate option. */
2453 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2457 ret
= ust_app_calibrate_glb(&ucalibrate
);
2459 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2465 ret
= LTTNG_ERR_UND
;
2476 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2478 int cmd_register_consumer(struct ltt_session
*session
,
2479 enum lttng_domain_type domain
, const char *sock_path
,
2480 struct consumer_data
*cdata
)
2483 struct consumer_socket
*socket
= NULL
;
2490 case LTTNG_DOMAIN_KERNEL
:
2492 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2496 /* Can't register a consumer if there is already one */
2497 if (ksess
->consumer_fds_sent
!= 0) {
2498 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2502 sock
= lttcomm_connect_unix_sock(sock_path
);
2504 ret
= LTTNG_ERR_CONNECT_FAIL
;
2507 cdata
->cmd_sock
= sock
;
2509 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2510 if (socket
== NULL
) {
2513 PERROR("close register consumer");
2515 cdata
->cmd_sock
= -1;
2516 ret
= LTTNG_ERR_FATAL
;
2520 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2521 if (socket
->lock
== NULL
) {
2522 PERROR("zmalloc pthread mutex");
2523 ret
= LTTNG_ERR_FATAL
;
2526 pthread_mutex_init(socket
->lock
, NULL
);
2527 socket
->registered
= 1;
2530 consumer_add_socket(socket
, ksess
->consumer
);
2533 pthread_mutex_lock(&cdata
->pid_mutex
);
2535 pthread_mutex_unlock(&cdata
->pid_mutex
);
2540 /* TODO: Userspace tracing */
2541 ret
= LTTNG_ERR_UND
;
2549 consumer_destroy_socket(socket
);
2555 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2557 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2558 struct lttng_domain
**domains
)
2563 struct lttng_ht_iter iter
;
2565 if (session
->kernel_session
!= NULL
) {
2566 DBG3("Listing domains found kernel domain");
2570 if (session
->ust_session
!= NULL
) {
2571 DBG3("Listing domains found UST global domain");
2575 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2577 if (agt
->being_used
) {
2588 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2589 if (*domains
== NULL
) {
2590 ret
= LTTNG_ERR_FATAL
;
2594 if (session
->kernel_session
!= NULL
) {
2595 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2597 /* Kernel session buffer type is always GLOBAL */
2598 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2603 if (session
->ust_session
!= NULL
) {
2604 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2605 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2609 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2611 if (agt
->being_used
) {
2612 (*domains
)[index
].type
= agt
->domain
;
2613 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2623 /* Return negative value to differentiate return code */
2629 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2631 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2632 struct ltt_session
*session
, struct lttng_channel
**channels
)
2635 ssize_t nb_chan
= 0;
2638 case LTTNG_DOMAIN_KERNEL
:
2639 if (session
->kernel_session
!= NULL
) {
2640 nb_chan
= session
->kernel_session
->channel_count
;
2642 DBG3("Number of kernel channels %zd", nb_chan
);
2644 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2647 case LTTNG_DOMAIN_UST
:
2648 if (session
->ust_session
!= NULL
) {
2650 nb_chan
= lttng_ht_get_count(
2651 session
->ust_session
->domain_global
.channels
);
2654 DBG3("Number of UST global channels %zd", nb_chan
);
2656 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2661 ret
= LTTNG_ERR_UND
;
2666 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2667 if (*channels
== NULL
) {
2668 ret
= LTTNG_ERR_FATAL
;
2672 list_lttng_channels(domain
, session
, *channels
);
2678 /* Return negative value to differentiate return code */
2683 * Command LTTNG_LIST_EVENTS processed by the client thread.
2685 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2686 struct ltt_session
*session
, char *channel_name
,
2687 struct lttng_event
**events
)
2690 ssize_t nb_event
= 0;
2693 case LTTNG_DOMAIN_KERNEL
:
2694 if (session
->kernel_session
!= NULL
) {
2695 nb_event
= list_lttng_kernel_events(channel_name
,
2696 session
->kernel_session
, events
);
2699 case LTTNG_DOMAIN_UST
:
2701 if (session
->ust_session
!= NULL
) {
2702 nb_event
= list_lttng_ust_global_events(channel_name
,
2703 &session
->ust_session
->domain_global
, events
);
2707 case LTTNG_DOMAIN_LOG4J
:
2708 case LTTNG_DOMAIN_JUL
:
2709 case LTTNG_DOMAIN_PYTHON
:
2710 if (session
->ust_session
) {
2711 struct lttng_ht_iter iter
;
2715 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2716 &iter
.iter
, agt
, node
.node
) {
2717 nb_event
= list_lttng_agent_events(agt
, events
);
2723 ret
= LTTNG_ERR_UND
;
2730 /* Return negative value to differentiate return code */
2735 * Using the session list, filled a lttng_session array to send back to the
2736 * client for session listing.
2738 * The session list lock MUST be acquired before calling this function. Use
2739 * session_lock_list() and session_unlock_list().
2741 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2746 struct ltt_session
*session
;
2747 struct ltt_session_list
*list
= session_get_list();
2749 DBG("Getting all available session for UID %d GID %d",
2752 * Iterate over session list and append data after the control struct in
2755 cds_list_for_each_entry(session
, &list
->head
, list
) {
2757 * Only list the sessions the user can control.
2759 if (!session_access_ok(session
, uid
, gid
)) {
2763 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2764 struct ltt_ust_session
*usess
= session
->ust_session
;
2766 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2767 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2768 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2769 ret
= build_network_session_path(sessions
[i
].path
,
2770 sizeof(sessions
[i
].path
), session
);
2772 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2773 session
->consumer
->dst
.trace_path
);
2776 PERROR("snprintf session path");
2780 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2781 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2782 sessions
[i
].enabled
= session
->active
;
2783 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2784 sessions
[i
].live_timer_interval
= session
->live_timer
;
2790 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2791 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2793 int cmd_data_pending(struct ltt_session
*session
)
2796 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2797 struct ltt_ust_session
*usess
= session
->ust_session
;
2801 /* Session MUST be stopped to ask for data availability. */
2802 if (session
->active
) {
2803 ret
= LTTNG_ERR_SESSION_STARTED
;
2807 * If stopped, just make sure we've started before else the above call
2808 * will always send that there is data pending.
2810 * The consumer assumes that when the data pending command is received,
2811 * the trace has been started before or else no output data is written
2812 * by the streams which is a condition for data pending. So, this is
2813 * *VERY* important that we don't ask the consumer before a start
2816 if (!session
->has_been_started
) {
2822 if (ksess
&& ksess
->consumer
) {
2823 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2825 /* Data is still being extracted for the kernel. */
2830 if (usess
&& usess
->consumer
) {
2831 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2833 /* Data is still being extracted for the kernel. */
2838 /* Data is ready to be read by a viewer */
2846 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2848 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2850 int cmd_snapshot_add_output(struct ltt_session
*session
,
2851 struct lttng_snapshot_output
*output
, uint32_t *id
)
2854 struct snapshot_output
*new_output
;
2859 DBG("Cmd snapshot add output for session %s", session
->name
);
2862 * Permission denied to create an output if the session is not
2863 * set in no output mode.
2865 if (session
->output_traces
) {
2866 ret
= LTTNG_ERR_EPERM
;
2870 /* Only one output is allowed until we have the "tee" feature. */
2871 if (session
->snapshot
.nb_output
== 1) {
2872 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2876 new_output
= snapshot_output_alloc();
2878 ret
= LTTNG_ERR_NOMEM
;
2882 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2883 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2884 &session
->snapshot
);
2886 if (ret
== -ENOMEM
) {
2887 ret
= LTTNG_ERR_NOMEM
;
2889 ret
= LTTNG_ERR_INVALID
;
2895 snapshot_add_output(&session
->snapshot
, new_output
);
2897 *id
= new_output
->id
;
2904 snapshot_output_destroy(new_output
);
2910 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2912 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2914 int cmd_snapshot_del_output(struct ltt_session
*session
,
2915 struct lttng_snapshot_output
*output
)
2918 struct snapshot_output
*sout
= NULL
;
2926 * Permission denied to create an output if the session is not
2927 * set in no output mode.
2929 if (session
->output_traces
) {
2930 ret
= LTTNG_ERR_EPERM
;
2935 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2937 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2938 } else if (*output
->name
!= '\0') {
2939 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2941 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2944 ret
= LTTNG_ERR_INVALID
;
2948 snapshot_delete_output(&session
->snapshot
, sout
);
2949 snapshot_output_destroy(sout
);
2958 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2960 * If no output is available, outputs is untouched and 0 is returned.
2962 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2964 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2965 struct lttng_snapshot_output
**outputs
)
2968 struct lttng_snapshot_output
*list
= NULL
;
2969 struct lttng_ht_iter iter
;
2970 struct snapshot_output
*output
;
2975 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2978 * Permission denied to create an output if the session is not
2979 * set in no output mode.
2981 if (session
->output_traces
) {
2982 ret
= -LTTNG_ERR_EPERM
;
2986 if (session
->snapshot
.nb_output
== 0) {
2991 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2993 ret
= -LTTNG_ERR_NOMEM
;
2997 /* Copy list from session to the new list object. */
2999 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3000 output
, node
.node
) {
3001 assert(output
->consumer
);
3002 list
[idx
].id
= output
->id
;
3003 list
[idx
].max_size
= output
->max_size
;
3004 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3005 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3006 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3007 sizeof(list
[idx
].ctrl_url
));
3010 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3011 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3013 ret
= -LTTNG_ERR_NOMEM
;
3018 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3019 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3021 ret
= -LTTNG_ERR_NOMEM
;
3030 ret
= session
->snapshot
.nb_output
;
3038 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3039 * snapshot output is *not* set with a remote destination.
3041 * Return 0 on success or a LTTNG_ERR code.
3043 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3044 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3047 struct lttng_ht_iter iter
;
3048 struct consumer_socket
*socket
;
3051 assert(snap_output
);
3054 DBG2("Set relayd object from snapshot output");
3056 /* Ignore if snapshot consumer output is not network. */
3057 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3062 * For each consumer socket, create and send the relayd object of the
3066 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3067 socket
, node
.node
) {
3068 ret
= send_consumer_relayd_sockets(0, session
->id
,
3069 snap_output
->consumer
, socket
,
3070 session
->name
, session
->hostname
,
3071 session
->live_timer
);
3072 if (ret
!= LTTNG_OK
) {
3084 * Record a kernel snapshot.
3086 * Return LTTNG_OK on success or a LTTNG_ERR code.
3088 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3089 struct snapshot_output
*output
, struct ltt_session
*session
,
3090 int wait
, uint64_t nb_packets_per_stream
)
3098 /* Get the datetime for the snapshot output directory. */
3099 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3100 sizeof(output
->datetime
));
3102 ret
= LTTNG_ERR_INVALID
;
3107 * Copy kernel session sockets so we can communicate with the right
3108 * consumer for the snapshot record command.
3110 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3112 ret
= LTTNG_ERR_NOMEM
;
3116 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3117 if (ret
!= LTTNG_OK
) {
3118 goto error_snapshot
;
3121 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3122 if (ret
!= LTTNG_OK
) {
3123 goto error_snapshot
;
3130 /* Clean up copied sockets so this output can use some other later on. */
3131 consumer_destroy_output_sockets(output
->consumer
);
3138 * Record a UST snapshot.
3140 * Return 0 on success or a LTTNG_ERR error code.
3142 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3143 struct snapshot_output
*output
, struct ltt_session
*session
,
3144 int wait
, uint64_t nb_packets_per_stream
)
3152 /* Get the datetime for the snapshot output directory. */
3153 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3154 sizeof(output
->datetime
));
3156 ret
= LTTNG_ERR_INVALID
;
3161 * Copy UST session sockets so we can communicate with the right
3162 * consumer for the snapshot record command.
3164 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3166 ret
= LTTNG_ERR_NOMEM
;
3170 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3171 if (ret
!= LTTNG_OK
) {
3172 goto error_snapshot
;
3175 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3179 ret
= LTTNG_ERR_INVALID
;
3182 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3185 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3188 goto error_snapshot
;
3194 /* Clean up copied sockets so this output can use some other later on. */
3195 consumer_destroy_output_sockets(output
->consumer
);
3201 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3202 uint64_t cur_nr_packets
)
3204 uint64_t tot_size
= 0;
3206 if (session
->kernel_session
) {
3207 struct ltt_kernel_channel
*chan
;
3208 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3210 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3211 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3213 * Don't take channel into account if we
3214 * already grab all its packets.
3218 tot_size
+= chan
->channel
->attr
.subbuf_size
3219 * chan
->stream_count
;
3223 if (session
->ust_session
) {
3224 struct ltt_ust_session
*usess
= session
->ust_session
;
3226 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3234 * Calculate the number of packets we can grab from each stream that
3235 * fits within the overall snapshot max size.
3237 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3238 * the number of packets per stream.
3240 * TODO: this approach is not perfect: we consider the worse case
3241 * (packet filling the sub-buffers) as an upper bound, but we could do
3242 * better if we do this calculation while we actually grab the packet
3243 * content: we would know how much padding we don't actually store into
3246 * This algorithm is currently bounded by the number of packets per
3249 * Since we call this algorithm before actually grabbing the data, it's
3250 * an approximation: for instance, applications could appear/disappear
3251 * in between this call and actually grabbing data.
3254 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3257 uint64_t cur_nb_packets
= 0;
3260 return 0; /* Infinite */
3263 size_left
= max_size
;
3265 uint64_t one_more_packet_tot_size
;
3267 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3269 if (!one_more_packet_tot_size
) {
3270 /* We are already grabbing all packets. */
3273 size_left
-= one_more_packet_tot_size
;
3274 if (size_left
< 0) {
3279 if (!cur_nb_packets
) {
3280 /* Not enough room to grab one packet of each stream, error. */
3283 return cur_nb_packets
;
3287 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3289 * The wait parameter is ignored so this call always wait for the snapshot to
3290 * complete before returning.
3292 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3294 int cmd_snapshot_record(struct ltt_session
*session
,
3295 struct lttng_snapshot_output
*output
, int wait
)
3298 unsigned int use_tmp_output
= 0;
3299 struct snapshot_output tmp_output
;
3300 unsigned int snapshot_success
= 0;
3305 DBG("Cmd snapshot record for session %s", session
->name
);
3308 * Permission denied to create an output if the session is not
3309 * set in no output mode.
3311 if (session
->output_traces
) {
3312 ret
= LTTNG_ERR_EPERM
;
3316 /* The session needs to be started at least once. */
3317 if (!session
->has_been_started
) {
3318 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3322 /* Use temporary output for the session. */
3323 if (*output
->ctrl_url
!= '\0') {
3324 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3325 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3328 if (ret
== -ENOMEM
) {
3329 ret
= LTTNG_ERR_NOMEM
;
3331 ret
= LTTNG_ERR_INVALID
;
3335 /* Use the global session count for the temporary snapshot. */
3336 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3340 if (session
->kernel_session
) {
3341 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3343 if (use_tmp_output
) {
3344 int64_t nb_packets_per_stream
;
3346 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3347 tmp_output
.max_size
);
3348 if (nb_packets_per_stream
< 0) {
3349 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3352 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3353 wait
, nb_packets_per_stream
);
3354 if (ret
!= LTTNG_OK
) {
3357 snapshot_success
= 1;
3359 struct snapshot_output
*sout
;
3360 struct lttng_ht_iter iter
;
3363 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3364 &iter
.iter
, sout
, node
.node
) {
3365 int64_t nb_packets_per_stream
;
3368 * Make a local copy of the output and assign the possible
3369 * temporary value given by the caller.
3371 memset(&tmp_output
, 0, sizeof(tmp_output
));
3372 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3374 if (output
->max_size
!= (uint64_t) -1ULL) {
3375 tmp_output
.max_size
= output
->max_size
;
3378 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3379 tmp_output
.max_size
);
3380 if (nb_packets_per_stream
< 0) {
3381 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3385 /* Use temporary name. */
3386 if (*output
->name
!= '\0') {
3387 strncpy(tmp_output
.name
, output
->name
,
3388 sizeof(tmp_output
.name
));
3391 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3393 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3394 session
, wait
, nb_packets_per_stream
);
3395 if (ret
!= LTTNG_OK
) {
3399 snapshot_success
= 1;
3405 if (session
->ust_session
) {
3406 struct ltt_ust_session
*usess
= session
->ust_session
;
3408 if (use_tmp_output
) {
3409 int64_t nb_packets_per_stream
;
3411 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3412 tmp_output
.max_size
);
3413 if (nb_packets_per_stream
< 0) {
3414 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3417 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3418 wait
, nb_packets_per_stream
);
3419 if (ret
!= LTTNG_OK
) {
3422 snapshot_success
= 1;
3424 struct snapshot_output
*sout
;
3425 struct lttng_ht_iter iter
;
3428 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3429 &iter
.iter
, sout
, node
.node
) {
3430 int64_t nb_packets_per_stream
;
3433 * Make a local copy of the output and assign the possible
3434 * temporary value given by the caller.
3436 memset(&tmp_output
, 0, sizeof(tmp_output
));
3437 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3439 if (output
->max_size
!= (uint64_t) -1ULL) {
3440 tmp_output
.max_size
= output
->max_size
;
3443 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3444 tmp_output
.max_size
);
3445 if (nb_packets_per_stream
< 0) {
3446 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3451 /* Use temporary name. */
3452 if (*output
->name
!= '\0') {
3453 strncpy(tmp_output
.name
, output
->name
,
3454 sizeof(tmp_output
.name
));
3457 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3459 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3460 wait
, nb_packets_per_stream
);
3461 if (ret
!= LTTNG_OK
) {
3465 snapshot_success
= 1;
3471 if (snapshot_success
) {
3472 session
->snapshot
.nb_snapshot
++;
3474 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3482 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3484 int cmd_set_session_shm_path(struct ltt_session
*session
,
3485 const char *shm_path
)
3491 * Can only set shm path before session is started.
3493 if (session
->has_been_started
) {
3494 return LTTNG_ERR_SESSION_STARTED
;
3497 strncpy(session
->shm_path
, shm_path
,
3498 sizeof(session
->shm_path
));
3499 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3505 * Init command subsystem.
3510 * Set network sequence index to 1 for streams to match a relayd
3511 * socket on the consumer side.
3513 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3514 relayd_net_seq_idx
= 1;
3515 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3517 DBG("Command subsystem initialized");