2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <urcu/list.h>
23 #include <urcu/uatomic.h>
25 #include <common/defaults.h>
26 #include <common/common.h>
27 #include <common/sessiond-comm/sessiond-comm.h>
28 #include <common/relayd/relayd.h>
29 #include <common/utils.h>
30 #include <common/compat/string.h>
35 #include "health-sessiond.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
46 * Used to keep a unique index for each relayd socket created where this value
47 * is associated with streams on the consumer so it can match the right relayd
48 * to send to. It must be accessed with the relayd_net_seq_idx_lock
51 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 static uint64_t relayd_net_seq_idx
;
54 static int validate_event_name(const char *);
55 static int validate_ust_event_name(const char *);
56 static int cmd_enable_event_internal(struct ltt_session
*session
,
57 struct lttng_domain
*domain
,
58 char *channel_name
, struct lttng_event
*event
,
59 char *filter_expression
,
60 struct lttng_filter_bytecode
*filter
,
61 struct lttng_event_exclusion
*exclusion
,
65 * Create a session path used by list_lttng_sessions for the case that the
66 * session consumer is on the network.
68 static int build_network_session_path(char *dst
, size_t size
,
69 struct ltt_session
*session
)
71 int ret
, kdata_port
, udata_port
;
72 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
73 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
78 memset(tmp_urls
, 0, sizeof(tmp_urls
));
79 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
81 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
83 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
84 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
85 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
88 if (session
->ust_session
&& session
->ust_session
->consumer
) {
89 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
90 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
93 if (uuri
== NULL
&& kuri
== NULL
) {
94 uri
= &session
->consumer
->dst
.net
.control
;
95 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
96 } else if (kuri
&& uuri
) {
97 ret
= uri_compare(kuri
, uuri
);
101 /* Build uuri URL string */
102 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
109 } else if (kuri
&& uuri
== NULL
) {
111 } else if (uuri
&& kuri
== NULL
) {
115 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
121 * Do we have a UST url set. If yes, this means we have both kernel and UST
124 if (*tmp_uurl
!= '\0') {
125 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
126 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
129 if (kuri
|| (!kuri
&& !uuri
)) {
132 /* No kernel URI, use the UST port. */
135 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
143 * Fill lttng_channel array of all channels.
145 static void list_lttng_channels(enum lttng_domain_type domain
,
146 struct ltt_session
*session
, struct lttng_channel
*channels
)
149 struct ltt_kernel_channel
*kchan
;
151 DBG("Listing channels for session %s", session
->name
);
154 case LTTNG_DOMAIN_KERNEL
:
155 /* Kernel channels */
156 if (session
->kernel_session
!= NULL
) {
157 cds_list_for_each_entry(kchan
,
158 &session
->kernel_session
->channel_list
.head
, list
) {
159 /* Copy lttng_channel struct to array */
160 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
161 channels
[i
].enabled
= kchan
->enabled
;
166 case LTTNG_DOMAIN_UST
:
168 struct lttng_ht_iter iter
;
169 struct ltt_ust_channel
*uchan
;
172 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
173 &iter
.iter
, uchan
, node
.node
) {
174 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
175 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
176 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
177 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
178 channels
[i
].attr
.switch_timer_interval
=
179 uchan
->attr
.switch_timer_interval
;
180 channels
[i
].attr
.read_timer_interval
=
181 uchan
->attr
.read_timer_interval
;
182 channels
[i
].enabled
= uchan
->enabled
;
183 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
184 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
185 switch (uchan
->attr
.output
) {
188 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
202 * Create a list of agent domain events.
204 * Return number of events in list on success or else a negative value.
206 static int list_lttng_agent_events(struct agent
*agt
,
207 struct lttng_event
**events
)
210 unsigned int nb_event
= 0;
211 struct agent_event
*event
;
212 struct lttng_event
*tmp_events
;
213 struct lttng_ht_iter iter
;
218 DBG3("Listing agent events");
221 nb_event
= lttng_ht_get_count(agt
->events
);
228 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
230 PERROR("zmalloc agent events session");
231 ret
= -LTTNG_ERR_FATAL
;
236 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
237 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
238 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
239 tmp_events
[i
].enabled
= event
->enabled
;
240 tmp_events
[i
].loglevel
= event
->loglevel_value
;
241 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
246 *events
= tmp_events
;
250 assert(nb_event
== i
);
255 * Create a list of ust global domain events.
257 static int list_lttng_ust_global_events(char *channel_name
,
258 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
261 unsigned int nb_event
= 0;
262 struct lttng_ht_iter iter
;
263 struct lttng_ht_node_str
*node
;
264 struct ltt_ust_channel
*uchan
;
265 struct ltt_ust_event
*uevent
;
266 struct lttng_event
*tmp
;
268 DBG("Listing UST global events for channel %s", channel_name
);
272 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
273 node
= lttng_ht_iter_get_node_str(&iter
);
275 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
279 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
281 nb_event
= lttng_ht_get_count(uchan
->events
);
287 DBG3("Listing UST global %d events", nb_event
);
289 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
291 ret
= LTTNG_ERR_FATAL
;
295 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
296 if (uevent
->internal
) {
297 /* This event should remain hidden from clients */
301 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
302 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
303 tmp
[i
].enabled
= uevent
->enabled
;
305 switch (uevent
->attr
.instrumentation
) {
306 case LTTNG_UST_TRACEPOINT
:
307 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
309 case LTTNG_UST_PROBE
:
310 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
312 case LTTNG_UST_FUNCTION
:
313 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
317 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
318 switch (uevent
->attr
.loglevel_type
) {
319 case LTTNG_UST_LOGLEVEL_ALL
:
320 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
322 case LTTNG_UST_LOGLEVEL_RANGE
:
323 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
325 case LTTNG_UST_LOGLEVEL_SINGLE
:
326 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
329 if (uevent
->filter
) {
332 if (uevent
->exclusion
) {
333 tmp
[i
].exclusion
= 1;
347 * Fill lttng_event array of all kernel events in the channel.
349 static int list_lttng_kernel_events(char *channel_name
,
350 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
353 unsigned int nb_event
;
354 struct ltt_kernel_event
*event
;
355 struct ltt_kernel_channel
*kchan
;
357 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
359 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
363 nb_event
= kchan
->event_count
;
365 DBG("Listing events for channel %s", kchan
->channel
->name
);
372 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
373 if (*events
== NULL
) {
374 ret
= LTTNG_ERR_FATAL
;
378 /* Kernel channels */
379 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
380 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
381 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
382 (*events
)[i
].enabled
= event
->enabled
;
383 (*events
)[i
].filter
=
384 (unsigned char) !!event
->filter_expression
;
386 switch (event
->event
->instrumentation
) {
387 case LTTNG_KERNEL_TRACEPOINT
:
388 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
390 case LTTNG_KERNEL_KRETPROBE
:
391 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
392 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
393 sizeof(struct lttng_kernel_kprobe
));
395 case LTTNG_KERNEL_KPROBE
:
396 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
397 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
398 sizeof(struct lttng_kernel_kprobe
));
400 case LTTNG_KERNEL_FUNCTION
:
401 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
402 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
403 sizeof(struct lttng_kernel_function
));
405 case LTTNG_KERNEL_NOOP
:
406 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
408 case LTTNG_KERNEL_SYSCALL
:
409 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
411 case LTTNG_KERNEL_ALL
:
422 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
434 /* Negate the error code to differentiate the size from an error */
439 * Add URI so the consumer output object. Set the correct path depending on the
440 * domain adding the default trace directory.
442 static int add_uri_to_consumer(struct consumer_output
*consumer
,
443 struct lttng_uri
*uri
, enum lttng_domain_type domain
,
444 const char *session_name
)
447 const char *default_trace_dir
;
451 if (consumer
== NULL
) {
452 DBG("No consumer detected. Don't add URI. Stopping.");
453 ret
= LTTNG_ERR_NO_CONSUMER
;
458 case LTTNG_DOMAIN_KERNEL
:
459 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
461 case LTTNG_DOMAIN_UST
:
462 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
466 * This case is possible is we try to add the URI to the global tracing
467 * session consumer object which in this case there is no subdir.
469 default_trace_dir
= "";
472 switch (uri
->dtype
) {
475 DBG2("Setting network URI to consumer");
477 if (consumer
->type
== CONSUMER_DST_NET
) {
478 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
479 consumer
->dst
.net
.control_isset
) ||
480 (uri
->stype
== LTTNG_STREAM_DATA
&&
481 consumer
->dst
.net
.data_isset
)) {
482 ret
= LTTNG_ERR_URL_EXIST
;
486 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
489 consumer
->type
= CONSUMER_DST_NET
;
491 /* Set URI into consumer output object */
492 ret
= consumer_set_network_uri(consumer
, uri
);
496 } else if (ret
== 1) {
498 * URI was the same in the consumer so we do not append the subdir
499 * again so to not duplicate output dir.
505 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
506 ret
= consumer_set_subdir(consumer
, session_name
);
508 ret
= LTTNG_ERR_FATAL
;
513 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
514 /* On a new subdir, reappend the default trace dir. */
515 strncat(consumer
->subdir
, default_trace_dir
,
516 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
517 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
522 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
523 memset(consumer
->dst
.trace_path
, 0,
524 sizeof(consumer
->dst
.trace_path
));
525 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
526 sizeof(consumer
->dst
.trace_path
));
527 /* Append default trace dir */
528 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
529 sizeof(consumer
->dst
.trace_path
) -
530 strlen(consumer
->dst
.trace_path
) - 1);
531 /* Flag consumer as local. */
532 consumer
->type
= CONSUMER_DST_LOCAL
;
543 * Init tracing by creating trace directory and sending fds kernel consumer.
545 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
548 struct lttng_ht_iter iter
;
549 struct consumer_socket
*socket
;
555 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
556 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
558 pthread_mutex_lock(socket
->lock
);
559 ret
= kernel_consumer_send_session(socket
, session
);
560 pthread_mutex_unlock(socket
->lock
);
562 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
574 * Create a socket to the relayd using the URI.
576 * On success, the relayd_sock pointer is set to the created socket.
577 * Else, it's stays untouched and a lttcomm error code is returned.
579 static int create_connect_relayd(struct lttng_uri
*uri
,
580 struct lttcomm_relayd_sock
**relayd_sock
)
583 struct lttcomm_relayd_sock
*rsock
;
585 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
586 RELAYD_VERSION_COMM_MINOR
);
588 ret
= LTTNG_ERR_FATAL
;
593 * Connect to relayd so we can proceed with a session creation. This call
594 * can possibly block for an arbitrary amount of time to set the health
595 * state to be in poll execution.
598 ret
= relayd_connect(rsock
);
601 ERR("Unable to reach lttng-relayd");
602 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
606 /* Create socket for control stream. */
607 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
608 DBG3("Creating relayd stream socket from URI");
610 /* Check relayd version */
611 ret
= relayd_version_check(rsock
);
613 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
616 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
617 DBG3("Creating relayd data socket from URI");
619 /* Command is not valid */
620 ERR("Relayd invalid stream type: %d", uri
->stype
);
621 ret
= LTTNG_ERR_INVALID
;
625 *relayd_sock
= rsock
;
630 /* The returned value is not useful since we are on an error path. */
631 (void) relayd_close(rsock
);
639 * Connect to the relayd using URI and send the socket to the right consumer.
641 static int send_consumer_relayd_socket(enum lttng_domain_type domain
,
642 unsigned int session_id
, struct lttng_uri
*relayd_uri
,
643 struct consumer_output
*consumer
,
644 struct consumer_socket
*consumer_sock
,
645 char *session_name
, char *hostname
, int session_live_timer
)
648 struct lttcomm_relayd_sock
*rsock
= NULL
;
650 /* Connect to relayd and make version check if uri is the control. */
651 ret
= create_connect_relayd(relayd_uri
, &rsock
);
652 if (ret
!= LTTNG_OK
) {
657 /* Set the network sequence index if not set. */
658 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
659 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
661 * Increment net_seq_idx because we are about to transfer the
662 * new relayd socket to the consumer.
663 * Assign unique key so the consumer can match streams.
665 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
666 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
669 /* Send relayd socket to consumer. */
670 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
671 relayd_uri
->stype
, session_id
,
672 session_name
, hostname
, session_live_timer
);
674 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
678 /* Flag that the corresponding socket was sent. */
679 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
680 consumer_sock
->control_sock_sent
= 1;
681 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
682 consumer_sock
->data_sock_sent
= 1;
688 * Close socket which was dup on the consumer side. The session daemon does
689 * NOT keep track of the relayd socket(s) once transfer to the consumer.
693 (void) relayd_close(rsock
);
697 if (ret
!= LTTNG_OK
) {
699 * The consumer output for this session should not be used anymore
700 * since the relayd connection failed thus making any tracing or/and
701 * streaming not usable.
703 consumer
->enabled
= 0;
709 * Send both relayd sockets to a specific consumer and domain. This is a
710 * helper function to facilitate sending the information to the consumer for a
713 static int send_consumer_relayd_sockets(enum lttng_domain_type domain
,
714 unsigned int session_id
, struct consumer_output
*consumer
,
715 struct consumer_socket
*sock
, char *session_name
,
716 char *hostname
, int session_live_timer
)
723 /* Sending control relayd socket. */
724 if (!sock
->control_sock_sent
) {
725 ret
= send_consumer_relayd_socket(domain
, session_id
,
726 &consumer
->dst
.net
.control
, consumer
, sock
,
727 session_name
, hostname
, session_live_timer
);
728 if (ret
!= LTTNG_OK
) {
733 /* Sending data relayd socket. */
734 if (!sock
->data_sock_sent
) {
735 ret
= send_consumer_relayd_socket(domain
, session_id
,
736 &consumer
->dst
.net
.data
, consumer
, sock
,
737 session_name
, hostname
, session_live_timer
);
738 if (ret
!= LTTNG_OK
) {
748 * Setup relayd connections for a tracing session. First creates the socket to
749 * the relayd and send them to the right domain consumer. Consumer type MUST be
752 int cmd_setup_relayd(struct ltt_session
*session
)
755 struct ltt_ust_session
*usess
;
756 struct ltt_kernel_session
*ksess
;
757 struct consumer_socket
*socket
;
758 struct lttng_ht_iter iter
;
762 usess
= session
->ust_session
;
763 ksess
= session
->kernel_session
;
765 DBG("Setting relayd for session %s", session
->name
);
769 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
770 && usess
->consumer
->enabled
) {
771 /* For each consumer socket, send relayd sockets */
772 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
774 pthread_mutex_lock(socket
->lock
);
775 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
776 usess
->consumer
, socket
,
777 session
->name
, session
->hostname
,
778 session
->live_timer
);
779 pthread_mutex_unlock(socket
->lock
);
780 if (ret
!= LTTNG_OK
) {
783 /* Session is now ready for network streaming. */
784 session
->net_handle
= 1;
788 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
789 && ksess
->consumer
->enabled
) {
790 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
792 pthread_mutex_lock(socket
->lock
);
793 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
794 ksess
->consumer
, socket
,
795 session
->name
, session
->hostname
,
796 session
->live_timer
);
797 pthread_mutex_unlock(socket
->lock
);
798 if (ret
!= LTTNG_OK
) {
801 /* Session is now ready for network streaming. */
802 session
->net_handle
= 1;
812 * Start a kernel session by opening all necessary streams.
814 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
817 struct ltt_kernel_channel
*kchan
;
819 /* Open kernel metadata */
820 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
821 ret
= kernel_open_metadata(ksess
);
823 ret
= LTTNG_ERR_KERN_META_FAIL
;
828 /* Open kernel metadata stream */
829 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
830 ret
= kernel_open_metadata_stream(ksess
);
832 ERR("Kernel create metadata stream failed");
833 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
838 /* For each channel */
839 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
840 if (kchan
->stream_count
== 0) {
841 ret
= kernel_open_channel_stream(kchan
);
843 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
846 /* Update the stream global counter */
847 ksess
->stream_count_global
+= ret
;
851 /* Setup kernel consumer socket and send fds to it */
852 ret
= init_kernel_tracing(ksess
);
854 ret
= LTTNG_ERR_KERN_START_FAIL
;
858 /* This start the kernel tracing */
859 ret
= kernel_start_session(ksess
);
861 ret
= LTTNG_ERR_KERN_START_FAIL
;
865 /* Quiescent wait after starting trace */
866 kernel_wait_quiescent(kernel_tracer_fd
);
877 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
879 int cmd_disable_channel(struct ltt_session
*session
,
880 enum lttng_domain_type domain
, char *channel_name
)
883 struct ltt_ust_session
*usess
;
885 usess
= session
->ust_session
;
890 case LTTNG_DOMAIN_KERNEL
:
892 ret
= channel_kernel_disable(session
->kernel_session
,
894 if (ret
!= LTTNG_OK
) {
898 kernel_wait_quiescent(kernel_tracer_fd
);
901 case LTTNG_DOMAIN_UST
:
903 struct ltt_ust_channel
*uchan
;
904 struct lttng_ht
*chan_ht
;
906 chan_ht
= usess
->domain_global
.channels
;
908 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
910 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
914 ret
= channel_ust_disable(usess
, uchan
);
915 if (ret
!= LTTNG_OK
) {
921 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
933 * Command LTTNG_TRACK_PID processed by the client thread.
935 * Called with session lock held.
937 int cmd_track_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
945 case LTTNG_DOMAIN_KERNEL
:
947 struct ltt_kernel_session
*ksess
;
949 ksess
= session
->kernel_session
;
951 ret
= kernel_track_pid(ksess
, pid
);
952 if (ret
!= LTTNG_OK
) {
956 kernel_wait_quiescent(kernel_tracer_fd
);
959 case LTTNG_DOMAIN_UST
:
961 struct ltt_ust_session
*usess
;
963 usess
= session
->ust_session
;
965 ret
= trace_ust_track_pid(usess
, pid
);
966 if (ret
!= LTTNG_OK
) {
972 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
984 * Command LTTNG_UNTRACK_PID processed by the client thread.
986 * Called with session lock held.
988 int cmd_untrack_pid(struct ltt_session
*session
, enum lttng_domain_type domain
,
996 case LTTNG_DOMAIN_KERNEL
:
998 struct ltt_kernel_session
*ksess
;
1000 ksess
= session
->kernel_session
;
1002 ret
= kernel_untrack_pid(ksess
, pid
);
1003 if (ret
!= LTTNG_OK
) {
1007 kernel_wait_quiescent(kernel_tracer_fd
);
1010 case LTTNG_DOMAIN_UST
:
1012 struct ltt_ust_session
*usess
;
1014 usess
= session
->ust_session
;
1016 ret
= trace_ust_untrack_pid(usess
, pid
);
1017 if (ret
!= LTTNG_OK
) {
1023 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1035 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1037 * The wpipe arguments is used as a notifier for the kernel thread.
1039 int cmd_enable_channel(struct ltt_session
*session
,
1040 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1043 struct ltt_ust_session
*usess
= session
->ust_session
;
1044 struct lttng_ht
*chan_ht
;
1051 len
= lttng_strnlen(attr
->name
, sizeof(attr
->name
));
1053 /* Validate channel name */
1054 if (attr
->name
[0] == '.' ||
1055 memchr(attr
->name
, '/', len
) != NULL
) {
1056 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1060 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1065 * Don't try to enable a channel if the session has been started at
1066 * some point in time before. The tracer does not allow it.
1068 if (session
->has_been_started
) {
1069 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1074 * If the session is a live session, remove the switch timer, the
1075 * live timer does the same thing but sends also synchronisation
1076 * beacons for inactive streams.
1078 if (session
->live_timer
> 0) {
1079 attr
->attr
.live_timer_interval
= session
->live_timer
;
1080 attr
->attr
.switch_timer_interval
= 0;
1084 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1085 * mode and with less than 2 subbuf so block it right away and send back an
1086 * invalid attribute error.
1088 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1089 ret
= LTTNG_ERR_INVALID
;
1093 switch (domain
->type
) {
1094 case LTTNG_DOMAIN_KERNEL
:
1096 struct ltt_kernel_channel
*kchan
;
1098 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1099 session
->kernel_session
);
1100 if (kchan
== NULL
) {
1101 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1102 if (attr
->name
[0] != '\0') {
1103 session
->kernel_session
->has_non_default_channel
= 1;
1106 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1109 if (ret
!= LTTNG_OK
) {
1113 kernel_wait_quiescent(kernel_tracer_fd
);
1116 case LTTNG_DOMAIN_UST
:
1117 case LTTNG_DOMAIN_JUL
:
1118 case LTTNG_DOMAIN_LOG4J
:
1119 case LTTNG_DOMAIN_PYTHON
:
1121 struct ltt_ust_channel
*uchan
;
1126 * Current agent implementation limitations force us to allow
1127 * only one channel at once in "agent" subdomains. Each
1128 * subdomain has a default channel name which must be strictly
1131 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1132 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1133 LTTNG_SYMBOL_NAME_LEN
)) {
1134 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1137 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1138 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1139 LTTNG_SYMBOL_NAME_LEN
)) {
1140 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1143 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1144 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1145 LTTNG_SYMBOL_NAME_LEN
)) {
1146 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1151 chan_ht
= usess
->domain_global
.channels
;
1153 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1154 if (uchan
== NULL
) {
1155 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1156 if (attr
->name
[0] != '\0') {
1157 usess
->has_non_default_channel
= 1;
1160 ret
= channel_ust_enable(usess
, uchan
);
1165 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1176 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1178 int cmd_disable_event(struct ltt_session
*session
,
1179 enum lttng_domain_type domain
, char *channel_name
,
1180 struct lttng_event
*event
)
1185 DBG("Disable event command for event \'%s\'", event
->name
);
1187 event_name
= event
->name
;
1188 if (validate_event_name(event_name
)) {
1189 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1193 /* Error out on unhandled search criteria */
1194 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1195 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1196 ret
= LTTNG_ERR_UNK
;
1203 case LTTNG_DOMAIN_KERNEL
:
1205 struct ltt_kernel_channel
*kchan
;
1206 struct ltt_kernel_session
*ksess
;
1208 ksess
= session
->kernel_session
;
1211 * If a non-default channel has been created in the
1212 * session, explicitely require that -c chan_name needs
1215 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1216 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1220 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1221 if (kchan
== NULL
) {
1222 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1226 switch (event
->type
) {
1227 case LTTNG_EVENT_ALL
:
1228 case LTTNG_EVENT_TRACEPOINT
:
1229 case LTTNG_EVENT_SYSCALL
:
1230 case LTTNG_EVENT_PROBE
:
1231 case LTTNG_EVENT_FUNCTION
:
1232 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1233 if (event_name
[0] == '\0') {
1234 ret
= event_kernel_disable_event(kchan
,
1237 ret
= event_kernel_disable_event(kchan
,
1238 event_name
, event
->type
);
1240 if (ret
!= LTTNG_OK
) {
1245 ret
= LTTNG_ERR_UNK
;
1249 kernel_wait_quiescent(kernel_tracer_fd
);
1252 case LTTNG_DOMAIN_UST
:
1254 struct ltt_ust_channel
*uchan
;
1255 struct ltt_ust_session
*usess
;
1257 usess
= session
->ust_session
;
1259 if (validate_ust_event_name(event_name
)) {
1260 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1265 * If a non-default channel has been created in the
1266 * session, explicitly require that -c chan_name needs
1269 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1270 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1274 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1276 if (uchan
== NULL
) {
1277 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1281 switch (event
->type
) {
1282 case LTTNG_EVENT_ALL
:
1284 * An empty event name means that everything
1285 * should be disabled.
1287 if (event
->name
[0] == '\0') {
1288 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1290 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1293 if (ret
!= LTTNG_OK
) {
1298 ret
= LTTNG_ERR_UNK
;
1302 DBG3("Disable UST event %s in channel %s completed", event_name
,
1306 case LTTNG_DOMAIN_LOG4J
:
1307 case LTTNG_DOMAIN_JUL
:
1308 case LTTNG_DOMAIN_PYTHON
:
1311 struct ltt_ust_session
*usess
= session
->ust_session
;
1315 switch (event
->type
) {
1316 case LTTNG_EVENT_ALL
:
1319 ret
= LTTNG_ERR_UNK
;
1323 agt
= trace_ust_find_agent(usess
, domain
);
1325 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1329 * An empty event name means that everything
1330 * should be disabled.
1332 if (event
->name
[0] == '\0') {
1333 ret
= event_agent_disable_all(usess
, agt
);
1335 ret
= event_agent_disable(usess
, agt
, event_name
);
1337 if (ret
!= LTTNG_OK
) {
1344 ret
= LTTNG_ERR_UND
;
1357 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1359 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1360 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1362 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1363 char *app_ctx_provider_name
= NULL
, *app_ctx_name
= NULL
;
1365 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
1366 app_ctx_provider_name
= ctx
->u
.app_ctx
.provider_name
;
1367 app_ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
1371 case LTTNG_DOMAIN_KERNEL
:
1372 assert(session
->kernel_session
);
1374 if (session
->kernel_session
->channel_count
== 0) {
1375 /* Create default channel */
1376 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1377 if (ret
!= LTTNG_OK
) {
1380 chan_kern_created
= 1;
1382 /* Add kernel context to kernel tracer */
1383 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1384 if (ret
!= LTTNG_OK
) {
1388 case LTTNG_DOMAIN_JUL
:
1389 case LTTNG_DOMAIN_LOG4J
:
1392 * Validate channel name.
1393 * If no channel name is given and the domain is JUL or LOG4J,
1394 * set it to the appropriate domain-specific channel name. If
1395 * a name is provided but does not match the expexted channel
1396 * name, return an error.
1398 if (domain
== LTTNG_DOMAIN_JUL
&& *channel_name
&&
1399 strcmp(channel_name
,
1400 DEFAULT_JUL_CHANNEL_NAME
)) {
1401 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1403 } else if (domain
== LTTNG_DOMAIN_LOG4J
&& *channel_name
&&
1404 strcmp(channel_name
,
1405 DEFAULT_LOG4J_CHANNEL_NAME
)) {
1406 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1409 /* break is _not_ missing here. */
1411 case LTTNG_DOMAIN_UST
:
1413 struct ltt_ust_session
*usess
= session
->ust_session
;
1414 unsigned int chan_count
;
1418 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1419 if (chan_count
== 0) {
1420 struct lttng_channel
*attr
;
1421 /* Create default channel */
1422 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1424 ret
= LTTNG_ERR_FATAL
;
1428 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1429 if (ret
!= LTTNG_OK
) {
1434 chan_ust_created
= 1;
1437 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1438 free(app_ctx_provider_name
);
1440 app_ctx_name
= NULL
;
1441 app_ctx_provider_name
= NULL
;
1442 if (ret
!= LTTNG_OK
) {
1448 ret
= LTTNG_ERR_UND
;
1456 if (chan_kern_created
) {
1457 struct ltt_kernel_channel
*kchan
=
1458 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1459 session
->kernel_session
);
1460 /* Created previously, this should NOT fail. */
1462 kernel_destroy_channel(kchan
);
1465 if (chan_ust_created
) {
1466 struct ltt_ust_channel
*uchan
=
1467 trace_ust_find_channel_by_name(
1468 session
->ust_session
->domain_global
.channels
,
1469 DEFAULT_CHANNEL_NAME
);
1470 /* Created previously, this should NOT fail. */
1472 /* Remove from the channel list of the session. */
1473 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1475 trace_ust_destroy_channel(uchan
);
1478 free(app_ctx_provider_name
);
1483 static int validate_event_name(const char *name
)
1486 const char *c
= name
;
1487 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1488 bool null_terminated
= false;
1491 * Make sure that unescaped wildcards are only used as the last
1492 * character of the event name.
1494 while (c
< event_name_end
) {
1497 null_terminated
= true;
1503 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1504 /* Wildcard is not the last character */
1505 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1514 if (!ret
&& !null_terminated
) {
1515 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1520 static inline bool name_starts_with(const char *name
, const char *prefix
)
1522 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1524 return !strncmp(name
, prefix
, max_cmp_len
);
1527 /* Perform userspace-specific event name validation */
1528 static int validate_ust_event_name(const char *name
)
1538 * Check name against all internal UST event component namespaces used
1541 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1542 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1543 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1552 * Internal version of cmd_enable_event() with a supplemental
1553 * "internal_event" flag which is used to enable internal events which should
1554 * be hidden from clients. Such events are used in the agent implementation to
1555 * enable the events through which all "agent" events are funeled.
1557 static int _cmd_enable_event(struct ltt_session
*session
,
1558 struct lttng_domain
*domain
,
1559 char *channel_name
, struct lttng_event
*event
,
1560 char *filter_expression
,
1561 struct lttng_filter_bytecode
*filter
,
1562 struct lttng_event_exclusion
*exclusion
,
1563 int wpipe
, bool internal_event
)
1565 int ret
, channel_created
= 0;
1566 struct lttng_channel
*attr
;
1570 assert(channel_name
);
1572 /* If we have a filter, we must have its filter expression */
1573 assert(!(!!filter_expression
^ !!filter
));
1575 DBG("Enable event command for event \'%s\'", event
->name
);
1579 ret
= validate_event_name(event
->name
);
1584 switch (domain
->type
) {
1585 case LTTNG_DOMAIN_KERNEL
:
1587 struct ltt_kernel_channel
*kchan
;
1590 * If a non-default channel has been created in the
1591 * session, explicitely require that -c chan_name needs
1594 if (session
->kernel_session
->has_non_default_channel
1595 && channel_name
[0] == '\0') {
1596 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1600 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1601 session
->kernel_session
);
1602 if (kchan
== NULL
) {
1603 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1604 LTTNG_BUFFER_GLOBAL
);
1606 ret
= LTTNG_ERR_FATAL
;
1609 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1611 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1612 if (ret
!= LTTNG_OK
) {
1618 channel_created
= 1;
1621 /* Get the newly created kernel channel pointer */
1622 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1623 session
->kernel_session
);
1624 if (kchan
== NULL
) {
1625 /* This sould not happen... */
1626 ret
= LTTNG_ERR_FATAL
;
1630 switch (event
->type
) {
1631 case LTTNG_EVENT_ALL
:
1633 char *filter_expression_a
= NULL
;
1634 struct lttng_filter_bytecode
*filter_a
= NULL
;
1637 * We need to duplicate filter_expression and filter,
1638 * because ownership is passed to first enable
1641 if (filter_expression
) {
1642 filter_expression_a
= strdup(filter_expression
);
1643 if (!filter_expression_a
) {
1644 ret
= LTTNG_ERR_FATAL
;
1649 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1651 free(filter_expression_a
);
1652 ret
= LTTNG_ERR_FATAL
;
1655 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1657 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1658 ret
= event_kernel_enable_event(kchan
, event
,
1659 filter_expression
, filter
);
1660 /* We have passed ownership */
1661 filter_expression
= NULL
;
1663 if (ret
!= LTTNG_OK
) {
1664 if (channel_created
) {
1665 /* Let's not leak a useless channel. */
1666 kernel_destroy_channel(kchan
);
1668 free(filter_expression_a
);
1672 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1673 ret
= event_kernel_enable_event(kchan
, event
,
1674 filter_expression_a
, filter_a
);
1675 /* We have passed ownership */
1676 filter_expression_a
= NULL
;
1678 if (ret
!= LTTNG_OK
) {
1683 case LTTNG_EVENT_PROBE
:
1684 case LTTNG_EVENT_FUNCTION
:
1685 case LTTNG_EVENT_FUNCTION_ENTRY
:
1686 case LTTNG_EVENT_TRACEPOINT
:
1687 ret
= event_kernel_enable_event(kchan
, event
,
1688 filter_expression
, filter
);
1689 /* We have passed ownership */
1690 filter_expression
= NULL
;
1692 if (ret
!= LTTNG_OK
) {
1693 if (channel_created
) {
1694 /* Let's not leak a useless channel. */
1695 kernel_destroy_channel(kchan
);
1700 case LTTNG_EVENT_SYSCALL
:
1701 ret
= event_kernel_enable_event(kchan
, event
,
1702 filter_expression
, filter
);
1703 /* We have passed ownership */
1704 filter_expression
= NULL
;
1706 if (ret
!= LTTNG_OK
) {
1711 ret
= LTTNG_ERR_UNK
;
1715 kernel_wait_quiescent(kernel_tracer_fd
);
1718 case LTTNG_DOMAIN_UST
:
1720 struct ltt_ust_channel
*uchan
;
1721 struct ltt_ust_session
*usess
= session
->ust_session
;
1726 * If a non-default channel has been created in the
1727 * session, explicitely require that -c chan_name needs
1730 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1731 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1735 /* Get channel from global UST domain */
1736 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1738 if (uchan
== NULL
) {
1739 /* Create default channel */
1740 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1741 usess
->buffer_type
);
1743 ret
= LTTNG_ERR_FATAL
;
1746 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1748 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1749 if (ret
!= LTTNG_OK
) {
1755 /* Get the newly created channel reference back */
1756 uchan
= trace_ust_find_channel_by_name(
1757 usess
->domain_global
.channels
, channel_name
);
1761 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1763 * Don't allow users to add UST events to channels which
1764 * are assigned to a userspace subdomain (JUL, Log4J,
1767 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1771 if (!internal_event
) {
1773 * Ensure the event name is not reserved for internal
1776 ret
= validate_ust_event_name(event
->name
);
1778 WARN("Userspace event name %s failed validation.",
1780 event
->name
: "NULL");
1781 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1786 /* At this point, the session and channel exist on the tracer */
1787 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1788 filter_expression
, filter
, exclusion
,
1790 /* We have passed ownership */
1791 filter_expression
= NULL
;
1794 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1799 case LTTNG_DOMAIN_LOG4J
:
1800 case LTTNG_DOMAIN_JUL
:
1801 case LTTNG_DOMAIN_PYTHON
:
1803 const char *default_event_name
, *default_chan_name
;
1805 struct lttng_event uevent
;
1806 struct lttng_domain tmp_dom
;
1807 struct ltt_ust_session
*usess
= session
->ust_session
;
1811 agt
= trace_ust_find_agent(usess
, domain
->type
);
1813 agt
= agent_create(domain
->type
);
1815 ret
= LTTNG_ERR_NOMEM
;
1818 agent_add(agt
, usess
->agents
);
1821 /* Create the default tracepoint. */
1822 memset(&uevent
, 0, sizeof(uevent
));
1823 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1824 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1825 default_event_name
= event_get_default_agent_ust_name(
1827 if (!default_event_name
) {
1828 ret
= LTTNG_ERR_FATAL
;
1831 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1832 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1835 * The domain type is changed because we are about to enable the
1836 * default channel and event for the JUL domain that are hardcoded.
1837 * This happens in the UST domain.
1839 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1840 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1842 switch (domain
->type
) {
1843 case LTTNG_DOMAIN_LOG4J
:
1844 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1846 case LTTNG_DOMAIN_JUL
:
1847 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1849 case LTTNG_DOMAIN_PYTHON
:
1850 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1853 /* The switch/case we are in makes this impossible */
1858 char *filter_expression_copy
= NULL
;
1859 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1862 const size_t filter_size
= sizeof(
1863 struct lttng_filter_bytecode
)
1866 filter_copy
= zmalloc(filter_size
);
1868 ret
= LTTNG_ERR_NOMEM
;
1871 memcpy(filter_copy
, filter
, filter_size
);
1873 filter_expression_copy
=
1874 strdup(filter_expression
);
1875 if (!filter_expression
) {
1876 ret
= LTTNG_ERR_NOMEM
;
1879 if (!filter_expression_copy
|| !filter_copy
) {
1880 free(filter_expression_copy
);
1886 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1887 (char *) default_chan_name
,
1888 &uevent
, filter_expression_copy
,
1889 filter_copy
, NULL
, wpipe
);
1892 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1896 /* The wild card * means that everything should be enabled. */
1897 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1898 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1901 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1905 filter_expression
= NULL
;
1906 if (ret
!= LTTNG_OK
) {
1913 ret
= LTTNG_ERR_UND
;
1920 free(filter_expression
);
1928 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1929 * We own filter, exclusion, and filter_expression.
1931 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1932 char *channel_name
, struct lttng_event
*event
,
1933 char *filter_expression
,
1934 struct lttng_filter_bytecode
*filter
,
1935 struct lttng_event_exclusion
*exclusion
,
1938 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1939 filter_expression
, filter
, exclusion
, wpipe
, false);
1943 * Enable an event which is internal to LTTng. An internal should
1944 * never be made visible to clients and are immune to checks such as
1947 static int cmd_enable_event_internal(struct ltt_session
*session
,
1948 struct lttng_domain
*domain
,
1949 char *channel_name
, struct lttng_event
*event
,
1950 char *filter_expression
,
1951 struct lttng_filter_bytecode
*filter
,
1952 struct lttng_event_exclusion
*exclusion
,
1955 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1956 filter_expression
, filter
, exclusion
, wpipe
, true);
1960 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1962 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1963 struct lttng_event
**events
)
1966 ssize_t nb_events
= 0;
1969 case LTTNG_DOMAIN_KERNEL
:
1970 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1971 if (nb_events
< 0) {
1972 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1976 case LTTNG_DOMAIN_UST
:
1977 nb_events
= ust_app_list_events(events
);
1978 if (nb_events
< 0) {
1979 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1983 case LTTNG_DOMAIN_LOG4J
:
1984 case LTTNG_DOMAIN_JUL
:
1985 case LTTNG_DOMAIN_PYTHON
:
1986 nb_events
= agent_list_events(events
, domain
);
1987 if (nb_events
< 0) {
1988 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1993 ret
= LTTNG_ERR_UND
;
2000 /* Return negative value to differentiate return code */
2005 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2007 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2008 struct lttng_event_field
**fields
)
2011 ssize_t nb_fields
= 0;
2014 case LTTNG_DOMAIN_UST
:
2015 nb_fields
= ust_app_list_event_fields(fields
);
2016 if (nb_fields
< 0) {
2017 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2021 case LTTNG_DOMAIN_KERNEL
:
2022 default: /* fall-through */
2023 ret
= LTTNG_ERR_UND
;
2030 /* Return negative value to differentiate return code */
2034 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2036 return syscall_table_list(events
);
2040 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2042 * Called with session lock held.
2044 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2045 enum lttng_domain_type domain
, int32_t **pids
)
2048 ssize_t nr_pids
= 0;
2051 case LTTNG_DOMAIN_KERNEL
:
2053 struct ltt_kernel_session
*ksess
;
2055 ksess
= session
->kernel_session
;
2056 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2058 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2063 case LTTNG_DOMAIN_UST
:
2065 struct ltt_ust_session
*usess
;
2067 usess
= session
->ust_session
;
2068 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2070 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2075 case LTTNG_DOMAIN_LOG4J
:
2076 case LTTNG_DOMAIN_JUL
:
2077 case LTTNG_DOMAIN_PYTHON
:
2079 ret
= LTTNG_ERR_UND
;
2086 /* Return negative value to differentiate return code */
2091 * Command LTTNG_START_TRACE processed by the client thread.
2093 * Called with session mutex held.
2095 int cmd_start_trace(struct ltt_session
*session
)
2098 unsigned long nb_chan
= 0;
2099 struct ltt_kernel_session
*ksession
;
2100 struct ltt_ust_session
*usess
;
2104 /* Ease our life a bit ;) */
2105 ksession
= session
->kernel_session
;
2106 usess
= session
->ust_session
;
2108 /* Is the session already started? */
2109 if (session
->active
) {
2110 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2115 * Starting a session without channel is useless since after that it's not
2116 * possible to enable channel thus inform the client.
2118 if (usess
&& usess
->domain_global
.channels
) {
2119 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2122 nb_chan
+= ksession
->channel_count
;
2125 ret
= LTTNG_ERR_NO_CHANNEL
;
2129 /* Kernel tracing */
2130 if (ksession
!= NULL
) {
2131 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2132 if (ret
!= LTTNG_OK
) {
2137 /* Flag session that trace should start automatically */
2140 * Even though the start trace might fail, flag this session active so
2141 * other application coming in are started by default.
2145 ret
= ust_app_start_trace_all(usess
);
2147 ret
= LTTNG_ERR_UST_START_FAIL
;
2152 /* Flag this after a successful start. */
2153 session
->has_been_started
= 1;
2154 session
->active
= 1;
2163 * Command LTTNG_STOP_TRACE processed by the client thread.
2165 int cmd_stop_trace(struct ltt_session
*session
)
2168 struct ltt_kernel_channel
*kchan
;
2169 struct ltt_kernel_session
*ksession
;
2170 struct ltt_ust_session
*usess
;
2175 ksession
= session
->kernel_session
;
2176 usess
= session
->ust_session
;
2178 /* Session is not active. Skip everythong and inform the client. */
2179 if (!session
->active
) {
2180 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2185 if (ksession
&& ksession
->active
) {
2186 DBG("Stop kernel tracing");
2188 /* Flush metadata if exist */
2189 if (ksession
->metadata_stream_fd
>= 0) {
2190 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2192 ERR("Kernel metadata flush failed");
2196 /* Flush all buffers before stopping */
2197 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2198 ret
= kernel_flush_buffer(kchan
);
2200 ERR("Kernel flush buffer error");
2204 ret
= kernel_stop_session(ksession
);
2206 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2210 kernel_wait_quiescent(kernel_tracer_fd
);
2212 ksession
->active
= 0;
2215 if (usess
&& usess
->active
) {
2217 * Even though the stop trace might fail, flag this session inactive so
2218 * other application coming in are not started by default.
2222 ret
= ust_app_stop_trace_all(usess
);
2224 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2229 /* Flag inactive after a successful stop. */
2230 session
->active
= 0;
2238 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2240 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2241 struct lttng_uri
*uris
)
2244 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2245 struct ltt_ust_session
*usess
= session
->ust_session
;
2251 /* Can't set consumer URI if the session is active. */
2252 if (session
->active
) {
2253 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2257 /* Set the "global" consumer URIs */
2258 for (i
= 0; i
< nb_uri
; i
++) {
2259 ret
= add_uri_to_consumer(session
->consumer
,
2260 &uris
[i
], 0, session
->name
);
2261 if (ret
!= LTTNG_OK
) {
2266 /* Set UST session URIs */
2267 if (session
->ust_session
) {
2268 for (i
= 0; i
< nb_uri
; i
++) {
2269 ret
= add_uri_to_consumer(
2270 session
->ust_session
->consumer
,
2271 &uris
[i
], LTTNG_DOMAIN_UST
,
2273 if (ret
!= LTTNG_OK
) {
2279 /* Set kernel session URIs */
2280 if (session
->kernel_session
) {
2281 for (i
= 0; i
< nb_uri
; i
++) {
2282 ret
= add_uri_to_consumer(
2283 session
->kernel_session
->consumer
,
2284 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2286 if (ret
!= LTTNG_OK
) {
2293 * Make sure to set the session in output mode after we set URI since a
2294 * session can be created without URL (thus flagged in no output mode).
2296 session
->output_traces
= 1;
2298 ksess
->output_traces
= 1;
2302 usess
->output_traces
= 1;
2313 * Command LTTNG_CREATE_SESSION processed by the client thread.
2315 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2316 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2319 struct ltt_session
*session
;
2325 * Verify if the session already exist
2327 * XXX: There is no need for the session lock list here since the caller
2328 * (process_client_msg) is holding it. We might want to change that so a
2329 * single command does not lock the entire session list.
2331 session
= session_find_by_name(name
);
2332 if (session
!= NULL
) {
2333 ret
= LTTNG_ERR_EXIST_SESS
;
2337 /* Create tracing session in the registry */
2338 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2339 LTTNG_SOCK_GET_GID_CRED(creds
));
2340 if (ret
!= LTTNG_OK
) {
2345 * Get the newly created session pointer back
2347 * XXX: There is no need for the session lock list here since the caller
2348 * (process_client_msg) is holding it. We might want to change that so a
2349 * single command does not lock the entire session list.
2351 session
= session_find_by_name(name
);
2354 session
->live_timer
= live_timer
;
2355 /* Create default consumer output for the session not yet created. */
2356 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2357 if (session
->consumer
== NULL
) {
2358 ret
= LTTNG_ERR_FATAL
;
2359 goto consumer_error
;
2363 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2364 if (ret
!= LTTNG_OK
) {
2365 goto consumer_error
;
2367 session
->output_traces
= 1;
2369 session
->output_traces
= 0;
2370 DBG2("Session %s created with no output", session
->name
);
2373 session
->consumer
->enabled
= 1;
2378 session_destroy(session
);
2385 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2387 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2388 size_t nb_uri
, lttng_sock_cred
*creds
)
2391 struct ltt_session
*session
;
2392 struct snapshot_output
*new_output
= NULL
;
2398 * Create session in no output mode with URIs set to NULL. The uris we've
2399 * received are for a default snapshot output if one.
2401 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2402 if (ret
!= LTTNG_OK
) {
2406 /* Get the newly created session pointer back. This should NEVER fail. */
2407 session
= session_find_by_name(name
);
2410 /* Flag session for snapshot mode. */
2411 session
->snapshot_mode
= 1;
2413 /* Skip snapshot output creation if no URI is given. */
2418 new_output
= snapshot_output_alloc();
2420 ret
= LTTNG_ERR_NOMEM
;
2421 goto error_snapshot_alloc
;
2424 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2425 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2427 if (ret
== -ENOMEM
) {
2428 ret
= LTTNG_ERR_NOMEM
;
2430 ret
= LTTNG_ERR_INVALID
;
2432 goto error_snapshot
;
2436 snapshot_add_output(&session
->snapshot
, new_output
);
2443 snapshot_output_destroy(new_output
);
2444 error_snapshot_alloc
:
2445 session_destroy(session
);
2451 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2453 * Called with session lock held.
2455 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2458 struct ltt_ust_session
*usess
;
2459 struct ltt_kernel_session
*ksess
;
2464 usess
= session
->ust_session
;
2465 ksess
= session
->kernel_session
;
2467 /* Clean kernel session teardown */
2468 kernel_destroy_session(ksess
);
2470 /* UST session teardown */
2472 /* Close any relayd session */
2473 consumer_output_send_destroy_relayd(usess
->consumer
);
2475 /* Destroy every UST application related to this session. */
2476 ret
= ust_app_destroy_trace_all(usess
);
2478 ERR("Error in ust_app_destroy_trace_all");
2481 /* Clean up the rest. */
2482 trace_ust_destroy_session(usess
);
2486 * Must notify the kernel thread here to update it's poll set in order to
2487 * remove the channel(s)' fd just destroyed.
2489 ret
= notify_thread_pipe(wpipe
);
2491 PERROR("write kernel poll pipe");
2494 ret
= session_destroy(session
);
2500 * Command LTTNG_CALIBRATE processed by the client thread.
2502 int cmd_calibrate(enum lttng_domain_type domain
,
2503 struct lttng_calibrate
*calibrate
)
2508 case LTTNG_DOMAIN_KERNEL
:
2510 struct lttng_kernel_calibrate kcalibrate
;
2512 switch (calibrate
->type
) {
2513 case LTTNG_CALIBRATE_FUNCTION
:
2515 /* Default and only possible calibrate option. */
2516 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2520 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2522 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2527 case LTTNG_DOMAIN_UST
:
2529 struct lttng_ust_calibrate ucalibrate
;
2531 switch (calibrate
->type
) {
2532 case LTTNG_CALIBRATE_FUNCTION
:
2534 /* Default and only possible calibrate option. */
2535 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2539 ret
= ust_app_calibrate_glb(&ucalibrate
);
2541 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2547 ret
= LTTNG_ERR_UND
;
2558 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2560 int cmd_register_consumer(struct ltt_session
*session
,
2561 enum lttng_domain_type domain
, const char *sock_path
,
2562 struct consumer_data
*cdata
)
2565 struct consumer_socket
*socket
= NULL
;
2572 case LTTNG_DOMAIN_KERNEL
:
2574 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2578 /* Can't register a consumer if there is already one */
2579 if (ksess
->consumer_fds_sent
!= 0) {
2580 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2584 sock
= lttcomm_connect_unix_sock(sock_path
);
2586 ret
= LTTNG_ERR_CONNECT_FAIL
;
2589 cdata
->cmd_sock
= sock
;
2591 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2592 if (socket
== NULL
) {
2595 PERROR("close register consumer");
2597 cdata
->cmd_sock
= -1;
2598 ret
= LTTNG_ERR_FATAL
;
2602 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2603 if (socket
->lock
== NULL
) {
2604 PERROR("zmalloc pthread mutex");
2605 ret
= LTTNG_ERR_FATAL
;
2608 pthread_mutex_init(socket
->lock
, NULL
);
2609 socket
->registered
= 1;
2612 consumer_add_socket(socket
, ksess
->consumer
);
2615 pthread_mutex_lock(&cdata
->pid_mutex
);
2617 pthread_mutex_unlock(&cdata
->pid_mutex
);
2622 /* TODO: Userspace tracing */
2623 ret
= LTTNG_ERR_UND
;
2631 consumer_destroy_socket(socket
);
2637 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2639 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2640 struct lttng_domain
**domains
)
2645 struct lttng_ht_iter iter
;
2647 if (session
->kernel_session
!= NULL
) {
2648 DBG3("Listing domains found kernel domain");
2652 if (session
->ust_session
!= NULL
) {
2653 DBG3("Listing domains found UST global domain");
2657 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2659 if (agt
->being_used
) {
2670 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2671 if (*domains
== NULL
) {
2672 ret
= LTTNG_ERR_FATAL
;
2676 if (session
->kernel_session
!= NULL
) {
2677 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2679 /* Kernel session buffer type is always GLOBAL */
2680 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2685 if (session
->ust_session
!= NULL
) {
2686 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2687 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2691 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2693 if (agt
->being_used
) {
2694 (*domains
)[index
].type
= agt
->domain
;
2695 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2705 /* Return negative value to differentiate return code */
2711 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2713 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2714 struct ltt_session
*session
, struct lttng_channel
**channels
)
2717 ssize_t nb_chan
= 0;
2720 case LTTNG_DOMAIN_KERNEL
:
2721 if (session
->kernel_session
!= NULL
) {
2722 nb_chan
= session
->kernel_session
->channel_count
;
2724 DBG3("Number of kernel channels %zd", nb_chan
);
2726 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2729 case LTTNG_DOMAIN_UST
:
2730 if (session
->ust_session
!= NULL
) {
2732 nb_chan
= lttng_ht_get_count(
2733 session
->ust_session
->domain_global
.channels
);
2736 DBG3("Number of UST global channels %zd", nb_chan
);
2738 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2743 ret
= LTTNG_ERR_UND
;
2748 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2749 if (*channels
== NULL
) {
2750 ret
= LTTNG_ERR_FATAL
;
2754 list_lttng_channels(domain
, session
, *channels
);
2760 /* Return negative value to differentiate return code */
2765 * Command LTTNG_LIST_EVENTS processed by the client thread.
2767 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2768 struct ltt_session
*session
, char *channel_name
,
2769 struct lttng_event
**events
)
2772 ssize_t nb_event
= 0;
2775 case LTTNG_DOMAIN_KERNEL
:
2776 if (session
->kernel_session
!= NULL
) {
2777 nb_event
= list_lttng_kernel_events(channel_name
,
2778 session
->kernel_session
, events
);
2781 case LTTNG_DOMAIN_UST
:
2783 if (session
->ust_session
!= NULL
) {
2784 nb_event
= list_lttng_ust_global_events(channel_name
,
2785 &session
->ust_session
->domain_global
, events
);
2789 case LTTNG_DOMAIN_LOG4J
:
2790 case LTTNG_DOMAIN_JUL
:
2791 case LTTNG_DOMAIN_PYTHON
:
2792 if (session
->ust_session
) {
2793 struct lttng_ht_iter iter
;
2797 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2798 &iter
.iter
, agt
, node
.node
) {
2799 if (agt
->domain
== domain
) {
2800 nb_event
= list_lttng_agent_events(
2809 ret
= LTTNG_ERR_UND
;
2816 /* Return negative value to differentiate return code */
2821 * Using the session list, filled a lttng_session array to send back to the
2822 * client for session listing.
2824 * The session list lock MUST be acquired before calling this function. Use
2825 * session_lock_list() and session_unlock_list().
2827 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2832 struct ltt_session
*session
;
2833 struct ltt_session_list
*list
= session_get_list();
2835 DBG("Getting all available session for UID %d GID %d",
2838 * Iterate over session list and append data after the control struct in
2841 cds_list_for_each_entry(session
, &list
->head
, list
) {
2843 * Only list the sessions the user can control.
2845 if (!session_access_ok(session
, uid
, gid
)) {
2849 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2850 struct ltt_ust_session
*usess
= session
->ust_session
;
2852 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2853 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2854 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2855 ret
= build_network_session_path(sessions
[i
].path
,
2856 sizeof(sessions
[i
].path
), session
);
2858 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2859 session
->consumer
->dst
.trace_path
);
2862 PERROR("snprintf session path");
2866 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2867 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2868 sessions
[i
].enabled
= session
->active
;
2869 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2870 sessions
[i
].live_timer_interval
= session
->live_timer
;
2876 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2877 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2879 int cmd_data_pending(struct ltt_session
*session
)
2882 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2883 struct ltt_ust_session
*usess
= session
->ust_session
;
2887 /* Session MUST be stopped to ask for data availability. */
2888 if (session
->active
) {
2889 ret
= LTTNG_ERR_SESSION_STARTED
;
2893 * If stopped, just make sure we've started before else the above call
2894 * will always send that there is data pending.
2896 * The consumer assumes that when the data pending command is received,
2897 * the trace has been started before or else no output data is written
2898 * by the streams which is a condition for data pending. So, this is
2899 * *VERY* important that we don't ask the consumer before a start
2902 if (!session
->has_been_started
) {
2908 if (ksess
&& ksess
->consumer
) {
2909 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2911 /* Data is still being extracted for the kernel. */
2916 if (usess
&& usess
->consumer
) {
2917 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2919 /* Data is still being extracted for the kernel. */
2924 /* Data is ready to be read by a viewer */
2932 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2934 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2936 int cmd_snapshot_add_output(struct ltt_session
*session
,
2937 struct lttng_snapshot_output
*output
, uint32_t *id
)
2940 struct snapshot_output
*new_output
;
2945 DBG("Cmd snapshot add output for session %s", session
->name
);
2948 * Permission denied to create an output if the session is not
2949 * set in no output mode.
2951 if (session
->output_traces
) {
2952 ret
= LTTNG_ERR_EPERM
;
2956 /* Only one output is allowed until we have the "tee" feature. */
2957 if (session
->snapshot
.nb_output
== 1) {
2958 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2962 new_output
= snapshot_output_alloc();
2964 ret
= LTTNG_ERR_NOMEM
;
2968 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2969 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2970 &session
->snapshot
);
2972 if (ret
== -ENOMEM
) {
2973 ret
= LTTNG_ERR_NOMEM
;
2975 ret
= LTTNG_ERR_INVALID
;
2981 snapshot_add_output(&session
->snapshot
, new_output
);
2983 *id
= new_output
->id
;
2990 snapshot_output_destroy(new_output
);
2996 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2998 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3000 int cmd_snapshot_del_output(struct ltt_session
*session
,
3001 struct lttng_snapshot_output
*output
)
3004 struct snapshot_output
*sout
= NULL
;
3012 * Permission denied to create an output if the session is not
3013 * set in no output mode.
3015 if (session
->output_traces
) {
3016 ret
= LTTNG_ERR_EPERM
;
3021 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3023 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3024 } else if (*output
->name
!= '\0') {
3025 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3027 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3030 ret
= LTTNG_ERR_INVALID
;
3034 snapshot_delete_output(&session
->snapshot
, sout
);
3035 snapshot_output_destroy(sout
);
3044 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3046 * If no output is available, outputs is untouched and 0 is returned.
3048 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3050 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3051 struct lttng_snapshot_output
**outputs
)
3054 struct lttng_snapshot_output
*list
= NULL
;
3055 struct lttng_ht_iter iter
;
3056 struct snapshot_output
*output
;
3061 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3064 * Permission denied to create an output if the session is not
3065 * set in no output mode.
3067 if (session
->output_traces
) {
3068 ret
= -LTTNG_ERR_EPERM
;
3072 if (session
->snapshot
.nb_output
== 0) {
3077 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3079 ret
= -LTTNG_ERR_NOMEM
;
3083 /* Copy list from session to the new list object. */
3085 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3086 output
, node
.node
) {
3087 assert(output
->consumer
);
3088 list
[idx
].id
= output
->id
;
3089 list
[idx
].max_size
= output
->max_size
;
3090 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3091 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3092 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3093 sizeof(list
[idx
].ctrl_url
));
3096 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3097 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3099 ret
= -LTTNG_ERR_NOMEM
;
3104 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3105 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3107 ret
= -LTTNG_ERR_NOMEM
;
3116 ret
= session
->snapshot
.nb_output
;
3124 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3125 * snapshot output is *not* set with a remote destination.
3127 * Return 0 on success or a LTTNG_ERR code.
3129 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3130 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3133 struct lttng_ht_iter iter
;
3134 struct consumer_socket
*socket
;
3137 assert(snap_output
);
3140 DBG2("Set relayd object from snapshot output");
3142 /* Ignore if snapshot consumer output is not network. */
3143 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3148 * For each consumer socket, create and send the relayd object of the
3152 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3153 socket
, node
.node
) {
3154 ret
= send_consumer_relayd_sockets(0, session
->id
,
3155 snap_output
->consumer
, socket
,
3156 session
->name
, session
->hostname
,
3157 session
->live_timer
);
3158 if (ret
!= LTTNG_OK
) {
3170 * Record a kernel snapshot.
3172 * Return LTTNG_OK on success or a LTTNG_ERR code.
3174 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3175 struct snapshot_output
*output
, struct ltt_session
*session
,
3176 int wait
, uint64_t nb_packets_per_stream
)
3184 /* Get the datetime for the snapshot output directory. */
3185 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3186 sizeof(output
->datetime
));
3188 ret
= LTTNG_ERR_INVALID
;
3193 * Copy kernel session sockets so we can communicate with the right
3194 * consumer for the snapshot record command.
3196 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3198 ret
= LTTNG_ERR_NOMEM
;
3202 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3203 if (ret
!= LTTNG_OK
) {
3204 goto error_snapshot
;
3207 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3208 if (ret
!= LTTNG_OK
) {
3209 goto error_snapshot
;
3216 /* Clean up copied sockets so this output can use some other later on. */
3217 consumer_destroy_output_sockets(output
->consumer
);
3224 * Record a UST snapshot.
3226 * Return 0 on success or a LTTNG_ERR error code.
3228 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3229 struct snapshot_output
*output
, struct ltt_session
*session
,
3230 int wait
, uint64_t nb_packets_per_stream
)
3238 /* Get the datetime for the snapshot output directory. */
3239 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3240 sizeof(output
->datetime
));
3242 ret
= LTTNG_ERR_INVALID
;
3247 * Copy UST session sockets so we can communicate with the right
3248 * consumer for the snapshot record command.
3250 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3252 ret
= LTTNG_ERR_NOMEM
;
3256 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3257 if (ret
!= LTTNG_OK
) {
3258 goto error_snapshot
;
3261 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3265 ret
= LTTNG_ERR_INVALID
;
3268 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3271 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3274 goto error_snapshot
;
3280 /* Clean up copied sockets so this output can use some other later on. */
3281 consumer_destroy_output_sockets(output
->consumer
);
3287 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3288 uint64_t cur_nr_packets
)
3290 uint64_t tot_size
= 0;
3292 if (session
->kernel_session
) {
3293 struct ltt_kernel_channel
*chan
;
3294 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3296 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3297 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3299 * Don't take channel into account if we
3300 * already grab all its packets.
3304 tot_size
+= chan
->channel
->attr
.subbuf_size
3305 * chan
->stream_count
;
3309 if (session
->ust_session
) {
3310 struct ltt_ust_session
*usess
= session
->ust_session
;
3312 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3320 * Calculate the number of packets we can grab from each stream that
3321 * fits within the overall snapshot max size.
3323 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3324 * the number of packets per stream.
3326 * TODO: this approach is not perfect: we consider the worse case
3327 * (packet filling the sub-buffers) as an upper bound, but we could do
3328 * better if we do this calculation while we actually grab the packet
3329 * content: we would know how much padding we don't actually store into
3332 * This algorithm is currently bounded by the number of packets per
3335 * Since we call this algorithm before actually grabbing the data, it's
3336 * an approximation: for instance, applications could appear/disappear
3337 * in between this call and actually grabbing data.
3340 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3343 uint64_t cur_nb_packets
= 0;
3346 return 0; /* Infinite */
3349 size_left
= max_size
;
3351 uint64_t one_more_packet_tot_size
;
3353 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3355 if (!one_more_packet_tot_size
) {
3356 /* We are already grabbing all packets. */
3359 size_left
-= one_more_packet_tot_size
;
3360 if (size_left
< 0) {
3365 if (!cur_nb_packets
) {
3366 /* Not enough room to grab one packet of each stream, error. */
3369 return cur_nb_packets
;
3373 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3375 * The wait parameter is ignored so this call always wait for the snapshot to
3376 * complete before returning.
3378 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3380 int cmd_snapshot_record(struct ltt_session
*session
,
3381 struct lttng_snapshot_output
*output
, int wait
)
3384 unsigned int use_tmp_output
= 0;
3385 struct snapshot_output tmp_output
;
3386 unsigned int snapshot_success
= 0;
3391 DBG("Cmd snapshot record for session %s", session
->name
);
3394 * Permission denied to create an output if the session is not
3395 * set in no output mode.
3397 if (session
->output_traces
) {
3398 ret
= LTTNG_ERR_EPERM
;
3402 /* The session needs to be started at least once. */
3403 if (!session
->has_been_started
) {
3404 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3408 /* Use temporary output for the session. */
3409 if (*output
->ctrl_url
!= '\0') {
3410 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3411 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3414 if (ret
== -ENOMEM
) {
3415 ret
= LTTNG_ERR_NOMEM
;
3417 ret
= LTTNG_ERR_INVALID
;
3421 /* Use the global session count for the temporary snapshot. */
3422 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3426 if (session
->kernel_session
) {
3427 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3429 if (use_tmp_output
) {
3430 int64_t nb_packets_per_stream
;
3432 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3433 tmp_output
.max_size
);
3434 if (nb_packets_per_stream
< 0) {
3435 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3438 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3439 wait
, nb_packets_per_stream
);
3440 if (ret
!= LTTNG_OK
) {
3443 snapshot_success
= 1;
3445 struct snapshot_output
*sout
;
3446 struct lttng_ht_iter iter
;
3449 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3450 &iter
.iter
, sout
, node
.node
) {
3451 int64_t nb_packets_per_stream
;
3454 * Make a local copy of the output and assign the possible
3455 * temporary value given by the caller.
3457 memset(&tmp_output
, 0, sizeof(tmp_output
));
3458 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3460 if (output
->max_size
!= (uint64_t) -1ULL) {
3461 tmp_output
.max_size
= output
->max_size
;
3464 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3465 tmp_output
.max_size
);
3466 if (nb_packets_per_stream
< 0) {
3467 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3471 /* Use temporary name. */
3472 if (*output
->name
!= '\0') {
3473 strncpy(tmp_output
.name
, output
->name
,
3474 sizeof(tmp_output
.name
));
3477 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3479 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3480 session
, wait
, nb_packets_per_stream
);
3481 if (ret
!= LTTNG_OK
) {
3485 snapshot_success
= 1;
3491 if (session
->ust_session
) {
3492 struct ltt_ust_session
*usess
= session
->ust_session
;
3494 if (use_tmp_output
) {
3495 int64_t nb_packets_per_stream
;
3497 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3498 tmp_output
.max_size
);
3499 if (nb_packets_per_stream
< 0) {
3500 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3503 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3504 wait
, nb_packets_per_stream
);
3505 if (ret
!= LTTNG_OK
) {
3508 snapshot_success
= 1;
3510 struct snapshot_output
*sout
;
3511 struct lttng_ht_iter iter
;
3514 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3515 &iter
.iter
, sout
, node
.node
) {
3516 int64_t nb_packets_per_stream
;
3519 * Make a local copy of the output and assign the possible
3520 * temporary value given by the caller.
3522 memset(&tmp_output
, 0, sizeof(tmp_output
));
3523 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3525 if (output
->max_size
!= (uint64_t) -1ULL) {
3526 tmp_output
.max_size
= output
->max_size
;
3529 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3530 tmp_output
.max_size
);
3531 if (nb_packets_per_stream
< 0) {
3532 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3537 /* Use temporary name. */
3538 if (*output
->name
!= '\0') {
3539 strncpy(tmp_output
.name
, output
->name
,
3540 sizeof(tmp_output
.name
));
3543 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3545 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3546 wait
, nb_packets_per_stream
);
3547 if (ret
!= LTTNG_OK
) {
3551 snapshot_success
= 1;
3557 if (snapshot_success
) {
3558 session
->snapshot
.nb_snapshot
++;
3560 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3568 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3570 int cmd_set_session_shm_path(struct ltt_session
*session
,
3571 const char *shm_path
)
3577 * Can only set shm path before session is started.
3579 if (session
->has_been_started
) {
3580 return LTTNG_ERR_SESSION_STARTED
;
3583 strncpy(session
->shm_path
, shm_path
,
3584 sizeof(session
->shm_path
));
3585 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3591 * Init command subsystem.
3596 * Set network sequence index to 1 for streams to match a relayd
3597 * socket on the consumer side.
3599 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3600 relayd_net_seq_idx
= 1;
3601 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3603 DBG("Command subsystem initialized");