2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <urcu/list.h>
24 #include <urcu/uatomic.h>
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
35 #include "health-sessiond.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
45 * Used to keep a unique index for each relayd socket created where this value
46 * is associated with streams on the consumer so it can match the right relayd
47 * to send to. It must be accessed with the relayd_net_seq_idx_lock
50 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 static uint64_t relayd_net_seq_idx
;
54 * Create a session path used by list_lttng_sessions for the case that the
55 * session consumer is on the network.
57 static int build_network_session_path(char *dst
, size_t size
,
58 struct ltt_session
*session
)
60 int ret
, kdata_port
, udata_port
;
61 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
62 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
67 memset(tmp_urls
, 0, sizeof(tmp_urls
));
68 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
70 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
72 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
73 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
74 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
77 if (session
->ust_session
&& session
->ust_session
->consumer
) {
78 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
79 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
82 if (uuri
== NULL
&& kuri
== NULL
) {
83 uri
= &session
->consumer
->dst
.net
.control
;
84 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
85 } else if (kuri
&& uuri
) {
86 ret
= uri_compare(kuri
, uuri
);
90 /* Build uuri URL string */
91 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
98 } else if (kuri
&& uuri
== NULL
) {
100 } else if (uuri
&& kuri
== NULL
) {
104 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
110 * Do we have a UST url set. If yes, this means we have both kernel and UST
113 if (*tmp_uurl
!= '\0') {
114 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
115 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
118 if (kuri
|| (!kuri
&& !uuri
)) {
121 /* No kernel URI, use the UST port. */
124 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
132 * Fill lttng_channel array of all channels.
134 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
135 struct lttng_channel
*channels
)
138 struct ltt_kernel_channel
*kchan
;
140 DBG("Listing channels for session %s", session
->name
);
143 case LTTNG_DOMAIN_KERNEL
:
144 /* Kernel channels */
145 if (session
->kernel_session
!= NULL
) {
146 cds_list_for_each_entry(kchan
,
147 &session
->kernel_session
->channel_list
.head
, list
) {
148 /* Copy lttng_channel struct to array */
149 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
150 channels
[i
].enabled
= kchan
->enabled
;
155 case LTTNG_DOMAIN_UST
:
157 struct lttng_ht_iter iter
;
158 struct ltt_ust_channel
*uchan
;
161 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
162 &iter
.iter
, uchan
, node
.node
) {
163 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
164 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
165 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
166 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
167 channels
[i
].attr
.switch_timer_interval
=
168 uchan
->attr
.switch_timer_interval
;
169 channels
[i
].attr
.read_timer_interval
=
170 uchan
->attr
.read_timer_interval
;
171 channels
[i
].enabled
= uchan
->enabled
;
172 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
173 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
174 switch (uchan
->attr
.output
) {
177 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
191 * Create a list of agent domain events.
193 * Return number of events in list on success or else a negative value.
195 static int list_lttng_agent_events(struct agent
*agt
,
196 struct lttng_event
**events
)
199 unsigned int nb_event
= 0;
200 struct agent_event
*event
;
201 struct lttng_event
*tmp_events
;
202 struct lttng_ht_iter iter
;
207 DBG3("Listing agent events");
210 nb_event
= lttng_ht_get_count(agt
->events
);
217 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
219 PERROR("zmalloc agent events session");
220 ret
= -LTTNG_ERR_FATAL
;
225 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
226 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
227 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
228 tmp_events
[i
].enabled
= event
->enabled
;
229 tmp_events
[i
].loglevel
= event
->loglevel
;
230 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
235 *events
= tmp_events
;
239 assert(nb_event
== i
);
244 * Create a list of ust global domain events.
246 static int list_lttng_ust_global_events(char *channel_name
,
247 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
250 unsigned int nb_event
= 0;
251 struct lttng_ht_iter iter
;
252 struct lttng_ht_node_str
*node
;
253 struct ltt_ust_channel
*uchan
;
254 struct ltt_ust_event
*uevent
;
255 struct lttng_event
*tmp
;
257 DBG("Listing UST global events for channel %s", channel_name
);
261 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
262 node
= lttng_ht_iter_get_node_str(&iter
);
264 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
268 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
270 nb_event
= lttng_ht_get_count(uchan
->events
);
276 DBG3("Listing UST global %d events", nb_event
);
278 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
280 ret
= LTTNG_ERR_FATAL
;
284 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
285 if (uevent
->internal
) {
286 /* This event should remain hidden from clients */
290 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
291 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
292 tmp
[i
].enabled
= uevent
->enabled
;
294 switch (uevent
->attr
.instrumentation
) {
295 case LTTNG_UST_TRACEPOINT
:
296 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
298 case LTTNG_UST_PROBE
:
299 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
301 case LTTNG_UST_FUNCTION
:
302 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
306 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
307 switch (uevent
->attr
.loglevel_type
) {
308 case LTTNG_UST_LOGLEVEL_ALL
:
309 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
311 case LTTNG_UST_LOGLEVEL_RANGE
:
312 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
314 case LTTNG_UST_LOGLEVEL_SINGLE
:
315 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
318 if (uevent
->filter
) {
321 if (uevent
->exclusion
) {
322 tmp
[i
].exclusion
= 1;
336 * Fill lttng_event array of all kernel events in the channel.
338 static int list_lttng_kernel_events(char *channel_name
,
339 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
342 unsigned int nb_event
;
343 struct ltt_kernel_event
*event
;
344 struct ltt_kernel_channel
*kchan
;
346 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
348 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
352 nb_event
= kchan
->event_count
;
354 DBG("Listing events for channel %s", kchan
->channel
->name
);
361 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
362 if (*events
== NULL
) {
363 ret
= LTTNG_ERR_FATAL
;
367 /* Kernel channels */
368 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
369 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
370 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
371 (*events
)[i
].enabled
= event
->enabled
;
373 switch (event
->event
->instrumentation
) {
374 case LTTNG_KERNEL_TRACEPOINT
:
375 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
377 case LTTNG_KERNEL_KRETPROBE
:
378 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
379 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
380 sizeof(struct lttng_kernel_kprobe
));
382 case LTTNG_KERNEL_KPROBE
:
383 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
384 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
385 sizeof(struct lttng_kernel_kprobe
));
387 case LTTNG_KERNEL_FUNCTION
:
388 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
389 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
390 sizeof(struct lttng_kernel_function
));
392 case LTTNG_KERNEL_NOOP
:
393 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
395 case LTTNG_KERNEL_SYSCALL
:
396 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
398 case LTTNG_KERNEL_ALL
:
409 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
421 /* Negate the error code to differentiate the size from an error */
426 * Add URI so the consumer output object. Set the correct path depending on the
427 * domain adding the default trace directory.
429 static int add_uri_to_consumer(struct consumer_output
*consumer
,
430 struct lttng_uri
*uri
, int domain
, const char *session_name
)
433 const char *default_trace_dir
;
437 if (consumer
== NULL
) {
438 DBG("No consumer detected. Don't add URI. Stopping.");
439 ret
= LTTNG_ERR_NO_CONSUMER
;
444 case LTTNG_DOMAIN_KERNEL
:
445 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
447 case LTTNG_DOMAIN_UST
:
448 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
452 * This case is possible is we try to add the URI to the global tracing
453 * session consumer object which in this case there is no subdir.
455 default_trace_dir
= "";
458 switch (uri
->dtype
) {
461 DBG2("Setting network URI to consumer");
463 if (consumer
->type
== CONSUMER_DST_NET
) {
464 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
465 consumer
->dst
.net
.control_isset
) ||
466 (uri
->stype
== LTTNG_STREAM_DATA
&&
467 consumer
->dst
.net
.data_isset
)) {
468 ret
= LTTNG_ERR_URL_EXIST
;
472 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
475 consumer
->type
= CONSUMER_DST_NET
;
477 /* Set URI into consumer output object */
478 ret
= consumer_set_network_uri(consumer
, uri
);
482 } else if (ret
== 1) {
484 * URI was the same in the consumer so we do not append the subdir
485 * again so to not duplicate output dir.
491 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
492 ret
= consumer_set_subdir(consumer
, session_name
);
494 ret
= LTTNG_ERR_FATAL
;
499 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
500 /* On a new subdir, reappend the default trace dir. */
501 strncat(consumer
->subdir
, default_trace_dir
,
502 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
503 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
508 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
509 memset(consumer
->dst
.trace_path
, 0,
510 sizeof(consumer
->dst
.trace_path
));
511 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
512 sizeof(consumer
->dst
.trace_path
));
513 /* Append default trace dir */
514 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
515 sizeof(consumer
->dst
.trace_path
) -
516 strlen(consumer
->dst
.trace_path
) - 1);
517 /* Flag consumer as local. */
518 consumer
->type
= CONSUMER_DST_LOCAL
;
529 * Init tracing by creating trace directory and sending fds kernel consumer.
531 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
534 struct lttng_ht_iter iter
;
535 struct consumer_socket
*socket
;
541 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
542 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
544 pthread_mutex_lock(socket
->lock
);
545 ret
= kernel_consumer_send_session(socket
, session
);
546 pthread_mutex_unlock(socket
->lock
);
548 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
560 * Create a socket to the relayd using the URI.
562 * On success, the relayd_sock pointer is set to the created socket.
563 * Else, it's stays untouched and a lttcomm error code is returned.
565 static int create_connect_relayd(struct lttng_uri
*uri
,
566 struct lttcomm_relayd_sock
**relayd_sock
)
569 struct lttcomm_relayd_sock
*rsock
;
571 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
572 RELAYD_VERSION_COMM_MINOR
);
574 ret
= LTTNG_ERR_FATAL
;
579 * Connect to relayd so we can proceed with a session creation. This call
580 * can possibly block for an arbitrary amount of time to set the health
581 * state to be in poll execution.
584 ret
= relayd_connect(rsock
);
587 ERR("Unable to reach lttng-relayd");
588 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
592 /* Create socket for control stream. */
593 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
594 DBG3("Creating relayd stream socket from URI");
596 /* Check relayd version */
597 ret
= relayd_version_check(rsock
);
599 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
602 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
603 DBG3("Creating relayd data socket from URI");
605 /* Command is not valid */
606 ERR("Relayd invalid stream type: %d", uri
->stype
);
607 ret
= LTTNG_ERR_INVALID
;
611 *relayd_sock
= rsock
;
616 /* The returned value is not useful since we are on an error path. */
617 (void) relayd_close(rsock
);
625 * Connect to the relayd using URI and send the socket to the right consumer.
627 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
628 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
629 struct consumer_socket
*consumer_sock
,
630 char *session_name
, char *hostname
, int session_live_timer
)
633 struct lttcomm_relayd_sock
*rsock
= NULL
;
635 /* Connect to relayd and make version check if uri is the control. */
636 ret
= create_connect_relayd(relayd_uri
, &rsock
);
637 if (ret
!= LTTNG_OK
) {
642 /* Set the network sequence index if not set. */
643 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
644 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
646 * Increment net_seq_idx because we are about to transfer the
647 * new relayd socket to the consumer.
648 * Assign unique key so the consumer can match streams.
650 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
651 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
654 /* Send relayd socket to consumer. */
655 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
656 relayd_uri
->stype
, session_id
,
657 session_name
, hostname
, session_live_timer
);
659 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
663 /* Flag that the corresponding socket was sent. */
664 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
665 consumer_sock
->control_sock_sent
= 1;
666 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
667 consumer_sock
->data_sock_sent
= 1;
673 * Close socket which was dup on the consumer side. The session daemon does
674 * NOT keep track of the relayd socket(s) once transfer to the consumer.
678 (void) relayd_close(rsock
);
682 if (ret
!= LTTNG_OK
) {
684 * The consumer output for this session should not be used anymore
685 * since the relayd connection failed thus making any tracing or/and
686 * streaming not usable.
688 consumer
->enabled
= 0;
694 * Send both relayd sockets to a specific consumer and domain. This is a
695 * helper function to facilitate sending the information to the consumer for a
698 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
699 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
700 char *session_name
, char *hostname
, int session_live_timer
)
707 /* Sending control relayd socket. */
708 if (!sock
->control_sock_sent
) {
709 ret
= send_consumer_relayd_socket(domain
, session_id
,
710 &consumer
->dst
.net
.control
, consumer
, sock
,
711 session_name
, hostname
, session_live_timer
);
712 if (ret
!= LTTNG_OK
) {
717 /* Sending data relayd socket. */
718 if (!sock
->data_sock_sent
) {
719 ret
= send_consumer_relayd_socket(domain
, session_id
,
720 &consumer
->dst
.net
.data
, consumer
, sock
,
721 session_name
, hostname
, session_live_timer
);
722 if (ret
!= LTTNG_OK
) {
732 * Setup relayd connections for a tracing session. First creates the socket to
733 * the relayd and send them to the right domain consumer. Consumer type MUST be
736 int cmd_setup_relayd(struct ltt_session
*session
)
739 struct ltt_ust_session
*usess
;
740 struct ltt_kernel_session
*ksess
;
741 struct consumer_socket
*socket
;
742 struct lttng_ht_iter iter
;
746 usess
= session
->ust_session
;
747 ksess
= session
->kernel_session
;
749 DBG("Setting relayd for session %s", session
->name
);
753 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
754 && usess
->consumer
->enabled
) {
755 /* For each consumer socket, send relayd sockets */
756 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
758 pthread_mutex_lock(socket
->lock
);
759 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
760 usess
->consumer
, socket
,
761 session
->name
, session
->hostname
,
762 session
->live_timer
);
763 pthread_mutex_unlock(socket
->lock
);
764 if (ret
!= LTTNG_OK
) {
767 /* Session is now ready for network streaming. */
768 session
->net_handle
= 1;
772 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
773 && ksess
->consumer
->enabled
) {
774 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
776 pthread_mutex_lock(socket
->lock
);
777 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
778 ksess
->consumer
, socket
,
779 session
->name
, session
->hostname
,
780 session
->live_timer
);
781 pthread_mutex_unlock(socket
->lock
);
782 if (ret
!= LTTNG_OK
) {
785 /* Session is now ready for network streaming. */
786 session
->net_handle
= 1;
796 * Start a kernel session by opening all necessary streams.
798 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
801 struct ltt_kernel_channel
*kchan
;
803 /* Open kernel metadata */
804 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
805 ret
= kernel_open_metadata(ksess
);
807 ret
= LTTNG_ERR_KERN_META_FAIL
;
812 /* Open kernel metadata stream */
813 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
814 ret
= kernel_open_metadata_stream(ksess
);
816 ERR("Kernel create metadata stream failed");
817 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
822 /* For each channel */
823 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
824 if (kchan
->stream_count
== 0) {
825 ret
= kernel_open_channel_stream(kchan
);
827 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
830 /* Update the stream global counter */
831 ksess
->stream_count_global
+= ret
;
835 /* Setup kernel consumer socket and send fds to it */
836 ret
= init_kernel_tracing(ksess
);
838 ret
= LTTNG_ERR_KERN_START_FAIL
;
842 /* This start the kernel tracing */
843 ret
= kernel_start_session(ksess
);
845 ret
= LTTNG_ERR_KERN_START_FAIL
;
849 /* Quiescent wait after starting trace */
850 kernel_wait_quiescent(kernel_tracer_fd
);
861 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
863 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
867 struct ltt_ust_session
*usess
;
869 usess
= session
->ust_session
;
874 case LTTNG_DOMAIN_KERNEL
:
876 ret
= channel_kernel_disable(session
->kernel_session
,
878 if (ret
!= LTTNG_OK
) {
882 kernel_wait_quiescent(kernel_tracer_fd
);
885 case LTTNG_DOMAIN_UST
:
887 struct ltt_ust_channel
*uchan
;
888 struct lttng_ht
*chan_ht
;
890 chan_ht
= usess
->domain_global
.channels
;
892 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
894 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
898 ret
= channel_ust_disable(usess
, uchan
);
899 if (ret
!= LTTNG_OK
) {
905 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
917 * Command LTTNG_TRACK_PID processed by the client thread.
919 * Called with session lock held.
921 int cmd_track_pid(struct ltt_session
*session
, int domain
, int pid
)
928 case LTTNG_DOMAIN_KERNEL
:
930 struct ltt_kernel_session
*ksess
;
932 ksess
= session
->kernel_session
;
934 ret
= kernel_track_pid(ksess
, pid
);
935 if (ret
!= LTTNG_OK
) {
939 kernel_wait_quiescent(kernel_tracer_fd
);
942 case LTTNG_DOMAIN_UST
:
944 struct ltt_ust_session
*usess
;
946 usess
= session
->ust_session
;
948 ret
= trace_ust_track_pid(usess
, pid
);
949 if (ret
!= LTTNG_OK
) {
955 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
967 * Command LTTNG_UNTRACK_PID processed by the client thread.
969 * Called with session lock held.
971 int cmd_untrack_pid(struct ltt_session
*session
, int domain
, int pid
)
978 case LTTNG_DOMAIN_KERNEL
:
980 struct ltt_kernel_session
*ksess
;
982 ksess
= session
->kernel_session
;
984 ret
= kernel_untrack_pid(ksess
, pid
);
985 if (ret
!= LTTNG_OK
) {
989 kernel_wait_quiescent(kernel_tracer_fd
);
992 case LTTNG_DOMAIN_UST
:
994 struct ltt_ust_session
*usess
;
996 usess
= session
->ust_session
;
998 ret
= trace_ust_untrack_pid(usess
, pid
);
999 if (ret
!= LTTNG_OK
) {
1005 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1017 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1019 * The wpipe arguments is used as a notifier for the kernel thread.
1021 int cmd_enable_channel(struct ltt_session
*session
,
1022 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1025 struct ltt_ust_session
*usess
= session
->ust_session
;
1026 struct lttng_ht
*chan_ht
;
1033 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1035 /* Validate channel name */
1036 if (attr
->name
[0] == '.' ||
1037 memchr(attr
->name
, '/', len
) != NULL
) {
1038 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1042 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1047 * Don't try to enable a channel if the session has been started at
1048 * some point in time before. The tracer does not allow it.
1050 if (session
->has_been_started
) {
1051 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1056 * If the session is a live session, remove the switch timer, the
1057 * live timer does the same thing but sends also synchronisation
1058 * beacons for inactive streams.
1060 if (session
->live_timer
> 0) {
1061 attr
->attr
.live_timer_interval
= session
->live_timer
;
1062 attr
->attr
.switch_timer_interval
= 0;
1066 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1067 * mode and with less than 2 subbuf so block it right away and send back an
1068 * invalid attribute error.
1070 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1071 ret
= LTTNG_ERR_INVALID
;
1075 switch (domain
->type
) {
1076 case LTTNG_DOMAIN_KERNEL
:
1078 struct ltt_kernel_channel
*kchan
;
1080 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1081 session
->kernel_session
);
1082 if (kchan
== NULL
) {
1083 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1084 if (attr
->name
[0] != '\0') {
1085 session
->kernel_session
->has_non_default_channel
= 1;
1088 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1091 if (ret
!= LTTNG_OK
) {
1095 kernel_wait_quiescent(kernel_tracer_fd
);
1098 case LTTNG_DOMAIN_UST
:
1100 struct ltt_ust_channel
*uchan
;
1102 chan_ht
= usess
->domain_global
.channels
;
1104 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1105 if (uchan
== NULL
) {
1106 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1107 if (attr
->name
[0] != '\0') {
1108 usess
->has_non_default_channel
= 1;
1111 ret
= channel_ust_enable(usess
, uchan
);
1116 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1127 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1129 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1131 struct lttng_event
*event
)
1136 DBG("Disable event command for event \'%s\'", event
->name
);
1138 event_name
= event
->name
;
1140 /* Error out on unhandled search criteria */
1141 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1142 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1143 return LTTNG_ERR_UNK
;
1149 case LTTNG_DOMAIN_KERNEL
:
1151 struct ltt_kernel_channel
*kchan
;
1152 struct ltt_kernel_session
*ksess
;
1154 ksess
= session
->kernel_session
;
1157 * If a non-default channel has been created in the
1158 * session, explicitely require that -c chan_name needs
1161 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1162 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1166 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1167 if (kchan
== NULL
) {
1168 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1172 switch (event
->type
) {
1173 case LTTNG_EVENT_ALL
:
1174 ret
= event_kernel_disable_event_all(kchan
);
1175 if (ret
!= LTTNG_OK
) {
1179 case LTTNG_EVENT_TRACEPOINT
: /* fall-through */
1180 case LTTNG_EVENT_SYSCALL
:
1181 if (!strcmp(event_name
, "*")) {
1182 ret
= event_kernel_disable_event_type(kchan
,
1185 ret
= event_kernel_disable_event(kchan
,
1188 if (ret
!= LTTNG_OK
) {
1192 case LTTNG_EVENT_PROBE
:
1193 case LTTNG_EVENT_FUNCTION
:
1194 case LTTNG_EVENT_FUNCTION_ENTRY
:
1195 ret
= event_kernel_disable_event(kchan
, event_name
);
1196 if (ret
!= LTTNG_OK
) {
1201 ret
= LTTNG_ERR_UNK
;
1205 kernel_wait_quiescent(kernel_tracer_fd
);
1208 case LTTNG_DOMAIN_UST
:
1210 struct ltt_ust_channel
*uchan
;
1211 struct ltt_ust_session
*usess
;
1213 usess
= session
->ust_session
;
1216 * If a non-default channel has been created in the
1217 * session, explicitely require that -c chan_name needs
1220 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1221 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1225 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1227 if (uchan
== NULL
) {
1228 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1232 switch (event
->type
) {
1233 case LTTNG_EVENT_ALL
:
1234 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1235 if (ret
!= LTTNG_OK
) {
1240 ret
= LTTNG_ERR_UNK
;
1244 DBG3("Disable UST event %s in channel %s completed", event_name
,
1248 case LTTNG_DOMAIN_LOG4J
:
1249 case LTTNG_DOMAIN_JUL
:
1250 case LTTNG_DOMAIN_PYTHON
:
1253 struct ltt_ust_session
*usess
= session
->ust_session
;
1257 switch (event
->type
) {
1258 case LTTNG_EVENT_ALL
:
1261 ret
= LTTNG_ERR_UNK
;
1265 agt
= trace_ust_find_agent(usess
, domain
);
1267 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1270 /* The wild card * means that everything should be disabled. */
1271 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1272 ret
= event_agent_disable_all(usess
, agt
);
1274 ret
= event_agent_disable(usess
, agt
, event_name
);
1276 if (ret
!= LTTNG_OK
) {
1283 ret
= LTTNG_ERR_UND
;
1295 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1297 int cmd_add_context(struct ltt_session
*session
, int domain
,
1298 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1300 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1303 case LTTNG_DOMAIN_KERNEL
:
1304 assert(session
->kernel_session
);
1306 if (session
->kernel_session
->channel_count
== 0) {
1307 /* Create default channel */
1308 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1309 if (ret
!= LTTNG_OK
) {
1312 chan_kern_created
= 1;
1314 /* Add kernel context to kernel tracer */
1315 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1316 if (ret
!= LTTNG_OK
) {
1320 case LTTNG_DOMAIN_UST
:
1322 struct ltt_ust_session
*usess
= session
->ust_session
;
1323 unsigned int chan_count
;
1327 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1328 if (chan_count
== 0) {
1329 struct lttng_channel
*attr
;
1330 /* Create default channel */
1331 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1333 ret
= LTTNG_ERR_FATAL
;
1337 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1338 if (ret
!= LTTNG_OK
) {
1343 chan_ust_created
= 1;
1346 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1347 if (ret
!= LTTNG_OK
) {
1353 ret
= LTTNG_ERR_UND
;
1360 if (chan_kern_created
) {
1361 struct ltt_kernel_channel
*kchan
=
1362 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1363 session
->kernel_session
);
1364 /* Created previously, this should NOT fail. */
1366 kernel_destroy_channel(kchan
);
1369 if (chan_ust_created
) {
1370 struct ltt_ust_channel
*uchan
=
1371 trace_ust_find_channel_by_name(
1372 session
->ust_session
->domain_global
.channels
,
1373 DEFAULT_CHANNEL_NAME
);
1374 /* Created previously, this should NOT fail. */
1376 /* Remove from the channel list of the session. */
1377 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1379 trace_ust_destroy_channel(uchan
);
1384 static int validate_event_name(const char *name
)
1387 const char *c
= name
;
1388 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1391 * Make sure that unescaped wildcards are only used as the last
1392 * character of the event name.
1394 while (c
< event_name_end
) {
1402 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1403 /* Wildcard is not the last character */
1404 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1416 static inline bool name_starts_with(const char *name
, const char *prefix
)
1418 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1420 return !strncmp(name
, prefix
, max_cmp_len
);
1423 /* Perform userspace-specific event name validation */
1424 static int validate_ust_event_name(const char *name
)
1434 * Check name against all internal UST event component namespaces used
1437 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1438 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1439 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1447 static int cmd_enable_event_internal(struct ltt_session
*session
,
1448 struct lttng_domain
*domain
,
1449 char *channel_name
, struct lttng_event
*event
,
1450 char *filter_expression
,
1451 struct lttng_filter_bytecode
*filter
,
1452 struct lttng_event_exclusion
*exclusion
,
1456 * Internal version of cmd_enable_event() with a supplemental
1457 * "internal_event" flag which is used to enable internal events which should
1458 * be hidden from clients. Such events are used in the agent implementation to
1459 * enable the events through which all "agent" events are funeled.
1461 static int _cmd_enable_event(struct ltt_session
*session
,
1462 struct lttng_domain
*domain
,
1463 char *channel_name
, struct lttng_event
*event
,
1464 char *filter_expression
,
1465 struct lttng_filter_bytecode
*filter
,
1466 struct lttng_event_exclusion
*exclusion
,
1467 int wpipe
, bool internal_event
)
1469 int ret
, channel_created
= 0;
1470 struct lttng_channel
*attr
;
1474 assert(channel_name
);
1476 DBG("Enable event command for event \'%s\'", event
->name
);
1478 ret
= validate_event_name(event
->name
);
1485 switch (domain
->type
) {
1486 case LTTNG_DOMAIN_KERNEL
:
1488 struct ltt_kernel_channel
*kchan
;
1491 * If a non-default channel has been created in the
1492 * session, explicitely require that -c chan_name needs
1495 if (session
->kernel_session
->has_non_default_channel
1496 && channel_name
[0] == '\0') {
1497 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1501 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1502 session
->kernel_session
);
1503 if (kchan
== NULL
) {
1504 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1505 LTTNG_BUFFER_GLOBAL
);
1507 ret
= LTTNG_ERR_FATAL
;
1510 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1512 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1513 if (ret
!= LTTNG_OK
) {
1519 channel_created
= 1;
1522 /* Get the newly created kernel channel pointer */
1523 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1524 session
->kernel_session
);
1525 if (kchan
== NULL
) {
1526 /* This sould not happen... */
1527 ret
= LTTNG_ERR_FATAL
;
1531 switch (event
->type
) {
1532 case LTTNG_EVENT_ALL
:
1534 char *filter_expression_a
= NULL
;
1535 struct lttng_filter_bytecode
*filter_a
= NULL
;
1538 * We need to duplicate filter_expression and filter,
1539 * because ownership is passed to first enable
1542 if (filter_expression
) {
1543 filter_expression_a
= strdup(filter_expression
);
1544 if (!filter_expression_a
) {
1545 ret
= LTTNG_ERR_FATAL
;
1550 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1552 free(filter_expression_a
);
1553 ret
= LTTNG_ERR_FATAL
;
1556 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1558 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1559 ret
= event_kernel_enable_event(kchan
, event
,
1560 filter_expression
, filter
);
1561 /* We have passed ownership */
1562 filter_expression
= NULL
;
1564 if (ret
!= LTTNG_OK
) {
1565 if (channel_created
) {
1566 /* Let's not leak a useless channel. */
1567 kernel_destroy_channel(kchan
);
1569 free(filter_expression_a
);
1573 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1574 ret
= event_kernel_enable_event(kchan
, event
,
1575 filter_expression_a
, filter_a
);
1576 if (ret
!= LTTNG_OK
) {
1577 free(filter_expression_a
);
1583 case LTTNG_EVENT_PROBE
:
1584 case LTTNG_EVENT_FUNCTION
:
1585 case LTTNG_EVENT_FUNCTION_ENTRY
:
1586 case LTTNG_EVENT_TRACEPOINT
:
1587 ret
= event_kernel_enable_event(kchan
, event
,
1588 filter_expression
, filter
);
1589 /* We have passed ownership */
1590 filter_expression
= NULL
;
1592 if (ret
!= LTTNG_OK
) {
1593 if (channel_created
) {
1594 /* Let's not leak a useless channel. */
1595 kernel_destroy_channel(kchan
);
1600 case LTTNG_EVENT_SYSCALL
:
1601 ret
= event_kernel_enable_event(kchan
, event
,
1602 filter_expression
, filter
);
1603 /* We have passed ownership */
1604 filter_expression
= NULL
;
1606 if (ret
!= LTTNG_OK
) {
1611 ret
= LTTNG_ERR_UNK
;
1615 kernel_wait_quiescent(kernel_tracer_fd
);
1618 case LTTNG_DOMAIN_UST
:
1620 struct ltt_ust_channel
*uchan
;
1621 struct ltt_ust_session
*usess
= session
->ust_session
;
1626 * If a non-default channel has been created in the
1627 * session, explicitely require that -c chan_name needs
1630 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1631 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1635 /* Get channel from global UST domain */
1636 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1638 if (uchan
== NULL
) {
1639 /* Create default channel */
1640 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1641 usess
->buffer_type
);
1643 ret
= LTTNG_ERR_FATAL
;
1646 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1648 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1649 if (ret
!= LTTNG_OK
) {
1655 /* Get the newly created channel reference back */
1656 uchan
= trace_ust_find_channel_by_name(
1657 usess
->domain_global
.channels
, channel_name
);
1661 if (!internal_event
) {
1663 * Ensure the event name is not reserved for internal
1666 ret
= validate_ust_event_name(event
->name
);
1668 WARN("Userspace event name %s failed validation.",
1670 event
->name
: "NULL");
1671 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1676 /* At this point, the session and channel exist on the tracer */
1677 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1678 filter_expression
, filter
, exclusion
,
1680 /* We have passed ownership */
1681 filter_expression
= NULL
;
1684 if (ret
!= LTTNG_OK
) {
1689 case LTTNG_DOMAIN_LOG4J
:
1690 case LTTNG_DOMAIN_JUL
:
1691 case LTTNG_DOMAIN_PYTHON
:
1693 const char *default_event_name
, *default_chan_name
;
1695 struct lttng_event uevent
;
1696 struct lttng_domain tmp_dom
;
1697 struct ltt_ust_session
*usess
= session
->ust_session
;
1701 agt
= trace_ust_find_agent(usess
, domain
->type
);
1703 agt
= agent_create(domain
->type
);
1705 ret
= -LTTNG_ERR_NOMEM
;
1708 agent_add(agt
, usess
->agents
);
1711 /* Create the default tracepoint. */
1712 memset(&uevent
, 0, sizeof(uevent
));
1713 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1714 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1715 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1716 if (!default_event_name
) {
1717 ret
= -LTTNG_ERR_FATAL
;
1720 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1721 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1724 * The domain type is changed because we are about to enable the
1725 * default channel and event for the JUL domain that are hardcoded.
1726 * This happens in the UST domain.
1728 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1729 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1731 switch (domain
->type
) {
1732 case LTTNG_DOMAIN_LOG4J
:
1733 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1735 case LTTNG_DOMAIN_JUL
:
1736 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1738 case LTTNG_DOMAIN_PYTHON
:
1739 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1742 /* The switch/case we are in should avoid this else big problem */
1747 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1750 filter_copy
= zmalloc(
1751 sizeof(struct lttng_filter_bytecode
)
1757 memcpy(filter_copy
, filter
,
1758 sizeof(struct lttng_filter_bytecode
)
1762 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1763 (char *) default_chan_name
,
1764 &uevent
, filter_expression
, filter_copy
,
1766 /* We have passed ownership */
1767 filter_expression
= NULL
;
1770 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1774 /* The wild card * means that everything should be enabled. */
1775 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1776 ret
= event_agent_enable_all(usess
, agt
, event
, filter
);
1779 ret
= event_agent_enable(usess
, agt
, event
, filter
);
1782 if (ret
!= LTTNG_OK
) {
1789 ret
= LTTNG_ERR_UND
;
1796 free(filter_expression
);
1804 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1805 * We own filter, exclusion, and filter_expression.
1807 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1808 char *channel_name
, struct lttng_event
*event
,
1809 char *filter_expression
,
1810 struct lttng_filter_bytecode
*filter
,
1811 struct lttng_event_exclusion
*exclusion
,
1814 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1815 filter_expression
, filter
, exclusion
, wpipe
, false);
1819 * Enable an event which is internal to LTTng. An internal should
1820 * never be made visible to clients and are immune to checks such as
1823 static int cmd_enable_event_internal(struct ltt_session
*session
,
1824 struct lttng_domain
*domain
,
1825 char *channel_name
, struct lttng_event
*event
,
1826 char *filter_expression
,
1827 struct lttng_filter_bytecode
*filter
,
1828 struct lttng_event_exclusion
*exclusion
,
1831 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1832 filter_expression
, filter
, exclusion
, wpipe
, true);
1836 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1838 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1841 ssize_t nb_events
= 0;
1844 case LTTNG_DOMAIN_KERNEL
:
1845 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1846 if (nb_events
< 0) {
1847 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1851 case LTTNG_DOMAIN_UST
:
1852 nb_events
= ust_app_list_events(events
);
1853 if (nb_events
< 0) {
1854 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1858 case LTTNG_DOMAIN_LOG4J
:
1859 case LTTNG_DOMAIN_JUL
:
1860 case LTTNG_DOMAIN_PYTHON
:
1861 nb_events
= agent_list_events(events
, domain
);
1862 if (nb_events
< 0) {
1863 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1868 ret
= LTTNG_ERR_UND
;
1875 /* Return negative value to differentiate return code */
1880 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1882 ssize_t
cmd_list_tracepoint_fields(int domain
,
1883 struct lttng_event_field
**fields
)
1886 ssize_t nb_fields
= 0;
1889 case LTTNG_DOMAIN_UST
:
1890 nb_fields
= ust_app_list_event_fields(fields
);
1891 if (nb_fields
< 0) {
1892 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1896 case LTTNG_DOMAIN_KERNEL
:
1897 default: /* fall-through */
1898 ret
= LTTNG_ERR_UND
;
1905 /* Return negative value to differentiate return code */
1909 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1911 return syscall_table_list(events
);
1915 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1917 * Called with session lock held.
1919 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1920 int domain
, int32_t **pids
)
1923 ssize_t nr_pids
= 0;
1926 case LTTNG_DOMAIN_KERNEL
:
1928 struct ltt_kernel_session
*ksess
;
1930 ksess
= session
->kernel_session
;
1931 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1933 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1938 case LTTNG_DOMAIN_UST
:
1940 struct ltt_ust_session
*usess
;
1942 usess
= session
->ust_session
;
1943 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
1945 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1950 case LTTNG_DOMAIN_LOG4J
:
1951 case LTTNG_DOMAIN_JUL
:
1952 case LTTNG_DOMAIN_PYTHON
:
1954 ret
= LTTNG_ERR_UND
;
1961 /* Return negative value to differentiate return code */
1966 * Command LTTNG_START_TRACE processed by the client thread.
1968 * Called with session mutex held.
1970 int cmd_start_trace(struct ltt_session
*session
)
1973 unsigned long nb_chan
= 0;
1974 struct ltt_kernel_session
*ksession
;
1975 struct ltt_ust_session
*usess
;
1979 /* Ease our life a bit ;) */
1980 ksession
= session
->kernel_session
;
1981 usess
= session
->ust_session
;
1983 /* Is the session already started? */
1984 if (session
->active
) {
1985 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1990 * Starting a session without channel is useless since after that it's not
1991 * possible to enable channel thus inform the client.
1993 if (usess
&& usess
->domain_global
.channels
) {
1995 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
1999 nb_chan
+= ksession
->channel_count
;
2002 ret
= LTTNG_ERR_NO_CHANNEL
;
2006 /* Kernel tracing */
2007 if (ksession
!= NULL
) {
2008 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2009 if (ret
!= LTTNG_OK
) {
2014 /* Flag session that trace should start automatically */
2017 * Even though the start trace might fail, flag this session active so
2018 * other application coming in are started by default.
2022 ret
= ust_app_start_trace_all(usess
);
2024 ret
= LTTNG_ERR_UST_START_FAIL
;
2029 /* Flag this after a successful start. */
2030 session
->has_been_started
= 1;
2031 session
->active
= 1;
2040 * Command LTTNG_STOP_TRACE processed by the client thread.
2042 int cmd_stop_trace(struct ltt_session
*session
)
2045 struct ltt_kernel_channel
*kchan
;
2046 struct ltt_kernel_session
*ksession
;
2047 struct ltt_ust_session
*usess
;
2052 ksession
= session
->kernel_session
;
2053 usess
= session
->ust_session
;
2055 /* Session is not active. Skip everythong and inform the client. */
2056 if (!session
->active
) {
2057 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2062 if (ksession
&& ksession
->active
) {
2063 DBG("Stop kernel tracing");
2065 /* Flush metadata if exist */
2066 if (ksession
->metadata_stream_fd
>= 0) {
2067 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2069 ERR("Kernel metadata flush failed");
2073 /* Flush all buffers before stopping */
2074 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2075 ret
= kernel_flush_buffer(kchan
);
2077 ERR("Kernel flush buffer error");
2081 ret
= kernel_stop_session(ksession
);
2083 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2087 kernel_wait_quiescent(kernel_tracer_fd
);
2089 ksession
->active
= 0;
2092 if (usess
&& usess
->active
) {
2094 * Even though the stop trace might fail, flag this session inactive so
2095 * other application coming in are not started by default.
2099 ret
= ust_app_stop_trace_all(usess
);
2101 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2106 /* Flag inactive after a successful stop. */
2107 session
->active
= 0;
2115 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2117 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2118 struct lttng_uri
*uris
)
2121 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2122 struct ltt_ust_session
*usess
= session
->ust_session
;
2128 /* Can't set consumer URI if the session is active. */
2129 if (session
->active
) {
2130 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2134 /* Set the "global" consumer URIs */
2135 for (i
= 0; i
< nb_uri
; i
++) {
2136 ret
= add_uri_to_consumer(session
->consumer
,
2137 &uris
[i
], 0, session
->name
);
2138 if (ret
!= LTTNG_OK
) {
2143 /* Set UST session URIs */
2144 if (session
->ust_session
) {
2145 for (i
= 0; i
< nb_uri
; i
++) {
2146 ret
= add_uri_to_consumer(
2147 session
->ust_session
->consumer
,
2148 &uris
[i
], LTTNG_DOMAIN_UST
,
2150 if (ret
!= LTTNG_OK
) {
2156 /* Set kernel session URIs */
2157 if (session
->kernel_session
) {
2158 for (i
= 0; i
< nb_uri
; i
++) {
2159 ret
= add_uri_to_consumer(
2160 session
->kernel_session
->consumer
,
2161 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2163 if (ret
!= LTTNG_OK
) {
2170 * Make sure to set the session in output mode after we set URI since a
2171 * session can be created without URL (thus flagged in no output mode).
2173 session
->output_traces
= 1;
2175 ksess
->output_traces
= 1;
2179 usess
->output_traces
= 1;
2190 * Command LTTNG_CREATE_SESSION processed by the client thread.
2192 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2193 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2196 struct ltt_session
*session
;
2202 * Verify if the session already exist
2204 * XXX: There is no need for the session lock list here since the caller
2205 * (process_client_msg) is holding it. We might want to change that so a
2206 * single command does not lock the entire session list.
2208 session
= session_find_by_name(name
);
2209 if (session
!= NULL
) {
2210 ret
= LTTNG_ERR_EXIST_SESS
;
2214 /* Create tracing session in the registry */
2215 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2216 LTTNG_SOCK_GET_GID_CRED(creds
));
2217 if (ret
!= LTTNG_OK
) {
2222 * Get the newly created session pointer back
2224 * XXX: There is no need for the session lock list here since the caller
2225 * (process_client_msg) is holding it. We might want to change that so a
2226 * single command does not lock the entire session list.
2228 session
= session_find_by_name(name
);
2231 session
->live_timer
= live_timer
;
2232 /* Create default consumer output for the session not yet created. */
2233 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2234 if (session
->consumer
== NULL
) {
2235 ret
= LTTNG_ERR_FATAL
;
2236 goto consumer_error
;
2240 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2241 if (ret
!= LTTNG_OK
) {
2242 goto consumer_error
;
2244 session
->output_traces
= 1;
2246 session
->output_traces
= 0;
2247 DBG2("Session %s created with no output", session
->name
);
2250 session
->consumer
->enabled
= 1;
2255 session_destroy(session
);
2262 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2264 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2265 size_t nb_uri
, lttng_sock_cred
*creds
)
2268 struct ltt_session
*session
;
2269 struct snapshot_output
*new_output
= NULL
;
2275 * Create session in no output mode with URIs set to NULL. The uris we've
2276 * received are for a default snapshot output if one.
2278 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2279 if (ret
!= LTTNG_OK
) {
2283 /* Get the newly created session pointer back. This should NEVER fail. */
2284 session
= session_find_by_name(name
);
2287 /* Flag session for snapshot mode. */
2288 session
->snapshot_mode
= 1;
2290 /* Skip snapshot output creation if no URI is given. */
2295 new_output
= snapshot_output_alloc();
2297 ret
= LTTNG_ERR_NOMEM
;
2298 goto error_snapshot_alloc
;
2301 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2302 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2304 if (ret
== -ENOMEM
) {
2305 ret
= LTTNG_ERR_NOMEM
;
2307 ret
= LTTNG_ERR_INVALID
;
2309 goto error_snapshot
;
2313 snapshot_add_output(&session
->snapshot
, new_output
);
2320 snapshot_output_destroy(new_output
);
2321 error_snapshot_alloc
:
2322 session_destroy(session
);
2328 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2330 * Called with session lock held.
2332 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2335 struct ltt_ust_session
*usess
;
2336 struct ltt_kernel_session
*ksess
;
2341 usess
= session
->ust_session
;
2342 ksess
= session
->kernel_session
;
2344 /* Clean kernel session teardown */
2345 kernel_destroy_session(ksess
);
2347 /* UST session teardown */
2349 /* Close any relayd session */
2350 consumer_output_send_destroy_relayd(usess
->consumer
);
2352 /* Destroy every UST application related to this session. */
2353 ret
= ust_app_destroy_trace_all(usess
);
2355 ERR("Error in ust_app_destroy_trace_all");
2358 /* Clean up the rest. */
2359 trace_ust_destroy_session(usess
);
2363 * Must notify the kernel thread here to update it's poll set in order to
2364 * remove the channel(s)' fd just destroyed.
2366 ret
= notify_thread_pipe(wpipe
);
2368 PERROR("write kernel poll pipe");
2371 ret
= session_destroy(session
);
2377 * Command LTTNG_CALIBRATE processed by the client thread.
2379 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2384 case LTTNG_DOMAIN_KERNEL
:
2386 struct lttng_kernel_calibrate kcalibrate
;
2388 switch (calibrate
->type
) {
2389 case LTTNG_CALIBRATE_FUNCTION
:
2391 /* Default and only possible calibrate option. */
2392 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2396 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2398 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2403 case LTTNG_DOMAIN_UST
:
2405 struct lttng_ust_calibrate ucalibrate
;
2407 switch (calibrate
->type
) {
2408 case LTTNG_CALIBRATE_FUNCTION
:
2410 /* Default and only possible calibrate option. */
2411 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2415 ret
= ust_app_calibrate_glb(&ucalibrate
);
2417 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2423 ret
= LTTNG_ERR_UND
;
2434 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2436 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2437 const char *sock_path
, struct consumer_data
*cdata
)
2440 struct consumer_socket
*socket
= NULL
;
2447 case LTTNG_DOMAIN_KERNEL
:
2449 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2453 /* Can't register a consumer if there is already one */
2454 if (ksess
->consumer_fds_sent
!= 0) {
2455 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2459 sock
= lttcomm_connect_unix_sock(sock_path
);
2461 ret
= LTTNG_ERR_CONNECT_FAIL
;
2464 cdata
->cmd_sock
= sock
;
2466 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2467 if (socket
== NULL
) {
2470 PERROR("close register consumer");
2472 cdata
->cmd_sock
= -1;
2473 ret
= LTTNG_ERR_FATAL
;
2477 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2478 if (socket
->lock
== NULL
) {
2479 PERROR("zmalloc pthread mutex");
2480 ret
= LTTNG_ERR_FATAL
;
2483 pthread_mutex_init(socket
->lock
, NULL
);
2484 socket
->registered
= 1;
2487 consumer_add_socket(socket
, ksess
->consumer
);
2490 pthread_mutex_lock(&cdata
->pid_mutex
);
2492 pthread_mutex_unlock(&cdata
->pid_mutex
);
2497 /* TODO: Userspace tracing */
2498 ret
= LTTNG_ERR_UND
;
2506 consumer_destroy_socket(socket
);
2512 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2514 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2515 struct lttng_domain
**domains
)
2520 struct lttng_ht_iter iter
;
2522 if (session
->kernel_session
!= NULL
) {
2523 DBG3("Listing domains found kernel domain");
2527 if (session
->ust_session
!= NULL
) {
2528 DBG3("Listing domains found UST global domain");
2532 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2534 if (agt
->being_used
) {
2545 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2546 if (*domains
== NULL
) {
2547 ret
= LTTNG_ERR_FATAL
;
2551 if (session
->kernel_session
!= NULL
) {
2552 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2554 /* Kernel session buffer type is always GLOBAL */
2555 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2560 if (session
->ust_session
!= NULL
) {
2561 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2562 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2566 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2568 if (agt
->being_used
) {
2569 (*domains
)[index
].type
= agt
->domain
;
2570 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2580 /* Return negative value to differentiate return code */
2586 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2588 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2589 struct lttng_channel
**channels
)
2592 ssize_t nb_chan
= 0;
2595 case LTTNG_DOMAIN_KERNEL
:
2596 if (session
->kernel_session
!= NULL
) {
2597 nb_chan
= session
->kernel_session
->channel_count
;
2599 DBG3("Number of kernel channels %zd", nb_chan
);
2601 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2604 case LTTNG_DOMAIN_UST
:
2605 if (session
->ust_session
!= NULL
) {
2607 nb_chan
= lttng_ht_get_count(
2608 session
->ust_session
->domain_global
.channels
);
2611 DBG3("Number of UST global channels %zd", nb_chan
);
2613 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2618 ret
= LTTNG_ERR_UND
;
2623 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2624 if (*channels
== NULL
) {
2625 ret
= LTTNG_ERR_FATAL
;
2629 list_lttng_channels(domain
, session
, *channels
);
2635 /* Return negative value to differentiate return code */
2640 * Command LTTNG_LIST_EVENTS processed by the client thread.
2642 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2643 char *channel_name
, struct lttng_event
**events
)
2646 ssize_t nb_event
= 0;
2649 case LTTNG_DOMAIN_KERNEL
:
2650 if (session
->kernel_session
!= NULL
) {
2651 nb_event
= list_lttng_kernel_events(channel_name
,
2652 session
->kernel_session
, events
);
2655 case LTTNG_DOMAIN_UST
:
2657 if (session
->ust_session
!= NULL
) {
2658 nb_event
= list_lttng_ust_global_events(channel_name
,
2659 &session
->ust_session
->domain_global
, events
);
2663 case LTTNG_DOMAIN_LOG4J
:
2664 case LTTNG_DOMAIN_JUL
:
2665 case LTTNG_DOMAIN_PYTHON
:
2666 if (session
->ust_session
) {
2667 struct lttng_ht_iter iter
;
2671 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2672 &iter
.iter
, agt
, node
.node
) {
2673 nb_event
= list_lttng_agent_events(agt
, events
);
2679 ret
= LTTNG_ERR_UND
;
2686 /* Return negative value to differentiate return code */
2691 * Using the session list, filled a lttng_session array to send back to the
2692 * client for session listing.
2694 * The session list lock MUST be acquired before calling this function. Use
2695 * session_lock_list() and session_unlock_list().
2697 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2702 struct ltt_session
*session
;
2703 struct ltt_session_list
*list
= session_get_list();
2705 DBG("Getting all available session for UID %d GID %d",
2708 * Iterate over session list and append data after the control struct in
2711 cds_list_for_each_entry(session
, &list
->head
, list
) {
2713 * Only list the sessions the user can control.
2715 if (!session_access_ok(session
, uid
, gid
)) {
2719 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2720 struct ltt_ust_session
*usess
= session
->ust_session
;
2722 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2723 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2724 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2725 ret
= build_network_session_path(sessions
[i
].path
,
2726 sizeof(sessions
[i
].path
), session
);
2728 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2729 session
->consumer
->dst
.trace_path
);
2732 PERROR("snprintf session path");
2736 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2737 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2738 sessions
[i
].enabled
= session
->active
;
2739 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2740 sessions
[i
].live_timer_interval
= session
->live_timer
;
2746 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2747 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2749 int cmd_data_pending(struct ltt_session
*session
)
2752 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2753 struct ltt_ust_session
*usess
= session
->ust_session
;
2757 /* Session MUST be stopped to ask for data availability. */
2758 if (session
->active
) {
2759 ret
= LTTNG_ERR_SESSION_STARTED
;
2763 * If stopped, just make sure we've started before else the above call
2764 * will always send that there is data pending.
2766 * The consumer assumes that when the data pending command is received,
2767 * the trace has been started before or else no output data is written
2768 * by the streams which is a condition for data pending. So, this is
2769 * *VERY* important that we don't ask the consumer before a start
2772 if (!session
->has_been_started
) {
2778 if (ksess
&& ksess
->consumer
) {
2779 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2781 /* Data is still being extracted for the kernel. */
2786 if (usess
&& usess
->consumer
) {
2787 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2789 /* Data is still being extracted for the kernel. */
2794 /* Data is ready to be read by a viewer */
2802 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2804 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2806 int cmd_snapshot_add_output(struct ltt_session
*session
,
2807 struct lttng_snapshot_output
*output
, uint32_t *id
)
2810 struct snapshot_output
*new_output
;
2815 DBG("Cmd snapshot add output for session %s", session
->name
);
2818 * Permission denied to create an output if the session is not
2819 * set in no output mode.
2821 if (session
->output_traces
) {
2822 ret
= LTTNG_ERR_EPERM
;
2826 /* Only one output is allowed until we have the "tee" feature. */
2827 if (session
->snapshot
.nb_output
== 1) {
2828 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2832 new_output
= snapshot_output_alloc();
2834 ret
= LTTNG_ERR_NOMEM
;
2838 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2839 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2840 &session
->snapshot
);
2842 if (ret
== -ENOMEM
) {
2843 ret
= LTTNG_ERR_NOMEM
;
2845 ret
= LTTNG_ERR_INVALID
;
2851 snapshot_add_output(&session
->snapshot
, new_output
);
2853 *id
= new_output
->id
;
2860 snapshot_output_destroy(new_output
);
2866 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2868 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2870 int cmd_snapshot_del_output(struct ltt_session
*session
,
2871 struct lttng_snapshot_output
*output
)
2874 struct snapshot_output
*sout
= NULL
;
2882 * Permission denied to create an output if the session is not
2883 * set in no output mode.
2885 if (session
->output_traces
) {
2886 ret
= LTTNG_ERR_EPERM
;
2891 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2893 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2894 } else if (*output
->name
!= '\0') {
2895 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2897 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2900 ret
= LTTNG_ERR_INVALID
;
2904 snapshot_delete_output(&session
->snapshot
, sout
);
2905 snapshot_output_destroy(sout
);
2914 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2916 * If no output is available, outputs is untouched and 0 is returned.
2918 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2920 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2921 struct lttng_snapshot_output
**outputs
)
2924 struct lttng_snapshot_output
*list
= NULL
;
2925 struct lttng_ht_iter iter
;
2926 struct snapshot_output
*output
;
2931 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2934 * Permission denied to create an output if the session is not
2935 * set in no output mode.
2937 if (session
->output_traces
) {
2938 ret
= -LTTNG_ERR_EPERM
;
2942 if (session
->snapshot
.nb_output
== 0) {
2947 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2949 ret
= -LTTNG_ERR_NOMEM
;
2953 /* Copy list from session to the new list object. */
2955 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2956 output
, node
.node
) {
2957 assert(output
->consumer
);
2958 list
[idx
].id
= output
->id
;
2959 list
[idx
].max_size
= output
->max_size
;
2960 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2961 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2962 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2963 sizeof(list
[idx
].ctrl_url
));
2966 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2967 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2969 ret
= -LTTNG_ERR_NOMEM
;
2974 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
2975 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
2977 ret
= -LTTNG_ERR_NOMEM
;
2986 ret
= session
->snapshot
.nb_output
;
2994 * Send relayd sockets from snapshot output to consumer. Ignore request if the
2995 * snapshot output is *not* set with a remote destination.
2997 * Return 0 on success or a LTTNG_ERR code.
2999 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3000 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3003 struct lttng_ht_iter iter
;
3004 struct consumer_socket
*socket
;
3007 assert(snap_output
);
3010 DBG2("Set relayd object from snapshot output");
3012 /* Ignore if snapshot consumer output is not network. */
3013 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3018 * For each consumer socket, create and send the relayd object of the
3022 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3023 socket
, node
.node
) {
3024 ret
= send_consumer_relayd_sockets(0, session
->id
,
3025 snap_output
->consumer
, socket
,
3026 session
->name
, session
->hostname
,
3027 session
->live_timer
);
3028 if (ret
!= LTTNG_OK
) {
3040 * Record a kernel snapshot.
3042 * Return LTTNG_OK on success or a LTTNG_ERR code.
3044 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3045 struct snapshot_output
*output
, struct ltt_session
*session
,
3046 int wait
, uint64_t nb_packets_per_stream
)
3054 /* Get the datetime for the snapshot output directory. */
3055 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3056 sizeof(output
->datetime
));
3058 ret
= LTTNG_ERR_INVALID
;
3063 * Copy kernel session sockets so we can communicate with the right
3064 * consumer for the snapshot record command.
3066 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3068 ret
= LTTNG_ERR_NOMEM
;
3072 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3073 if (ret
!= LTTNG_OK
) {
3074 goto error_snapshot
;
3077 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3078 if (ret
!= LTTNG_OK
) {
3079 goto error_snapshot
;
3086 /* Clean up copied sockets so this output can use some other later on. */
3087 consumer_destroy_output_sockets(output
->consumer
);
3094 * Record a UST snapshot.
3096 * Return 0 on success or a LTTNG_ERR error code.
3098 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3099 struct snapshot_output
*output
, struct ltt_session
*session
,
3100 int wait
, uint64_t nb_packets_per_stream
)
3108 /* Get the datetime for the snapshot output directory. */
3109 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3110 sizeof(output
->datetime
));
3112 ret
= LTTNG_ERR_INVALID
;
3117 * Copy UST session sockets so we can communicate with the right
3118 * consumer for the snapshot record command.
3120 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3122 ret
= LTTNG_ERR_NOMEM
;
3126 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3127 if (ret
!= LTTNG_OK
) {
3128 goto error_snapshot
;
3131 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3135 ret
= LTTNG_ERR_INVALID
;
3138 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3141 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3144 goto error_snapshot
;
3150 /* Clean up copied sockets so this output can use some other later on. */
3151 consumer_destroy_output_sockets(output
->consumer
);
3157 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3158 uint64_t cur_nr_packets
)
3160 uint64_t tot_size
= 0;
3162 if (session
->kernel_session
) {
3163 struct ltt_kernel_channel
*chan
;
3164 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3166 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3167 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3169 * Don't take channel into account if we
3170 * already grab all its packets.
3174 tot_size
+= chan
->channel
->attr
.subbuf_size
3175 * chan
->stream_count
;
3179 if (session
->ust_session
) {
3180 struct ltt_ust_session
*usess
= session
->ust_session
;
3182 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3190 * Calculate the number of packets we can grab from each stream that
3191 * fits within the overall snapshot max size.
3193 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3194 * the number of packets per stream.
3196 * TODO: this approach is not perfect: we consider the worse case
3197 * (packet filling the sub-buffers) as an upper bound, but we could do
3198 * better if we do this calculation while we actually grab the packet
3199 * content: we would know how much padding we don't actually store into
3202 * This algorithm is currently bounded by the number of packets per
3205 * Since we call this algorithm before actually grabbing the data, it's
3206 * an approximation: for instance, applications could appear/disappear
3207 * in between this call and actually grabbing data.
3210 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3213 uint64_t cur_nb_packets
= 0;
3216 return 0; /* Infinite */
3219 size_left
= max_size
;
3221 uint64_t one_more_packet_tot_size
;
3223 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3225 if (!one_more_packet_tot_size
) {
3226 /* We are already grabbing all packets. */
3229 size_left
-= one_more_packet_tot_size
;
3230 if (size_left
< 0) {
3235 if (!cur_nb_packets
) {
3236 /* Not enough room to grab one packet of each stream, error. */
3239 return cur_nb_packets
;
3243 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3245 * The wait parameter is ignored so this call always wait for the snapshot to
3246 * complete before returning.
3248 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3250 int cmd_snapshot_record(struct ltt_session
*session
,
3251 struct lttng_snapshot_output
*output
, int wait
)
3254 unsigned int use_tmp_output
= 0;
3255 struct snapshot_output tmp_output
;
3256 unsigned int snapshot_success
= 0;
3261 DBG("Cmd snapshot record for session %s", session
->name
);
3264 * Permission denied to create an output if the session is not
3265 * set in no output mode.
3267 if (session
->output_traces
) {
3268 ret
= LTTNG_ERR_EPERM
;
3272 /* The session needs to be started at least once. */
3273 if (!session
->has_been_started
) {
3274 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3278 /* Use temporary output for the session. */
3279 if (*output
->ctrl_url
!= '\0') {
3280 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3281 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3284 if (ret
== -ENOMEM
) {
3285 ret
= LTTNG_ERR_NOMEM
;
3287 ret
= LTTNG_ERR_INVALID
;
3291 /* Use the global session count for the temporary snapshot. */
3292 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3296 if (session
->kernel_session
) {
3297 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3299 if (use_tmp_output
) {
3300 int64_t nb_packets_per_stream
;
3302 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3303 tmp_output
.max_size
);
3304 if (nb_packets_per_stream
< 0) {
3305 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3308 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3309 wait
, nb_packets_per_stream
);
3310 if (ret
!= LTTNG_OK
) {
3313 snapshot_success
= 1;
3315 struct snapshot_output
*sout
;
3316 struct lttng_ht_iter iter
;
3319 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3320 &iter
.iter
, sout
, node
.node
) {
3321 int64_t nb_packets_per_stream
;
3324 * Make a local copy of the output and assign the possible
3325 * temporary value given by the caller.
3327 memset(&tmp_output
, 0, sizeof(tmp_output
));
3328 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3330 if (output
->max_size
!= (uint64_t) -1ULL) {
3331 tmp_output
.max_size
= output
->max_size
;
3334 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3335 tmp_output
.max_size
);
3336 if (nb_packets_per_stream
< 0) {
3337 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3341 /* Use temporary name. */
3342 if (*output
->name
!= '\0') {
3343 strncpy(tmp_output
.name
, output
->name
,
3344 sizeof(tmp_output
.name
));
3347 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3349 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3350 session
, wait
, nb_packets_per_stream
);
3351 if (ret
!= LTTNG_OK
) {
3355 snapshot_success
= 1;
3361 if (session
->ust_session
) {
3362 struct ltt_ust_session
*usess
= session
->ust_session
;
3364 if (use_tmp_output
) {
3365 int64_t nb_packets_per_stream
;
3367 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3368 tmp_output
.max_size
);
3369 if (nb_packets_per_stream
< 0) {
3370 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3373 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3374 wait
, nb_packets_per_stream
);
3375 if (ret
!= LTTNG_OK
) {
3378 snapshot_success
= 1;
3380 struct snapshot_output
*sout
;
3381 struct lttng_ht_iter iter
;
3384 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3385 &iter
.iter
, sout
, node
.node
) {
3386 int64_t nb_packets_per_stream
;
3389 * Make a local copy of the output and assign the possible
3390 * temporary value given by the caller.
3392 memset(&tmp_output
, 0, sizeof(tmp_output
));
3393 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3395 if (output
->max_size
!= (uint64_t) -1ULL) {
3396 tmp_output
.max_size
= output
->max_size
;
3399 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3400 tmp_output
.max_size
);
3401 if (nb_packets_per_stream
< 0) {
3402 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3407 /* Use temporary name. */
3408 if (*output
->name
!= '\0') {
3409 strncpy(tmp_output
.name
, output
->name
,
3410 sizeof(tmp_output
.name
));
3413 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3415 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3416 wait
, nb_packets_per_stream
);
3417 if (ret
!= LTTNG_OK
) {
3421 snapshot_success
= 1;
3427 if (snapshot_success
) {
3428 session
->snapshot
.nb_snapshot
++;
3430 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3438 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3440 int cmd_set_session_shm_path(struct ltt_session
*session
,
3441 const char *shm_path
)
3447 * Can only set shm path before session is started.
3449 if (session
->has_been_started
) {
3450 return LTTNG_ERR_SESSION_STARTED
;
3453 strncpy(session
->shm_path
, shm_path
,
3454 sizeof(session
->shm_path
));
3455 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3461 * Init command subsystem.
3466 * Set network sequence index to 1 for streams to match a relayd
3467 * socket on the consumer side.
3469 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3470 relayd_net_seq_idx
= 1;
3471 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3473 DBG("Command subsystem initialized");