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_ERR_UST_EVENT_ENABLED
) {
1795 goto already_enabled
;
1796 } else if (ret
!= LTTNG_OK
) {
1801 case LTTNG_DOMAIN_LOG4J
:
1802 case LTTNG_DOMAIN_JUL
:
1803 case LTTNG_DOMAIN_PYTHON
:
1805 const char *default_event_name
, *default_chan_name
;
1807 struct lttng_event uevent
;
1808 struct lttng_domain tmp_dom
;
1809 struct ltt_ust_session
*usess
= session
->ust_session
;
1813 agt
= trace_ust_find_agent(usess
, domain
->type
);
1815 agt
= agent_create(domain
->type
);
1817 ret
= LTTNG_ERR_NOMEM
;
1820 agent_add(agt
, usess
->agents
);
1823 /* Create the default tracepoint. */
1824 memset(&uevent
, 0, sizeof(uevent
));
1825 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1826 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1827 default_event_name
= event_get_default_agent_ust_name(
1829 if (!default_event_name
) {
1830 ret
= LTTNG_ERR_FATAL
;
1833 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1834 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1837 * The domain type is changed because we are about to enable the
1838 * default channel and event for the JUL domain that are hardcoded.
1839 * This happens in the UST domain.
1841 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1842 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1844 switch (domain
->type
) {
1845 case LTTNG_DOMAIN_LOG4J
:
1846 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1848 case LTTNG_DOMAIN_JUL
:
1849 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1851 case LTTNG_DOMAIN_PYTHON
:
1852 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1855 /* The switch/case we are in makes this impossible */
1860 char *filter_expression_copy
= NULL
;
1861 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1864 const size_t filter_size
= sizeof(
1865 struct lttng_filter_bytecode
)
1868 filter_copy
= zmalloc(filter_size
);
1870 ret
= LTTNG_ERR_NOMEM
;
1873 memcpy(filter_copy
, filter
, filter_size
);
1875 filter_expression_copy
=
1876 strdup(filter_expression
);
1877 if (!filter_expression
) {
1878 ret
= LTTNG_ERR_NOMEM
;
1881 if (!filter_expression_copy
|| !filter_copy
) {
1882 free(filter_expression_copy
);
1888 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1889 (char *) default_chan_name
,
1890 &uevent
, filter_expression_copy
,
1891 filter_copy
, NULL
, wpipe
);
1894 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1895 goto already_enabled
;
1896 } else if (ret
!= LTTNG_OK
) {
1900 /* The wild card * means that everything should be enabled. */
1901 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1902 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1905 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1909 filter_expression
= NULL
;
1910 if (ret
!= LTTNG_OK
) {
1917 ret
= LTTNG_ERR_UND
;
1925 free(filter_expression
);
1933 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1934 * We own filter, exclusion, and filter_expression.
1936 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1937 char *channel_name
, struct lttng_event
*event
,
1938 char *filter_expression
,
1939 struct lttng_filter_bytecode
*filter
,
1940 struct lttng_event_exclusion
*exclusion
,
1943 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1944 filter_expression
, filter
, exclusion
, wpipe
, false);
1948 * Enable an event which is internal to LTTng. An internal should
1949 * never be made visible to clients and are immune to checks such as
1952 static int cmd_enable_event_internal(struct ltt_session
*session
,
1953 struct lttng_domain
*domain
,
1954 char *channel_name
, struct lttng_event
*event
,
1955 char *filter_expression
,
1956 struct lttng_filter_bytecode
*filter
,
1957 struct lttng_event_exclusion
*exclusion
,
1960 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1961 filter_expression
, filter
, exclusion
, wpipe
, true);
1965 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1967 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1968 struct lttng_event
**events
)
1971 ssize_t nb_events
= 0;
1974 case LTTNG_DOMAIN_KERNEL
:
1975 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1976 if (nb_events
< 0) {
1977 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1981 case LTTNG_DOMAIN_UST
:
1982 nb_events
= ust_app_list_events(events
);
1983 if (nb_events
< 0) {
1984 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1988 case LTTNG_DOMAIN_LOG4J
:
1989 case LTTNG_DOMAIN_JUL
:
1990 case LTTNG_DOMAIN_PYTHON
:
1991 nb_events
= agent_list_events(events
, domain
);
1992 if (nb_events
< 0) {
1993 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1998 ret
= LTTNG_ERR_UND
;
2005 /* Return negative value to differentiate return code */
2010 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2012 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
2013 struct lttng_event_field
**fields
)
2016 ssize_t nb_fields
= 0;
2019 case LTTNG_DOMAIN_UST
:
2020 nb_fields
= ust_app_list_event_fields(fields
);
2021 if (nb_fields
< 0) {
2022 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2026 case LTTNG_DOMAIN_KERNEL
:
2027 default: /* fall-through */
2028 ret
= LTTNG_ERR_UND
;
2035 /* Return negative value to differentiate return code */
2039 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
2041 return syscall_table_list(events
);
2045 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2047 * Called with session lock held.
2049 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2050 enum lttng_domain_type domain
, int32_t **pids
)
2053 ssize_t nr_pids
= 0;
2056 case LTTNG_DOMAIN_KERNEL
:
2058 struct ltt_kernel_session
*ksess
;
2060 ksess
= session
->kernel_session
;
2061 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2063 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2068 case LTTNG_DOMAIN_UST
:
2070 struct ltt_ust_session
*usess
;
2072 usess
= session
->ust_session
;
2073 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2075 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2080 case LTTNG_DOMAIN_LOG4J
:
2081 case LTTNG_DOMAIN_JUL
:
2082 case LTTNG_DOMAIN_PYTHON
:
2084 ret
= LTTNG_ERR_UND
;
2091 /* Return negative value to differentiate return code */
2096 * Command LTTNG_START_TRACE processed by the client thread.
2098 * Called with session mutex held.
2100 int cmd_start_trace(struct ltt_session
*session
)
2103 unsigned long nb_chan
= 0;
2104 struct ltt_kernel_session
*ksession
;
2105 struct ltt_ust_session
*usess
;
2109 /* Ease our life a bit ;) */
2110 ksession
= session
->kernel_session
;
2111 usess
= session
->ust_session
;
2113 /* Is the session already started? */
2114 if (session
->active
) {
2115 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2120 * Starting a session without channel is useless since after that it's not
2121 * possible to enable channel thus inform the client.
2123 if (usess
&& usess
->domain_global
.channels
) {
2124 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2127 nb_chan
+= ksession
->channel_count
;
2130 ret
= LTTNG_ERR_NO_CHANNEL
;
2134 /* Kernel tracing */
2135 if (ksession
!= NULL
) {
2136 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2137 if (ret
!= LTTNG_OK
) {
2142 /* Flag session that trace should start automatically */
2145 * Even though the start trace might fail, flag this session active so
2146 * other application coming in are started by default.
2150 ret
= ust_app_start_trace_all(usess
);
2152 ret
= LTTNG_ERR_UST_START_FAIL
;
2157 /* Flag this after a successful start. */
2158 session
->has_been_started
= 1;
2159 session
->active
= 1;
2168 * Command LTTNG_STOP_TRACE processed by the client thread.
2170 int cmd_stop_trace(struct ltt_session
*session
)
2173 struct ltt_kernel_channel
*kchan
;
2174 struct ltt_kernel_session
*ksession
;
2175 struct ltt_ust_session
*usess
;
2180 ksession
= session
->kernel_session
;
2181 usess
= session
->ust_session
;
2183 /* Session is not active. Skip everythong and inform the client. */
2184 if (!session
->active
) {
2185 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2190 if (ksession
&& ksession
->active
) {
2191 DBG("Stop kernel tracing");
2193 /* Flush metadata if exist */
2194 if (ksession
->metadata_stream_fd
>= 0) {
2195 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2197 ERR("Kernel metadata flush failed");
2201 /* Flush all buffers before stopping */
2202 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2203 ret
= kernel_flush_buffer(kchan
);
2205 ERR("Kernel flush buffer error");
2209 ret
= kernel_stop_session(ksession
);
2211 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2215 kernel_wait_quiescent(kernel_tracer_fd
);
2217 ksession
->active
= 0;
2220 if (usess
&& usess
->active
) {
2222 * Even though the stop trace might fail, flag this session inactive so
2223 * other application coming in are not started by default.
2227 ret
= ust_app_stop_trace_all(usess
);
2229 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2234 /* Flag inactive after a successful stop. */
2235 session
->active
= 0;
2243 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2245 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2246 struct lttng_uri
*uris
)
2249 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2250 struct ltt_ust_session
*usess
= session
->ust_session
;
2256 /* Can't set consumer URI if the session is active. */
2257 if (session
->active
) {
2258 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2262 /* Set the "global" consumer URIs */
2263 for (i
= 0; i
< nb_uri
; i
++) {
2264 ret
= add_uri_to_consumer(session
->consumer
,
2265 &uris
[i
], 0, session
->name
);
2266 if (ret
!= LTTNG_OK
) {
2271 /* Set UST session URIs */
2272 if (session
->ust_session
) {
2273 for (i
= 0; i
< nb_uri
; i
++) {
2274 ret
= add_uri_to_consumer(
2275 session
->ust_session
->consumer
,
2276 &uris
[i
], LTTNG_DOMAIN_UST
,
2278 if (ret
!= LTTNG_OK
) {
2284 /* Set kernel session URIs */
2285 if (session
->kernel_session
) {
2286 for (i
= 0; i
< nb_uri
; i
++) {
2287 ret
= add_uri_to_consumer(
2288 session
->kernel_session
->consumer
,
2289 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2291 if (ret
!= LTTNG_OK
) {
2298 * Make sure to set the session in output mode after we set URI since a
2299 * session can be created without URL (thus flagged in no output mode).
2301 session
->output_traces
= 1;
2303 ksess
->output_traces
= 1;
2307 usess
->output_traces
= 1;
2318 * Command LTTNG_CREATE_SESSION processed by the client thread.
2320 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2321 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2324 struct ltt_session
*session
;
2330 * Verify if the session already exist
2332 * XXX: There is no need for the session lock list here since the caller
2333 * (process_client_msg) is holding it. We might want to change that so a
2334 * single command does not lock the entire session list.
2336 session
= session_find_by_name(name
);
2337 if (session
!= NULL
) {
2338 ret
= LTTNG_ERR_EXIST_SESS
;
2342 /* Create tracing session in the registry */
2343 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2344 LTTNG_SOCK_GET_GID_CRED(creds
));
2345 if (ret
!= LTTNG_OK
) {
2350 * Get the newly created session pointer back
2352 * XXX: There is no need for the session lock list here since the caller
2353 * (process_client_msg) is holding it. We might want to change that so a
2354 * single command does not lock the entire session list.
2356 session
= session_find_by_name(name
);
2359 session
->live_timer
= live_timer
;
2360 /* Create default consumer output for the session not yet created. */
2361 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2362 if (session
->consumer
== NULL
) {
2363 ret
= LTTNG_ERR_FATAL
;
2364 goto consumer_error
;
2368 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2369 if (ret
!= LTTNG_OK
) {
2370 goto consumer_error
;
2372 session
->output_traces
= 1;
2374 session
->output_traces
= 0;
2375 DBG2("Session %s created with no output", session
->name
);
2378 session
->consumer
->enabled
= 1;
2383 session_destroy(session
);
2390 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2392 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2393 size_t nb_uri
, lttng_sock_cred
*creds
)
2396 struct ltt_session
*session
;
2397 struct snapshot_output
*new_output
= NULL
;
2403 * Create session in no output mode with URIs set to NULL. The uris we've
2404 * received are for a default snapshot output if one.
2406 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2407 if (ret
!= LTTNG_OK
) {
2411 /* Get the newly created session pointer back. This should NEVER fail. */
2412 session
= session_find_by_name(name
);
2415 /* Flag session for snapshot mode. */
2416 session
->snapshot_mode
= 1;
2418 /* Skip snapshot output creation if no URI is given. */
2423 new_output
= snapshot_output_alloc();
2425 ret
= LTTNG_ERR_NOMEM
;
2426 goto error_snapshot_alloc
;
2429 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2430 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2432 if (ret
== -ENOMEM
) {
2433 ret
= LTTNG_ERR_NOMEM
;
2435 ret
= LTTNG_ERR_INVALID
;
2437 goto error_snapshot
;
2441 snapshot_add_output(&session
->snapshot
, new_output
);
2448 snapshot_output_destroy(new_output
);
2449 error_snapshot_alloc
:
2450 session_destroy(session
);
2456 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2458 * Called with session lock held.
2460 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2463 struct ltt_ust_session
*usess
;
2464 struct ltt_kernel_session
*ksess
;
2469 usess
= session
->ust_session
;
2470 ksess
= session
->kernel_session
;
2472 /* Clean kernel session teardown */
2473 kernel_destroy_session(ksess
);
2475 /* UST session teardown */
2477 /* Close any relayd session */
2478 consumer_output_send_destroy_relayd(usess
->consumer
);
2480 /* Destroy every UST application related to this session. */
2481 ret
= ust_app_destroy_trace_all(usess
);
2483 ERR("Error in ust_app_destroy_trace_all");
2486 /* Clean up the rest. */
2487 trace_ust_destroy_session(usess
);
2491 * Must notify the kernel thread here to update it's poll set in order to
2492 * remove the channel(s)' fd just destroyed.
2494 ret
= notify_thread_pipe(wpipe
);
2496 PERROR("write kernel poll pipe");
2499 ret
= session_destroy(session
);
2505 * Command LTTNG_CALIBRATE processed by the client thread.
2507 int cmd_calibrate(enum lttng_domain_type domain
,
2508 struct lttng_calibrate
*calibrate
)
2513 case LTTNG_DOMAIN_KERNEL
:
2515 struct lttng_kernel_calibrate kcalibrate
;
2517 switch (calibrate
->type
) {
2518 case LTTNG_CALIBRATE_FUNCTION
:
2520 /* Default and only possible calibrate option. */
2521 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2525 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2527 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2532 case LTTNG_DOMAIN_UST
:
2534 struct lttng_ust_calibrate ucalibrate
;
2536 switch (calibrate
->type
) {
2537 case LTTNG_CALIBRATE_FUNCTION
:
2539 /* Default and only possible calibrate option. */
2540 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2544 ret
= ust_app_calibrate_glb(&ucalibrate
);
2546 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2552 ret
= LTTNG_ERR_UND
;
2563 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2565 int cmd_register_consumer(struct ltt_session
*session
,
2566 enum lttng_domain_type domain
, const char *sock_path
,
2567 struct consumer_data
*cdata
)
2570 struct consumer_socket
*socket
= NULL
;
2577 case LTTNG_DOMAIN_KERNEL
:
2579 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2583 /* Can't register a consumer if there is already one */
2584 if (ksess
->consumer_fds_sent
!= 0) {
2585 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2589 sock
= lttcomm_connect_unix_sock(sock_path
);
2591 ret
= LTTNG_ERR_CONNECT_FAIL
;
2594 cdata
->cmd_sock
= sock
;
2596 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2597 if (socket
== NULL
) {
2600 PERROR("close register consumer");
2602 cdata
->cmd_sock
= -1;
2603 ret
= LTTNG_ERR_FATAL
;
2607 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2608 if (socket
->lock
== NULL
) {
2609 PERROR("zmalloc pthread mutex");
2610 ret
= LTTNG_ERR_FATAL
;
2613 pthread_mutex_init(socket
->lock
, NULL
);
2614 socket
->registered
= 1;
2617 consumer_add_socket(socket
, ksess
->consumer
);
2620 pthread_mutex_lock(&cdata
->pid_mutex
);
2622 pthread_mutex_unlock(&cdata
->pid_mutex
);
2627 /* TODO: Userspace tracing */
2628 ret
= LTTNG_ERR_UND
;
2636 consumer_destroy_socket(socket
);
2642 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2644 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2645 struct lttng_domain
**domains
)
2650 struct lttng_ht_iter iter
;
2652 if (session
->kernel_session
!= NULL
) {
2653 DBG3("Listing domains found kernel domain");
2657 if (session
->ust_session
!= NULL
) {
2658 DBG3("Listing domains found UST global domain");
2662 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2664 if (agt
->being_used
) {
2675 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2676 if (*domains
== NULL
) {
2677 ret
= LTTNG_ERR_FATAL
;
2681 if (session
->kernel_session
!= NULL
) {
2682 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2684 /* Kernel session buffer type is always GLOBAL */
2685 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2690 if (session
->ust_session
!= NULL
) {
2691 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2692 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2696 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2698 if (agt
->being_used
) {
2699 (*domains
)[index
].type
= agt
->domain
;
2700 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2710 /* Return negative value to differentiate return code */
2716 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2718 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2719 struct ltt_session
*session
, struct lttng_channel
**channels
)
2722 ssize_t nb_chan
= 0;
2725 case LTTNG_DOMAIN_KERNEL
:
2726 if (session
->kernel_session
!= NULL
) {
2727 nb_chan
= session
->kernel_session
->channel_count
;
2729 DBG3("Number of kernel channels %zd", nb_chan
);
2731 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2734 case LTTNG_DOMAIN_UST
:
2735 if (session
->ust_session
!= NULL
) {
2737 nb_chan
= lttng_ht_get_count(
2738 session
->ust_session
->domain_global
.channels
);
2741 DBG3("Number of UST global channels %zd", nb_chan
);
2743 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2748 ret
= LTTNG_ERR_UND
;
2753 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2754 if (*channels
== NULL
) {
2755 ret
= LTTNG_ERR_FATAL
;
2759 list_lttng_channels(domain
, session
, *channels
);
2765 /* Return negative value to differentiate return code */
2770 * Command LTTNG_LIST_EVENTS processed by the client thread.
2772 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2773 struct ltt_session
*session
, char *channel_name
,
2774 struct lttng_event
**events
)
2777 ssize_t nb_event
= 0;
2780 case LTTNG_DOMAIN_KERNEL
:
2781 if (session
->kernel_session
!= NULL
) {
2782 nb_event
= list_lttng_kernel_events(channel_name
,
2783 session
->kernel_session
, events
);
2786 case LTTNG_DOMAIN_UST
:
2788 if (session
->ust_session
!= NULL
) {
2789 nb_event
= list_lttng_ust_global_events(channel_name
,
2790 &session
->ust_session
->domain_global
, events
);
2794 case LTTNG_DOMAIN_LOG4J
:
2795 case LTTNG_DOMAIN_JUL
:
2796 case LTTNG_DOMAIN_PYTHON
:
2797 if (session
->ust_session
) {
2798 struct lttng_ht_iter iter
;
2802 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2803 &iter
.iter
, agt
, node
.node
) {
2804 if (agt
->domain
== domain
) {
2805 nb_event
= list_lttng_agent_events(
2814 ret
= LTTNG_ERR_UND
;
2821 /* Return negative value to differentiate return code */
2826 * Using the session list, filled a lttng_session array to send back to the
2827 * client for session listing.
2829 * The session list lock MUST be acquired before calling this function. Use
2830 * session_lock_list() and session_unlock_list().
2832 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2837 struct ltt_session
*session
;
2838 struct ltt_session_list
*list
= session_get_list();
2840 DBG("Getting all available session for UID %d GID %d",
2843 * Iterate over session list and append data after the control struct in
2846 cds_list_for_each_entry(session
, &list
->head
, list
) {
2848 * Only list the sessions the user can control.
2850 if (!session_access_ok(session
, uid
, gid
)) {
2854 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2855 struct ltt_ust_session
*usess
= session
->ust_session
;
2857 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2858 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2859 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2860 ret
= build_network_session_path(sessions
[i
].path
,
2861 sizeof(sessions
[i
].path
), session
);
2863 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2864 session
->consumer
->dst
.trace_path
);
2867 PERROR("snprintf session path");
2871 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2872 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2873 sessions
[i
].enabled
= session
->active
;
2874 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2875 sessions
[i
].live_timer_interval
= session
->live_timer
;
2881 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2882 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2884 int cmd_data_pending(struct ltt_session
*session
)
2887 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2888 struct ltt_ust_session
*usess
= session
->ust_session
;
2892 /* Session MUST be stopped to ask for data availability. */
2893 if (session
->active
) {
2894 ret
= LTTNG_ERR_SESSION_STARTED
;
2898 * If stopped, just make sure we've started before else the above call
2899 * will always send that there is data pending.
2901 * The consumer assumes that when the data pending command is received,
2902 * the trace has been started before or else no output data is written
2903 * by the streams which is a condition for data pending. So, this is
2904 * *VERY* important that we don't ask the consumer before a start
2907 if (!session
->has_been_started
) {
2913 if (ksess
&& ksess
->consumer
) {
2914 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2916 /* Data is still being extracted for the kernel. */
2921 if (usess
&& usess
->consumer
) {
2922 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2924 /* Data is still being extracted for the kernel. */
2929 /* Data is ready to be read by a viewer */
2937 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2939 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2941 int cmd_snapshot_add_output(struct ltt_session
*session
,
2942 struct lttng_snapshot_output
*output
, uint32_t *id
)
2945 struct snapshot_output
*new_output
;
2950 DBG("Cmd snapshot add output for session %s", session
->name
);
2953 * Permission denied to create an output if the session is not
2954 * set in no output mode.
2956 if (session
->output_traces
) {
2957 ret
= LTTNG_ERR_EPERM
;
2961 /* Only one output is allowed until we have the "tee" feature. */
2962 if (session
->snapshot
.nb_output
== 1) {
2963 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2967 new_output
= snapshot_output_alloc();
2969 ret
= LTTNG_ERR_NOMEM
;
2973 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2974 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2975 &session
->snapshot
);
2977 if (ret
== -ENOMEM
) {
2978 ret
= LTTNG_ERR_NOMEM
;
2980 ret
= LTTNG_ERR_INVALID
;
2986 snapshot_add_output(&session
->snapshot
, new_output
);
2988 *id
= new_output
->id
;
2995 snapshot_output_destroy(new_output
);
3001 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3003 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3005 int cmd_snapshot_del_output(struct ltt_session
*session
,
3006 struct lttng_snapshot_output
*output
)
3009 struct snapshot_output
*sout
= NULL
;
3017 * Permission denied to create an output if the session is not
3018 * set in no output mode.
3020 if (session
->output_traces
) {
3021 ret
= LTTNG_ERR_EPERM
;
3026 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
3028 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
3029 } else if (*output
->name
!= '\0') {
3030 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
3032 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
3035 ret
= LTTNG_ERR_INVALID
;
3039 snapshot_delete_output(&session
->snapshot
, sout
);
3040 snapshot_output_destroy(sout
);
3049 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3051 * If no output is available, outputs is untouched and 0 is returned.
3053 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3055 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3056 struct lttng_snapshot_output
**outputs
)
3059 struct lttng_snapshot_output
*list
= NULL
;
3060 struct lttng_ht_iter iter
;
3061 struct snapshot_output
*output
;
3066 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3069 * Permission denied to create an output if the session is not
3070 * set in no output mode.
3072 if (session
->output_traces
) {
3073 ret
= -LTTNG_ERR_EPERM
;
3077 if (session
->snapshot
.nb_output
== 0) {
3082 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3084 ret
= -LTTNG_ERR_NOMEM
;
3088 /* Copy list from session to the new list object. */
3090 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3091 output
, node
.node
) {
3092 assert(output
->consumer
);
3093 list
[idx
].id
= output
->id
;
3094 list
[idx
].max_size
= output
->max_size
;
3095 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3096 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3097 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3098 sizeof(list
[idx
].ctrl_url
));
3101 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3102 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3104 ret
= -LTTNG_ERR_NOMEM
;
3109 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3110 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3112 ret
= -LTTNG_ERR_NOMEM
;
3121 ret
= session
->snapshot
.nb_output
;
3129 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3130 * snapshot output is *not* set with a remote destination.
3132 * Return 0 on success or a LTTNG_ERR code.
3134 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3135 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3138 struct lttng_ht_iter iter
;
3139 struct consumer_socket
*socket
;
3142 assert(snap_output
);
3145 DBG2("Set relayd object from snapshot output");
3147 /* Ignore if snapshot consumer output is not network. */
3148 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3153 * For each consumer socket, create and send the relayd object of the
3157 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3158 socket
, node
.node
) {
3159 ret
= send_consumer_relayd_sockets(0, session
->id
,
3160 snap_output
->consumer
, socket
,
3161 session
->name
, session
->hostname
,
3162 session
->live_timer
);
3163 if (ret
!= LTTNG_OK
) {
3175 * Record a kernel snapshot.
3177 * Return LTTNG_OK on success or a LTTNG_ERR code.
3179 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3180 struct snapshot_output
*output
, struct ltt_session
*session
,
3181 int wait
, uint64_t nb_packets_per_stream
)
3189 /* Get the datetime for the snapshot output directory. */
3190 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3191 sizeof(output
->datetime
));
3193 ret
= LTTNG_ERR_INVALID
;
3198 * Copy kernel session sockets so we can communicate with the right
3199 * consumer for the snapshot record command.
3201 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3203 ret
= LTTNG_ERR_NOMEM
;
3207 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3208 if (ret
!= LTTNG_OK
) {
3209 goto error_snapshot
;
3212 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3213 if (ret
!= LTTNG_OK
) {
3214 goto error_snapshot
;
3221 /* Clean up copied sockets so this output can use some other later on. */
3222 consumer_destroy_output_sockets(output
->consumer
);
3229 * Record a UST snapshot.
3231 * Return 0 on success or a LTTNG_ERR error code.
3233 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3234 struct snapshot_output
*output
, struct ltt_session
*session
,
3235 int wait
, uint64_t nb_packets_per_stream
)
3243 /* Get the datetime for the snapshot output directory. */
3244 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3245 sizeof(output
->datetime
));
3247 ret
= LTTNG_ERR_INVALID
;
3252 * Copy UST session sockets so we can communicate with the right
3253 * consumer for the snapshot record command.
3255 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3257 ret
= LTTNG_ERR_NOMEM
;
3261 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3262 if (ret
!= LTTNG_OK
) {
3263 goto error_snapshot
;
3266 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3270 ret
= LTTNG_ERR_INVALID
;
3273 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3276 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3279 goto error_snapshot
;
3285 /* Clean up copied sockets so this output can use some other later on. */
3286 consumer_destroy_output_sockets(output
->consumer
);
3292 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3293 uint64_t cur_nr_packets
)
3295 uint64_t tot_size
= 0;
3297 if (session
->kernel_session
) {
3298 struct ltt_kernel_channel
*chan
;
3299 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3301 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3302 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3304 * Don't take channel into account if we
3305 * already grab all its packets.
3309 tot_size
+= chan
->channel
->attr
.subbuf_size
3310 * chan
->stream_count
;
3314 if (session
->ust_session
) {
3315 struct ltt_ust_session
*usess
= session
->ust_session
;
3317 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3325 * Calculate the number of packets we can grab from each stream that
3326 * fits within the overall snapshot max size.
3328 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3329 * the number of packets per stream.
3331 * TODO: this approach is not perfect: we consider the worse case
3332 * (packet filling the sub-buffers) as an upper bound, but we could do
3333 * better if we do this calculation while we actually grab the packet
3334 * content: we would know how much padding we don't actually store into
3337 * This algorithm is currently bounded by the number of packets per
3340 * Since we call this algorithm before actually grabbing the data, it's
3341 * an approximation: for instance, applications could appear/disappear
3342 * in between this call and actually grabbing data.
3345 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3348 uint64_t cur_nb_packets
= 0;
3351 return 0; /* Infinite */
3354 size_left
= max_size
;
3356 uint64_t one_more_packet_tot_size
;
3358 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3360 if (!one_more_packet_tot_size
) {
3361 /* We are already grabbing all packets. */
3364 size_left
-= one_more_packet_tot_size
;
3365 if (size_left
< 0) {
3370 if (!cur_nb_packets
) {
3371 /* Not enough room to grab one packet of each stream, error. */
3374 return cur_nb_packets
;
3378 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3380 * The wait parameter is ignored so this call always wait for the snapshot to
3381 * complete before returning.
3383 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3385 int cmd_snapshot_record(struct ltt_session
*session
,
3386 struct lttng_snapshot_output
*output
, int wait
)
3389 unsigned int use_tmp_output
= 0;
3390 struct snapshot_output tmp_output
;
3391 unsigned int snapshot_success
= 0;
3396 DBG("Cmd snapshot record for session %s", session
->name
);
3399 * Permission denied to create an output if the session is not
3400 * set in no output mode.
3402 if (session
->output_traces
) {
3403 ret
= LTTNG_ERR_EPERM
;
3407 /* The session needs to be started at least once. */
3408 if (!session
->has_been_started
) {
3409 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3413 /* Use temporary output for the session. */
3414 if (*output
->ctrl_url
!= '\0') {
3415 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3416 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3419 if (ret
== -ENOMEM
) {
3420 ret
= LTTNG_ERR_NOMEM
;
3422 ret
= LTTNG_ERR_INVALID
;
3426 /* Use the global session count for the temporary snapshot. */
3427 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3431 if (session
->kernel_session
) {
3432 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3434 if (use_tmp_output
) {
3435 int64_t nb_packets_per_stream
;
3437 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3438 tmp_output
.max_size
);
3439 if (nb_packets_per_stream
< 0) {
3440 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3443 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3444 wait
, nb_packets_per_stream
);
3445 if (ret
!= LTTNG_OK
) {
3448 snapshot_success
= 1;
3450 struct snapshot_output
*sout
;
3451 struct lttng_ht_iter iter
;
3454 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3455 &iter
.iter
, sout
, node
.node
) {
3456 int64_t nb_packets_per_stream
;
3459 * Make a local copy of the output and assign the possible
3460 * temporary value given by the caller.
3462 memset(&tmp_output
, 0, sizeof(tmp_output
));
3463 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3465 if (output
->max_size
!= (uint64_t) -1ULL) {
3466 tmp_output
.max_size
= output
->max_size
;
3469 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3470 tmp_output
.max_size
);
3471 if (nb_packets_per_stream
< 0) {
3472 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3476 /* Use temporary name. */
3477 if (*output
->name
!= '\0') {
3478 strncpy(tmp_output
.name
, output
->name
,
3479 sizeof(tmp_output
.name
));
3482 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3484 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3485 session
, wait
, nb_packets_per_stream
);
3486 if (ret
!= LTTNG_OK
) {
3490 snapshot_success
= 1;
3496 if (session
->ust_session
) {
3497 struct ltt_ust_session
*usess
= session
->ust_session
;
3499 if (use_tmp_output
) {
3500 int64_t nb_packets_per_stream
;
3502 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3503 tmp_output
.max_size
);
3504 if (nb_packets_per_stream
< 0) {
3505 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3508 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3509 wait
, nb_packets_per_stream
);
3510 if (ret
!= LTTNG_OK
) {
3513 snapshot_success
= 1;
3515 struct snapshot_output
*sout
;
3516 struct lttng_ht_iter iter
;
3519 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3520 &iter
.iter
, sout
, node
.node
) {
3521 int64_t nb_packets_per_stream
;
3524 * Make a local copy of the output and assign the possible
3525 * temporary value given by the caller.
3527 memset(&tmp_output
, 0, sizeof(tmp_output
));
3528 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3530 if (output
->max_size
!= (uint64_t) -1ULL) {
3531 tmp_output
.max_size
= output
->max_size
;
3534 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3535 tmp_output
.max_size
);
3536 if (nb_packets_per_stream
< 0) {
3537 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3542 /* Use temporary name. */
3543 if (*output
->name
!= '\0') {
3544 strncpy(tmp_output
.name
, output
->name
,
3545 sizeof(tmp_output
.name
));
3548 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3550 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3551 wait
, nb_packets_per_stream
);
3552 if (ret
!= LTTNG_OK
) {
3556 snapshot_success
= 1;
3562 if (snapshot_success
) {
3563 session
->snapshot
.nb_snapshot
++;
3565 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3573 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3575 int cmd_set_session_shm_path(struct ltt_session
*session
,
3576 const char *shm_path
)
3582 * Can only set shm path before session is started.
3584 if (session
->has_been_started
) {
3585 return LTTNG_ERR_SESSION_STARTED
;
3588 strncpy(session
->shm_path
, shm_path
,
3589 sizeof(session
->shm_path
));
3590 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3596 * Init command subsystem.
3601 * Set network sequence index to 1 for streams to match a relayd
3602 * socket on the consumer side.
3604 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3605 relayd_net_seq_idx
= 1;
3606 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3608 DBG("Command subsystem initialized");