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_value
;
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
:
1111 case LTTNG_DOMAIN_JUL
:
1112 case LTTNG_DOMAIN_LOG4J
:
1113 case LTTNG_DOMAIN_PYTHON
:
1115 struct ltt_ust_channel
*uchan
;
1120 * Current agent implementation limitations force us to allow
1121 * only one channel at once in "agent" subdomains. Each
1122 * subdomain has a default channel name which must be strictly
1125 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1126 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1127 LTTNG_SYMBOL_NAME_LEN
)) {
1128 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1131 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1132 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1133 LTTNG_SYMBOL_NAME_LEN
)) {
1134 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1137 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1138 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1139 LTTNG_SYMBOL_NAME_LEN
)) {
1140 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1145 chan_ht
= usess
->domain_global
.channels
;
1147 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1148 if (uchan
== NULL
) {
1149 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1150 if (attr
->name
[0] != '\0') {
1151 usess
->has_non_default_channel
= 1;
1154 ret
= channel_ust_enable(usess
, uchan
);
1159 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1170 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1172 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1174 struct lttng_event
*event
)
1179 DBG("Disable event command for event \'%s\'", event
->name
);
1181 event_name
= event
->name
;
1182 if (validate_event_name(event_name
)) {
1183 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1187 /* Error out on unhandled search criteria */
1188 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1189 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1190 ret
= LTTNG_ERR_UNK
;
1197 case LTTNG_DOMAIN_KERNEL
:
1199 struct ltt_kernel_channel
*kchan
;
1200 struct ltt_kernel_session
*ksess
;
1202 ksess
= session
->kernel_session
;
1205 * If a non-default channel has been created in the
1206 * session, explicitely require that -c chan_name needs
1209 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1210 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1214 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1215 if (kchan
== NULL
) {
1216 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1220 switch (event
->type
) {
1221 case LTTNG_EVENT_ALL
:
1222 case LTTNG_EVENT_TRACEPOINT
:
1223 case LTTNG_EVENT_SYSCALL
:
1224 case LTTNG_EVENT_PROBE
:
1225 case LTTNG_EVENT_FUNCTION
:
1226 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1227 if (event_name
[0] == '\0') {
1228 ret
= event_kernel_disable_event(kchan
,
1231 ret
= event_kernel_disable_event(kchan
,
1232 event_name
, event
->type
);
1234 if (ret
!= LTTNG_OK
) {
1239 ret
= LTTNG_ERR_UNK
;
1243 kernel_wait_quiescent(kernel_tracer_fd
);
1246 case LTTNG_DOMAIN_UST
:
1248 struct ltt_ust_channel
*uchan
;
1249 struct ltt_ust_session
*usess
;
1251 usess
= session
->ust_session
;
1253 if (validate_ust_event_name(event_name
)) {
1254 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1259 * If a non-default channel has been created in the
1260 * session, explicitly require that -c chan_name needs
1263 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1264 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1268 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1270 if (uchan
== NULL
) {
1271 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1275 switch (event
->type
) {
1276 case LTTNG_EVENT_ALL
:
1277 if (strlen(event
->name
) == 1 &&
1278 !strncmp(event
->name
, "*", 1)) {
1279 ret
= event_ust_disable_all_tracepoints(usess
,
1282 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1285 if (ret
!= LTTNG_OK
) {
1290 ret
= LTTNG_ERR_UNK
;
1294 DBG3("Disable UST event %s in channel %s completed", event_name
,
1298 case LTTNG_DOMAIN_LOG4J
:
1299 case LTTNG_DOMAIN_JUL
:
1300 case LTTNG_DOMAIN_PYTHON
:
1303 struct ltt_ust_session
*usess
= session
->ust_session
;
1307 switch (event
->type
) {
1308 case LTTNG_EVENT_ALL
:
1311 ret
= LTTNG_ERR_UNK
;
1315 agt
= trace_ust_find_agent(usess
, domain
);
1317 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1320 /* The wild card * means that everything should be disabled. */
1321 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1322 ret
= event_agent_disable_all(usess
, agt
);
1324 ret
= event_agent_disable(usess
, agt
, event_name
);
1326 if (ret
!= LTTNG_OK
) {
1333 ret
= LTTNG_ERR_UND
;
1346 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1348 int cmd_add_context(struct ltt_session
*session
, int domain
,
1349 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1351 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1354 case LTTNG_DOMAIN_KERNEL
:
1355 assert(session
->kernel_session
);
1357 if (session
->kernel_session
->channel_count
== 0) {
1358 /* Create default channel */
1359 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1360 if (ret
!= LTTNG_OK
) {
1363 chan_kern_created
= 1;
1365 /* Add kernel context to kernel tracer */
1366 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1367 if (ret
!= LTTNG_OK
) {
1371 case LTTNG_DOMAIN_UST
:
1373 struct ltt_ust_session
*usess
= session
->ust_session
;
1374 unsigned int chan_count
;
1378 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1379 if (chan_count
== 0) {
1380 struct lttng_channel
*attr
;
1381 /* Create default channel */
1382 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1384 ret
= LTTNG_ERR_FATAL
;
1388 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1389 if (ret
!= LTTNG_OK
) {
1394 chan_ust_created
= 1;
1397 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1398 if (ret
!= LTTNG_OK
) {
1404 ret
= LTTNG_ERR_UND
;
1411 if (chan_kern_created
) {
1412 struct ltt_kernel_channel
*kchan
=
1413 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1414 session
->kernel_session
);
1415 /* Created previously, this should NOT fail. */
1417 kernel_destroy_channel(kchan
);
1420 if (chan_ust_created
) {
1421 struct ltt_ust_channel
*uchan
=
1422 trace_ust_find_channel_by_name(
1423 session
->ust_session
->domain_global
.channels
,
1424 DEFAULT_CHANNEL_NAME
);
1425 /* Created previously, this should NOT fail. */
1427 /* Remove from the channel list of the session. */
1428 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1430 trace_ust_destroy_channel(uchan
);
1435 static int validate_event_name(const char *name
)
1438 const char *c
= name
;
1439 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1442 * Make sure that unescaped wildcards are only used as the last
1443 * character of the event name.
1445 while (c
< event_name_end
) {
1453 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1454 /* Wildcard is not the last character */
1455 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1467 static inline bool name_starts_with(const char *name
, const char *prefix
)
1469 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1471 return !strncmp(name
, prefix
, max_cmp_len
);
1474 /* Perform userspace-specific event name validation */
1475 static int validate_ust_event_name(const char *name
)
1485 * Check name against all internal UST event component namespaces used
1488 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1489 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1490 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1499 * Internal version of cmd_enable_event() with a supplemental
1500 * "internal_event" flag which is used to enable internal events which should
1501 * be hidden from clients. Such events are used in the agent implementation to
1502 * enable the events through which all "agent" events are funeled.
1504 static int _cmd_enable_event(struct ltt_session
*session
,
1505 struct lttng_domain
*domain
,
1506 char *channel_name
, struct lttng_event
*event
,
1507 char *filter_expression
,
1508 struct lttng_filter_bytecode
*filter
,
1509 struct lttng_event_exclusion
*exclusion
,
1510 int wpipe
, bool internal_event
)
1512 int ret
, channel_created
= 0;
1513 struct lttng_channel
*attr
;
1517 assert(channel_name
);
1519 DBG("Enable event command for event \'%s\'", event
->name
);
1523 ret
= validate_event_name(event
->name
);
1528 switch (domain
->type
) {
1529 case LTTNG_DOMAIN_KERNEL
:
1531 struct ltt_kernel_channel
*kchan
;
1534 * If a non-default channel has been created in the
1535 * session, explicitely require that -c chan_name needs
1538 if (session
->kernel_session
->has_non_default_channel
1539 && channel_name
[0] == '\0') {
1540 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1544 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1545 session
->kernel_session
);
1546 if (kchan
== NULL
) {
1547 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1548 LTTNG_BUFFER_GLOBAL
);
1550 ret
= LTTNG_ERR_FATAL
;
1553 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1555 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1556 if (ret
!= LTTNG_OK
) {
1562 channel_created
= 1;
1565 /* Get the newly created kernel channel pointer */
1566 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1567 session
->kernel_session
);
1568 if (kchan
== NULL
) {
1569 /* This sould not happen... */
1570 ret
= LTTNG_ERR_FATAL
;
1574 switch (event
->type
) {
1575 case LTTNG_EVENT_ALL
:
1577 char *filter_expression_a
= NULL
;
1578 struct lttng_filter_bytecode
*filter_a
= NULL
;
1581 * We need to duplicate filter_expression and filter,
1582 * because ownership is passed to first enable
1585 if (filter_expression
) {
1586 filter_expression_a
= strdup(filter_expression
);
1587 if (!filter_expression_a
) {
1588 ret
= LTTNG_ERR_FATAL
;
1593 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1595 free(filter_expression_a
);
1596 ret
= LTTNG_ERR_FATAL
;
1599 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1601 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
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
);
1612 free(filter_expression_a
);
1616 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1617 ret
= event_kernel_enable_event(kchan
, event
,
1618 filter_expression_a
, filter_a
);
1619 /* We have passed ownership */
1620 filter_expression_a
= NULL
;
1622 if (ret
!= LTTNG_OK
) {
1627 case LTTNG_EVENT_PROBE
:
1628 case LTTNG_EVENT_FUNCTION
:
1629 case LTTNG_EVENT_FUNCTION_ENTRY
:
1630 case LTTNG_EVENT_TRACEPOINT
:
1631 ret
= event_kernel_enable_event(kchan
, event
,
1632 filter_expression
, filter
);
1633 /* We have passed ownership */
1634 filter_expression
= NULL
;
1636 if (ret
!= LTTNG_OK
) {
1637 if (channel_created
) {
1638 /* Let's not leak a useless channel. */
1639 kernel_destroy_channel(kchan
);
1644 case LTTNG_EVENT_SYSCALL
:
1645 ret
= event_kernel_enable_event(kchan
, event
,
1646 filter_expression
, filter
);
1647 /* We have passed ownership */
1648 filter_expression
= NULL
;
1650 if (ret
!= LTTNG_OK
) {
1655 ret
= LTTNG_ERR_UNK
;
1659 kernel_wait_quiescent(kernel_tracer_fd
);
1662 case LTTNG_DOMAIN_UST
:
1664 struct ltt_ust_channel
*uchan
;
1665 struct ltt_ust_session
*usess
= session
->ust_session
;
1670 * If a non-default channel has been created in the
1671 * session, explicitely require that -c chan_name needs
1674 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1675 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1679 /* Get channel from global UST domain */
1680 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1682 if (uchan
== NULL
) {
1683 /* Create default channel */
1684 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1685 usess
->buffer_type
);
1687 ret
= LTTNG_ERR_FATAL
;
1690 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1692 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1693 if (ret
!= LTTNG_OK
) {
1699 /* Get the newly created channel reference back */
1700 uchan
= trace_ust_find_channel_by_name(
1701 usess
->domain_global
.channels
, channel_name
);
1705 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1707 * Don't allow users to add UST events to channels which
1708 * are assigned to a userspace subdomain (JUL, Log4J,
1711 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1715 if (!internal_event
) {
1717 * Ensure the event name is not reserved for internal
1720 ret
= validate_ust_event_name(event
->name
);
1722 WARN("Userspace event name %s failed validation.",
1724 event
->name
: "NULL");
1725 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1730 /* At this point, the session and channel exist on the tracer */
1731 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1732 filter_expression
, filter
, exclusion
,
1734 /* We have passed ownership */
1735 filter_expression
= NULL
;
1738 if (ret
!= LTTNG_OK
) {
1743 case LTTNG_DOMAIN_LOG4J
:
1744 case LTTNG_DOMAIN_JUL
:
1745 case LTTNG_DOMAIN_PYTHON
:
1747 const char *default_event_name
, *default_chan_name
;
1749 struct lttng_event uevent
;
1750 struct lttng_domain tmp_dom
;
1751 struct ltt_ust_session
*usess
= session
->ust_session
;
1755 agt
= trace_ust_find_agent(usess
, domain
->type
);
1757 agt
= agent_create(domain
->type
);
1759 ret
= LTTNG_ERR_NOMEM
;
1762 agent_add(agt
, usess
->agents
);
1765 /* Create the default tracepoint. */
1766 memset(&uevent
, 0, sizeof(uevent
));
1767 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1768 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1769 default_event_name
= event_get_default_agent_ust_name(
1771 if (!default_event_name
) {
1772 ret
= LTTNG_ERR_FATAL
;
1775 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1776 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1779 * The domain type is changed because we are about to enable the
1780 * default channel and event for the JUL domain that are hardcoded.
1781 * This happens in the UST domain.
1783 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1784 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1786 switch (domain
->type
) {
1787 case LTTNG_DOMAIN_LOG4J
:
1788 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1790 case LTTNG_DOMAIN_JUL
:
1791 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1793 case LTTNG_DOMAIN_PYTHON
:
1794 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1797 /* The switch/case we are in should avoid this else big problem */
1802 char *filter_expression_copy
= NULL
;
1803 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1806 const size_t filter_size
= sizeof(
1807 struct lttng_filter_bytecode
)
1810 filter_copy
= zmalloc(filter_size
);
1812 ret
= LTTNG_ERR_NOMEM
;
1815 memcpy(filter_copy
, filter
, filter_size
);
1817 filter_expression_copy
=
1818 strdup(filter_expression
);
1819 if (!filter_expression
) {
1820 ret
= LTTNG_ERR_NOMEM
;
1823 if (!filter_expression_copy
|| !filter_copy
) {
1824 free(filter_expression_copy
);
1830 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1831 (char *) default_chan_name
,
1832 &uevent
, filter_expression_copy
,
1833 filter_copy
, NULL
, wpipe
);
1836 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1840 /* The wild card * means that everything should be enabled. */
1841 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1842 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1845 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1849 filter_expression
= NULL
;
1850 if (ret
!= LTTNG_OK
) {
1857 ret
= LTTNG_ERR_UND
;
1864 free(filter_expression
);
1872 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1873 * We own filter, exclusion, and filter_expression.
1875 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1876 char *channel_name
, struct lttng_event
*event
,
1877 char *filter_expression
,
1878 struct lttng_filter_bytecode
*filter
,
1879 struct lttng_event_exclusion
*exclusion
,
1882 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1883 filter_expression
, filter
, exclusion
, wpipe
, false);
1887 * Enable an event which is internal to LTTng. An internal should
1888 * never be made visible to clients and are immune to checks such as
1891 static int cmd_enable_event_internal(struct ltt_session
*session
,
1892 struct lttng_domain
*domain
,
1893 char *channel_name
, struct lttng_event
*event
,
1894 char *filter_expression
,
1895 struct lttng_filter_bytecode
*filter
,
1896 struct lttng_event_exclusion
*exclusion
,
1899 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1900 filter_expression
, filter
, exclusion
, wpipe
, true);
1904 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1906 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1909 ssize_t nb_events
= 0;
1912 case LTTNG_DOMAIN_KERNEL
:
1913 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1914 if (nb_events
< 0) {
1915 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1919 case LTTNG_DOMAIN_UST
:
1920 nb_events
= ust_app_list_events(events
);
1921 if (nb_events
< 0) {
1922 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1926 case LTTNG_DOMAIN_LOG4J
:
1927 case LTTNG_DOMAIN_JUL
:
1928 case LTTNG_DOMAIN_PYTHON
:
1929 nb_events
= agent_list_events(events
, domain
);
1930 if (nb_events
< 0) {
1931 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1936 ret
= LTTNG_ERR_UND
;
1943 /* Return negative value to differentiate return code */
1948 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1950 ssize_t
cmd_list_tracepoint_fields(int domain
,
1951 struct lttng_event_field
**fields
)
1954 ssize_t nb_fields
= 0;
1957 case LTTNG_DOMAIN_UST
:
1958 nb_fields
= ust_app_list_event_fields(fields
);
1959 if (nb_fields
< 0) {
1960 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1964 case LTTNG_DOMAIN_KERNEL
:
1965 default: /* fall-through */
1966 ret
= LTTNG_ERR_UND
;
1973 /* Return negative value to differentiate return code */
1977 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1979 return syscall_table_list(events
);
1983 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1985 * Called with session lock held.
1987 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1988 int domain
, int32_t **pids
)
1991 ssize_t nr_pids
= 0;
1994 case LTTNG_DOMAIN_KERNEL
:
1996 struct ltt_kernel_session
*ksess
;
1998 ksess
= session
->kernel_session
;
1999 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2001 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2006 case LTTNG_DOMAIN_UST
:
2008 struct ltt_ust_session
*usess
;
2010 usess
= session
->ust_session
;
2011 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2013 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2018 case LTTNG_DOMAIN_LOG4J
:
2019 case LTTNG_DOMAIN_JUL
:
2020 case LTTNG_DOMAIN_PYTHON
:
2022 ret
= LTTNG_ERR_UND
;
2029 /* Return negative value to differentiate return code */
2034 * Command LTTNG_START_TRACE processed by the client thread.
2036 * Called with session mutex held.
2038 int cmd_start_trace(struct ltt_session
*session
)
2041 unsigned long nb_chan
= 0;
2042 struct ltt_kernel_session
*ksession
;
2043 struct ltt_ust_session
*usess
;
2047 /* Ease our life a bit ;) */
2048 ksession
= session
->kernel_session
;
2049 usess
= session
->ust_session
;
2051 /* Is the session already started? */
2052 if (session
->active
) {
2053 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2058 * Starting a session without channel is useless since after that it's not
2059 * possible to enable channel thus inform the client.
2061 if (usess
&& usess
->domain_global
.channels
) {
2063 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2067 nb_chan
+= ksession
->channel_count
;
2070 ret
= LTTNG_ERR_NO_CHANNEL
;
2074 /* Kernel tracing */
2075 if (ksession
!= NULL
) {
2076 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2077 if (ret
!= LTTNG_OK
) {
2082 /* Flag session that trace should start automatically */
2085 * Even though the start trace might fail, flag this session active so
2086 * other application coming in are started by default.
2090 ret
= ust_app_start_trace_all(usess
);
2092 ret
= LTTNG_ERR_UST_START_FAIL
;
2097 /* Flag this after a successful start. */
2098 session
->has_been_started
= 1;
2099 session
->active
= 1;
2108 * Command LTTNG_STOP_TRACE processed by the client thread.
2110 int cmd_stop_trace(struct ltt_session
*session
)
2113 struct ltt_kernel_channel
*kchan
;
2114 struct ltt_kernel_session
*ksession
;
2115 struct ltt_ust_session
*usess
;
2120 ksession
= session
->kernel_session
;
2121 usess
= session
->ust_session
;
2123 /* Session is not active. Skip everythong and inform the client. */
2124 if (!session
->active
) {
2125 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2130 if (ksession
&& ksession
->active
) {
2131 DBG("Stop kernel tracing");
2133 /* Flush metadata if exist */
2134 if (ksession
->metadata_stream_fd
>= 0) {
2135 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2137 ERR("Kernel metadata flush failed");
2141 /* Flush all buffers before stopping */
2142 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2143 ret
= kernel_flush_buffer(kchan
);
2145 ERR("Kernel flush buffer error");
2149 ret
= kernel_stop_session(ksession
);
2151 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2155 kernel_wait_quiescent(kernel_tracer_fd
);
2157 ksession
->active
= 0;
2160 if (usess
&& usess
->active
) {
2162 * Even though the stop trace might fail, flag this session inactive so
2163 * other application coming in are not started by default.
2167 ret
= ust_app_stop_trace_all(usess
);
2169 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2174 /* Flag inactive after a successful stop. */
2175 session
->active
= 0;
2183 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2185 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2186 struct lttng_uri
*uris
)
2189 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2190 struct ltt_ust_session
*usess
= session
->ust_session
;
2196 /* Can't set consumer URI if the session is active. */
2197 if (session
->active
) {
2198 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2202 /* Set the "global" consumer URIs */
2203 for (i
= 0; i
< nb_uri
; i
++) {
2204 ret
= add_uri_to_consumer(session
->consumer
,
2205 &uris
[i
], 0, session
->name
);
2206 if (ret
!= LTTNG_OK
) {
2211 /* Set UST session URIs */
2212 if (session
->ust_session
) {
2213 for (i
= 0; i
< nb_uri
; i
++) {
2214 ret
= add_uri_to_consumer(
2215 session
->ust_session
->consumer
,
2216 &uris
[i
], LTTNG_DOMAIN_UST
,
2218 if (ret
!= LTTNG_OK
) {
2224 /* Set kernel session URIs */
2225 if (session
->kernel_session
) {
2226 for (i
= 0; i
< nb_uri
; i
++) {
2227 ret
= add_uri_to_consumer(
2228 session
->kernel_session
->consumer
,
2229 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2231 if (ret
!= LTTNG_OK
) {
2238 * Make sure to set the session in output mode after we set URI since a
2239 * session can be created without URL (thus flagged in no output mode).
2241 session
->output_traces
= 1;
2243 ksess
->output_traces
= 1;
2247 usess
->output_traces
= 1;
2258 * Command LTTNG_CREATE_SESSION processed by the client thread.
2260 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2261 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2264 struct ltt_session
*session
;
2270 * Verify if the session already exist
2272 * XXX: There is no need for the session lock list here since the caller
2273 * (process_client_msg) is holding it. We might want to change that so a
2274 * single command does not lock the entire session list.
2276 session
= session_find_by_name(name
);
2277 if (session
!= NULL
) {
2278 ret
= LTTNG_ERR_EXIST_SESS
;
2282 /* Create tracing session in the registry */
2283 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2284 LTTNG_SOCK_GET_GID_CRED(creds
));
2285 if (ret
!= LTTNG_OK
) {
2290 * Get the newly created session pointer back
2292 * XXX: There is no need for the session lock list here since the caller
2293 * (process_client_msg) is holding it. We might want to change that so a
2294 * single command does not lock the entire session list.
2296 session
= session_find_by_name(name
);
2299 session
->live_timer
= live_timer
;
2300 /* Create default consumer output for the session not yet created. */
2301 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2302 if (session
->consumer
== NULL
) {
2303 ret
= LTTNG_ERR_FATAL
;
2304 goto consumer_error
;
2308 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2309 if (ret
!= LTTNG_OK
) {
2310 goto consumer_error
;
2312 session
->output_traces
= 1;
2314 session
->output_traces
= 0;
2315 DBG2("Session %s created with no output", session
->name
);
2318 session
->consumer
->enabled
= 1;
2323 session_destroy(session
);
2330 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2332 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2333 size_t nb_uri
, lttng_sock_cred
*creds
)
2336 struct ltt_session
*session
;
2337 struct snapshot_output
*new_output
= NULL
;
2343 * Create session in no output mode with URIs set to NULL. The uris we've
2344 * received are for a default snapshot output if one.
2346 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2347 if (ret
!= LTTNG_OK
) {
2351 /* Get the newly created session pointer back. This should NEVER fail. */
2352 session
= session_find_by_name(name
);
2355 /* Flag session for snapshot mode. */
2356 session
->snapshot_mode
= 1;
2358 /* Skip snapshot output creation if no URI is given. */
2363 new_output
= snapshot_output_alloc();
2365 ret
= LTTNG_ERR_NOMEM
;
2366 goto error_snapshot_alloc
;
2369 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2370 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2372 if (ret
== -ENOMEM
) {
2373 ret
= LTTNG_ERR_NOMEM
;
2375 ret
= LTTNG_ERR_INVALID
;
2377 goto error_snapshot
;
2381 snapshot_add_output(&session
->snapshot
, new_output
);
2388 snapshot_output_destroy(new_output
);
2389 error_snapshot_alloc
:
2390 session_destroy(session
);
2396 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2398 * Called with session lock held.
2400 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2403 struct ltt_ust_session
*usess
;
2404 struct ltt_kernel_session
*ksess
;
2409 usess
= session
->ust_session
;
2410 ksess
= session
->kernel_session
;
2412 /* Clean kernel session teardown */
2413 kernel_destroy_session(ksess
);
2415 /* UST session teardown */
2417 /* Close any relayd session */
2418 consumer_output_send_destroy_relayd(usess
->consumer
);
2420 /* Destroy every UST application related to this session. */
2421 ret
= ust_app_destroy_trace_all(usess
);
2423 ERR("Error in ust_app_destroy_trace_all");
2426 /* Clean up the rest. */
2427 trace_ust_destroy_session(usess
);
2431 * Must notify the kernel thread here to update it's poll set in order to
2432 * remove the channel(s)' fd just destroyed.
2434 ret
= notify_thread_pipe(wpipe
);
2436 PERROR("write kernel poll pipe");
2439 ret
= session_destroy(session
);
2445 * Command LTTNG_CALIBRATE processed by the client thread.
2447 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2452 case LTTNG_DOMAIN_KERNEL
:
2454 struct lttng_kernel_calibrate kcalibrate
;
2456 switch (calibrate
->type
) {
2457 case LTTNG_CALIBRATE_FUNCTION
:
2459 /* Default and only possible calibrate option. */
2460 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2464 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2466 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2471 case LTTNG_DOMAIN_UST
:
2473 struct lttng_ust_calibrate ucalibrate
;
2475 switch (calibrate
->type
) {
2476 case LTTNG_CALIBRATE_FUNCTION
:
2478 /* Default and only possible calibrate option. */
2479 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2483 ret
= ust_app_calibrate_glb(&ucalibrate
);
2485 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2491 ret
= LTTNG_ERR_UND
;
2502 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2504 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2505 const char *sock_path
, struct consumer_data
*cdata
)
2508 struct consumer_socket
*socket
= NULL
;
2515 case LTTNG_DOMAIN_KERNEL
:
2517 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2521 /* Can't register a consumer if there is already one */
2522 if (ksess
->consumer_fds_sent
!= 0) {
2523 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2527 sock
= lttcomm_connect_unix_sock(sock_path
);
2529 ret
= LTTNG_ERR_CONNECT_FAIL
;
2532 cdata
->cmd_sock
= sock
;
2534 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2535 if (socket
== NULL
) {
2538 PERROR("close register consumer");
2540 cdata
->cmd_sock
= -1;
2541 ret
= LTTNG_ERR_FATAL
;
2545 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2546 if (socket
->lock
== NULL
) {
2547 PERROR("zmalloc pthread mutex");
2548 ret
= LTTNG_ERR_FATAL
;
2551 pthread_mutex_init(socket
->lock
, NULL
);
2552 socket
->registered
= 1;
2555 consumer_add_socket(socket
, ksess
->consumer
);
2558 pthread_mutex_lock(&cdata
->pid_mutex
);
2560 pthread_mutex_unlock(&cdata
->pid_mutex
);
2565 /* TODO: Userspace tracing */
2566 ret
= LTTNG_ERR_UND
;
2574 consumer_destroy_socket(socket
);
2580 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2582 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2583 struct lttng_domain
**domains
)
2588 struct lttng_ht_iter iter
;
2590 if (session
->kernel_session
!= NULL
) {
2591 DBG3("Listing domains found kernel domain");
2595 if (session
->ust_session
!= NULL
) {
2596 DBG3("Listing domains found UST global domain");
2600 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2602 if (agt
->being_used
) {
2613 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2614 if (*domains
== NULL
) {
2615 ret
= LTTNG_ERR_FATAL
;
2619 if (session
->kernel_session
!= NULL
) {
2620 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2622 /* Kernel session buffer type is always GLOBAL */
2623 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2628 if (session
->ust_session
!= NULL
) {
2629 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2630 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2634 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2636 if (agt
->being_used
) {
2637 (*domains
)[index
].type
= agt
->domain
;
2638 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2648 /* Return negative value to differentiate return code */
2654 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2656 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2657 struct lttng_channel
**channels
)
2660 ssize_t nb_chan
= 0;
2663 case LTTNG_DOMAIN_KERNEL
:
2664 if (session
->kernel_session
!= NULL
) {
2665 nb_chan
= session
->kernel_session
->channel_count
;
2667 DBG3("Number of kernel channels %zd", nb_chan
);
2669 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2672 case LTTNG_DOMAIN_UST
:
2673 if (session
->ust_session
!= NULL
) {
2675 nb_chan
= lttng_ht_get_count(
2676 session
->ust_session
->domain_global
.channels
);
2679 DBG3("Number of UST global channels %zd", nb_chan
);
2681 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2686 ret
= LTTNG_ERR_UND
;
2691 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2692 if (*channels
== NULL
) {
2693 ret
= LTTNG_ERR_FATAL
;
2697 list_lttng_channels(domain
, session
, *channels
);
2703 /* Return negative value to differentiate return code */
2708 * Command LTTNG_LIST_EVENTS processed by the client thread.
2710 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2711 char *channel_name
, struct lttng_event
**events
)
2714 ssize_t nb_event
= 0;
2717 case LTTNG_DOMAIN_KERNEL
:
2718 if (session
->kernel_session
!= NULL
) {
2719 nb_event
= list_lttng_kernel_events(channel_name
,
2720 session
->kernel_session
, events
);
2723 case LTTNG_DOMAIN_UST
:
2725 if (session
->ust_session
!= NULL
) {
2726 nb_event
= list_lttng_ust_global_events(channel_name
,
2727 &session
->ust_session
->domain_global
, events
);
2731 case LTTNG_DOMAIN_LOG4J
:
2732 case LTTNG_DOMAIN_JUL
:
2733 case LTTNG_DOMAIN_PYTHON
:
2734 if (session
->ust_session
) {
2735 struct lttng_ht_iter iter
;
2739 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2740 &iter
.iter
, agt
, node
.node
) {
2741 if (agt
->domain
== domain
) {
2742 nb_event
= list_lttng_agent_events(
2751 ret
= LTTNG_ERR_UND
;
2758 /* Return negative value to differentiate return code */
2763 * Using the session list, filled a lttng_session array to send back to the
2764 * client for session listing.
2766 * The session list lock MUST be acquired before calling this function. Use
2767 * session_lock_list() and session_unlock_list().
2769 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2774 struct ltt_session
*session
;
2775 struct ltt_session_list
*list
= session_get_list();
2777 DBG("Getting all available session for UID %d GID %d",
2780 * Iterate over session list and append data after the control struct in
2783 cds_list_for_each_entry(session
, &list
->head
, list
) {
2785 * Only list the sessions the user can control.
2787 if (!session_access_ok(session
, uid
, gid
)) {
2791 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2792 struct ltt_ust_session
*usess
= session
->ust_session
;
2794 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2795 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2796 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2797 ret
= build_network_session_path(sessions
[i
].path
,
2798 sizeof(sessions
[i
].path
), session
);
2800 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2801 session
->consumer
->dst
.trace_path
);
2804 PERROR("snprintf session path");
2808 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2809 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2810 sessions
[i
].enabled
= session
->active
;
2811 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2812 sessions
[i
].live_timer_interval
= session
->live_timer
;
2818 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2819 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2821 int cmd_data_pending(struct ltt_session
*session
)
2824 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2825 struct ltt_ust_session
*usess
= session
->ust_session
;
2829 /* Session MUST be stopped to ask for data availability. */
2830 if (session
->active
) {
2831 ret
= LTTNG_ERR_SESSION_STARTED
;
2835 * If stopped, just make sure we've started before else the above call
2836 * will always send that there is data pending.
2838 * The consumer assumes that when the data pending command is received,
2839 * the trace has been started before or else no output data is written
2840 * by the streams which is a condition for data pending. So, this is
2841 * *VERY* important that we don't ask the consumer before a start
2844 if (!session
->has_been_started
) {
2850 if (ksess
&& ksess
->consumer
) {
2851 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2853 /* Data is still being extracted for the kernel. */
2858 if (usess
&& usess
->consumer
) {
2859 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2861 /* Data is still being extracted for the kernel. */
2866 /* Data is ready to be read by a viewer */
2874 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2876 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2878 int cmd_snapshot_add_output(struct ltt_session
*session
,
2879 struct lttng_snapshot_output
*output
, uint32_t *id
)
2882 struct snapshot_output
*new_output
;
2887 DBG("Cmd snapshot add output for session %s", session
->name
);
2890 * Permission denied to create an output if the session is not
2891 * set in no output mode.
2893 if (session
->output_traces
) {
2894 ret
= LTTNG_ERR_EPERM
;
2898 /* Only one output is allowed until we have the "tee" feature. */
2899 if (session
->snapshot
.nb_output
== 1) {
2900 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2904 new_output
= snapshot_output_alloc();
2906 ret
= LTTNG_ERR_NOMEM
;
2910 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2911 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2912 &session
->snapshot
);
2914 if (ret
== -ENOMEM
) {
2915 ret
= LTTNG_ERR_NOMEM
;
2917 ret
= LTTNG_ERR_INVALID
;
2923 snapshot_add_output(&session
->snapshot
, new_output
);
2925 *id
= new_output
->id
;
2932 snapshot_output_destroy(new_output
);
2938 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2940 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2942 int cmd_snapshot_del_output(struct ltt_session
*session
,
2943 struct lttng_snapshot_output
*output
)
2946 struct snapshot_output
*sout
= NULL
;
2954 * Permission denied to create an output if the session is not
2955 * set in no output mode.
2957 if (session
->output_traces
) {
2958 ret
= LTTNG_ERR_EPERM
;
2963 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2965 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2966 } else if (*output
->name
!= '\0') {
2967 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2969 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2972 ret
= LTTNG_ERR_INVALID
;
2976 snapshot_delete_output(&session
->snapshot
, sout
);
2977 snapshot_output_destroy(sout
);
2986 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2988 * If no output is available, outputs is untouched and 0 is returned.
2990 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2992 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2993 struct lttng_snapshot_output
**outputs
)
2996 struct lttng_snapshot_output
*list
= NULL
;
2997 struct lttng_ht_iter iter
;
2998 struct snapshot_output
*output
;
3003 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3006 * Permission denied to create an output if the session is not
3007 * set in no output mode.
3009 if (session
->output_traces
) {
3010 ret
= -LTTNG_ERR_EPERM
;
3014 if (session
->snapshot
.nb_output
== 0) {
3019 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3021 ret
= -LTTNG_ERR_NOMEM
;
3025 /* Copy list from session to the new list object. */
3027 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3028 output
, node
.node
) {
3029 assert(output
->consumer
);
3030 list
[idx
].id
= output
->id
;
3031 list
[idx
].max_size
= output
->max_size
;
3032 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3033 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3034 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3035 sizeof(list
[idx
].ctrl_url
));
3038 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3039 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3041 ret
= -LTTNG_ERR_NOMEM
;
3046 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3047 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3049 ret
= -LTTNG_ERR_NOMEM
;
3058 ret
= session
->snapshot
.nb_output
;
3066 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3067 * snapshot output is *not* set with a remote destination.
3069 * Return 0 on success or a LTTNG_ERR code.
3071 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3072 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3075 struct lttng_ht_iter iter
;
3076 struct consumer_socket
*socket
;
3079 assert(snap_output
);
3082 DBG2("Set relayd object from snapshot output");
3084 /* Ignore if snapshot consumer output is not network. */
3085 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3090 * For each consumer socket, create and send the relayd object of the
3094 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3095 socket
, node
.node
) {
3096 ret
= send_consumer_relayd_sockets(0, session
->id
,
3097 snap_output
->consumer
, socket
,
3098 session
->name
, session
->hostname
,
3099 session
->live_timer
);
3100 if (ret
!= LTTNG_OK
) {
3112 * Record a kernel snapshot.
3114 * Return LTTNG_OK on success or a LTTNG_ERR code.
3116 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3117 struct snapshot_output
*output
, struct ltt_session
*session
,
3118 int wait
, uint64_t nb_packets_per_stream
)
3126 /* Get the datetime for the snapshot output directory. */
3127 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3128 sizeof(output
->datetime
));
3130 ret
= LTTNG_ERR_INVALID
;
3135 * Copy kernel session sockets so we can communicate with the right
3136 * consumer for the snapshot record command.
3138 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3140 ret
= LTTNG_ERR_NOMEM
;
3144 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3145 if (ret
!= LTTNG_OK
) {
3146 goto error_snapshot
;
3149 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3150 if (ret
!= LTTNG_OK
) {
3151 goto error_snapshot
;
3158 /* Clean up copied sockets so this output can use some other later on. */
3159 consumer_destroy_output_sockets(output
->consumer
);
3166 * Record a UST snapshot.
3168 * Return 0 on success or a LTTNG_ERR error code.
3170 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3171 struct snapshot_output
*output
, struct ltt_session
*session
,
3172 int wait
, uint64_t nb_packets_per_stream
)
3180 /* Get the datetime for the snapshot output directory. */
3181 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3182 sizeof(output
->datetime
));
3184 ret
= LTTNG_ERR_INVALID
;
3189 * Copy UST session sockets so we can communicate with the right
3190 * consumer for the snapshot record command.
3192 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3194 ret
= LTTNG_ERR_NOMEM
;
3198 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3199 if (ret
!= LTTNG_OK
) {
3200 goto error_snapshot
;
3203 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3207 ret
= LTTNG_ERR_INVALID
;
3210 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3213 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3216 goto error_snapshot
;
3222 /* Clean up copied sockets so this output can use some other later on. */
3223 consumer_destroy_output_sockets(output
->consumer
);
3229 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3230 uint64_t cur_nr_packets
)
3232 uint64_t tot_size
= 0;
3234 if (session
->kernel_session
) {
3235 struct ltt_kernel_channel
*chan
;
3236 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3238 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3239 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3241 * Don't take channel into account if we
3242 * already grab all its packets.
3246 tot_size
+= chan
->channel
->attr
.subbuf_size
3247 * chan
->stream_count
;
3251 if (session
->ust_session
) {
3252 struct ltt_ust_session
*usess
= session
->ust_session
;
3254 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3262 * Calculate the number of packets we can grab from each stream that
3263 * fits within the overall snapshot max size.
3265 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3266 * the number of packets per stream.
3268 * TODO: this approach is not perfect: we consider the worse case
3269 * (packet filling the sub-buffers) as an upper bound, but we could do
3270 * better if we do this calculation while we actually grab the packet
3271 * content: we would know how much padding we don't actually store into
3274 * This algorithm is currently bounded by the number of packets per
3277 * Since we call this algorithm before actually grabbing the data, it's
3278 * an approximation: for instance, applications could appear/disappear
3279 * in between this call and actually grabbing data.
3282 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3285 uint64_t cur_nb_packets
= 0;
3288 return 0; /* Infinite */
3291 size_left
= max_size
;
3293 uint64_t one_more_packet_tot_size
;
3295 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3297 if (!one_more_packet_tot_size
) {
3298 /* We are already grabbing all packets. */
3301 size_left
-= one_more_packet_tot_size
;
3302 if (size_left
< 0) {
3307 if (!cur_nb_packets
) {
3308 /* Not enough room to grab one packet of each stream, error. */
3311 return cur_nb_packets
;
3315 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3317 * The wait parameter is ignored so this call always wait for the snapshot to
3318 * complete before returning.
3320 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3322 int cmd_snapshot_record(struct ltt_session
*session
,
3323 struct lttng_snapshot_output
*output
, int wait
)
3326 unsigned int use_tmp_output
= 0;
3327 struct snapshot_output tmp_output
;
3328 unsigned int snapshot_success
= 0;
3333 DBG("Cmd snapshot record for session %s", session
->name
);
3336 * Permission denied to create an output if the session is not
3337 * set in no output mode.
3339 if (session
->output_traces
) {
3340 ret
= LTTNG_ERR_EPERM
;
3344 /* The session needs to be started at least once. */
3345 if (!session
->has_been_started
) {
3346 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3350 /* Use temporary output for the session. */
3351 if (*output
->ctrl_url
!= '\0') {
3352 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3353 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3356 if (ret
== -ENOMEM
) {
3357 ret
= LTTNG_ERR_NOMEM
;
3359 ret
= LTTNG_ERR_INVALID
;
3363 /* Use the global session count for the temporary snapshot. */
3364 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3368 if (session
->kernel_session
) {
3369 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3371 if (use_tmp_output
) {
3372 int64_t nb_packets_per_stream
;
3374 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3375 tmp_output
.max_size
);
3376 if (nb_packets_per_stream
< 0) {
3377 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3380 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3381 wait
, nb_packets_per_stream
);
3382 if (ret
!= LTTNG_OK
) {
3385 snapshot_success
= 1;
3387 struct snapshot_output
*sout
;
3388 struct lttng_ht_iter iter
;
3391 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3392 &iter
.iter
, sout
, node
.node
) {
3393 int64_t nb_packets_per_stream
;
3396 * Make a local copy of the output and assign the possible
3397 * temporary value given by the caller.
3399 memset(&tmp_output
, 0, sizeof(tmp_output
));
3400 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3402 if (output
->max_size
!= (uint64_t) -1ULL) {
3403 tmp_output
.max_size
= output
->max_size
;
3406 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3407 tmp_output
.max_size
);
3408 if (nb_packets_per_stream
< 0) {
3409 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3413 /* Use temporary name. */
3414 if (*output
->name
!= '\0') {
3415 strncpy(tmp_output
.name
, output
->name
,
3416 sizeof(tmp_output
.name
));
3419 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3421 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3422 session
, wait
, nb_packets_per_stream
);
3423 if (ret
!= LTTNG_OK
) {
3427 snapshot_success
= 1;
3433 if (session
->ust_session
) {
3434 struct ltt_ust_session
*usess
= session
->ust_session
;
3436 if (use_tmp_output
) {
3437 int64_t nb_packets_per_stream
;
3439 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3440 tmp_output
.max_size
);
3441 if (nb_packets_per_stream
< 0) {
3442 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3445 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3446 wait
, nb_packets_per_stream
);
3447 if (ret
!= LTTNG_OK
) {
3450 snapshot_success
= 1;
3452 struct snapshot_output
*sout
;
3453 struct lttng_ht_iter iter
;
3456 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3457 &iter
.iter
, sout
, node
.node
) {
3458 int64_t nb_packets_per_stream
;
3461 * Make a local copy of the output and assign the possible
3462 * temporary value given by the caller.
3464 memset(&tmp_output
, 0, sizeof(tmp_output
));
3465 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3467 if (output
->max_size
!= (uint64_t) -1ULL) {
3468 tmp_output
.max_size
= output
->max_size
;
3471 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3472 tmp_output
.max_size
);
3473 if (nb_packets_per_stream
< 0) {
3474 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3479 /* Use temporary name. */
3480 if (*output
->name
!= '\0') {
3481 strncpy(tmp_output
.name
, output
->name
,
3482 sizeof(tmp_output
.name
));
3485 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3487 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3488 wait
, nb_packets_per_stream
);
3489 if (ret
!= LTTNG_OK
) {
3493 snapshot_success
= 1;
3499 if (snapshot_success
) {
3500 session
->snapshot
.nb_snapshot
++;
3502 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3510 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3512 int cmd_set_session_shm_path(struct ltt_session
*session
,
3513 const char *shm_path
)
3519 * Can only set shm path before session is started.
3521 if (session
->has_been_started
) {
3522 return LTTNG_ERR_SESSION_STARTED
;
3525 strncpy(session
->shm_path
, shm_path
,
3526 sizeof(session
->shm_path
));
3527 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3533 * Init command subsystem.
3538 * Set network sequence index to 1 for streams to match a relayd
3539 * socket on the consumer side.
3541 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3542 relayd_net_seq_idx
= 1;
3543 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3545 DBG("Command subsystem initialized");