2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <urcu/list.h>
24 #include <urcu/uatomic.h>
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
35 #include "health-sessiond.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
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
;
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
= 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
:
1118 struct ltt_ust_channel
*uchan
;
1120 chan_ht
= usess
->domain_global
.channels
;
1122 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1123 if (uchan
== NULL
) {
1124 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1125 if (attr
->name
[0] != '\0') {
1126 usess
->has_non_default_channel
= 1;
1129 ret
= channel_ust_enable(usess
, uchan
);
1134 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1145 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1147 int cmd_disable_event(struct ltt_session
*session
,
1148 enum lttng_domain_type domain
, char *channel_name
,
1149 struct lttng_event
*event
)
1154 DBG("Disable event command for event \'%s\'", event
->name
);
1156 event_name
= event
->name
;
1157 if (validate_event_name(event_name
)) {
1158 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1162 /* Error out on unhandled search criteria */
1163 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1164 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1165 ret
= LTTNG_ERR_UNK
;
1172 case LTTNG_DOMAIN_KERNEL
:
1174 struct ltt_kernel_channel
*kchan
;
1175 struct ltt_kernel_session
*ksess
;
1177 ksess
= session
->kernel_session
;
1180 * If a non-default channel has been created in the
1181 * session, explicitely require that -c chan_name needs
1184 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1185 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1189 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1190 if (kchan
== NULL
) {
1191 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1195 switch (event
->type
) {
1196 case LTTNG_EVENT_ALL
:
1197 ret
= event_kernel_disable_event_all(kchan
);
1198 if (ret
!= LTTNG_OK
) {
1202 case LTTNG_EVENT_TRACEPOINT
: /* fall-through */
1203 case LTTNG_EVENT_SYSCALL
:
1204 if (!strcmp(event_name
, "*")) {
1205 ret
= event_kernel_disable_event_type(kchan
,
1208 ret
= event_kernel_disable_event(kchan
,
1211 if (ret
!= LTTNG_OK
) {
1215 case LTTNG_EVENT_PROBE
:
1216 case LTTNG_EVENT_FUNCTION
:
1217 case LTTNG_EVENT_FUNCTION_ENTRY
:
1218 ret
= event_kernel_disable_event(kchan
, event_name
);
1219 if (ret
!= LTTNG_OK
) {
1224 ret
= LTTNG_ERR_UNK
;
1228 kernel_wait_quiescent(kernel_tracer_fd
);
1231 case LTTNG_DOMAIN_UST
:
1233 struct ltt_ust_channel
*uchan
;
1234 struct ltt_ust_session
*usess
;
1236 usess
= session
->ust_session
;
1238 if (validate_ust_event_name(event_name
)) {
1239 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1244 * If a non-default channel has been created in the
1245 * session, explicitely require that -c chan_name needs
1248 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1249 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1253 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1255 if (uchan
== NULL
) {
1256 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1260 switch (event
->type
) {
1261 case LTTNG_EVENT_ALL
:
1262 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1263 if (ret
!= LTTNG_OK
) {
1268 ret
= LTTNG_ERR_UNK
;
1272 DBG3("Disable UST event %s in channel %s completed", event_name
,
1276 case LTTNG_DOMAIN_LOG4J
:
1277 case LTTNG_DOMAIN_JUL
:
1278 case LTTNG_DOMAIN_PYTHON
:
1281 struct ltt_ust_session
*usess
= session
->ust_session
;
1285 switch (event
->type
) {
1286 case LTTNG_EVENT_ALL
:
1289 ret
= LTTNG_ERR_UNK
;
1293 agt
= trace_ust_find_agent(usess
, domain
);
1295 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1298 /* The wild card * means that everything should be disabled. */
1299 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1300 ret
= event_agent_disable_all(usess
, agt
);
1302 ret
= event_agent_disable(usess
, agt
, event_name
);
1304 if (ret
!= LTTNG_OK
) {
1311 ret
= LTTNG_ERR_UND
;
1324 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1326 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1327 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1329 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1332 case LTTNG_DOMAIN_KERNEL
:
1333 assert(session
->kernel_session
);
1335 if (session
->kernel_session
->channel_count
== 0) {
1336 /* Create default channel */
1337 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1338 if (ret
!= LTTNG_OK
) {
1341 chan_kern_created
= 1;
1343 /* Add kernel context to kernel tracer */
1344 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1345 if (ret
!= LTTNG_OK
) {
1349 case LTTNG_DOMAIN_UST
:
1351 struct ltt_ust_session
*usess
= session
->ust_session
;
1352 unsigned int chan_count
;
1356 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1357 if (chan_count
== 0) {
1358 struct lttng_channel
*attr
;
1359 /* Create default channel */
1360 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1362 ret
= LTTNG_ERR_FATAL
;
1366 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1367 if (ret
!= LTTNG_OK
) {
1372 chan_ust_created
= 1;
1375 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1376 if (ret
!= LTTNG_OK
) {
1382 ret
= LTTNG_ERR_UND
;
1389 if (chan_kern_created
) {
1390 struct ltt_kernel_channel
*kchan
=
1391 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1392 session
->kernel_session
);
1393 /* Created previously, this should NOT fail. */
1395 kernel_destroy_channel(kchan
);
1398 if (chan_ust_created
) {
1399 struct ltt_ust_channel
*uchan
=
1400 trace_ust_find_channel_by_name(
1401 session
->ust_session
->domain_global
.channels
,
1402 DEFAULT_CHANNEL_NAME
);
1403 /* Created previously, this should NOT fail. */
1405 /* Remove from the channel list of the session. */
1406 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1408 trace_ust_destroy_channel(uchan
);
1413 static int validate_event_name(const char *name
)
1416 const char *c
= name
;
1417 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1418 bool null_terminated
= false;
1421 * Make sure that unescaped wildcards are only used as the last
1422 * character of the event name.
1424 while (c
< event_name_end
) {
1427 null_terminated
= true;
1433 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1434 /* Wildcard is not the last character */
1435 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1444 if (!ret
&& !null_terminated
) {
1445 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1450 static inline bool name_starts_with(const char *name
, const char *prefix
)
1452 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1454 return !strncmp(name
, prefix
, max_cmp_len
);
1457 /* Perform userspace-specific event name validation */
1458 static int validate_ust_event_name(const char *name
)
1468 * Check name against all internal UST event component namespaces used
1471 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1472 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1473 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1482 * Internal version of cmd_enable_event() with a supplemental
1483 * "internal_event" flag which is used to enable internal events which should
1484 * be hidden from clients. Such events are used in the agent implementation to
1485 * enable the events through which all "agent" events are funeled.
1487 static int _cmd_enable_event(struct ltt_session
*session
,
1488 struct lttng_domain
*domain
,
1489 char *channel_name
, struct lttng_event
*event
,
1490 char *filter_expression
,
1491 struct lttng_filter_bytecode
*filter
,
1492 struct lttng_event_exclusion
*exclusion
,
1493 int wpipe
, bool internal_event
)
1495 int ret
, channel_created
= 0;
1496 struct lttng_channel
*attr
;
1500 assert(channel_name
);
1502 /* If we have a filter, we must have its filter expression */
1503 assert(!(!!filter_expression
^ !!filter
));
1505 DBG("Enable event command for event \'%s\'", event
->name
);
1507 ret
= validate_event_name(event
->name
);
1514 switch (domain
->type
) {
1515 case LTTNG_DOMAIN_KERNEL
:
1517 struct ltt_kernel_channel
*kchan
;
1520 * If a non-default channel has been created in the
1521 * session, explicitely require that -c chan_name needs
1524 if (session
->kernel_session
->has_non_default_channel
1525 && channel_name
[0] == '\0') {
1526 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1530 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1531 session
->kernel_session
);
1532 if (kchan
== NULL
) {
1533 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1534 LTTNG_BUFFER_GLOBAL
);
1536 ret
= LTTNG_ERR_FATAL
;
1539 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1541 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1542 if (ret
!= LTTNG_OK
) {
1548 channel_created
= 1;
1551 /* Get the newly created kernel channel pointer */
1552 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1553 session
->kernel_session
);
1554 if (kchan
== NULL
) {
1555 /* This sould not happen... */
1556 ret
= LTTNG_ERR_FATAL
;
1560 switch (event
->type
) {
1561 case LTTNG_EVENT_ALL
:
1563 char *filter_expression_a
= NULL
;
1564 struct lttng_filter_bytecode
*filter_a
= NULL
;
1567 * We need to duplicate filter_expression and filter,
1568 * because ownership is passed to first enable
1571 if (filter_expression
) {
1572 filter_expression_a
= strdup(filter_expression
);
1573 if (!filter_expression_a
) {
1574 ret
= LTTNG_ERR_FATAL
;
1579 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1581 free(filter_expression_a
);
1582 ret
= LTTNG_ERR_FATAL
;
1585 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1587 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1588 ret
= event_kernel_enable_event(kchan
, event
,
1589 filter_expression
, filter
);
1590 /* We have passed ownership */
1591 filter_expression
= NULL
;
1593 if (ret
!= LTTNG_OK
) {
1594 if (channel_created
) {
1595 /* Let's not leak a useless channel. */
1596 kernel_destroy_channel(kchan
);
1598 free(filter_expression_a
);
1602 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1603 ret
= event_kernel_enable_event(kchan
, event
,
1604 filter_expression_a
, filter_a
);
1605 if (ret
!= LTTNG_OK
) {
1606 free(filter_expression_a
);
1612 case LTTNG_EVENT_PROBE
:
1613 case LTTNG_EVENT_FUNCTION
:
1614 case LTTNG_EVENT_FUNCTION_ENTRY
:
1615 case LTTNG_EVENT_TRACEPOINT
:
1616 ret
= event_kernel_enable_event(kchan
, event
,
1617 filter_expression
, filter
);
1618 /* We have passed ownership */
1619 filter_expression
= NULL
;
1621 if (ret
!= LTTNG_OK
) {
1622 if (channel_created
) {
1623 /* Let's not leak a useless channel. */
1624 kernel_destroy_channel(kchan
);
1629 case LTTNG_EVENT_SYSCALL
:
1630 ret
= event_kernel_enable_event(kchan
, event
,
1631 filter_expression
, filter
);
1632 /* We have passed ownership */
1633 filter_expression
= NULL
;
1635 if (ret
!= LTTNG_OK
) {
1640 ret
= LTTNG_ERR_UNK
;
1644 kernel_wait_quiescent(kernel_tracer_fd
);
1647 case LTTNG_DOMAIN_UST
:
1649 struct ltt_ust_channel
*uchan
;
1650 struct ltt_ust_session
*usess
= session
->ust_session
;
1655 * If a non-default channel has been created in the
1656 * session, explicitely require that -c chan_name needs
1659 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1660 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1664 /* Get channel from global UST domain */
1665 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1667 if (uchan
== NULL
) {
1668 /* Create default channel */
1669 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1670 usess
->buffer_type
);
1672 ret
= LTTNG_ERR_FATAL
;
1675 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1677 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1678 if (ret
!= LTTNG_OK
) {
1684 /* Get the newly created channel reference back */
1685 uchan
= trace_ust_find_channel_by_name(
1686 usess
->domain_global
.channels
, channel_name
);
1690 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1692 * Don't allow users to add UST events to channels which
1693 * are assigned to a userspace subdomain (JUL, Log4J,
1696 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1700 if (!internal_event
) {
1702 * Ensure the event name is not reserved for internal
1705 ret
= validate_ust_event_name(event
->name
);
1707 WARN("Userspace event name %s failed validation.",
1709 event
->name
: "NULL");
1710 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1715 /* At this point, the session and channel exist on the tracer */
1716 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1717 filter_expression
, filter
, exclusion
,
1719 /* We have passed ownership */
1720 filter_expression
= NULL
;
1723 if (ret
!= LTTNG_OK
) {
1728 case LTTNG_DOMAIN_LOG4J
:
1729 case LTTNG_DOMAIN_JUL
:
1730 case LTTNG_DOMAIN_PYTHON
:
1732 const char *default_event_name
, *default_chan_name
;
1734 struct lttng_event uevent
;
1735 struct lttng_domain tmp_dom
;
1736 struct ltt_ust_session
*usess
= session
->ust_session
;
1740 agt
= trace_ust_find_agent(usess
, domain
->type
);
1742 agt
= agent_create(domain
->type
);
1744 ret
= LTTNG_ERR_NOMEM
;
1747 agent_add(agt
, usess
->agents
);
1750 /* Create the default tracepoint. */
1751 memset(&uevent
, 0, sizeof(uevent
));
1752 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1753 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1754 default_event_name
= event_get_default_agent_ust_name(
1756 if (!default_event_name
) {
1757 ret
= LTTNG_ERR_FATAL
;
1760 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1761 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1764 * The domain type is changed because we are about to enable the
1765 * default channel and event for the JUL domain that are hardcoded.
1766 * This happens in the UST domain.
1768 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1769 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1771 switch (domain
->type
) {
1772 case LTTNG_DOMAIN_LOG4J
:
1773 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1775 case LTTNG_DOMAIN_JUL
:
1776 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1778 case LTTNG_DOMAIN_PYTHON
:
1779 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1782 /* The switch/case we are in makes this impossible */
1787 char *filter_expression_copy
= NULL
;
1788 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1791 const size_t filter_size
= sizeof(
1792 struct lttng_filter_bytecode
)
1795 filter_copy
= zmalloc(filter_size
);
1797 ret
= LTTNG_ERR_NOMEM
;
1799 memcpy(filter_copy
, filter
, filter_size
);
1801 filter_expression_copy
=
1802 strdup(filter_expression
);
1803 if (!filter_expression
) {
1804 ret
= LTTNG_ERR_NOMEM
;
1807 if (!filter_expression_copy
|| !filter_copy
) {
1808 free(filter_expression_copy
);
1814 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1815 (char *) default_chan_name
,
1816 &uevent
, filter_expression_copy
,
1817 filter_copy
, NULL
, wpipe
);
1820 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1824 /* The wild card * means that everything should be enabled. */
1825 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1826 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1829 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1833 filter_expression
= NULL
;
1834 if (ret
!= LTTNG_OK
) {
1841 ret
= LTTNG_ERR_UND
;
1848 free(filter_expression
);
1856 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1857 * We own filter, exclusion, and filter_expression.
1859 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1860 char *channel_name
, struct lttng_event
*event
,
1861 char *filter_expression
,
1862 struct lttng_filter_bytecode
*filter
,
1863 struct lttng_event_exclusion
*exclusion
,
1866 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1867 filter_expression
, filter
, exclusion
, wpipe
, false);
1871 * Enable an event which is internal to LTTng. An internal should
1872 * never be made visible to clients and are immune to checks such as
1875 static int cmd_enable_event_internal(struct ltt_session
*session
,
1876 struct lttng_domain
*domain
,
1877 char *channel_name
, struct lttng_event
*event
,
1878 char *filter_expression
,
1879 struct lttng_filter_bytecode
*filter
,
1880 struct lttng_event_exclusion
*exclusion
,
1883 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1884 filter_expression
, filter
, exclusion
, wpipe
, true);
1888 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1890 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1891 struct lttng_event
**events
)
1894 ssize_t nb_events
= 0;
1897 case LTTNG_DOMAIN_KERNEL
:
1898 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1899 if (nb_events
< 0) {
1900 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1904 case LTTNG_DOMAIN_UST
:
1905 nb_events
= ust_app_list_events(events
);
1906 if (nb_events
< 0) {
1907 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1911 case LTTNG_DOMAIN_LOG4J
:
1912 case LTTNG_DOMAIN_JUL
:
1913 case LTTNG_DOMAIN_PYTHON
:
1914 nb_events
= agent_list_events(events
, domain
);
1915 if (nb_events
< 0) {
1916 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1921 ret
= LTTNG_ERR_UND
;
1928 /* Return negative value to differentiate return code */
1933 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1935 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
1936 struct lttng_event_field
**fields
)
1939 ssize_t nb_fields
= 0;
1942 case LTTNG_DOMAIN_UST
:
1943 nb_fields
= ust_app_list_event_fields(fields
);
1944 if (nb_fields
< 0) {
1945 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1949 case LTTNG_DOMAIN_KERNEL
:
1950 default: /* fall-through */
1951 ret
= LTTNG_ERR_UND
;
1958 /* Return negative value to differentiate return code */
1962 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1964 return syscall_table_list(events
);
1968 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1970 * Called with session lock held.
1972 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1973 enum lttng_domain_type domain
, int32_t **pids
)
1976 ssize_t nr_pids
= 0;
1979 case LTTNG_DOMAIN_KERNEL
:
1981 struct ltt_kernel_session
*ksess
;
1983 ksess
= session
->kernel_session
;
1984 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1986 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1991 case LTTNG_DOMAIN_UST
:
1993 struct ltt_ust_session
*usess
;
1995 usess
= session
->ust_session
;
1996 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
1998 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2003 case LTTNG_DOMAIN_LOG4J
:
2004 case LTTNG_DOMAIN_JUL
:
2005 case LTTNG_DOMAIN_PYTHON
:
2007 ret
= LTTNG_ERR_UND
;
2014 /* Return negative value to differentiate return code */
2019 * Command LTTNG_START_TRACE processed by the client thread.
2021 * Called with session mutex held.
2023 int cmd_start_trace(struct ltt_session
*session
)
2026 unsigned long nb_chan
= 0;
2027 struct ltt_kernel_session
*ksession
;
2028 struct ltt_ust_session
*usess
;
2032 /* Ease our life a bit ;) */
2033 ksession
= session
->kernel_session
;
2034 usess
= session
->ust_session
;
2036 /* Is the session already started? */
2037 if (session
->active
) {
2038 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2043 * Starting a session without channel is useless since after that it's not
2044 * possible to enable channel thus inform the client.
2046 if (usess
&& usess
->domain_global
.channels
) {
2047 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2050 nb_chan
+= ksession
->channel_count
;
2053 ret
= LTTNG_ERR_NO_CHANNEL
;
2057 /* Kernel tracing */
2058 if (ksession
!= NULL
) {
2059 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2060 if (ret
!= LTTNG_OK
) {
2065 /* Flag session that trace should start automatically */
2068 * Even though the start trace might fail, flag this session active so
2069 * other application coming in are started by default.
2073 ret
= ust_app_start_trace_all(usess
);
2075 ret
= LTTNG_ERR_UST_START_FAIL
;
2080 /* Flag this after a successful start. */
2081 session
->has_been_started
= 1;
2082 session
->active
= 1;
2091 * Command LTTNG_STOP_TRACE processed by the client thread.
2093 int cmd_stop_trace(struct ltt_session
*session
)
2096 struct ltt_kernel_channel
*kchan
;
2097 struct ltt_kernel_session
*ksession
;
2098 struct ltt_ust_session
*usess
;
2103 ksession
= session
->kernel_session
;
2104 usess
= session
->ust_session
;
2106 /* Session is not active. Skip everythong and inform the client. */
2107 if (!session
->active
) {
2108 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2113 if (ksession
&& ksession
->active
) {
2114 DBG("Stop kernel tracing");
2116 /* Flush metadata if exist */
2117 if (ksession
->metadata_stream_fd
>= 0) {
2118 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2120 ERR("Kernel metadata flush failed");
2124 /* Flush all buffers before stopping */
2125 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2126 ret
= kernel_flush_buffer(kchan
);
2128 ERR("Kernel flush buffer error");
2132 ret
= kernel_stop_session(ksession
);
2134 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2138 kernel_wait_quiescent(kernel_tracer_fd
);
2140 ksession
->active
= 0;
2143 if (usess
&& usess
->active
) {
2145 * Even though the stop trace might fail, flag this session inactive so
2146 * other application coming in are not started by default.
2150 ret
= ust_app_stop_trace_all(usess
);
2152 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2157 /* Flag inactive after a successful stop. */
2158 session
->active
= 0;
2166 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2168 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2169 struct lttng_uri
*uris
)
2172 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2173 struct ltt_ust_session
*usess
= session
->ust_session
;
2179 /* Can't set consumer URI if the session is active. */
2180 if (session
->active
) {
2181 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2185 /* Set the "global" consumer URIs */
2186 for (i
= 0; i
< nb_uri
; i
++) {
2187 ret
= add_uri_to_consumer(session
->consumer
,
2188 &uris
[i
], 0, session
->name
);
2189 if (ret
!= LTTNG_OK
) {
2194 /* Set UST session URIs */
2195 if (session
->ust_session
) {
2196 for (i
= 0; i
< nb_uri
; i
++) {
2197 ret
= add_uri_to_consumer(
2198 session
->ust_session
->consumer
,
2199 &uris
[i
], LTTNG_DOMAIN_UST
,
2201 if (ret
!= LTTNG_OK
) {
2207 /* Set kernel session URIs */
2208 if (session
->kernel_session
) {
2209 for (i
= 0; i
< nb_uri
; i
++) {
2210 ret
= add_uri_to_consumer(
2211 session
->kernel_session
->consumer
,
2212 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2214 if (ret
!= LTTNG_OK
) {
2221 * Make sure to set the session in output mode after we set URI since a
2222 * session can be created without URL (thus flagged in no output mode).
2224 session
->output_traces
= 1;
2226 ksess
->output_traces
= 1;
2230 usess
->output_traces
= 1;
2241 * Command LTTNG_CREATE_SESSION processed by the client thread.
2243 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2244 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2247 struct ltt_session
*session
;
2253 * Verify if the session already exist
2255 * XXX: There is no need for the session lock list here since the caller
2256 * (process_client_msg) is holding it. We might want to change that so a
2257 * single command does not lock the entire session list.
2259 session
= session_find_by_name(name
);
2260 if (session
!= NULL
) {
2261 ret
= LTTNG_ERR_EXIST_SESS
;
2265 /* Create tracing session in the registry */
2266 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2267 LTTNG_SOCK_GET_GID_CRED(creds
));
2268 if (ret
!= LTTNG_OK
) {
2273 * Get the newly created session pointer back
2275 * XXX: There is no need for the session lock list here since the caller
2276 * (process_client_msg) is holding it. We might want to change that so a
2277 * single command does not lock the entire session list.
2279 session
= session_find_by_name(name
);
2282 session
->live_timer
= live_timer
;
2283 /* Create default consumer output for the session not yet created. */
2284 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2285 if (session
->consumer
== NULL
) {
2286 ret
= LTTNG_ERR_FATAL
;
2287 goto consumer_error
;
2291 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2292 if (ret
!= LTTNG_OK
) {
2293 goto consumer_error
;
2295 session
->output_traces
= 1;
2297 session
->output_traces
= 0;
2298 DBG2("Session %s created with no output", session
->name
);
2301 session
->consumer
->enabled
= 1;
2306 session_destroy(session
);
2313 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2315 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2316 size_t nb_uri
, lttng_sock_cred
*creds
)
2319 struct ltt_session
*session
;
2320 struct snapshot_output
*new_output
= NULL
;
2326 * Create session in no output mode with URIs set to NULL. The uris we've
2327 * received are for a default snapshot output if one.
2329 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2330 if (ret
!= LTTNG_OK
) {
2334 /* Get the newly created session pointer back. This should NEVER fail. */
2335 session
= session_find_by_name(name
);
2338 /* Flag session for snapshot mode. */
2339 session
->snapshot_mode
= 1;
2341 /* Skip snapshot output creation if no URI is given. */
2346 new_output
= snapshot_output_alloc();
2348 ret
= LTTNG_ERR_NOMEM
;
2349 goto error_snapshot_alloc
;
2352 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2353 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2355 if (ret
== -ENOMEM
) {
2356 ret
= LTTNG_ERR_NOMEM
;
2358 ret
= LTTNG_ERR_INVALID
;
2360 goto error_snapshot
;
2364 snapshot_add_output(&session
->snapshot
, new_output
);
2371 snapshot_output_destroy(new_output
);
2372 error_snapshot_alloc
:
2373 session_destroy(session
);
2379 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2381 * Called with session lock held.
2383 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2386 struct ltt_ust_session
*usess
;
2387 struct ltt_kernel_session
*ksess
;
2392 usess
= session
->ust_session
;
2393 ksess
= session
->kernel_session
;
2395 /* Clean kernel session teardown */
2396 kernel_destroy_session(ksess
);
2398 /* UST session teardown */
2400 /* Close any relayd session */
2401 consumer_output_send_destroy_relayd(usess
->consumer
);
2403 /* Destroy every UST application related to this session. */
2404 ret
= ust_app_destroy_trace_all(usess
);
2406 ERR("Error in ust_app_destroy_trace_all");
2409 /* Clean up the rest. */
2410 trace_ust_destroy_session(usess
);
2414 * Must notify the kernel thread here to update it's poll set in order to
2415 * remove the channel(s)' fd just destroyed.
2417 ret
= notify_thread_pipe(wpipe
);
2419 PERROR("write kernel poll pipe");
2422 ret
= session_destroy(session
);
2428 * Command LTTNG_CALIBRATE processed by the client thread.
2430 int cmd_calibrate(enum lttng_domain_type domain
,
2431 struct lttng_calibrate
*calibrate
)
2436 case LTTNG_DOMAIN_KERNEL
:
2438 struct lttng_kernel_calibrate kcalibrate
;
2440 switch (calibrate
->type
) {
2441 case LTTNG_CALIBRATE_FUNCTION
:
2443 /* Default and only possible calibrate option. */
2444 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2448 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2450 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2455 case LTTNG_DOMAIN_UST
:
2457 struct lttng_ust_calibrate ucalibrate
;
2459 switch (calibrate
->type
) {
2460 case LTTNG_CALIBRATE_FUNCTION
:
2462 /* Default and only possible calibrate option. */
2463 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2467 ret
= ust_app_calibrate_glb(&ucalibrate
);
2469 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2475 ret
= LTTNG_ERR_UND
;
2486 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2488 int cmd_register_consumer(struct ltt_session
*session
,
2489 enum lttng_domain_type domain
, const char *sock_path
,
2490 struct consumer_data
*cdata
)
2493 struct consumer_socket
*socket
= NULL
;
2500 case LTTNG_DOMAIN_KERNEL
:
2502 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2506 /* Can't register a consumer if there is already one */
2507 if (ksess
->consumer_fds_sent
!= 0) {
2508 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2512 sock
= lttcomm_connect_unix_sock(sock_path
);
2514 ret
= LTTNG_ERR_CONNECT_FAIL
;
2517 cdata
->cmd_sock
= sock
;
2519 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2520 if (socket
== NULL
) {
2523 PERROR("close register consumer");
2525 cdata
->cmd_sock
= -1;
2526 ret
= LTTNG_ERR_FATAL
;
2530 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2531 if (socket
->lock
== NULL
) {
2532 PERROR("zmalloc pthread mutex");
2533 ret
= LTTNG_ERR_FATAL
;
2536 pthread_mutex_init(socket
->lock
, NULL
);
2537 socket
->registered
= 1;
2540 consumer_add_socket(socket
, ksess
->consumer
);
2543 pthread_mutex_lock(&cdata
->pid_mutex
);
2545 pthread_mutex_unlock(&cdata
->pid_mutex
);
2550 /* TODO: Userspace tracing */
2551 ret
= LTTNG_ERR_UND
;
2559 consumer_destroy_socket(socket
);
2565 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2567 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2568 struct lttng_domain
**domains
)
2573 struct lttng_ht_iter iter
;
2575 if (session
->kernel_session
!= NULL
) {
2576 DBG3("Listing domains found kernel domain");
2580 if (session
->ust_session
!= NULL
) {
2581 DBG3("Listing domains found UST global domain");
2585 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2587 if (agt
->being_used
) {
2598 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2599 if (*domains
== NULL
) {
2600 ret
= LTTNG_ERR_FATAL
;
2604 if (session
->kernel_session
!= NULL
) {
2605 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2607 /* Kernel session buffer type is always GLOBAL */
2608 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2613 if (session
->ust_session
!= NULL
) {
2614 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2615 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2619 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2621 if (agt
->being_used
) {
2622 (*domains
)[index
].type
= agt
->domain
;
2623 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2633 /* Return negative value to differentiate return code */
2639 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2641 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2642 struct ltt_session
*session
, struct lttng_channel
**channels
)
2645 ssize_t nb_chan
= 0;
2648 case LTTNG_DOMAIN_KERNEL
:
2649 if (session
->kernel_session
!= NULL
) {
2650 nb_chan
= session
->kernel_session
->channel_count
;
2652 DBG3("Number of kernel channels %zd", nb_chan
);
2654 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2657 case LTTNG_DOMAIN_UST
:
2658 if (session
->ust_session
!= NULL
) {
2660 nb_chan
= lttng_ht_get_count(
2661 session
->ust_session
->domain_global
.channels
);
2664 DBG3("Number of UST global channels %zd", nb_chan
);
2666 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2671 ret
= LTTNG_ERR_UND
;
2676 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2677 if (*channels
== NULL
) {
2678 ret
= LTTNG_ERR_FATAL
;
2682 list_lttng_channels(domain
, session
, *channels
);
2688 /* Return negative value to differentiate return code */
2693 * Command LTTNG_LIST_EVENTS processed by the client thread.
2695 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2696 struct ltt_session
*session
, char *channel_name
,
2697 struct lttng_event
**events
)
2700 ssize_t nb_event
= 0;
2703 case LTTNG_DOMAIN_KERNEL
:
2704 if (session
->kernel_session
!= NULL
) {
2705 nb_event
= list_lttng_kernel_events(channel_name
,
2706 session
->kernel_session
, events
);
2709 case LTTNG_DOMAIN_UST
:
2711 if (session
->ust_session
!= NULL
) {
2712 nb_event
= list_lttng_ust_global_events(channel_name
,
2713 &session
->ust_session
->domain_global
, events
);
2717 case LTTNG_DOMAIN_LOG4J
:
2718 case LTTNG_DOMAIN_JUL
:
2719 case LTTNG_DOMAIN_PYTHON
:
2720 if (session
->ust_session
) {
2721 struct lttng_ht_iter iter
;
2725 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2726 &iter
.iter
, agt
, node
.node
) {
2727 nb_event
= list_lttng_agent_events(agt
, events
);
2733 ret
= LTTNG_ERR_UND
;
2740 /* Return negative value to differentiate return code */
2745 * Using the session list, filled a lttng_session array to send back to the
2746 * client for session listing.
2748 * The session list lock MUST be acquired before calling this function. Use
2749 * session_lock_list() and session_unlock_list().
2751 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2756 struct ltt_session
*session
;
2757 struct ltt_session_list
*list
= session_get_list();
2759 DBG("Getting all available session for UID %d GID %d",
2762 * Iterate over session list and append data after the control struct in
2765 cds_list_for_each_entry(session
, &list
->head
, list
) {
2767 * Only list the sessions the user can control.
2769 if (!session_access_ok(session
, uid
, gid
)) {
2773 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2774 struct ltt_ust_session
*usess
= session
->ust_session
;
2776 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2777 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2778 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2779 ret
= build_network_session_path(sessions
[i
].path
,
2780 sizeof(sessions
[i
].path
), session
);
2782 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2783 session
->consumer
->dst
.trace_path
);
2786 PERROR("snprintf session path");
2790 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2791 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2792 sessions
[i
].enabled
= session
->active
;
2793 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2794 sessions
[i
].live_timer_interval
= session
->live_timer
;
2800 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2801 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2803 int cmd_data_pending(struct ltt_session
*session
)
2806 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2807 struct ltt_ust_session
*usess
= session
->ust_session
;
2811 /* Session MUST be stopped to ask for data availability. */
2812 if (session
->active
) {
2813 ret
= LTTNG_ERR_SESSION_STARTED
;
2817 * If stopped, just make sure we've started before else the above call
2818 * will always send that there is data pending.
2820 * The consumer assumes that when the data pending command is received,
2821 * the trace has been started before or else no output data is written
2822 * by the streams which is a condition for data pending. So, this is
2823 * *VERY* important that we don't ask the consumer before a start
2826 if (!session
->has_been_started
) {
2832 if (ksess
&& ksess
->consumer
) {
2833 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2835 /* Data is still being extracted for the kernel. */
2840 if (usess
&& usess
->consumer
) {
2841 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2843 /* Data is still being extracted for the kernel. */
2848 /* Data is ready to be read by a viewer */
2856 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2858 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2860 int cmd_snapshot_add_output(struct ltt_session
*session
,
2861 struct lttng_snapshot_output
*output
, uint32_t *id
)
2864 struct snapshot_output
*new_output
;
2869 DBG("Cmd snapshot add output for session %s", session
->name
);
2872 * Permission denied to create an output if the session is not
2873 * set in no output mode.
2875 if (session
->output_traces
) {
2876 ret
= LTTNG_ERR_EPERM
;
2880 /* Only one output is allowed until we have the "tee" feature. */
2881 if (session
->snapshot
.nb_output
== 1) {
2882 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2886 new_output
= snapshot_output_alloc();
2888 ret
= LTTNG_ERR_NOMEM
;
2892 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2893 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2894 &session
->snapshot
);
2896 if (ret
== -ENOMEM
) {
2897 ret
= LTTNG_ERR_NOMEM
;
2899 ret
= LTTNG_ERR_INVALID
;
2905 snapshot_add_output(&session
->snapshot
, new_output
);
2907 *id
= new_output
->id
;
2914 snapshot_output_destroy(new_output
);
2920 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2922 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2924 int cmd_snapshot_del_output(struct ltt_session
*session
,
2925 struct lttng_snapshot_output
*output
)
2928 struct snapshot_output
*sout
= NULL
;
2936 * Permission denied to create an output if the session is not
2937 * set in no output mode.
2939 if (session
->output_traces
) {
2940 ret
= LTTNG_ERR_EPERM
;
2945 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2947 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2948 } else if (*output
->name
!= '\0') {
2949 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2951 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2954 ret
= LTTNG_ERR_INVALID
;
2958 snapshot_delete_output(&session
->snapshot
, sout
);
2959 snapshot_output_destroy(sout
);
2968 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2970 * If no output is available, outputs is untouched and 0 is returned.
2972 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2974 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2975 struct lttng_snapshot_output
**outputs
)
2978 struct lttng_snapshot_output
*list
= NULL
;
2979 struct lttng_ht_iter iter
;
2980 struct snapshot_output
*output
;
2985 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2988 * Permission denied to create an output if the session is not
2989 * set in no output mode.
2991 if (session
->output_traces
) {
2992 ret
= -LTTNG_ERR_EPERM
;
2996 if (session
->snapshot
.nb_output
== 0) {
3001 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3003 ret
= -LTTNG_ERR_NOMEM
;
3007 /* Copy list from session to the new list object. */
3009 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3010 output
, node
.node
) {
3011 assert(output
->consumer
);
3012 list
[idx
].id
= output
->id
;
3013 list
[idx
].max_size
= output
->max_size
;
3014 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3015 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3016 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3017 sizeof(list
[idx
].ctrl_url
));
3020 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3021 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3023 ret
= -LTTNG_ERR_NOMEM
;
3028 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3029 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3031 ret
= -LTTNG_ERR_NOMEM
;
3040 ret
= session
->snapshot
.nb_output
;
3048 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3049 * snapshot output is *not* set with a remote destination.
3051 * Return 0 on success or a LTTNG_ERR code.
3053 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3054 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3057 struct lttng_ht_iter iter
;
3058 struct consumer_socket
*socket
;
3061 assert(snap_output
);
3064 DBG2("Set relayd object from snapshot output");
3066 /* Ignore if snapshot consumer output is not network. */
3067 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3072 * For each consumer socket, create and send the relayd object of the
3076 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3077 socket
, node
.node
) {
3078 ret
= send_consumer_relayd_sockets(0, session
->id
,
3079 snap_output
->consumer
, socket
,
3080 session
->name
, session
->hostname
,
3081 session
->live_timer
);
3082 if (ret
!= LTTNG_OK
) {
3094 * Record a kernel snapshot.
3096 * Return LTTNG_OK on success or a LTTNG_ERR code.
3098 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3099 struct snapshot_output
*output
, struct ltt_session
*session
,
3100 int wait
, uint64_t nb_packets_per_stream
)
3108 /* Get the datetime for the snapshot output directory. */
3109 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3110 sizeof(output
->datetime
));
3112 ret
= LTTNG_ERR_INVALID
;
3117 * Copy kernel session sockets so we can communicate with the right
3118 * consumer for the snapshot record command.
3120 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3122 ret
= LTTNG_ERR_NOMEM
;
3126 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3127 if (ret
!= LTTNG_OK
) {
3128 goto error_snapshot
;
3131 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3132 if (ret
!= LTTNG_OK
) {
3133 goto error_snapshot
;
3140 /* Clean up copied sockets so this output can use some other later on. */
3141 consumer_destroy_output_sockets(output
->consumer
);
3148 * Record a UST snapshot.
3150 * Return 0 on success or a LTTNG_ERR error code.
3152 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3153 struct snapshot_output
*output
, struct ltt_session
*session
,
3154 int wait
, uint64_t nb_packets_per_stream
)
3162 /* Get the datetime for the snapshot output directory. */
3163 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3164 sizeof(output
->datetime
));
3166 ret
= LTTNG_ERR_INVALID
;
3171 * Copy UST session sockets so we can communicate with the right
3172 * consumer for the snapshot record command.
3174 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3176 ret
= LTTNG_ERR_NOMEM
;
3180 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3181 if (ret
!= LTTNG_OK
) {
3182 goto error_snapshot
;
3185 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3189 ret
= LTTNG_ERR_INVALID
;
3192 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3195 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3198 goto error_snapshot
;
3204 /* Clean up copied sockets so this output can use some other later on. */
3205 consumer_destroy_output_sockets(output
->consumer
);
3211 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3212 uint64_t cur_nr_packets
)
3214 uint64_t tot_size
= 0;
3216 if (session
->kernel_session
) {
3217 struct ltt_kernel_channel
*chan
;
3218 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3220 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3221 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3223 * Don't take channel into account if we
3224 * already grab all its packets.
3228 tot_size
+= chan
->channel
->attr
.subbuf_size
3229 * chan
->stream_count
;
3233 if (session
->ust_session
) {
3234 struct ltt_ust_session
*usess
= session
->ust_session
;
3236 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3244 * Calculate the number of packets we can grab from each stream that
3245 * fits within the overall snapshot max size.
3247 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3248 * the number of packets per stream.
3250 * TODO: this approach is not perfect: we consider the worse case
3251 * (packet filling the sub-buffers) as an upper bound, but we could do
3252 * better if we do this calculation while we actually grab the packet
3253 * content: we would know how much padding we don't actually store into
3256 * This algorithm is currently bounded by the number of packets per
3259 * Since we call this algorithm before actually grabbing the data, it's
3260 * an approximation: for instance, applications could appear/disappear
3261 * in between this call and actually grabbing data.
3264 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3267 uint64_t cur_nb_packets
= 0;
3270 return 0; /* Infinite */
3273 size_left
= max_size
;
3275 uint64_t one_more_packet_tot_size
;
3277 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3279 if (!one_more_packet_tot_size
) {
3280 /* We are already grabbing all packets. */
3283 size_left
-= one_more_packet_tot_size
;
3284 if (size_left
< 0) {
3289 if (!cur_nb_packets
) {
3290 /* Not enough room to grab one packet of each stream, error. */
3293 return cur_nb_packets
;
3297 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3299 * The wait parameter is ignored so this call always wait for the snapshot to
3300 * complete before returning.
3302 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3304 int cmd_snapshot_record(struct ltt_session
*session
,
3305 struct lttng_snapshot_output
*output
, int wait
)
3308 unsigned int use_tmp_output
= 0;
3309 struct snapshot_output tmp_output
;
3310 unsigned int snapshot_success
= 0;
3315 DBG("Cmd snapshot record for session %s", session
->name
);
3318 * Permission denied to create an output if the session is not
3319 * set in no output mode.
3321 if (session
->output_traces
) {
3322 ret
= LTTNG_ERR_EPERM
;
3326 /* The session needs to be started at least once. */
3327 if (!session
->has_been_started
) {
3328 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3332 /* Use temporary output for the session. */
3333 if (*output
->ctrl_url
!= '\0') {
3334 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3335 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3338 if (ret
== -ENOMEM
) {
3339 ret
= LTTNG_ERR_NOMEM
;
3341 ret
= LTTNG_ERR_INVALID
;
3345 /* Use the global session count for the temporary snapshot. */
3346 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3350 if (session
->kernel_session
) {
3351 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3353 if (use_tmp_output
) {
3354 int64_t nb_packets_per_stream
;
3356 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3357 tmp_output
.max_size
);
3358 if (nb_packets_per_stream
< 0) {
3359 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3362 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3363 wait
, nb_packets_per_stream
);
3364 if (ret
!= LTTNG_OK
) {
3367 snapshot_success
= 1;
3369 struct snapshot_output
*sout
;
3370 struct lttng_ht_iter iter
;
3373 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3374 &iter
.iter
, sout
, node
.node
) {
3375 int64_t nb_packets_per_stream
;
3378 * Make a local copy of the output and assign the possible
3379 * temporary value given by the caller.
3381 memset(&tmp_output
, 0, sizeof(tmp_output
));
3382 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3384 if (output
->max_size
!= (uint64_t) -1ULL) {
3385 tmp_output
.max_size
= output
->max_size
;
3388 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3389 tmp_output
.max_size
);
3390 if (nb_packets_per_stream
< 0) {
3391 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3395 /* Use temporary name. */
3396 if (*output
->name
!= '\0') {
3397 strncpy(tmp_output
.name
, output
->name
,
3398 sizeof(tmp_output
.name
));
3401 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3403 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3404 session
, wait
, nb_packets_per_stream
);
3405 if (ret
!= LTTNG_OK
) {
3409 snapshot_success
= 1;
3415 if (session
->ust_session
) {
3416 struct ltt_ust_session
*usess
= session
->ust_session
;
3418 if (use_tmp_output
) {
3419 int64_t nb_packets_per_stream
;
3421 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3422 tmp_output
.max_size
);
3423 if (nb_packets_per_stream
< 0) {
3424 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3427 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3428 wait
, nb_packets_per_stream
);
3429 if (ret
!= LTTNG_OK
) {
3432 snapshot_success
= 1;
3434 struct snapshot_output
*sout
;
3435 struct lttng_ht_iter iter
;
3438 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3439 &iter
.iter
, sout
, node
.node
) {
3440 int64_t nb_packets_per_stream
;
3443 * Make a local copy of the output and assign the possible
3444 * temporary value given by the caller.
3446 memset(&tmp_output
, 0, sizeof(tmp_output
));
3447 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3449 if (output
->max_size
!= (uint64_t) -1ULL) {
3450 tmp_output
.max_size
= output
->max_size
;
3453 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3454 tmp_output
.max_size
);
3455 if (nb_packets_per_stream
< 0) {
3456 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3461 /* Use temporary name. */
3462 if (*output
->name
!= '\0') {
3463 strncpy(tmp_output
.name
, output
->name
,
3464 sizeof(tmp_output
.name
));
3467 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3469 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3470 wait
, nb_packets_per_stream
);
3471 if (ret
!= LTTNG_OK
) {
3475 snapshot_success
= 1;
3481 if (snapshot_success
) {
3482 session
->snapshot
.nb_snapshot
++;
3484 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3492 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3494 int cmd_set_session_shm_path(struct ltt_session
*session
,
3495 const char *shm_path
)
3501 * Can only set shm path before session is started.
3503 if (session
->has_been_started
) {
3504 return LTTNG_ERR_SESSION_STARTED
;
3507 strncpy(session
->shm_path
, shm_path
,
3508 sizeof(session
->shm_path
));
3509 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3515 * Init command subsystem.
3520 * Set network sequence index to 1 for streams to match a relayd
3521 * socket on the consumer side.
3523 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3524 relayd_net_seq_idx
= 1;
3525 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3527 DBG("Command subsystem initialized");