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
;
382 (*events
)[i
].filter
=
383 (unsigned char) !!event
->filter_expression
;
385 switch (event
->event
->instrumentation
) {
386 case LTTNG_KERNEL_TRACEPOINT
:
387 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
389 case LTTNG_KERNEL_KRETPROBE
:
390 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
391 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
392 sizeof(struct lttng_kernel_kprobe
));
394 case LTTNG_KERNEL_KPROBE
:
395 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
396 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
397 sizeof(struct lttng_kernel_kprobe
));
399 case LTTNG_KERNEL_FUNCTION
:
400 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
401 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
402 sizeof(struct lttng_kernel_function
));
404 case LTTNG_KERNEL_NOOP
:
405 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
407 case LTTNG_KERNEL_SYSCALL
:
408 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
410 case LTTNG_KERNEL_ALL
:
421 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
433 /* Negate the error code to differentiate the size from an error */
438 * Add URI so the consumer output object. Set the correct path depending on the
439 * domain adding the default trace directory.
441 static int add_uri_to_consumer(struct consumer_output
*consumer
,
442 struct lttng_uri
*uri
, int domain
, const char *session_name
)
445 const char *default_trace_dir
;
449 if (consumer
== NULL
) {
450 DBG("No consumer detected. Don't add URI. Stopping.");
451 ret
= LTTNG_ERR_NO_CONSUMER
;
456 case LTTNG_DOMAIN_KERNEL
:
457 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
459 case LTTNG_DOMAIN_UST
:
460 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
464 * This case is possible is we try to add the URI to the global tracing
465 * session consumer object which in this case there is no subdir.
467 default_trace_dir
= "";
470 switch (uri
->dtype
) {
473 DBG2("Setting network URI to consumer");
475 if (consumer
->type
== CONSUMER_DST_NET
) {
476 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
477 consumer
->dst
.net
.control_isset
) ||
478 (uri
->stype
== LTTNG_STREAM_DATA
&&
479 consumer
->dst
.net
.data_isset
)) {
480 ret
= LTTNG_ERR_URL_EXIST
;
484 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
487 consumer
->type
= CONSUMER_DST_NET
;
489 /* Set URI into consumer output object */
490 ret
= consumer_set_network_uri(consumer
, uri
);
494 } else if (ret
== 1) {
496 * URI was the same in the consumer so we do not append the subdir
497 * again so to not duplicate output dir.
503 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
504 ret
= consumer_set_subdir(consumer
, session_name
);
506 ret
= LTTNG_ERR_FATAL
;
511 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
512 /* On a new subdir, reappend the default trace dir. */
513 strncat(consumer
->subdir
, default_trace_dir
,
514 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
515 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
520 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
521 memset(consumer
->dst
.trace_path
, 0,
522 sizeof(consumer
->dst
.trace_path
));
523 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
524 sizeof(consumer
->dst
.trace_path
));
525 /* Append default trace dir */
526 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
527 sizeof(consumer
->dst
.trace_path
) -
528 strlen(consumer
->dst
.trace_path
) - 1);
529 /* Flag consumer as local. */
530 consumer
->type
= CONSUMER_DST_LOCAL
;
541 * Init tracing by creating trace directory and sending fds kernel consumer.
543 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
546 struct lttng_ht_iter iter
;
547 struct consumer_socket
*socket
;
553 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
554 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
556 pthread_mutex_lock(socket
->lock
);
557 ret
= kernel_consumer_send_session(socket
, session
);
558 pthread_mutex_unlock(socket
->lock
);
560 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
572 * Create a socket to the relayd using the URI.
574 * On success, the relayd_sock pointer is set to the created socket.
575 * Else, it's stays untouched and a lttcomm error code is returned.
577 static int create_connect_relayd(struct lttng_uri
*uri
,
578 struct lttcomm_relayd_sock
**relayd_sock
)
581 struct lttcomm_relayd_sock
*rsock
;
583 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
584 RELAYD_VERSION_COMM_MINOR
);
586 ret
= LTTNG_ERR_FATAL
;
591 * Connect to relayd so we can proceed with a session creation. This call
592 * can possibly block for an arbitrary amount of time to set the health
593 * state to be in poll execution.
596 ret
= relayd_connect(rsock
);
599 ERR("Unable to reach lttng-relayd");
600 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
604 /* Create socket for control stream. */
605 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
606 DBG3("Creating relayd stream socket from URI");
608 /* Check relayd version */
609 ret
= relayd_version_check(rsock
);
611 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
614 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
615 DBG3("Creating relayd data socket from URI");
617 /* Command is not valid */
618 ERR("Relayd invalid stream type: %d", uri
->stype
);
619 ret
= LTTNG_ERR_INVALID
;
623 *relayd_sock
= rsock
;
628 /* The returned value is not useful since we are on an error path. */
629 (void) relayd_close(rsock
);
637 * Connect to the relayd using URI and send the socket to the right consumer.
639 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
640 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
641 struct consumer_socket
*consumer_sock
,
642 char *session_name
, char *hostname
, int session_live_timer
)
645 struct lttcomm_relayd_sock
*rsock
= NULL
;
647 /* Connect to relayd and make version check if uri is the control. */
648 ret
= create_connect_relayd(relayd_uri
, &rsock
);
649 if (ret
!= LTTNG_OK
) {
654 /* Set the network sequence index if not set. */
655 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
656 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
658 * Increment net_seq_idx because we are about to transfer the
659 * new relayd socket to the consumer.
660 * Assign unique key so the consumer can match streams.
662 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
663 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
666 /* Send relayd socket to consumer. */
667 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
668 relayd_uri
->stype
, session_id
,
669 session_name
, hostname
, session_live_timer
);
671 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
675 /* Flag that the corresponding socket was sent. */
676 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
677 consumer_sock
->control_sock_sent
= 1;
678 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
679 consumer_sock
->data_sock_sent
= 1;
685 * Close socket which was dup on the consumer side. The session daemon does
686 * NOT keep track of the relayd socket(s) once transfer to the consumer.
690 (void) relayd_close(rsock
);
694 if (ret
!= LTTNG_OK
) {
696 * The consumer output for this session should not be used anymore
697 * since the relayd connection failed thus making any tracing or/and
698 * streaming not usable.
700 consumer
->enabled
= 0;
706 * Send both relayd sockets to a specific consumer and domain. This is a
707 * helper function to facilitate sending the information to the consumer for a
710 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
711 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
712 char *session_name
, char *hostname
, int session_live_timer
)
719 /* Sending control relayd socket. */
720 if (!sock
->control_sock_sent
) {
721 ret
= send_consumer_relayd_socket(domain
, session_id
,
722 &consumer
->dst
.net
.control
, consumer
, sock
,
723 session_name
, hostname
, session_live_timer
);
724 if (ret
!= LTTNG_OK
) {
729 /* Sending data relayd socket. */
730 if (!sock
->data_sock_sent
) {
731 ret
= send_consumer_relayd_socket(domain
, session_id
,
732 &consumer
->dst
.net
.data
, consumer
, sock
,
733 session_name
, hostname
, session_live_timer
);
734 if (ret
!= LTTNG_OK
) {
744 * Setup relayd connections for a tracing session. First creates the socket to
745 * the relayd and send them to the right domain consumer. Consumer type MUST be
748 int cmd_setup_relayd(struct ltt_session
*session
)
751 struct ltt_ust_session
*usess
;
752 struct ltt_kernel_session
*ksess
;
753 struct consumer_socket
*socket
;
754 struct lttng_ht_iter iter
;
758 usess
= session
->ust_session
;
759 ksess
= session
->kernel_session
;
761 DBG("Setting relayd for session %s", session
->name
);
765 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
766 && usess
->consumer
->enabled
) {
767 /* For each consumer socket, send relayd sockets */
768 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
770 pthread_mutex_lock(socket
->lock
);
771 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
772 usess
->consumer
, socket
,
773 session
->name
, session
->hostname
,
774 session
->live_timer
);
775 pthread_mutex_unlock(socket
->lock
);
776 if (ret
!= LTTNG_OK
) {
779 /* Session is now ready for network streaming. */
780 session
->net_handle
= 1;
784 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
785 && ksess
->consumer
->enabled
) {
786 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
788 pthread_mutex_lock(socket
->lock
);
789 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
790 ksess
->consumer
, socket
,
791 session
->name
, session
->hostname
,
792 session
->live_timer
);
793 pthread_mutex_unlock(socket
->lock
);
794 if (ret
!= LTTNG_OK
) {
797 /* Session is now ready for network streaming. */
798 session
->net_handle
= 1;
808 * Start a kernel session by opening all necessary streams.
810 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
813 struct ltt_kernel_channel
*kchan
;
815 /* Open kernel metadata */
816 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
817 ret
= kernel_open_metadata(ksess
);
819 ret
= LTTNG_ERR_KERN_META_FAIL
;
824 /* Open kernel metadata stream */
825 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
826 ret
= kernel_open_metadata_stream(ksess
);
828 ERR("Kernel create metadata stream failed");
829 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
834 /* For each channel */
835 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
836 if (kchan
->stream_count
== 0) {
837 ret
= kernel_open_channel_stream(kchan
);
839 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
842 /* Update the stream global counter */
843 ksess
->stream_count_global
+= ret
;
847 /* Setup kernel consumer socket and send fds to it */
848 ret
= init_kernel_tracing(ksess
);
850 ret
= LTTNG_ERR_KERN_START_FAIL
;
854 /* This start the kernel tracing */
855 ret
= kernel_start_session(ksess
);
857 ret
= LTTNG_ERR_KERN_START_FAIL
;
861 /* Quiescent wait after starting trace */
862 kernel_wait_quiescent(kernel_tracer_fd
);
873 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
875 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
879 struct ltt_ust_session
*usess
;
881 usess
= session
->ust_session
;
886 case LTTNG_DOMAIN_KERNEL
:
888 ret
= channel_kernel_disable(session
->kernel_session
,
890 if (ret
!= LTTNG_OK
) {
894 kernel_wait_quiescent(kernel_tracer_fd
);
897 case LTTNG_DOMAIN_UST
:
899 struct ltt_ust_channel
*uchan
;
900 struct lttng_ht
*chan_ht
;
902 chan_ht
= usess
->domain_global
.channels
;
904 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
906 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
910 ret
= channel_ust_disable(usess
, uchan
);
911 if (ret
!= LTTNG_OK
) {
917 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
929 * Command LTTNG_TRACK_PID processed by the client thread.
931 * Called with session lock held.
933 int cmd_track_pid(struct ltt_session
*session
, int domain
, int pid
)
940 case LTTNG_DOMAIN_KERNEL
:
942 struct ltt_kernel_session
*ksess
;
944 ksess
= session
->kernel_session
;
946 ret
= kernel_track_pid(ksess
, pid
);
947 if (ret
!= LTTNG_OK
) {
951 kernel_wait_quiescent(kernel_tracer_fd
);
954 case LTTNG_DOMAIN_UST
:
956 struct ltt_ust_session
*usess
;
958 usess
= session
->ust_session
;
960 ret
= trace_ust_track_pid(usess
, pid
);
961 if (ret
!= LTTNG_OK
) {
967 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
979 * Command LTTNG_UNTRACK_PID processed by the client thread.
981 * Called with session lock held.
983 int cmd_untrack_pid(struct ltt_session
*session
, int domain
, int pid
)
990 case LTTNG_DOMAIN_KERNEL
:
992 struct ltt_kernel_session
*ksess
;
994 ksess
= session
->kernel_session
;
996 ret
= kernel_untrack_pid(ksess
, pid
);
997 if (ret
!= LTTNG_OK
) {
1001 kernel_wait_quiescent(kernel_tracer_fd
);
1004 case LTTNG_DOMAIN_UST
:
1006 struct ltt_ust_session
*usess
;
1008 usess
= session
->ust_session
;
1010 ret
= trace_ust_untrack_pid(usess
, pid
);
1011 if (ret
!= LTTNG_OK
) {
1017 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1029 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1031 * The wpipe arguments is used as a notifier for the kernel thread.
1033 int cmd_enable_channel(struct ltt_session
*session
,
1034 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1037 struct ltt_ust_session
*usess
= session
->ust_session
;
1038 struct lttng_ht
*chan_ht
;
1045 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1047 /* Validate channel name */
1048 if (attr
->name
[0] == '.' ||
1049 memchr(attr
->name
, '/', len
) != NULL
) {
1050 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1054 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1059 * Don't try to enable a channel if the session has been started at
1060 * some point in time before. The tracer does not allow it.
1062 if (session
->has_been_started
) {
1063 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1068 * If the session is a live session, remove the switch timer, the
1069 * live timer does the same thing but sends also synchronisation
1070 * beacons for inactive streams.
1072 if (session
->live_timer
> 0) {
1073 attr
->attr
.live_timer_interval
= session
->live_timer
;
1074 attr
->attr
.switch_timer_interval
= 0;
1078 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1079 * mode and with less than 2 subbuf so block it right away and send back an
1080 * invalid attribute error.
1082 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1083 ret
= LTTNG_ERR_INVALID
;
1087 switch (domain
->type
) {
1088 case LTTNG_DOMAIN_KERNEL
:
1090 struct ltt_kernel_channel
*kchan
;
1092 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1093 session
->kernel_session
);
1094 if (kchan
== NULL
) {
1095 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1096 if (attr
->name
[0] != '\0') {
1097 session
->kernel_session
->has_non_default_channel
= 1;
1100 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1103 if (ret
!= LTTNG_OK
) {
1107 kernel_wait_quiescent(kernel_tracer_fd
);
1110 case LTTNG_DOMAIN_UST
:
1112 struct ltt_ust_channel
*uchan
;
1114 chan_ht
= usess
->domain_global
.channels
;
1116 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1117 if (uchan
== NULL
) {
1118 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1119 if (attr
->name
[0] != '\0') {
1120 usess
->has_non_default_channel
= 1;
1123 ret
= channel_ust_enable(usess
, uchan
);
1128 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1139 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1141 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1143 struct lttng_event
*event
)
1148 DBG("Disable event command for event \'%s\'", event
->name
);
1150 event_name
= event
->name
;
1151 if (validate_event_name(event_name
)) {
1152 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1156 /* Error out on unhandled search criteria */
1157 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1158 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1159 ret
= LTTNG_ERR_UNK
;
1166 case LTTNG_DOMAIN_KERNEL
:
1168 struct ltt_kernel_channel
*kchan
;
1169 struct ltt_kernel_session
*ksess
;
1171 ksess
= session
->kernel_session
;
1174 * If a non-default channel has been created in the
1175 * session, explicitely require that -c chan_name needs
1178 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1179 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1183 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1184 if (kchan
== NULL
) {
1185 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1189 switch (event
->type
) {
1190 case LTTNG_EVENT_ALL
:
1191 ret
= event_kernel_disable_event_all(kchan
);
1192 if (ret
!= LTTNG_OK
) {
1196 case LTTNG_EVENT_TRACEPOINT
: /* fall-through */
1197 case LTTNG_EVENT_SYSCALL
:
1198 if (!strcmp(event_name
, "*")) {
1199 ret
= event_kernel_disable_event_type(kchan
,
1202 ret
= event_kernel_disable_event(kchan
,
1205 if (ret
!= LTTNG_OK
) {
1209 case LTTNG_EVENT_PROBE
:
1210 case LTTNG_EVENT_FUNCTION
:
1211 case LTTNG_EVENT_FUNCTION_ENTRY
:
1212 ret
= event_kernel_disable_event(kchan
, event_name
);
1213 if (ret
!= LTTNG_OK
) {
1218 ret
= LTTNG_ERR_UNK
;
1222 kernel_wait_quiescent(kernel_tracer_fd
);
1225 case LTTNG_DOMAIN_UST
:
1227 struct ltt_ust_channel
*uchan
;
1228 struct ltt_ust_session
*usess
;
1230 usess
= session
->ust_session
;
1232 if (validate_ust_event_name(event_name
)) {
1233 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1238 * If a non-default channel has been created in the
1239 * session, explicitely require that -c chan_name needs
1242 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1243 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1247 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1249 if (uchan
== NULL
) {
1250 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1254 switch (event
->type
) {
1255 case LTTNG_EVENT_ALL
:
1256 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1257 if (ret
!= LTTNG_OK
) {
1262 ret
= LTTNG_ERR_UNK
;
1266 DBG3("Disable UST event %s in channel %s completed", event_name
,
1270 case LTTNG_DOMAIN_LOG4J
:
1271 case LTTNG_DOMAIN_JUL
:
1272 case LTTNG_DOMAIN_PYTHON
:
1275 struct ltt_ust_session
*usess
= session
->ust_session
;
1279 switch (event
->type
) {
1280 case LTTNG_EVENT_ALL
:
1283 ret
= LTTNG_ERR_UNK
;
1287 agt
= trace_ust_find_agent(usess
, domain
);
1289 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1292 /* The wild card * means that everything should be disabled. */
1293 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1294 ret
= event_agent_disable_all(usess
, agt
);
1296 ret
= event_agent_disable(usess
, agt
, event_name
);
1298 if (ret
!= LTTNG_OK
) {
1305 ret
= LTTNG_ERR_UND
;
1318 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1320 int cmd_add_context(struct ltt_session
*session
, int domain
,
1321 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1323 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1326 case LTTNG_DOMAIN_KERNEL
:
1327 assert(session
->kernel_session
);
1329 if (session
->kernel_session
->channel_count
== 0) {
1330 /* Create default channel */
1331 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1332 if (ret
!= LTTNG_OK
) {
1335 chan_kern_created
= 1;
1337 /* Add kernel context to kernel tracer */
1338 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1339 if (ret
!= LTTNG_OK
) {
1343 case LTTNG_DOMAIN_UST
:
1345 struct ltt_ust_session
*usess
= session
->ust_session
;
1346 unsigned int chan_count
;
1350 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1351 if (chan_count
== 0) {
1352 struct lttng_channel
*attr
;
1353 /* Create default channel */
1354 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1356 ret
= LTTNG_ERR_FATAL
;
1360 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1361 if (ret
!= LTTNG_OK
) {
1366 chan_ust_created
= 1;
1369 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1370 if (ret
!= LTTNG_OK
) {
1376 ret
= LTTNG_ERR_UND
;
1383 if (chan_kern_created
) {
1384 struct ltt_kernel_channel
*kchan
=
1385 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1386 session
->kernel_session
);
1387 /* Created previously, this should NOT fail. */
1389 kernel_destroy_channel(kchan
);
1392 if (chan_ust_created
) {
1393 struct ltt_ust_channel
*uchan
=
1394 trace_ust_find_channel_by_name(
1395 session
->ust_session
->domain_global
.channels
,
1396 DEFAULT_CHANNEL_NAME
);
1397 /* Created previously, this should NOT fail. */
1399 /* Remove from the channel list of the session. */
1400 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1402 trace_ust_destroy_channel(uchan
);
1407 static int validate_event_name(const char *name
)
1410 const char *c
= name
;
1411 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1414 * Make sure that unescaped wildcards are only used as the last
1415 * character of the event name.
1417 while (c
< event_name_end
) {
1425 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1426 /* Wildcard is not the last character */
1427 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1439 static inline bool name_starts_with(const char *name
, const char *prefix
)
1441 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1443 return !strncmp(name
, prefix
, max_cmp_len
);
1446 /* Perform userspace-specific event name validation */
1447 static int validate_ust_event_name(const char *name
)
1457 * Check name against all internal UST event component namespaces used
1460 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1461 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1462 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1471 * Internal version of cmd_enable_event() with a supplemental
1472 * "internal_event" flag which is used to enable internal events which should
1473 * be hidden from clients. Such events are used in the agent implementation to
1474 * enable the events through which all "agent" events are funeled.
1476 static int _cmd_enable_event(struct ltt_session
*session
,
1477 struct lttng_domain
*domain
,
1478 char *channel_name
, struct lttng_event
*event
,
1479 char *filter_expression
,
1480 struct lttng_filter_bytecode
*filter
,
1481 struct lttng_event_exclusion
*exclusion
,
1482 int wpipe
, bool internal_event
)
1484 int ret
, channel_created
= 0;
1485 struct lttng_channel
*attr
;
1489 assert(channel_name
);
1491 DBG("Enable event command for event \'%s\'", event
->name
);
1493 ret
= validate_event_name(event
->name
);
1500 switch (domain
->type
) {
1501 case LTTNG_DOMAIN_KERNEL
:
1503 struct ltt_kernel_channel
*kchan
;
1506 * If a non-default channel has been created in the
1507 * session, explicitely require that -c chan_name needs
1510 if (session
->kernel_session
->has_non_default_channel
1511 && channel_name
[0] == '\0') {
1512 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1516 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1517 session
->kernel_session
);
1518 if (kchan
== NULL
) {
1519 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1520 LTTNG_BUFFER_GLOBAL
);
1522 ret
= LTTNG_ERR_FATAL
;
1525 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1527 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1528 if (ret
!= LTTNG_OK
) {
1534 channel_created
= 1;
1537 /* Get the newly created kernel channel pointer */
1538 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1539 session
->kernel_session
);
1540 if (kchan
== NULL
) {
1541 /* This sould not happen... */
1542 ret
= LTTNG_ERR_FATAL
;
1546 switch (event
->type
) {
1547 case LTTNG_EVENT_ALL
:
1549 char *filter_expression_a
= NULL
;
1550 struct lttng_filter_bytecode
*filter_a
= NULL
;
1553 * We need to duplicate filter_expression and filter,
1554 * because ownership is passed to first enable
1557 if (filter_expression
) {
1558 filter_expression_a
= strdup(filter_expression
);
1559 if (!filter_expression_a
) {
1560 ret
= LTTNG_ERR_FATAL
;
1565 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1567 free(filter_expression_a
);
1568 ret
= LTTNG_ERR_FATAL
;
1571 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1573 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1574 ret
= event_kernel_enable_event(kchan
, event
,
1575 filter_expression
, filter
);
1576 /* We have passed ownership */
1577 filter_expression
= NULL
;
1579 if (ret
!= LTTNG_OK
) {
1580 if (channel_created
) {
1581 /* Let's not leak a useless channel. */
1582 kernel_destroy_channel(kchan
);
1584 free(filter_expression_a
);
1588 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1589 ret
= event_kernel_enable_event(kchan
, event
,
1590 filter_expression_a
, filter_a
);
1591 if (ret
!= LTTNG_OK
) {
1592 free(filter_expression_a
);
1598 case LTTNG_EVENT_PROBE
:
1599 case LTTNG_EVENT_FUNCTION
:
1600 case LTTNG_EVENT_FUNCTION_ENTRY
:
1601 case LTTNG_EVENT_TRACEPOINT
:
1602 ret
= event_kernel_enable_event(kchan
, event
,
1603 filter_expression
, filter
);
1604 /* We have passed ownership */
1605 filter_expression
= NULL
;
1607 if (ret
!= LTTNG_OK
) {
1608 if (channel_created
) {
1609 /* Let's not leak a useless channel. */
1610 kernel_destroy_channel(kchan
);
1615 case LTTNG_EVENT_SYSCALL
:
1616 ret
= event_kernel_enable_event(kchan
, event
,
1617 filter_expression
, filter
);
1618 /* We have passed ownership */
1619 filter_expression
= NULL
;
1621 if (ret
!= LTTNG_OK
) {
1626 ret
= LTTNG_ERR_UNK
;
1630 kernel_wait_quiescent(kernel_tracer_fd
);
1633 case LTTNG_DOMAIN_UST
:
1635 struct ltt_ust_channel
*uchan
;
1636 struct ltt_ust_session
*usess
= session
->ust_session
;
1641 * If a non-default channel has been created in the
1642 * session, explicitely require that -c chan_name needs
1645 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1646 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1650 /* Get channel from global UST domain */
1651 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1653 if (uchan
== NULL
) {
1654 /* Create default channel */
1655 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1656 usess
->buffer_type
);
1658 ret
= LTTNG_ERR_FATAL
;
1661 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1663 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1664 if (ret
!= LTTNG_OK
) {
1670 /* Get the newly created channel reference back */
1671 uchan
= trace_ust_find_channel_by_name(
1672 usess
->domain_global
.channels
, channel_name
);
1676 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1678 * Don't allow users to add UST events to channels which
1679 * are assigned to a userspace subdomain (JUL, Log4J,
1682 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1686 if (!internal_event
) {
1688 * Ensure the event name is not reserved for internal
1691 ret
= validate_ust_event_name(event
->name
);
1693 WARN("Userspace event name %s failed validation.",
1695 event
->name
: "NULL");
1696 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1701 /* At this point, the session and channel exist on the tracer */
1702 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1703 filter_expression
, filter
, exclusion
,
1705 /* We have passed ownership */
1706 filter_expression
= NULL
;
1709 if (ret
!= LTTNG_OK
) {
1714 case LTTNG_DOMAIN_LOG4J
:
1715 case LTTNG_DOMAIN_JUL
:
1716 case LTTNG_DOMAIN_PYTHON
:
1718 const char *default_event_name
, *default_chan_name
;
1720 struct lttng_event uevent
;
1721 struct lttng_domain tmp_dom
;
1722 struct ltt_ust_session
*usess
= session
->ust_session
;
1726 agt
= trace_ust_find_agent(usess
, domain
->type
);
1728 agt
= agent_create(domain
->type
);
1730 ret
= LTTNG_ERR_NOMEM
;
1733 agent_add(agt
, usess
->agents
);
1736 /* Create the default tracepoint. */
1737 memset(&uevent
, 0, sizeof(uevent
));
1738 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1739 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1740 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1741 if (!default_event_name
) {
1742 ret
= LTTNG_ERR_FATAL
;
1745 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1746 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1749 * The domain type is changed because we are about to enable the
1750 * default channel and event for the JUL domain that are hardcoded.
1751 * This happens in the UST domain.
1753 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1754 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1756 switch (domain
->type
) {
1757 case LTTNG_DOMAIN_LOG4J
:
1758 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1760 case LTTNG_DOMAIN_JUL
:
1761 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1763 case LTTNG_DOMAIN_PYTHON
:
1764 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1767 /* The switch/case we are in should avoid this else big problem */
1772 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1773 char *filter_expression_copy
= NULL
;
1776 filter_copy
= zmalloc(
1777 sizeof(struct lttng_filter_bytecode
)
1780 ret
= LTTNG_ERR_NOMEM
;
1784 memcpy(filter_copy
, filter
,
1785 sizeof(struct lttng_filter_bytecode
)
1789 if (filter_expression
) {
1790 filter_expression_copy
=
1791 strdup(filter_expression
);
1792 if (!filter_expression
) {
1793 ret
= LTTNG_ERR_NOMEM
;
1794 goto error_free_copy
;
1798 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1799 (char *) default_chan_name
,
1800 &uevent
, filter_expression_copy
,
1801 filter_copy
, NULL
, wpipe
);
1803 filter_expression_copy
= NULL
;
1806 free(filter_expression_copy
);
1809 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1813 /* The wild card * means that everything should be enabled. */
1814 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1815 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1819 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1823 if (ret
!= LTTNG_OK
) {
1830 ret
= LTTNG_ERR_UND
;
1837 free(filter_expression
);
1845 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1846 * We own filter, exclusion, and filter_expression.
1848 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1849 char *channel_name
, struct lttng_event
*event
,
1850 char *filter_expression
,
1851 struct lttng_filter_bytecode
*filter
,
1852 struct lttng_event_exclusion
*exclusion
,
1855 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1856 filter_expression
, filter
, exclusion
, wpipe
, false);
1860 * Enable an event which is internal to LTTng. An internal should
1861 * never be made visible to clients and are immune to checks such as
1864 static int cmd_enable_event_internal(struct ltt_session
*session
,
1865 struct lttng_domain
*domain
,
1866 char *channel_name
, struct lttng_event
*event
,
1867 char *filter_expression
,
1868 struct lttng_filter_bytecode
*filter
,
1869 struct lttng_event_exclusion
*exclusion
,
1872 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1873 filter_expression
, filter
, exclusion
, wpipe
, true);
1877 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1879 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1882 ssize_t nb_events
= 0;
1885 case LTTNG_DOMAIN_KERNEL
:
1886 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1887 if (nb_events
< 0) {
1888 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1892 case LTTNG_DOMAIN_UST
:
1893 nb_events
= ust_app_list_events(events
);
1894 if (nb_events
< 0) {
1895 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1899 case LTTNG_DOMAIN_LOG4J
:
1900 case LTTNG_DOMAIN_JUL
:
1901 case LTTNG_DOMAIN_PYTHON
:
1902 nb_events
= agent_list_events(events
, domain
);
1903 if (nb_events
< 0) {
1904 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1909 ret
= LTTNG_ERR_UND
;
1916 /* Return negative value to differentiate return code */
1921 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1923 ssize_t
cmd_list_tracepoint_fields(int domain
,
1924 struct lttng_event_field
**fields
)
1927 ssize_t nb_fields
= 0;
1930 case LTTNG_DOMAIN_UST
:
1931 nb_fields
= ust_app_list_event_fields(fields
);
1932 if (nb_fields
< 0) {
1933 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1937 case LTTNG_DOMAIN_KERNEL
:
1938 default: /* fall-through */
1939 ret
= LTTNG_ERR_UND
;
1946 /* Return negative value to differentiate return code */
1950 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1952 return syscall_table_list(events
);
1956 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1958 * Called with session lock held.
1960 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1961 int domain
, int32_t **pids
)
1964 ssize_t nr_pids
= 0;
1967 case LTTNG_DOMAIN_KERNEL
:
1969 struct ltt_kernel_session
*ksess
;
1971 ksess
= session
->kernel_session
;
1972 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1974 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1979 case LTTNG_DOMAIN_UST
:
1981 struct ltt_ust_session
*usess
;
1983 usess
= session
->ust_session
;
1984 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
1986 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1991 case LTTNG_DOMAIN_LOG4J
:
1992 case LTTNG_DOMAIN_JUL
:
1993 case LTTNG_DOMAIN_PYTHON
:
1995 ret
= LTTNG_ERR_UND
;
2002 /* Return negative value to differentiate return code */
2007 * Command LTTNG_START_TRACE processed by the client thread.
2009 * Called with session mutex held.
2011 int cmd_start_trace(struct ltt_session
*session
)
2014 unsigned long nb_chan
= 0;
2015 struct ltt_kernel_session
*ksession
;
2016 struct ltt_ust_session
*usess
;
2020 /* Ease our life a bit ;) */
2021 ksession
= session
->kernel_session
;
2022 usess
= session
->ust_session
;
2024 /* Is the session already started? */
2025 if (session
->active
) {
2026 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2031 * Starting a session without channel is useless since after that it's not
2032 * possible to enable channel thus inform the client.
2034 if (usess
&& usess
->domain_global
.channels
) {
2036 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2040 nb_chan
+= ksession
->channel_count
;
2043 ret
= LTTNG_ERR_NO_CHANNEL
;
2047 /* Kernel tracing */
2048 if (ksession
!= NULL
) {
2049 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2050 if (ret
!= LTTNG_OK
) {
2055 /* Flag session that trace should start automatically */
2058 * Even though the start trace might fail, flag this session active so
2059 * other application coming in are started by default.
2063 ret
= ust_app_start_trace_all(usess
);
2065 ret
= LTTNG_ERR_UST_START_FAIL
;
2070 /* Flag this after a successful start. */
2071 session
->has_been_started
= 1;
2072 session
->active
= 1;
2081 * Command LTTNG_STOP_TRACE processed by the client thread.
2083 int cmd_stop_trace(struct ltt_session
*session
)
2086 struct ltt_kernel_channel
*kchan
;
2087 struct ltt_kernel_session
*ksession
;
2088 struct ltt_ust_session
*usess
;
2093 ksession
= session
->kernel_session
;
2094 usess
= session
->ust_session
;
2096 /* Session is not active. Skip everythong and inform the client. */
2097 if (!session
->active
) {
2098 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2103 if (ksession
&& ksession
->active
) {
2104 DBG("Stop kernel tracing");
2106 /* Flush metadata if exist */
2107 if (ksession
->metadata_stream_fd
>= 0) {
2108 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2110 ERR("Kernel metadata flush failed");
2114 /* Flush all buffers before stopping */
2115 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2116 ret
= kernel_flush_buffer(kchan
);
2118 ERR("Kernel flush buffer error");
2122 ret
= kernel_stop_session(ksession
);
2124 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2128 kernel_wait_quiescent(kernel_tracer_fd
);
2130 ksession
->active
= 0;
2133 if (usess
&& usess
->active
) {
2135 * Even though the stop trace might fail, flag this session inactive so
2136 * other application coming in are not started by default.
2140 ret
= ust_app_stop_trace_all(usess
);
2142 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2147 /* Flag inactive after a successful stop. */
2148 session
->active
= 0;
2156 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2158 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2159 struct lttng_uri
*uris
)
2162 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2163 struct ltt_ust_session
*usess
= session
->ust_session
;
2169 /* Can't set consumer URI if the session is active. */
2170 if (session
->active
) {
2171 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2175 /* Set the "global" consumer URIs */
2176 for (i
= 0; i
< nb_uri
; i
++) {
2177 ret
= add_uri_to_consumer(session
->consumer
,
2178 &uris
[i
], 0, session
->name
);
2179 if (ret
!= LTTNG_OK
) {
2184 /* Set UST session URIs */
2185 if (session
->ust_session
) {
2186 for (i
= 0; i
< nb_uri
; i
++) {
2187 ret
= add_uri_to_consumer(
2188 session
->ust_session
->consumer
,
2189 &uris
[i
], LTTNG_DOMAIN_UST
,
2191 if (ret
!= LTTNG_OK
) {
2197 /* Set kernel session URIs */
2198 if (session
->kernel_session
) {
2199 for (i
= 0; i
< nb_uri
; i
++) {
2200 ret
= add_uri_to_consumer(
2201 session
->kernel_session
->consumer
,
2202 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2204 if (ret
!= LTTNG_OK
) {
2211 * Make sure to set the session in output mode after we set URI since a
2212 * session can be created without URL (thus flagged in no output mode).
2214 session
->output_traces
= 1;
2216 ksess
->output_traces
= 1;
2220 usess
->output_traces
= 1;
2231 * Command LTTNG_CREATE_SESSION processed by the client thread.
2233 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2234 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2237 struct ltt_session
*session
;
2243 * Verify if the session already exist
2245 * XXX: There is no need for the session lock list here since the caller
2246 * (process_client_msg) is holding it. We might want to change that so a
2247 * single command does not lock the entire session list.
2249 session
= session_find_by_name(name
);
2250 if (session
!= NULL
) {
2251 ret
= LTTNG_ERR_EXIST_SESS
;
2255 /* Create tracing session in the registry */
2256 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2257 LTTNG_SOCK_GET_GID_CRED(creds
));
2258 if (ret
!= LTTNG_OK
) {
2263 * Get the newly created session pointer back
2265 * XXX: There is no need for the session lock list here since the caller
2266 * (process_client_msg) is holding it. We might want to change that so a
2267 * single command does not lock the entire session list.
2269 session
= session_find_by_name(name
);
2272 session
->live_timer
= live_timer
;
2273 /* Create default consumer output for the session not yet created. */
2274 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2275 if (session
->consumer
== NULL
) {
2276 ret
= LTTNG_ERR_FATAL
;
2277 goto consumer_error
;
2281 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2282 if (ret
!= LTTNG_OK
) {
2283 goto consumer_error
;
2285 session
->output_traces
= 1;
2287 session
->output_traces
= 0;
2288 DBG2("Session %s created with no output", session
->name
);
2291 session
->consumer
->enabled
= 1;
2296 session_destroy(session
);
2303 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2305 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2306 size_t nb_uri
, lttng_sock_cred
*creds
)
2309 struct ltt_session
*session
;
2310 struct snapshot_output
*new_output
= NULL
;
2316 * Create session in no output mode with URIs set to NULL. The uris we've
2317 * received are for a default snapshot output if one.
2319 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2320 if (ret
!= LTTNG_OK
) {
2324 /* Get the newly created session pointer back. This should NEVER fail. */
2325 session
= session_find_by_name(name
);
2328 /* Flag session for snapshot mode. */
2329 session
->snapshot_mode
= 1;
2331 /* Skip snapshot output creation if no URI is given. */
2336 new_output
= snapshot_output_alloc();
2338 ret
= LTTNG_ERR_NOMEM
;
2339 goto error_snapshot_alloc
;
2342 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2343 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2345 if (ret
== -ENOMEM
) {
2346 ret
= LTTNG_ERR_NOMEM
;
2348 ret
= LTTNG_ERR_INVALID
;
2350 goto error_snapshot
;
2354 snapshot_add_output(&session
->snapshot
, new_output
);
2361 snapshot_output_destroy(new_output
);
2362 error_snapshot_alloc
:
2363 session_destroy(session
);
2369 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2371 * Called with session lock held.
2373 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2376 struct ltt_ust_session
*usess
;
2377 struct ltt_kernel_session
*ksess
;
2382 usess
= session
->ust_session
;
2383 ksess
= session
->kernel_session
;
2385 /* Clean kernel session teardown */
2386 kernel_destroy_session(ksess
);
2388 /* UST session teardown */
2390 /* Close any relayd session */
2391 consumer_output_send_destroy_relayd(usess
->consumer
);
2393 /* Destroy every UST application related to this session. */
2394 ret
= ust_app_destroy_trace_all(usess
);
2396 ERR("Error in ust_app_destroy_trace_all");
2399 /* Clean up the rest. */
2400 trace_ust_destroy_session(usess
);
2404 * Must notify the kernel thread here to update it's poll set in order to
2405 * remove the channel(s)' fd just destroyed.
2407 ret
= notify_thread_pipe(wpipe
);
2409 PERROR("write kernel poll pipe");
2412 ret
= session_destroy(session
);
2418 * Command LTTNG_CALIBRATE processed by the client thread.
2420 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2425 case LTTNG_DOMAIN_KERNEL
:
2427 struct lttng_kernel_calibrate kcalibrate
;
2429 switch (calibrate
->type
) {
2430 case LTTNG_CALIBRATE_FUNCTION
:
2432 /* Default and only possible calibrate option. */
2433 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2437 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2439 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2444 case LTTNG_DOMAIN_UST
:
2446 struct lttng_ust_calibrate ucalibrate
;
2448 switch (calibrate
->type
) {
2449 case LTTNG_CALIBRATE_FUNCTION
:
2451 /* Default and only possible calibrate option. */
2452 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2456 ret
= ust_app_calibrate_glb(&ucalibrate
);
2458 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2464 ret
= LTTNG_ERR_UND
;
2475 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2477 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2478 const char *sock_path
, struct consumer_data
*cdata
)
2481 struct consumer_socket
*socket
= NULL
;
2488 case LTTNG_DOMAIN_KERNEL
:
2490 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2494 /* Can't register a consumer if there is already one */
2495 if (ksess
->consumer_fds_sent
!= 0) {
2496 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2500 sock
= lttcomm_connect_unix_sock(sock_path
);
2502 ret
= LTTNG_ERR_CONNECT_FAIL
;
2505 cdata
->cmd_sock
= sock
;
2507 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2508 if (socket
== NULL
) {
2511 PERROR("close register consumer");
2513 cdata
->cmd_sock
= -1;
2514 ret
= LTTNG_ERR_FATAL
;
2518 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2519 if (socket
->lock
== NULL
) {
2520 PERROR("zmalloc pthread mutex");
2521 ret
= LTTNG_ERR_FATAL
;
2524 pthread_mutex_init(socket
->lock
, NULL
);
2525 socket
->registered
= 1;
2528 consumer_add_socket(socket
, ksess
->consumer
);
2531 pthread_mutex_lock(&cdata
->pid_mutex
);
2533 pthread_mutex_unlock(&cdata
->pid_mutex
);
2538 /* TODO: Userspace tracing */
2539 ret
= LTTNG_ERR_UND
;
2547 consumer_destroy_socket(socket
);
2553 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2555 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2556 struct lttng_domain
**domains
)
2561 struct lttng_ht_iter iter
;
2563 if (session
->kernel_session
!= NULL
) {
2564 DBG3("Listing domains found kernel domain");
2568 if (session
->ust_session
!= NULL
) {
2569 DBG3("Listing domains found UST global domain");
2573 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2575 if (agt
->being_used
) {
2586 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2587 if (*domains
== NULL
) {
2588 ret
= LTTNG_ERR_FATAL
;
2592 if (session
->kernel_session
!= NULL
) {
2593 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2595 /* Kernel session buffer type is always GLOBAL */
2596 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2601 if (session
->ust_session
!= NULL
) {
2602 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2603 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2607 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2609 if (agt
->being_used
) {
2610 (*domains
)[index
].type
= agt
->domain
;
2611 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2621 /* Return negative value to differentiate return code */
2627 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2629 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2630 struct lttng_channel
**channels
)
2633 ssize_t nb_chan
= 0;
2636 case LTTNG_DOMAIN_KERNEL
:
2637 if (session
->kernel_session
!= NULL
) {
2638 nb_chan
= session
->kernel_session
->channel_count
;
2640 DBG3("Number of kernel channels %zd", nb_chan
);
2642 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2645 case LTTNG_DOMAIN_UST
:
2646 if (session
->ust_session
!= NULL
) {
2648 nb_chan
= lttng_ht_get_count(
2649 session
->ust_session
->domain_global
.channels
);
2652 DBG3("Number of UST global channels %zd", nb_chan
);
2654 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2659 ret
= LTTNG_ERR_UND
;
2664 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2665 if (*channels
== NULL
) {
2666 ret
= LTTNG_ERR_FATAL
;
2670 list_lttng_channels(domain
, session
, *channels
);
2676 /* Return negative value to differentiate return code */
2681 * Command LTTNG_LIST_EVENTS processed by the client thread.
2683 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2684 char *channel_name
, struct lttng_event
**events
)
2687 ssize_t nb_event
= 0;
2690 case LTTNG_DOMAIN_KERNEL
:
2691 if (session
->kernel_session
!= NULL
) {
2692 nb_event
= list_lttng_kernel_events(channel_name
,
2693 session
->kernel_session
, events
);
2696 case LTTNG_DOMAIN_UST
:
2698 if (session
->ust_session
!= NULL
) {
2699 nb_event
= list_lttng_ust_global_events(channel_name
,
2700 &session
->ust_session
->domain_global
, events
);
2704 case LTTNG_DOMAIN_LOG4J
:
2705 case LTTNG_DOMAIN_JUL
:
2706 case LTTNG_DOMAIN_PYTHON
:
2707 if (session
->ust_session
) {
2708 struct lttng_ht_iter iter
;
2712 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2713 &iter
.iter
, agt
, node
.node
) {
2714 nb_event
= list_lttng_agent_events(agt
, events
);
2720 ret
= LTTNG_ERR_UND
;
2727 /* Return negative value to differentiate return code */
2732 * Using the session list, filled a lttng_session array to send back to the
2733 * client for session listing.
2735 * The session list lock MUST be acquired before calling this function. Use
2736 * session_lock_list() and session_unlock_list().
2738 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2743 struct ltt_session
*session
;
2744 struct ltt_session_list
*list
= session_get_list();
2746 DBG("Getting all available session for UID %d GID %d",
2749 * Iterate over session list and append data after the control struct in
2752 cds_list_for_each_entry(session
, &list
->head
, list
) {
2754 * Only list the sessions the user can control.
2756 if (!session_access_ok(session
, uid
, gid
)) {
2760 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2761 struct ltt_ust_session
*usess
= session
->ust_session
;
2763 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2764 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2765 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2766 ret
= build_network_session_path(sessions
[i
].path
,
2767 sizeof(sessions
[i
].path
), session
);
2769 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2770 session
->consumer
->dst
.trace_path
);
2773 PERROR("snprintf session path");
2777 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2778 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2779 sessions
[i
].enabled
= session
->active
;
2780 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2781 sessions
[i
].live_timer_interval
= session
->live_timer
;
2787 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2788 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2790 int cmd_data_pending(struct ltt_session
*session
)
2793 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2794 struct ltt_ust_session
*usess
= session
->ust_session
;
2798 /* Session MUST be stopped to ask for data availability. */
2799 if (session
->active
) {
2800 ret
= LTTNG_ERR_SESSION_STARTED
;
2804 * If stopped, just make sure we've started before else the above call
2805 * will always send that there is data pending.
2807 * The consumer assumes that when the data pending command is received,
2808 * the trace has been started before or else no output data is written
2809 * by the streams which is a condition for data pending. So, this is
2810 * *VERY* important that we don't ask the consumer before a start
2813 if (!session
->has_been_started
) {
2819 if (ksess
&& ksess
->consumer
) {
2820 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2822 /* Data is still being extracted for the kernel. */
2827 if (usess
&& usess
->consumer
) {
2828 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2830 /* Data is still being extracted for the kernel. */
2835 /* Data is ready to be read by a viewer */
2843 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2845 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2847 int cmd_snapshot_add_output(struct ltt_session
*session
,
2848 struct lttng_snapshot_output
*output
, uint32_t *id
)
2851 struct snapshot_output
*new_output
;
2856 DBG("Cmd snapshot add output for session %s", session
->name
);
2859 * Permission denied to create an output if the session is not
2860 * set in no output mode.
2862 if (session
->output_traces
) {
2863 ret
= LTTNG_ERR_EPERM
;
2867 /* Only one output is allowed until we have the "tee" feature. */
2868 if (session
->snapshot
.nb_output
== 1) {
2869 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2873 new_output
= snapshot_output_alloc();
2875 ret
= LTTNG_ERR_NOMEM
;
2879 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2880 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2881 &session
->snapshot
);
2883 if (ret
== -ENOMEM
) {
2884 ret
= LTTNG_ERR_NOMEM
;
2886 ret
= LTTNG_ERR_INVALID
;
2892 snapshot_add_output(&session
->snapshot
, new_output
);
2894 *id
= new_output
->id
;
2901 snapshot_output_destroy(new_output
);
2907 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2909 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2911 int cmd_snapshot_del_output(struct ltt_session
*session
,
2912 struct lttng_snapshot_output
*output
)
2915 struct snapshot_output
*sout
= NULL
;
2923 * Permission denied to create an output if the session is not
2924 * set in no output mode.
2926 if (session
->output_traces
) {
2927 ret
= LTTNG_ERR_EPERM
;
2932 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2934 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2935 } else if (*output
->name
!= '\0') {
2936 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2938 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2941 ret
= LTTNG_ERR_INVALID
;
2945 snapshot_delete_output(&session
->snapshot
, sout
);
2946 snapshot_output_destroy(sout
);
2955 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2957 * If no output is available, outputs is untouched and 0 is returned.
2959 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2961 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2962 struct lttng_snapshot_output
**outputs
)
2965 struct lttng_snapshot_output
*list
= NULL
;
2966 struct lttng_ht_iter iter
;
2967 struct snapshot_output
*output
;
2972 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2975 * Permission denied to create an output if the session is not
2976 * set in no output mode.
2978 if (session
->output_traces
) {
2979 ret
= -LTTNG_ERR_EPERM
;
2983 if (session
->snapshot
.nb_output
== 0) {
2988 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2990 ret
= -LTTNG_ERR_NOMEM
;
2994 /* Copy list from session to the new list object. */
2996 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2997 output
, node
.node
) {
2998 assert(output
->consumer
);
2999 list
[idx
].id
= output
->id
;
3000 list
[idx
].max_size
= output
->max_size
;
3001 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3002 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3003 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3004 sizeof(list
[idx
].ctrl_url
));
3007 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3008 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3010 ret
= -LTTNG_ERR_NOMEM
;
3015 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3016 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3018 ret
= -LTTNG_ERR_NOMEM
;
3027 ret
= session
->snapshot
.nb_output
;
3035 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3036 * snapshot output is *not* set with a remote destination.
3038 * Return 0 on success or a LTTNG_ERR code.
3040 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3041 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3044 struct lttng_ht_iter iter
;
3045 struct consumer_socket
*socket
;
3048 assert(snap_output
);
3051 DBG2("Set relayd object from snapshot output");
3053 /* Ignore if snapshot consumer output is not network. */
3054 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3059 * For each consumer socket, create and send the relayd object of the
3063 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3064 socket
, node
.node
) {
3065 ret
= send_consumer_relayd_sockets(0, session
->id
,
3066 snap_output
->consumer
, socket
,
3067 session
->name
, session
->hostname
,
3068 session
->live_timer
);
3069 if (ret
!= LTTNG_OK
) {
3081 * Record a kernel snapshot.
3083 * Return LTTNG_OK on success or a LTTNG_ERR code.
3085 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3086 struct snapshot_output
*output
, struct ltt_session
*session
,
3087 int wait
, uint64_t nb_packets_per_stream
)
3095 /* Get the datetime for the snapshot output directory. */
3096 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3097 sizeof(output
->datetime
));
3099 ret
= LTTNG_ERR_INVALID
;
3104 * Copy kernel session sockets so we can communicate with the right
3105 * consumer for the snapshot record command.
3107 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3109 ret
= LTTNG_ERR_NOMEM
;
3113 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3114 if (ret
!= LTTNG_OK
) {
3115 goto error_snapshot
;
3118 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3119 if (ret
!= LTTNG_OK
) {
3120 goto error_snapshot
;
3127 /* Clean up copied sockets so this output can use some other later on. */
3128 consumer_destroy_output_sockets(output
->consumer
);
3135 * Record a UST snapshot.
3137 * Return 0 on success or a LTTNG_ERR error code.
3139 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3140 struct snapshot_output
*output
, struct ltt_session
*session
,
3141 int wait
, uint64_t nb_packets_per_stream
)
3149 /* Get the datetime for the snapshot output directory. */
3150 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3151 sizeof(output
->datetime
));
3153 ret
= LTTNG_ERR_INVALID
;
3158 * Copy UST session sockets so we can communicate with the right
3159 * consumer for the snapshot record command.
3161 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3163 ret
= LTTNG_ERR_NOMEM
;
3167 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3168 if (ret
!= LTTNG_OK
) {
3169 goto error_snapshot
;
3172 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3176 ret
= LTTNG_ERR_INVALID
;
3179 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3182 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3185 goto error_snapshot
;
3191 /* Clean up copied sockets so this output can use some other later on. */
3192 consumer_destroy_output_sockets(output
->consumer
);
3198 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3199 uint64_t cur_nr_packets
)
3201 uint64_t tot_size
= 0;
3203 if (session
->kernel_session
) {
3204 struct ltt_kernel_channel
*chan
;
3205 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3207 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3208 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3210 * Don't take channel into account if we
3211 * already grab all its packets.
3215 tot_size
+= chan
->channel
->attr
.subbuf_size
3216 * chan
->stream_count
;
3220 if (session
->ust_session
) {
3221 struct ltt_ust_session
*usess
= session
->ust_session
;
3223 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3231 * Calculate the number of packets we can grab from each stream that
3232 * fits within the overall snapshot max size.
3234 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3235 * the number of packets per stream.
3237 * TODO: this approach is not perfect: we consider the worse case
3238 * (packet filling the sub-buffers) as an upper bound, but we could do
3239 * better if we do this calculation while we actually grab the packet
3240 * content: we would know how much padding we don't actually store into
3243 * This algorithm is currently bounded by the number of packets per
3246 * Since we call this algorithm before actually grabbing the data, it's
3247 * an approximation: for instance, applications could appear/disappear
3248 * in between this call and actually grabbing data.
3251 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3254 uint64_t cur_nb_packets
= 0;
3257 return 0; /* Infinite */
3260 size_left
= max_size
;
3262 uint64_t one_more_packet_tot_size
;
3264 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3266 if (!one_more_packet_tot_size
) {
3267 /* We are already grabbing all packets. */
3270 size_left
-= one_more_packet_tot_size
;
3271 if (size_left
< 0) {
3276 if (!cur_nb_packets
) {
3277 /* Not enough room to grab one packet of each stream, error. */
3280 return cur_nb_packets
;
3284 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3286 * The wait parameter is ignored so this call always wait for the snapshot to
3287 * complete before returning.
3289 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3291 int cmd_snapshot_record(struct ltt_session
*session
,
3292 struct lttng_snapshot_output
*output
, int wait
)
3295 unsigned int use_tmp_output
= 0;
3296 struct snapshot_output tmp_output
;
3297 unsigned int snapshot_success
= 0;
3302 DBG("Cmd snapshot record for session %s", session
->name
);
3305 * Permission denied to create an output if the session is not
3306 * set in no output mode.
3308 if (session
->output_traces
) {
3309 ret
= LTTNG_ERR_EPERM
;
3313 /* The session needs to be started at least once. */
3314 if (!session
->has_been_started
) {
3315 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3319 /* Use temporary output for the session. */
3320 if (*output
->ctrl_url
!= '\0') {
3321 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3322 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3325 if (ret
== -ENOMEM
) {
3326 ret
= LTTNG_ERR_NOMEM
;
3328 ret
= LTTNG_ERR_INVALID
;
3332 /* Use the global session count for the temporary snapshot. */
3333 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3337 if (session
->kernel_session
) {
3338 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3340 if (use_tmp_output
) {
3341 int64_t nb_packets_per_stream
;
3343 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3344 tmp_output
.max_size
);
3345 if (nb_packets_per_stream
< 0) {
3346 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3349 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3350 wait
, nb_packets_per_stream
);
3351 if (ret
!= LTTNG_OK
) {
3354 snapshot_success
= 1;
3356 struct snapshot_output
*sout
;
3357 struct lttng_ht_iter iter
;
3360 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3361 &iter
.iter
, sout
, node
.node
) {
3362 int64_t nb_packets_per_stream
;
3365 * Make a local copy of the output and assign the possible
3366 * temporary value given by the caller.
3368 memset(&tmp_output
, 0, sizeof(tmp_output
));
3369 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3371 if (output
->max_size
!= (uint64_t) -1ULL) {
3372 tmp_output
.max_size
= output
->max_size
;
3375 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3376 tmp_output
.max_size
);
3377 if (nb_packets_per_stream
< 0) {
3378 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3382 /* Use temporary name. */
3383 if (*output
->name
!= '\0') {
3384 strncpy(tmp_output
.name
, output
->name
,
3385 sizeof(tmp_output
.name
));
3388 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3390 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3391 session
, wait
, nb_packets_per_stream
);
3392 if (ret
!= LTTNG_OK
) {
3396 snapshot_success
= 1;
3402 if (session
->ust_session
) {
3403 struct ltt_ust_session
*usess
= session
->ust_session
;
3405 if (use_tmp_output
) {
3406 int64_t nb_packets_per_stream
;
3408 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3409 tmp_output
.max_size
);
3410 if (nb_packets_per_stream
< 0) {
3411 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3414 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3415 wait
, nb_packets_per_stream
);
3416 if (ret
!= LTTNG_OK
) {
3419 snapshot_success
= 1;
3421 struct snapshot_output
*sout
;
3422 struct lttng_ht_iter iter
;
3425 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3426 &iter
.iter
, sout
, node
.node
) {
3427 int64_t nb_packets_per_stream
;
3430 * Make a local copy of the output and assign the possible
3431 * temporary value given by the caller.
3433 memset(&tmp_output
, 0, sizeof(tmp_output
));
3434 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3436 if (output
->max_size
!= (uint64_t) -1ULL) {
3437 tmp_output
.max_size
= output
->max_size
;
3440 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3441 tmp_output
.max_size
);
3442 if (nb_packets_per_stream
< 0) {
3443 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3448 /* Use temporary name. */
3449 if (*output
->name
!= '\0') {
3450 strncpy(tmp_output
.name
, output
->name
,
3451 sizeof(tmp_output
.name
));
3454 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3456 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3457 wait
, nb_packets_per_stream
);
3458 if (ret
!= LTTNG_OK
) {
3462 snapshot_success
= 1;
3468 if (snapshot_success
) {
3469 session
->snapshot
.nb_snapshot
++;
3471 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3479 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3481 int cmd_set_session_shm_path(struct ltt_session
*session
,
3482 const char *shm_path
)
3488 * Can only set shm path before session is started.
3490 if (session
->has_been_started
) {
3491 return LTTNG_ERR_SESSION_STARTED
;
3494 strncpy(session
->shm_path
, shm_path
,
3495 sizeof(session
->shm_path
));
3496 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3502 * Init command subsystem.
3507 * Set network sequence index to 1 for streams to match a relayd
3508 * socket on the consumer side.
3510 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3511 relayd_net_seq_idx
= 1;
3512 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3514 DBG("Command subsystem initialized");