2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <urcu/list.h>
24 #include <urcu/uatomic.h>
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
35 #include "health-sessiond.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
45 * Used to keep a unique index for each relayd socket created where this value
46 * is associated with streams on the consumer so it can match the right relayd
47 * to send to. It must be accessed with the relayd_net_seq_idx_lock
50 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 static uint64_t relayd_net_seq_idx
;
53 static int validate_event_name(const char *);
54 static int validate_ust_event_name(const char *);
55 static int cmd_enable_event_internal(struct ltt_session
*session
,
56 struct lttng_domain
*domain
,
57 char *channel_name
, struct lttng_event
*event
,
58 char *filter_expression
,
59 struct lttng_filter_bytecode
*filter
,
60 struct lttng_event_exclusion
*exclusion
,
64 * Create a session path used by list_lttng_sessions for the case that the
65 * session consumer is on the network.
67 static int build_network_session_path(char *dst
, size_t size
,
68 struct ltt_session
*session
)
70 int ret
, kdata_port
, udata_port
;
71 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
72 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
77 memset(tmp_urls
, 0, sizeof(tmp_urls
));
78 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
80 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
82 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
83 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
84 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
87 if (session
->ust_session
&& session
->ust_session
->consumer
) {
88 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
89 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
92 if (uuri
== NULL
&& kuri
== NULL
) {
93 uri
= &session
->consumer
->dst
.net
.control
;
94 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
95 } else if (kuri
&& uuri
) {
96 ret
= uri_compare(kuri
, uuri
);
100 /* Build uuri URL string */
101 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
108 } else if (kuri
&& uuri
== NULL
) {
110 } else if (uuri
&& kuri
== NULL
) {
114 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
120 * Do we have a UST url set. If yes, this means we have both kernel and UST
123 if (*tmp_uurl
!= '\0') {
124 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
125 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
128 if (kuri
|| (!kuri
&& !uuri
)) {
131 /* No kernel URI, use the UST port. */
134 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
142 * Fill lttng_channel array of all channels.
144 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
145 struct lttng_channel
*channels
)
148 struct ltt_kernel_channel
*kchan
;
150 DBG("Listing channels for session %s", session
->name
);
153 case LTTNG_DOMAIN_KERNEL
:
154 /* Kernel channels */
155 if (session
->kernel_session
!= NULL
) {
156 cds_list_for_each_entry(kchan
,
157 &session
->kernel_session
->channel_list
.head
, list
) {
158 /* Copy lttng_channel struct to array */
159 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
160 channels
[i
].enabled
= kchan
->enabled
;
165 case LTTNG_DOMAIN_UST
:
167 struct lttng_ht_iter iter
;
168 struct ltt_ust_channel
*uchan
;
171 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
172 &iter
.iter
, uchan
, node
.node
) {
173 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
174 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
175 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
176 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
177 channels
[i
].attr
.switch_timer_interval
=
178 uchan
->attr
.switch_timer_interval
;
179 channels
[i
].attr
.read_timer_interval
=
180 uchan
->attr
.read_timer_interval
;
181 channels
[i
].enabled
= uchan
->enabled
;
182 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
183 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
184 switch (uchan
->attr
.output
) {
187 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
201 * Create a list of agent domain events.
203 * Return number of events in list on success or else a negative value.
205 static int list_lttng_agent_events(struct agent
*agt
,
206 struct lttng_event
**events
)
209 unsigned int nb_event
= 0;
210 struct agent_event
*event
;
211 struct lttng_event
*tmp_events
;
212 struct lttng_ht_iter iter
;
217 DBG3("Listing agent events");
220 nb_event
= lttng_ht_get_count(agt
->events
);
227 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
229 PERROR("zmalloc agent events session");
230 ret
= -LTTNG_ERR_FATAL
;
235 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
236 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
237 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
238 tmp_events
[i
].enabled
= event
->enabled
;
239 tmp_events
[i
].loglevel
= event
->loglevel
;
240 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
245 *events
= tmp_events
;
249 assert(nb_event
== i
);
254 * Create a list of ust global domain events.
256 static int list_lttng_ust_global_events(char *channel_name
,
257 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
260 unsigned int nb_event
= 0;
261 struct lttng_ht_iter iter
;
262 struct lttng_ht_node_str
*node
;
263 struct ltt_ust_channel
*uchan
;
264 struct ltt_ust_event
*uevent
;
265 struct lttng_event
*tmp
;
267 DBG("Listing UST global events for channel %s", channel_name
);
271 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
272 node
= lttng_ht_iter_get_node_str(&iter
);
274 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
278 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
280 nb_event
= lttng_ht_get_count(uchan
->events
);
286 DBG3("Listing UST global %d events", nb_event
);
288 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
290 ret
= LTTNG_ERR_FATAL
;
294 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
295 if (uevent
->internal
) {
296 /* This event should remain hidden from clients */
300 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
301 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
302 tmp
[i
].enabled
= uevent
->enabled
;
304 switch (uevent
->attr
.instrumentation
) {
305 case LTTNG_UST_TRACEPOINT
:
306 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
308 case LTTNG_UST_PROBE
:
309 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
311 case LTTNG_UST_FUNCTION
:
312 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
316 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
317 switch (uevent
->attr
.loglevel_type
) {
318 case LTTNG_UST_LOGLEVEL_ALL
:
319 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
321 case LTTNG_UST_LOGLEVEL_RANGE
:
322 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
324 case LTTNG_UST_LOGLEVEL_SINGLE
:
325 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
328 if (uevent
->filter
) {
331 if (uevent
->exclusion
) {
332 tmp
[i
].exclusion
= 1;
346 * Fill lttng_event array of all kernel events in the channel.
348 static int list_lttng_kernel_events(char *channel_name
,
349 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
352 unsigned int nb_event
;
353 struct ltt_kernel_event
*event
;
354 struct ltt_kernel_channel
*kchan
;
356 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
358 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
362 nb_event
= kchan
->event_count
;
364 DBG("Listing events for channel %s", kchan
->channel
->name
);
371 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
372 if (*events
== NULL
) {
373 ret
= LTTNG_ERR_FATAL
;
377 /* Kernel channels */
378 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
379 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
380 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
381 (*events
)[i
].enabled
= event
->enabled
;
383 switch (event
->event
->instrumentation
) {
384 case LTTNG_KERNEL_TRACEPOINT
:
385 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
387 case LTTNG_KERNEL_KRETPROBE
:
388 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
389 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
390 sizeof(struct lttng_kernel_kprobe
));
392 case LTTNG_KERNEL_KPROBE
:
393 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
394 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
395 sizeof(struct lttng_kernel_kprobe
));
397 case LTTNG_KERNEL_FUNCTION
:
398 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
399 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
400 sizeof(struct lttng_kernel_function
));
402 case LTTNG_KERNEL_NOOP
:
403 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
405 case LTTNG_KERNEL_SYSCALL
:
406 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
408 case LTTNG_KERNEL_ALL
:
419 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
431 /* Negate the error code to differentiate the size from an error */
436 * Add URI so the consumer output object. Set the correct path depending on the
437 * domain adding the default trace directory.
439 static int add_uri_to_consumer(struct consumer_output
*consumer
,
440 struct lttng_uri
*uri
, int domain
, const char *session_name
)
443 const char *default_trace_dir
;
447 if (consumer
== NULL
) {
448 DBG("No consumer detected. Don't add URI. Stopping.");
449 ret
= LTTNG_ERR_NO_CONSUMER
;
454 case LTTNG_DOMAIN_KERNEL
:
455 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
457 case LTTNG_DOMAIN_UST
:
458 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
462 * This case is possible is we try to add the URI to the global tracing
463 * session consumer object which in this case there is no subdir.
465 default_trace_dir
= "";
468 switch (uri
->dtype
) {
471 DBG2("Setting network URI to consumer");
473 if (consumer
->type
== CONSUMER_DST_NET
) {
474 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
475 consumer
->dst
.net
.control_isset
) ||
476 (uri
->stype
== LTTNG_STREAM_DATA
&&
477 consumer
->dst
.net
.data_isset
)) {
478 ret
= LTTNG_ERR_URL_EXIST
;
482 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
485 consumer
->type
= CONSUMER_DST_NET
;
487 /* Set URI into consumer output object */
488 ret
= consumer_set_network_uri(consumer
, uri
);
492 } else if (ret
== 1) {
494 * URI was the same in the consumer so we do not append the subdir
495 * again so to not duplicate output dir.
501 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
502 ret
= consumer_set_subdir(consumer
, session_name
);
504 ret
= LTTNG_ERR_FATAL
;
509 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
510 /* On a new subdir, reappend the default trace dir. */
511 strncat(consumer
->subdir
, default_trace_dir
,
512 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
513 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
518 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
519 memset(consumer
->dst
.trace_path
, 0,
520 sizeof(consumer
->dst
.trace_path
));
521 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
522 sizeof(consumer
->dst
.trace_path
));
523 /* Append default trace dir */
524 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
525 sizeof(consumer
->dst
.trace_path
) -
526 strlen(consumer
->dst
.trace_path
) - 1);
527 /* Flag consumer as local. */
528 consumer
->type
= CONSUMER_DST_LOCAL
;
539 * Init tracing by creating trace directory and sending fds kernel consumer.
541 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
544 struct lttng_ht_iter iter
;
545 struct consumer_socket
*socket
;
551 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
552 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
554 pthread_mutex_lock(socket
->lock
);
555 ret
= kernel_consumer_send_session(socket
, session
);
556 pthread_mutex_unlock(socket
->lock
);
558 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
570 * Create a socket to the relayd using the URI.
572 * On success, the relayd_sock pointer is set to the created socket.
573 * Else, it's stays untouched and a lttcomm error code is returned.
575 static int create_connect_relayd(struct lttng_uri
*uri
,
576 struct lttcomm_relayd_sock
**relayd_sock
)
579 struct lttcomm_relayd_sock
*rsock
;
581 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
582 RELAYD_VERSION_COMM_MINOR
);
584 ret
= LTTNG_ERR_FATAL
;
589 * Connect to relayd so we can proceed with a session creation. This call
590 * can possibly block for an arbitrary amount of time to set the health
591 * state to be in poll execution.
594 ret
= relayd_connect(rsock
);
597 ERR("Unable to reach lttng-relayd");
598 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
602 /* Create socket for control stream. */
603 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
604 DBG3("Creating relayd stream socket from URI");
606 /* Check relayd version */
607 ret
= relayd_version_check(rsock
);
609 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
612 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
613 DBG3("Creating relayd data socket from URI");
615 /* Command is not valid */
616 ERR("Relayd invalid stream type: %d", uri
->stype
);
617 ret
= LTTNG_ERR_INVALID
;
621 *relayd_sock
= rsock
;
626 /* The returned value is not useful since we are on an error path. */
627 (void) relayd_close(rsock
);
635 * Connect to the relayd using URI and send the socket to the right consumer.
637 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
638 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
639 struct consumer_socket
*consumer_sock
,
640 char *session_name
, char *hostname
, int session_live_timer
)
643 struct lttcomm_relayd_sock
*rsock
= NULL
;
645 /* Connect to relayd and make version check if uri is the control. */
646 ret
= create_connect_relayd(relayd_uri
, &rsock
);
647 if (ret
!= LTTNG_OK
) {
652 /* Set the network sequence index if not set. */
653 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
654 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
656 * Increment net_seq_idx because we are about to transfer the
657 * new relayd socket to the consumer.
658 * Assign unique key so the consumer can match streams.
660 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
661 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
664 /* Send relayd socket to consumer. */
665 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
666 relayd_uri
->stype
, session_id
,
667 session_name
, hostname
, session_live_timer
);
669 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
673 /* Flag that the corresponding socket was sent. */
674 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
675 consumer_sock
->control_sock_sent
= 1;
676 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
677 consumer_sock
->data_sock_sent
= 1;
683 * Close socket which was dup on the consumer side. The session daemon does
684 * NOT keep track of the relayd socket(s) once transfer to the consumer.
688 (void) relayd_close(rsock
);
692 if (ret
!= LTTNG_OK
) {
694 * The consumer output for this session should not be used anymore
695 * since the relayd connection failed thus making any tracing or/and
696 * streaming not usable.
698 consumer
->enabled
= 0;
704 * Send both relayd sockets to a specific consumer and domain. This is a
705 * helper function to facilitate sending the information to the consumer for a
708 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
709 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
710 char *session_name
, char *hostname
, int session_live_timer
)
717 /* Sending control relayd socket. */
718 if (!sock
->control_sock_sent
) {
719 ret
= send_consumer_relayd_socket(domain
, session_id
,
720 &consumer
->dst
.net
.control
, consumer
, sock
,
721 session_name
, hostname
, session_live_timer
);
722 if (ret
!= LTTNG_OK
) {
727 /* Sending data relayd socket. */
728 if (!sock
->data_sock_sent
) {
729 ret
= send_consumer_relayd_socket(domain
, session_id
,
730 &consumer
->dst
.net
.data
, consumer
, sock
,
731 session_name
, hostname
, session_live_timer
);
732 if (ret
!= LTTNG_OK
) {
742 * Setup relayd connections for a tracing session. First creates the socket to
743 * the relayd and send them to the right domain consumer. Consumer type MUST be
746 int cmd_setup_relayd(struct ltt_session
*session
)
749 struct ltt_ust_session
*usess
;
750 struct ltt_kernel_session
*ksess
;
751 struct consumer_socket
*socket
;
752 struct lttng_ht_iter iter
;
756 usess
= session
->ust_session
;
757 ksess
= session
->kernel_session
;
759 DBG("Setting relayd for session %s", session
->name
);
763 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
764 && usess
->consumer
->enabled
) {
765 /* For each consumer socket, send relayd sockets */
766 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
768 pthread_mutex_lock(socket
->lock
);
769 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
770 usess
->consumer
, socket
,
771 session
->name
, session
->hostname
,
772 session
->live_timer
);
773 pthread_mutex_unlock(socket
->lock
);
774 if (ret
!= LTTNG_OK
) {
777 /* Session is now ready for network streaming. */
778 session
->net_handle
= 1;
782 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
783 && ksess
->consumer
->enabled
) {
784 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
786 pthread_mutex_lock(socket
->lock
);
787 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
788 ksess
->consumer
, socket
,
789 session
->name
, session
->hostname
,
790 session
->live_timer
);
791 pthread_mutex_unlock(socket
->lock
);
792 if (ret
!= LTTNG_OK
) {
795 /* Session is now ready for network streaming. */
796 session
->net_handle
= 1;
806 * Start a kernel session by opening all necessary streams.
808 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
811 struct ltt_kernel_channel
*kchan
;
813 /* Open kernel metadata */
814 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
815 ret
= kernel_open_metadata(ksess
);
817 ret
= LTTNG_ERR_KERN_META_FAIL
;
822 /* Open kernel metadata stream */
823 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
824 ret
= kernel_open_metadata_stream(ksess
);
826 ERR("Kernel create metadata stream failed");
827 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
832 /* For each channel */
833 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
834 if (kchan
->stream_count
== 0) {
835 ret
= kernel_open_channel_stream(kchan
);
837 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
840 /* Update the stream global counter */
841 ksess
->stream_count_global
+= ret
;
845 /* Setup kernel consumer socket and send fds to it */
846 ret
= init_kernel_tracing(ksess
);
848 ret
= LTTNG_ERR_KERN_START_FAIL
;
852 /* This start the kernel tracing */
853 ret
= kernel_start_session(ksess
);
855 ret
= LTTNG_ERR_KERN_START_FAIL
;
859 /* Quiescent wait after starting trace */
860 kernel_wait_quiescent(kernel_tracer_fd
);
871 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
873 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
877 struct ltt_ust_session
*usess
;
879 usess
= session
->ust_session
;
884 case LTTNG_DOMAIN_KERNEL
:
886 ret
= channel_kernel_disable(session
->kernel_session
,
888 if (ret
!= LTTNG_OK
) {
892 kernel_wait_quiescent(kernel_tracer_fd
);
895 case LTTNG_DOMAIN_UST
:
897 struct ltt_ust_channel
*uchan
;
898 struct lttng_ht
*chan_ht
;
900 chan_ht
= usess
->domain_global
.channels
;
902 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
904 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
908 ret
= channel_ust_disable(usess
, uchan
);
909 if (ret
!= LTTNG_OK
) {
915 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
927 * Command LTTNG_TRACK_PID processed by the client thread.
929 * Called with session lock held.
931 int cmd_track_pid(struct ltt_session
*session
, int domain
, int pid
)
938 case LTTNG_DOMAIN_KERNEL
:
940 struct ltt_kernel_session
*ksess
;
942 ksess
= session
->kernel_session
;
944 ret
= kernel_track_pid(ksess
, pid
);
945 if (ret
!= LTTNG_OK
) {
949 kernel_wait_quiescent(kernel_tracer_fd
);
952 case LTTNG_DOMAIN_UST
:
954 struct ltt_ust_session
*usess
;
956 usess
= session
->ust_session
;
958 ret
= trace_ust_track_pid(usess
, pid
);
959 if (ret
!= LTTNG_OK
) {
965 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
977 * Command LTTNG_UNTRACK_PID processed by the client thread.
979 * Called with session lock held.
981 int cmd_untrack_pid(struct ltt_session
*session
, int domain
, int pid
)
988 case LTTNG_DOMAIN_KERNEL
:
990 struct ltt_kernel_session
*ksess
;
992 ksess
= session
->kernel_session
;
994 ret
= kernel_untrack_pid(ksess
, pid
);
995 if (ret
!= LTTNG_OK
) {
999 kernel_wait_quiescent(kernel_tracer_fd
);
1002 case LTTNG_DOMAIN_UST
:
1004 struct ltt_ust_session
*usess
;
1006 usess
= session
->ust_session
;
1008 ret
= trace_ust_untrack_pid(usess
, pid
);
1009 if (ret
!= LTTNG_OK
) {
1015 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1027 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1029 * The wpipe arguments is used as a notifier for the kernel thread.
1031 int cmd_enable_channel(struct ltt_session
*session
,
1032 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1035 struct ltt_ust_session
*usess
= session
->ust_session
;
1036 struct lttng_ht
*chan_ht
;
1043 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1045 /* Validate channel name */
1046 if (attr
->name
[0] == '.' ||
1047 memchr(attr
->name
, '/', len
) != NULL
) {
1048 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1052 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1057 * Don't try to enable a channel if the session has been started at
1058 * some point in time before. The tracer does not allow it.
1060 if (session
->has_been_started
) {
1061 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1066 * If the session is a live session, remove the switch timer, the
1067 * live timer does the same thing but sends also synchronisation
1068 * beacons for inactive streams.
1070 if (session
->live_timer
> 0) {
1071 attr
->attr
.live_timer_interval
= session
->live_timer
;
1072 attr
->attr
.switch_timer_interval
= 0;
1076 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1077 * mode and with less than 2 subbuf so block it right away and send back an
1078 * invalid attribute error.
1080 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1081 ret
= LTTNG_ERR_INVALID
;
1085 switch (domain
->type
) {
1086 case LTTNG_DOMAIN_KERNEL
:
1088 struct ltt_kernel_channel
*kchan
;
1090 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1091 session
->kernel_session
);
1092 if (kchan
== NULL
) {
1093 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1094 if (attr
->name
[0] != '\0') {
1095 session
->kernel_session
->has_non_default_channel
= 1;
1098 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1101 if (ret
!= LTTNG_OK
) {
1105 kernel_wait_quiescent(kernel_tracer_fd
);
1108 case LTTNG_DOMAIN_UST
:
1110 struct ltt_ust_channel
*uchan
;
1112 chan_ht
= usess
->domain_global
.channels
;
1114 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1115 if (uchan
== NULL
) {
1116 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1117 if (attr
->name
[0] != '\0') {
1118 usess
->has_non_default_channel
= 1;
1121 ret
= channel_ust_enable(usess
, uchan
);
1126 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1137 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1139 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1141 struct lttng_event
*event
)
1146 DBG("Disable event command for event \'%s\'", event
->name
);
1148 event_name
= event
->name
;
1149 if (validate_event_name(event_name
)) {
1150 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1154 /* Error out on unhandled search criteria */
1155 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1156 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1157 ret
= LTTNG_ERR_UNK
;
1164 case LTTNG_DOMAIN_KERNEL
:
1166 struct ltt_kernel_channel
*kchan
;
1167 struct ltt_kernel_session
*ksess
;
1169 ksess
= session
->kernel_session
;
1172 * If a non-default channel has been created in the
1173 * session, explicitely require that -c chan_name needs
1176 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1177 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1181 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1182 if (kchan
== NULL
) {
1183 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1187 switch (event
->type
) {
1188 case LTTNG_EVENT_ALL
:
1189 ret
= event_kernel_disable_event_all(kchan
);
1190 if (ret
!= LTTNG_OK
) {
1194 case LTTNG_EVENT_TRACEPOINT
: /* fall-through */
1195 case LTTNG_EVENT_SYSCALL
:
1196 if (!strcmp(event_name
, "*")) {
1197 ret
= event_kernel_disable_event_type(kchan
,
1200 ret
= event_kernel_disable_event(kchan
,
1203 if (ret
!= LTTNG_OK
) {
1207 case LTTNG_EVENT_PROBE
:
1208 case LTTNG_EVENT_FUNCTION
:
1209 case LTTNG_EVENT_FUNCTION_ENTRY
:
1210 ret
= event_kernel_disable_event(kchan
, event_name
);
1211 if (ret
!= LTTNG_OK
) {
1216 ret
= LTTNG_ERR_UNK
;
1220 kernel_wait_quiescent(kernel_tracer_fd
);
1223 case LTTNG_DOMAIN_UST
:
1225 struct ltt_ust_channel
*uchan
;
1226 struct ltt_ust_session
*usess
;
1228 usess
= session
->ust_session
;
1230 if (validate_ust_event_name(event_name
)) {
1231 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1236 * If a non-default channel has been created in the
1237 * session, explicitely require that -c chan_name needs
1240 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1241 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1245 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1247 if (uchan
== NULL
) {
1248 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1252 switch (event
->type
) {
1253 case LTTNG_EVENT_ALL
:
1254 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1255 if (ret
!= LTTNG_OK
) {
1260 ret
= LTTNG_ERR_UNK
;
1264 DBG3("Disable UST event %s in channel %s completed", event_name
,
1268 case LTTNG_DOMAIN_LOG4J
:
1269 case LTTNG_DOMAIN_JUL
:
1270 case LTTNG_DOMAIN_PYTHON
:
1273 struct ltt_ust_session
*usess
= session
->ust_session
;
1277 switch (event
->type
) {
1278 case LTTNG_EVENT_ALL
:
1281 ret
= LTTNG_ERR_UNK
;
1285 agt
= trace_ust_find_agent(usess
, domain
);
1287 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1290 /* The wild card * means that everything should be disabled. */
1291 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1292 ret
= event_agent_disable_all(usess
, agt
);
1294 ret
= event_agent_disable(usess
, agt
, event_name
);
1296 if (ret
!= LTTNG_OK
) {
1303 ret
= LTTNG_ERR_UND
;
1316 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1318 int cmd_add_context(struct ltt_session
*session
, int domain
,
1319 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1321 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1324 case LTTNG_DOMAIN_KERNEL
:
1325 assert(session
->kernel_session
);
1327 if (session
->kernel_session
->channel_count
== 0) {
1328 /* Create default channel */
1329 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1330 if (ret
!= LTTNG_OK
) {
1333 chan_kern_created
= 1;
1335 /* Add kernel context to kernel tracer */
1336 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1337 if (ret
!= LTTNG_OK
) {
1341 case LTTNG_DOMAIN_UST
:
1343 struct ltt_ust_session
*usess
= session
->ust_session
;
1344 unsigned int chan_count
;
1348 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1349 if (chan_count
== 0) {
1350 struct lttng_channel
*attr
;
1351 /* Create default channel */
1352 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1354 ret
= LTTNG_ERR_FATAL
;
1358 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1359 if (ret
!= LTTNG_OK
) {
1364 chan_ust_created
= 1;
1367 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1368 if (ret
!= LTTNG_OK
) {
1374 ret
= LTTNG_ERR_UND
;
1381 if (chan_kern_created
) {
1382 struct ltt_kernel_channel
*kchan
=
1383 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1384 session
->kernel_session
);
1385 /* Created previously, this should NOT fail. */
1387 kernel_destroy_channel(kchan
);
1390 if (chan_ust_created
) {
1391 struct ltt_ust_channel
*uchan
=
1392 trace_ust_find_channel_by_name(
1393 session
->ust_session
->domain_global
.channels
,
1394 DEFAULT_CHANNEL_NAME
);
1395 /* Created previously, this should NOT fail. */
1397 /* Remove from the channel list of the session. */
1398 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1400 trace_ust_destroy_channel(uchan
);
1405 static int validate_event_name(const char *name
)
1408 const char *c
= name
;
1409 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1412 * Make sure that unescaped wildcards are only used as the last
1413 * character of the event name.
1415 while (c
< event_name_end
) {
1423 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1424 /* Wildcard is not the last character */
1425 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1437 static inline bool name_starts_with(const char *name
, const char *prefix
)
1439 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1441 return !strncmp(name
, prefix
, max_cmp_len
);
1444 /* Perform userspace-specific event name validation */
1445 static int validate_ust_event_name(const char *name
)
1455 * Check name against all internal UST event component namespaces used
1458 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1459 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1460 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1469 * Internal version of cmd_enable_event() with a supplemental
1470 * "internal_event" flag which is used to enable internal events which should
1471 * be hidden from clients. Such events are used in the agent implementation to
1472 * enable the events through which all "agent" events are funeled.
1474 static int _cmd_enable_event(struct ltt_session
*session
,
1475 struct lttng_domain
*domain
,
1476 char *channel_name
, struct lttng_event
*event
,
1477 char *filter_expression
,
1478 struct lttng_filter_bytecode
*filter
,
1479 struct lttng_event_exclusion
*exclusion
,
1480 int wpipe
, bool internal_event
)
1482 int ret
, channel_created
= 0;
1483 struct lttng_channel
*attr
;
1487 assert(channel_name
);
1489 DBG("Enable event command for event \'%s\'", event
->name
);
1491 ret
= validate_event_name(event
->name
);
1498 switch (domain
->type
) {
1499 case LTTNG_DOMAIN_KERNEL
:
1501 struct ltt_kernel_channel
*kchan
;
1504 * If a non-default channel has been created in the
1505 * session, explicitely require that -c chan_name needs
1508 if (session
->kernel_session
->has_non_default_channel
1509 && channel_name
[0] == '\0') {
1510 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1514 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1515 session
->kernel_session
);
1516 if (kchan
== NULL
) {
1517 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1518 LTTNG_BUFFER_GLOBAL
);
1520 ret
= LTTNG_ERR_FATAL
;
1523 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1525 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1526 if (ret
!= LTTNG_OK
) {
1532 channel_created
= 1;
1535 /* Get the newly created kernel channel pointer */
1536 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1537 session
->kernel_session
);
1538 if (kchan
== NULL
) {
1539 /* This sould not happen... */
1540 ret
= LTTNG_ERR_FATAL
;
1544 switch (event
->type
) {
1545 case LTTNG_EVENT_ALL
:
1547 char *filter_expression_a
= NULL
;
1548 struct lttng_filter_bytecode
*filter_a
= NULL
;
1551 * We need to duplicate filter_expression and filter,
1552 * because ownership is passed to first enable
1555 if (filter_expression
) {
1556 filter_expression_a
= strdup(filter_expression
);
1557 if (!filter_expression_a
) {
1558 ret
= LTTNG_ERR_FATAL
;
1563 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1565 free(filter_expression_a
);
1566 ret
= LTTNG_ERR_FATAL
;
1569 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1571 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1572 ret
= event_kernel_enable_event(kchan
, event
,
1573 filter_expression
, filter
);
1574 /* We have passed ownership */
1575 filter_expression
= NULL
;
1577 if (ret
!= LTTNG_OK
) {
1578 if (channel_created
) {
1579 /* Let's not leak a useless channel. */
1580 kernel_destroy_channel(kchan
);
1582 free(filter_expression_a
);
1586 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1587 ret
= event_kernel_enable_event(kchan
, event
,
1588 filter_expression_a
, filter_a
);
1589 if (ret
!= LTTNG_OK
) {
1590 free(filter_expression_a
);
1596 case LTTNG_EVENT_PROBE
:
1597 case LTTNG_EVENT_FUNCTION
:
1598 case LTTNG_EVENT_FUNCTION_ENTRY
:
1599 case LTTNG_EVENT_TRACEPOINT
:
1600 ret
= event_kernel_enable_event(kchan
, event
,
1601 filter_expression
, filter
);
1602 /* We have passed ownership */
1603 filter_expression
= NULL
;
1605 if (ret
!= LTTNG_OK
) {
1606 if (channel_created
) {
1607 /* Let's not leak a useless channel. */
1608 kernel_destroy_channel(kchan
);
1613 case LTTNG_EVENT_SYSCALL
:
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
) {
1624 ret
= LTTNG_ERR_UNK
;
1628 kernel_wait_quiescent(kernel_tracer_fd
);
1631 case LTTNG_DOMAIN_UST
:
1633 struct ltt_ust_channel
*uchan
;
1634 struct ltt_ust_session
*usess
= session
->ust_session
;
1639 * If a non-default channel has been created in the
1640 * session, explicitely require that -c chan_name needs
1643 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1644 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1648 /* Get channel from global UST domain */
1649 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1651 if (uchan
== NULL
) {
1652 /* Create default channel */
1653 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1654 usess
->buffer_type
);
1656 ret
= LTTNG_ERR_FATAL
;
1659 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1661 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1662 if (ret
!= LTTNG_OK
) {
1668 /* Get the newly created channel reference back */
1669 uchan
= trace_ust_find_channel_by_name(
1670 usess
->domain_global
.channels
, channel_name
);
1674 if (!internal_event
) {
1676 * Ensure the event name is not reserved for internal
1679 ret
= validate_ust_event_name(event
->name
);
1681 WARN("Userspace event name %s failed validation.",
1683 event
->name
: "NULL");
1684 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1689 /* At this point, the session and channel exist on the tracer */
1690 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1691 filter_expression
, filter
, exclusion
,
1693 /* We have passed ownership */
1694 filter_expression
= NULL
;
1697 if (ret
!= LTTNG_OK
) {
1702 case LTTNG_DOMAIN_LOG4J
:
1703 case LTTNG_DOMAIN_JUL
:
1704 case LTTNG_DOMAIN_PYTHON
:
1706 const char *default_event_name
, *default_chan_name
;
1708 struct lttng_event uevent
;
1709 struct lttng_domain tmp_dom
;
1710 struct ltt_ust_session
*usess
= session
->ust_session
;
1714 agt
= trace_ust_find_agent(usess
, domain
->type
);
1716 agt
= agent_create(domain
->type
);
1718 ret
= LTTNG_ERR_NOMEM
;
1721 agent_add(agt
, usess
->agents
);
1724 /* Create the default tracepoint. */
1725 memset(&uevent
, 0, sizeof(uevent
));
1726 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1727 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1728 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1729 if (!default_event_name
) {
1730 ret
= LTTNG_ERR_FATAL
;
1733 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1734 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1737 * The domain type is changed because we are about to enable the
1738 * default channel and event for the JUL domain that are hardcoded.
1739 * This happens in the UST domain.
1741 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1742 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1744 switch (domain
->type
) {
1745 case LTTNG_DOMAIN_LOG4J
:
1746 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1748 case LTTNG_DOMAIN_JUL
:
1749 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1751 case LTTNG_DOMAIN_PYTHON
:
1752 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1755 /* The switch/case we are in should avoid this else big problem */
1760 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1761 char *filter_expression_copy
= NULL
;
1764 filter_copy
= zmalloc(
1765 sizeof(struct lttng_filter_bytecode
)
1768 ret
= LTTNG_ERR_NOMEM
;
1772 memcpy(filter_copy
, filter
,
1773 sizeof(struct lttng_filter_bytecode
)
1777 if (filter_expression
) {
1778 filter_expression_copy
=
1779 strdup(filter_expression
);
1780 if (!filter_expression
) {
1781 ret
= LTTNG_ERR_NOMEM
;
1782 goto error_free_copy
;
1786 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1787 (char *) default_chan_name
,
1788 &uevent
, filter_expression_copy
,
1789 filter_copy
, NULL
, wpipe
);
1791 filter_expression_copy
= NULL
;
1794 free(filter_expression_copy
);
1797 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1801 /* The wild card * means that everything should be enabled. */
1802 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1803 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1807 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1811 if (ret
!= LTTNG_OK
) {
1818 ret
= LTTNG_ERR_UND
;
1825 free(filter_expression
);
1833 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1834 * We own filter, exclusion, and filter_expression.
1836 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1837 char *channel_name
, struct lttng_event
*event
,
1838 char *filter_expression
,
1839 struct lttng_filter_bytecode
*filter
,
1840 struct lttng_event_exclusion
*exclusion
,
1843 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1844 filter_expression
, filter
, exclusion
, wpipe
, false);
1848 * Enable an event which is internal to LTTng. An internal should
1849 * never be made visible to clients and are immune to checks such as
1852 static int cmd_enable_event_internal(struct ltt_session
*session
,
1853 struct lttng_domain
*domain
,
1854 char *channel_name
, struct lttng_event
*event
,
1855 char *filter_expression
,
1856 struct lttng_filter_bytecode
*filter
,
1857 struct lttng_event_exclusion
*exclusion
,
1860 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1861 filter_expression
, filter
, exclusion
, wpipe
, true);
1865 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1867 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1870 ssize_t nb_events
= 0;
1873 case LTTNG_DOMAIN_KERNEL
:
1874 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1875 if (nb_events
< 0) {
1876 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1880 case LTTNG_DOMAIN_UST
:
1881 nb_events
= ust_app_list_events(events
);
1882 if (nb_events
< 0) {
1883 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1887 case LTTNG_DOMAIN_LOG4J
:
1888 case LTTNG_DOMAIN_JUL
:
1889 case LTTNG_DOMAIN_PYTHON
:
1890 nb_events
= agent_list_events(events
, domain
);
1891 if (nb_events
< 0) {
1892 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1897 ret
= LTTNG_ERR_UND
;
1904 /* Return negative value to differentiate return code */
1909 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1911 ssize_t
cmd_list_tracepoint_fields(int domain
,
1912 struct lttng_event_field
**fields
)
1915 ssize_t nb_fields
= 0;
1918 case LTTNG_DOMAIN_UST
:
1919 nb_fields
= ust_app_list_event_fields(fields
);
1920 if (nb_fields
< 0) {
1921 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1925 case LTTNG_DOMAIN_KERNEL
:
1926 default: /* fall-through */
1927 ret
= LTTNG_ERR_UND
;
1934 /* Return negative value to differentiate return code */
1938 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1940 return syscall_table_list(events
);
1944 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1946 * Called with session lock held.
1948 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1949 int domain
, int32_t **pids
)
1952 ssize_t nr_pids
= 0;
1955 case LTTNG_DOMAIN_KERNEL
:
1957 struct ltt_kernel_session
*ksess
;
1959 ksess
= session
->kernel_session
;
1960 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1962 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1967 case LTTNG_DOMAIN_UST
:
1969 struct ltt_ust_session
*usess
;
1971 usess
= session
->ust_session
;
1972 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
1974 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1979 case LTTNG_DOMAIN_LOG4J
:
1980 case LTTNG_DOMAIN_JUL
:
1981 case LTTNG_DOMAIN_PYTHON
:
1983 ret
= LTTNG_ERR_UND
;
1990 /* Return negative value to differentiate return code */
1995 * Command LTTNG_START_TRACE processed by the client thread.
1997 * Called with session mutex held.
1999 int cmd_start_trace(struct ltt_session
*session
)
2002 unsigned long nb_chan
= 0;
2003 struct ltt_kernel_session
*ksession
;
2004 struct ltt_ust_session
*usess
;
2008 /* Ease our life a bit ;) */
2009 ksession
= session
->kernel_session
;
2010 usess
= session
->ust_session
;
2012 /* Is the session already started? */
2013 if (session
->active
) {
2014 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2019 * Starting a session without channel is useless since after that it's not
2020 * possible to enable channel thus inform the client.
2022 if (usess
&& usess
->domain_global
.channels
) {
2024 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2028 nb_chan
+= ksession
->channel_count
;
2031 ret
= LTTNG_ERR_NO_CHANNEL
;
2035 /* Kernel tracing */
2036 if (ksession
!= NULL
) {
2037 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2038 if (ret
!= LTTNG_OK
) {
2043 /* Flag session that trace should start automatically */
2046 * Even though the start trace might fail, flag this session active so
2047 * other application coming in are started by default.
2051 ret
= ust_app_start_trace_all(usess
);
2053 ret
= LTTNG_ERR_UST_START_FAIL
;
2058 /* Flag this after a successful start. */
2059 session
->has_been_started
= 1;
2060 session
->active
= 1;
2069 * Command LTTNG_STOP_TRACE processed by the client thread.
2071 int cmd_stop_trace(struct ltt_session
*session
)
2074 struct ltt_kernel_channel
*kchan
;
2075 struct ltt_kernel_session
*ksession
;
2076 struct ltt_ust_session
*usess
;
2081 ksession
= session
->kernel_session
;
2082 usess
= session
->ust_session
;
2084 /* Session is not active. Skip everythong and inform the client. */
2085 if (!session
->active
) {
2086 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2091 if (ksession
&& ksession
->active
) {
2092 DBG("Stop kernel tracing");
2094 /* Flush metadata if exist */
2095 if (ksession
->metadata_stream_fd
>= 0) {
2096 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2098 ERR("Kernel metadata flush failed");
2102 /* Flush all buffers before stopping */
2103 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2104 ret
= kernel_flush_buffer(kchan
);
2106 ERR("Kernel flush buffer error");
2110 ret
= kernel_stop_session(ksession
);
2112 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2116 kernel_wait_quiescent(kernel_tracer_fd
);
2118 ksession
->active
= 0;
2121 if (usess
&& usess
->active
) {
2123 * Even though the stop trace might fail, flag this session inactive so
2124 * other application coming in are not started by default.
2128 ret
= ust_app_stop_trace_all(usess
);
2130 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2135 /* Flag inactive after a successful stop. */
2136 session
->active
= 0;
2144 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2146 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2147 struct lttng_uri
*uris
)
2150 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2151 struct ltt_ust_session
*usess
= session
->ust_session
;
2157 /* Can't set consumer URI if the session is active. */
2158 if (session
->active
) {
2159 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2163 /* Set the "global" consumer URIs */
2164 for (i
= 0; i
< nb_uri
; i
++) {
2165 ret
= add_uri_to_consumer(session
->consumer
,
2166 &uris
[i
], 0, session
->name
);
2167 if (ret
!= LTTNG_OK
) {
2172 /* Set UST session URIs */
2173 if (session
->ust_session
) {
2174 for (i
= 0; i
< nb_uri
; i
++) {
2175 ret
= add_uri_to_consumer(
2176 session
->ust_session
->consumer
,
2177 &uris
[i
], LTTNG_DOMAIN_UST
,
2179 if (ret
!= LTTNG_OK
) {
2185 /* Set kernel session URIs */
2186 if (session
->kernel_session
) {
2187 for (i
= 0; i
< nb_uri
; i
++) {
2188 ret
= add_uri_to_consumer(
2189 session
->kernel_session
->consumer
,
2190 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2192 if (ret
!= LTTNG_OK
) {
2199 * Make sure to set the session in output mode after we set URI since a
2200 * session can be created without URL (thus flagged in no output mode).
2202 session
->output_traces
= 1;
2204 ksess
->output_traces
= 1;
2208 usess
->output_traces
= 1;
2219 * Command LTTNG_CREATE_SESSION processed by the client thread.
2221 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2222 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2225 struct ltt_session
*session
;
2231 * Verify if the session already exist
2233 * XXX: There is no need for the session lock list here since the caller
2234 * (process_client_msg) is holding it. We might want to change that so a
2235 * single command does not lock the entire session list.
2237 session
= session_find_by_name(name
);
2238 if (session
!= NULL
) {
2239 ret
= LTTNG_ERR_EXIST_SESS
;
2243 /* Create tracing session in the registry */
2244 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2245 LTTNG_SOCK_GET_GID_CRED(creds
));
2246 if (ret
!= LTTNG_OK
) {
2251 * Get the newly created session pointer back
2253 * XXX: There is no need for the session lock list here since the caller
2254 * (process_client_msg) is holding it. We might want to change that so a
2255 * single command does not lock the entire session list.
2257 session
= session_find_by_name(name
);
2260 session
->live_timer
= live_timer
;
2261 /* Create default consumer output for the session not yet created. */
2262 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2263 if (session
->consumer
== NULL
) {
2264 ret
= LTTNG_ERR_FATAL
;
2265 goto consumer_error
;
2269 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2270 if (ret
!= LTTNG_OK
) {
2271 goto consumer_error
;
2273 session
->output_traces
= 1;
2275 session
->output_traces
= 0;
2276 DBG2("Session %s created with no output", session
->name
);
2279 session
->consumer
->enabled
= 1;
2284 session_destroy(session
);
2291 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2293 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2294 size_t nb_uri
, lttng_sock_cred
*creds
)
2297 struct ltt_session
*session
;
2298 struct snapshot_output
*new_output
= NULL
;
2304 * Create session in no output mode with URIs set to NULL. The uris we've
2305 * received are for a default snapshot output if one.
2307 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2308 if (ret
!= LTTNG_OK
) {
2312 /* Get the newly created session pointer back. This should NEVER fail. */
2313 session
= session_find_by_name(name
);
2316 /* Flag session for snapshot mode. */
2317 session
->snapshot_mode
= 1;
2319 /* Skip snapshot output creation if no URI is given. */
2324 new_output
= snapshot_output_alloc();
2326 ret
= LTTNG_ERR_NOMEM
;
2327 goto error_snapshot_alloc
;
2330 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2331 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2333 if (ret
== -ENOMEM
) {
2334 ret
= LTTNG_ERR_NOMEM
;
2336 ret
= LTTNG_ERR_INVALID
;
2338 goto error_snapshot
;
2342 snapshot_add_output(&session
->snapshot
, new_output
);
2349 snapshot_output_destroy(new_output
);
2350 error_snapshot_alloc
:
2351 session_destroy(session
);
2357 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2359 * Called with session lock held.
2361 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2364 struct ltt_ust_session
*usess
;
2365 struct ltt_kernel_session
*ksess
;
2370 usess
= session
->ust_session
;
2371 ksess
= session
->kernel_session
;
2373 /* Clean kernel session teardown */
2374 kernel_destroy_session(ksess
);
2376 /* UST session teardown */
2378 /* Close any relayd session */
2379 consumer_output_send_destroy_relayd(usess
->consumer
);
2381 /* Destroy every UST application related to this session. */
2382 ret
= ust_app_destroy_trace_all(usess
);
2384 ERR("Error in ust_app_destroy_trace_all");
2387 /* Clean up the rest. */
2388 trace_ust_destroy_session(usess
);
2392 * Must notify the kernel thread here to update it's poll set in order to
2393 * remove the channel(s)' fd just destroyed.
2395 ret
= notify_thread_pipe(wpipe
);
2397 PERROR("write kernel poll pipe");
2400 ret
= session_destroy(session
);
2406 * Command LTTNG_CALIBRATE processed by the client thread.
2408 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2413 case LTTNG_DOMAIN_KERNEL
:
2415 struct lttng_kernel_calibrate kcalibrate
;
2417 switch (calibrate
->type
) {
2418 case LTTNG_CALIBRATE_FUNCTION
:
2420 /* Default and only possible calibrate option. */
2421 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2425 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2427 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2432 case LTTNG_DOMAIN_UST
:
2434 struct lttng_ust_calibrate ucalibrate
;
2436 switch (calibrate
->type
) {
2437 case LTTNG_CALIBRATE_FUNCTION
:
2439 /* Default and only possible calibrate option. */
2440 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2444 ret
= ust_app_calibrate_glb(&ucalibrate
);
2446 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2452 ret
= LTTNG_ERR_UND
;
2463 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2465 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2466 const char *sock_path
, struct consumer_data
*cdata
)
2469 struct consumer_socket
*socket
= NULL
;
2476 case LTTNG_DOMAIN_KERNEL
:
2478 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2482 /* Can't register a consumer if there is already one */
2483 if (ksess
->consumer_fds_sent
!= 0) {
2484 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2488 sock
= lttcomm_connect_unix_sock(sock_path
);
2490 ret
= LTTNG_ERR_CONNECT_FAIL
;
2493 cdata
->cmd_sock
= sock
;
2495 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2496 if (socket
== NULL
) {
2499 PERROR("close register consumer");
2501 cdata
->cmd_sock
= -1;
2502 ret
= LTTNG_ERR_FATAL
;
2506 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2507 if (socket
->lock
== NULL
) {
2508 PERROR("zmalloc pthread mutex");
2509 ret
= LTTNG_ERR_FATAL
;
2512 pthread_mutex_init(socket
->lock
, NULL
);
2513 socket
->registered
= 1;
2516 consumer_add_socket(socket
, ksess
->consumer
);
2519 pthread_mutex_lock(&cdata
->pid_mutex
);
2521 pthread_mutex_unlock(&cdata
->pid_mutex
);
2526 /* TODO: Userspace tracing */
2527 ret
= LTTNG_ERR_UND
;
2535 consumer_destroy_socket(socket
);
2541 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2543 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2544 struct lttng_domain
**domains
)
2549 struct lttng_ht_iter iter
;
2551 if (session
->kernel_session
!= NULL
) {
2552 DBG3("Listing domains found kernel domain");
2556 if (session
->ust_session
!= NULL
) {
2557 DBG3("Listing domains found UST global domain");
2561 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2563 if (agt
->being_used
) {
2574 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2575 if (*domains
== NULL
) {
2576 ret
= LTTNG_ERR_FATAL
;
2580 if (session
->kernel_session
!= NULL
) {
2581 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2583 /* Kernel session buffer type is always GLOBAL */
2584 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2589 if (session
->ust_session
!= NULL
) {
2590 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2591 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2595 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2597 if (agt
->being_used
) {
2598 (*domains
)[index
].type
= agt
->domain
;
2599 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2609 /* Return negative value to differentiate return code */
2615 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2617 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2618 struct lttng_channel
**channels
)
2621 ssize_t nb_chan
= 0;
2624 case LTTNG_DOMAIN_KERNEL
:
2625 if (session
->kernel_session
!= NULL
) {
2626 nb_chan
= session
->kernel_session
->channel_count
;
2628 DBG3("Number of kernel channels %zd", nb_chan
);
2630 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2633 case LTTNG_DOMAIN_UST
:
2634 if (session
->ust_session
!= NULL
) {
2636 nb_chan
= lttng_ht_get_count(
2637 session
->ust_session
->domain_global
.channels
);
2640 DBG3("Number of UST global channels %zd", nb_chan
);
2642 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2647 ret
= LTTNG_ERR_UND
;
2652 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2653 if (*channels
== NULL
) {
2654 ret
= LTTNG_ERR_FATAL
;
2658 list_lttng_channels(domain
, session
, *channels
);
2664 /* Return negative value to differentiate return code */
2669 * Command LTTNG_LIST_EVENTS processed by the client thread.
2671 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2672 char *channel_name
, struct lttng_event
**events
)
2675 ssize_t nb_event
= 0;
2678 case LTTNG_DOMAIN_KERNEL
:
2679 if (session
->kernel_session
!= NULL
) {
2680 nb_event
= list_lttng_kernel_events(channel_name
,
2681 session
->kernel_session
, events
);
2684 case LTTNG_DOMAIN_UST
:
2686 if (session
->ust_session
!= NULL
) {
2687 nb_event
= list_lttng_ust_global_events(channel_name
,
2688 &session
->ust_session
->domain_global
, events
);
2692 case LTTNG_DOMAIN_LOG4J
:
2693 case LTTNG_DOMAIN_JUL
:
2694 case LTTNG_DOMAIN_PYTHON
:
2695 if (session
->ust_session
) {
2696 struct lttng_ht_iter iter
;
2700 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2701 &iter
.iter
, agt
, node
.node
) {
2702 nb_event
= list_lttng_agent_events(agt
, events
);
2708 ret
= LTTNG_ERR_UND
;
2715 /* Return negative value to differentiate return code */
2720 * Using the session list, filled a lttng_session array to send back to the
2721 * client for session listing.
2723 * The session list lock MUST be acquired before calling this function. Use
2724 * session_lock_list() and session_unlock_list().
2726 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2731 struct ltt_session
*session
;
2732 struct ltt_session_list
*list
= session_get_list();
2734 DBG("Getting all available session for UID %d GID %d",
2737 * Iterate over session list and append data after the control struct in
2740 cds_list_for_each_entry(session
, &list
->head
, list
) {
2742 * Only list the sessions the user can control.
2744 if (!session_access_ok(session
, uid
, gid
)) {
2748 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2749 struct ltt_ust_session
*usess
= session
->ust_session
;
2751 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2752 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2753 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2754 ret
= build_network_session_path(sessions
[i
].path
,
2755 sizeof(sessions
[i
].path
), session
);
2757 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2758 session
->consumer
->dst
.trace_path
);
2761 PERROR("snprintf session path");
2765 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2766 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2767 sessions
[i
].enabled
= session
->active
;
2768 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2769 sessions
[i
].live_timer_interval
= session
->live_timer
;
2775 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2776 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2778 int cmd_data_pending(struct ltt_session
*session
)
2781 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2782 struct ltt_ust_session
*usess
= session
->ust_session
;
2786 /* Session MUST be stopped to ask for data availability. */
2787 if (session
->active
) {
2788 ret
= LTTNG_ERR_SESSION_STARTED
;
2792 * If stopped, just make sure we've started before else the above call
2793 * will always send that there is data pending.
2795 * The consumer assumes that when the data pending command is received,
2796 * the trace has been started before or else no output data is written
2797 * by the streams which is a condition for data pending. So, this is
2798 * *VERY* important that we don't ask the consumer before a start
2801 if (!session
->has_been_started
) {
2807 if (ksess
&& ksess
->consumer
) {
2808 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2810 /* Data is still being extracted for the kernel. */
2815 if (usess
&& usess
->consumer
) {
2816 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2818 /* Data is still being extracted for the kernel. */
2823 /* Data is ready to be read by a viewer */
2831 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2833 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2835 int cmd_snapshot_add_output(struct ltt_session
*session
,
2836 struct lttng_snapshot_output
*output
, uint32_t *id
)
2839 struct snapshot_output
*new_output
;
2844 DBG("Cmd snapshot add output for session %s", session
->name
);
2847 * Permission denied to create an output if the session is not
2848 * set in no output mode.
2850 if (session
->output_traces
) {
2851 ret
= LTTNG_ERR_EPERM
;
2855 /* Only one output is allowed until we have the "tee" feature. */
2856 if (session
->snapshot
.nb_output
== 1) {
2857 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2861 new_output
= snapshot_output_alloc();
2863 ret
= LTTNG_ERR_NOMEM
;
2867 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2868 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2869 &session
->snapshot
);
2871 if (ret
== -ENOMEM
) {
2872 ret
= LTTNG_ERR_NOMEM
;
2874 ret
= LTTNG_ERR_INVALID
;
2880 snapshot_add_output(&session
->snapshot
, new_output
);
2882 *id
= new_output
->id
;
2889 snapshot_output_destroy(new_output
);
2895 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2897 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2899 int cmd_snapshot_del_output(struct ltt_session
*session
,
2900 struct lttng_snapshot_output
*output
)
2903 struct snapshot_output
*sout
= NULL
;
2911 * Permission denied to create an output if the session is not
2912 * set in no output mode.
2914 if (session
->output_traces
) {
2915 ret
= LTTNG_ERR_EPERM
;
2920 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2922 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2923 } else if (*output
->name
!= '\0') {
2924 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2926 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2929 ret
= LTTNG_ERR_INVALID
;
2933 snapshot_delete_output(&session
->snapshot
, sout
);
2934 snapshot_output_destroy(sout
);
2943 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2945 * If no output is available, outputs is untouched and 0 is returned.
2947 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2949 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2950 struct lttng_snapshot_output
**outputs
)
2953 struct lttng_snapshot_output
*list
= NULL
;
2954 struct lttng_ht_iter iter
;
2955 struct snapshot_output
*output
;
2960 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2963 * Permission denied to create an output if the session is not
2964 * set in no output mode.
2966 if (session
->output_traces
) {
2967 ret
= -LTTNG_ERR_EPERM
;
2971 if (session
->snapshot
.nb_output
== 0) {
2976 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2978 ret
= -LTTNG_ERR_NOMEM
;
2982 /* Copy list from session to the new list object. */
2984 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2985 output
, node
.node
) {
2986 assert(output
->consumer
);
2987 list
[idx
].id
= output
->id
;
2988 list
[idx
].max_size
= output
->max_size
;
2989 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2990 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2991 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2992 sizeof(list
[idx
].ctrl_url
));
2995 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2996 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2998 ret
= -LTTNG_ERR_NOMEM
;
3003 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3004 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3006 ret
= -LTTNG_ERR_NOMEM
;
3015 ret
= session
->snapshot
.nb_output
;
3023 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3024 * snapshot output is *not* set with a remote destination.
3026 * Return 0 on success or a LTTNG_ERR code.
3028 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3029 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3032 struct lttng_ht_iter iter
;
3033 struct consumer_socket
*socket
;
3036 assert(snap_output
);
3039 DBG2("Set relayd object from snapshot output");
3041 /* Ignore if snapshot consumer output is not network. */
3042 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3047 * For each consumer socket, create and send the relayd object of the
3051 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3052 socket
, node
.node
) {
3053 ret
= send_consumer_relayd_sockets(0, session
->id
,
3054 snap_output
->consumer
, socket
,
3055 session
->name
, session
->hostname
,
3056 session
->live_timer
);
3057 if (ret
!= LTTNG_OK
) {
3069 * Record a kernel snapshot.
3071 * Return LTTNG_OK on success or a LTTNG_ERR code.
3073 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3074 struct snapshot_output
*output
, struct ltt_session
*session
,
3075 int wait
, uint64_t nb_packets_per_stream
)
3083 /* Get the datetime for the snapshot output directory. */
3084 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3085 sizeof(output
->datetime
));
3087 ret
= LTTNG_ERR_INVALID
;
3092 * Copy kernel session sockets so we can communicate with the right
3093 * consumer for the snapshot record command.
3095 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3097 ret
= LTTNG_ERR_NOMEM
;
3101 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3102 if (ret
!= LTTNG_OK
) {
3103 goto error_snapshot
;
3106 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3107 if (ret
!= LTTNG_OK
) {
3108 goto error_snapshot
;
3115 /* Clean up copied sockets so this output can use some other later on. */
3116 consumer_destroy_output_sockets(output
->consumer
);
3123 * Record a UST snapshot.
3125 * Return 0 on success or a LTTNG_ERR error code.
3127 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3128 struct snapshot_output
*output
, struct ltt_session
*session
,
3129 int wait
, uint64_t nb_packets_per_stream
)
3137 /* Get the datetime for the snapshot output directory. */
3138 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3139 sizeof(output
->datetime
));
3141 ret
= LTTNG_ERR_INVALID
;
3146 * Copy UST session sockets so we can communicate with the right
3147 * consumer for the snapshot record command.
3149 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3151 ret
= LTTNG_ERR_NOMEM
;
3155 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3156 if (ret
!= LTTNG_OK
) {
3157 goto error_snapshot
;
3160 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3164 ret
= LTTNG_ERR_INVALID
;
3167 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3170 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3173 goto error_snapshot
;
3179 /* Clean up copied sockets so this output can use some other later on. */
3180 consumer_destroy_output_sockets(output
->consumer
);
3186 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3187 uint64_t cur_nr_packets
)
3189 uint64_t tot_size
= 0;
3191 if (session
->kernel_session
) {
3192 struct ltt_kernel_channel
*chan
;
3193 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3195 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3196 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3198 * Don't take channel into account if we
3199 * already grab all its packets.
3203 tot_size
+= chan
->channel
->attr
.subbuf_size
3204 * chan
->stream_count
;
3208 if (session
->ust_session
) {
3209 struct ltt_ust_session
*usess
= session
->ust_session
;
3211 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3219 * Calculate the number of packets we can grab from each stream that
3220 * fits within the overall snapshot max size.
3222 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3223 * the number of packets per stream.
3225 * TODO: this approach is not perfect: we consider the worse case
3226 * (packet filling the sub-buffers) as an upper bound, but we could do
3227 * better if we do this calculation while we actually grab the packet
3228 * content: we would know how much padding we don't actually store into
3231 * This algorithm is currently bounded by the number of packets per
3234 * Since we call this algorithm before actually grabbing the data, it's
3235 * an approximation: for instance, applications could appear/disappear
3236 * in between this call and actually grabbing data.
3239 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3242 uint64_t cur_nb_packets
= 0;
3245 return 0; /* Infinite */
3248 size_left
= max_size
;
3250 uint64_t one_more_packet_tot_size
;
3252 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3254 if (!one_more_packet_tot_size
) {
3255 /* We are already grabbing all packets. */
3258 size_left
-= one_more_packet_tot_size
;
3259 if (size_left
< 0) {
3264 if (!cur_nb_packets
) {
3265 /* Not enough room to grab one packet of each stream, error. */
3268 return cur_nb_packets
;
3272 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3274 * The wait parameter is ignored so this call always wait for the snapshot to
3275 * complete before returning.
3277 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3279 int cmd_snapshot_record(struct ltt_session
*session
,
3280 struct lttng_snapshot_output
*output
, int wait
)
3283 unsigned int use_tmp_output
= 0;
3284 struct snapshot_output tmp_output
;
3285 unsigned int snapshot_success
= 0;
3290 DBG("Cmd snapshot record for session %s", session
->name
);
3293 * Permission denied to create an output if the session is not
3294 * set in no output mode.
3296 if (session
->output_traces
) {
3297 ret
= LTTNG_ERR_EPERM
;
3301 /* The session needs to be started at least once. */
3302 if (!session
->has_been_started
) {
3303 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3307 /* Use temporary output for the session. */
3308 if (*output
->ctrl_url
!= '\0') {
3309 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3310 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3313 if (ret
== -ENOMEM
) {
3314 ret
= LTTNG_ERR_NOMEM
;
3316 ret
= LTTNG_ERR_INVALID
;
3320 /* Use the global session count for the temporary snapshot. */
3321 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3325 if (session
->kernel_session
) {
3326 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3328 if (use_tmp_output
) {
3329 int64_t nb_packets_per_stream
;
3331 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3332 tmp_output
.max_size
);
3333 if (nb_packets_per_stream
< 0) {
3334 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3337 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3338 wait
, nb_packets_per_stream
);
3339 if (ret
!= LTTNG_OK
) {
3342 snapshot_success
= 1;
3344 struct snapshot_output
*sout
;
3345 struct lttng_ht_iter iter
;
3348 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3349 &iter
.iter
, sout
, node
.node
) {
3350 int64_t nb_packets_per_stream
;
3353 * Make a local copy of the output and assign the possible
3354 * temporary value given by the caller.
3356 memset(&tmp_output
, 0, sizeof(tmp_output
));
3357 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3359 if (output
->max_size
!= (uint64_t) -1ULL) {
3360 tmp_output
.max_size
= output
->max_size
;
3363 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3364 tmp_output
.max_size
);
3365 if (nb_packets_per_stream
< 0) {
3366 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3370 /* Use temporary name. */
3371 if (*output
->name
!= '\0') {
3372 strncpy(tmp_output
.name
, output
->name
,
3373 sizeof(tmp_output
.name
));
3376 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3378 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3379 session
, wait
, nb_packets_per_stream
);
3380 if (ret
!= LTTNG_OK
) {
3384 snapshot_success
= 1;
3390 if (session
->ust_session
) {
3391 struct ltt_ust_session
*usess
= session
->ust_session
;
3393 if (use_tmp_output
) {
3394 int64_t nb_packets_per_stream
;
3396 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3397 tmp_output
.max_size
);
3398 if (nb_packets_per_stream
< 0) {
3399 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3402 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3403 wait
, nb_packets_per_stream
);
3404 if (ret
!= LTTNG_OK
) {
3407 snapshot_success
= 1;
3409 struct snapshot_output
*sout
;
3410 struct lttng_ht_iter iter
;
3413 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3414 &iter
.iter
, sout
, node
.node
) {
3415 int64_t nb_packets_per_stream
;
3418 * Make a local copy of the output and assign the possible
3419 * temporary value given by the caller.
3421 memset(&tmp_output
, 0, sizeof(tmp_output
));
3422 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3424 if (output
->max_size
!= (uint64_t) -1ULL) {
3425 tmp_output
.max_size
= output
->max_size
;
3428 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3429 tmp_output
.max_size
);
3430 if (nb_packets_per_stream
< 0) {
3431 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3436 /* Use temporary name. */
3437 if (*output
->name
!= '\0') {
3438 strncpy(tmp_output
.name
, output
->name
,
3439 sizeof(tmp_output
.name
));
3442 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3444 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3445 wait
, nb_packets_per_stream
);
3446 if (ret
!= LTTNG_OK
) {
3450 snapshot_success
= 1;
3456 if (snapshot_success
) {
3457 session
->snapshot
.nb_snapshot
++;
3459 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3467 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3469 int cmd_set_session_shm_path(struct ltt_session
*session
,
3470 const char *shm_path
)
3476 * Can only set shm path before session is started.
3478 if (session
->has_been_started
) {
3479 return LTTNG_ERR_SESSION_STARTED
;
3482 strncpy(session
->shm_path
, shm_path
,
3483 sizeof(session
->shm_path
));
3484 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3490 * Init command subsystem.
3495 * Set network sequence index to 1 for streams to match a relayd
3496 * socket on the consumer side.
3498 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3499 relayd_net_seq_idx
= 1;
3500 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3502 DBG("Command subsystem initialized");