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_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
= 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 ret
= event_kernel_disable_event_all(kchan
);
1229 if (ret
!= LTTNG_OK
) {
1233 case LTTNG_EVENT_TRACEPOINT
: /* fall-through */
1234 case LTTNG_EVENT_SYSCALL
:
1235 if (!strcmp(event_name
, "*")) {
1236 ret
= event_kernel_disable_event_type(kchan
,
1239 ret
= event_kernel_disable_event(kchan
,
1242 if (ret
!= LTTNG_OK
) {
1246 case LTTNG_EVENT_PROBE
:
1247 case LTTNG_EVENT_FUNCTION
:
1248 case LTTNG_EVENT_FUNCTION_ENTRY
:
1249 ret
= event_kernel_disable_event(kchan
, event_name
);
1250 if (ret
!= LTTNG_OK
) {
1255 ret
= LTTNG_ERR_UNK
;
1259 kernel_wait_quiescent(kernel_tracer_fd
);
1262 case LTTNG_DOMAIN_UST
:
1264 struct ltt_ust_channel
*uchan
;
1265 struct ltt_ust_session
*usess
;
1267 usess
= session
->ust_session
;
1269 if (validate_ust_event_name(event_name
)) {
1270 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1275 * If a non-default channel has been created in the
1276 * session, explicitely require that -c chan_name needs
1279 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1280 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1284 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1286 if (uchan
== NULL
) {
1287 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1291 switch (event
->type
) {
1292 case LTTNG_EVENT_ALL
:
1293 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1294 if (ret
!= LTTNG_OK
) {
1299 ret
= LTTNG_ERR_UNK
;
1303 DBG3("Disable UST event %s in channel %s completed", event_name
,
1307 case LTTNG_DOMAIN_LOG4J
:
1308 case LTTNG_DOMAIN_JUL
:
1309 case LTTNG_DOMAIN_PYTHON
:
1312 struct ltt_ust_session
*usess
= session
->ust_session
;
1316 switch (event
->type
) {
1317 case LTTNG_EVENT_ALL
:
1320 ret
= LTTNG_ERR_UNK
;
1324 agt
= trace_ust_find_agent(usess
, domain
);
1326 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1329 /* The wild card * means that everything should be disabled. */
1330 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1331 ret
= event_agent_disable_all(usess
, agt
);
1333 ret
= event_agent_disable(usess
, agt
, event_name
);
1335 if (ret
!= LTTNG_OK
) {
1342 ret
= LTTNG_ERR_UND
;
1355 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1357 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1358 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1360 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1363 case LTTNG_DOMAIN_KERNEL
:
1364 assert(session
->kernel_session
);
1366 if (session
->kernel_session
->channel_count
== 0) {
1367 /* Create default channel */
1368 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1369 if (ret
!= LTTNG_OK
) {
1372 chan_kern_created
= 1;
1374 /* Add kernel context to kernel tracer */
1375 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1376 if (ret
!= LTTNG_OK
) {
1380 case LTTNG_DOMAIN_UST
:
1382 struct ltt_ust_session
*usess
= session
->ust_session
;
1383 unsigned int chan_count
;
1387 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1388 if (chan_count
== 0) {
1389 struct lttng_channel
*attr
;
1390 /* Create default channel */
1391 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1393 ret
= LTTNG_ERR_FATAL
;
1397 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1398 if (ret
!= LTTNG_OK
) {
1403 chan_ust_created
= 1;
1406 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1407 if (ret
!= LTTNG_OK
) {
1413 ret
= LTTNG_ERR_UND
;
1420 if (chan_kern_created
) {
1421 struct ltt_kernel_channel
*kchan
=
1422 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1423 session
->kernel_session
);
1424 /* Created previously, this should NOT fail. */
1426 kernel_destroy_channel(kchan
);
1429 if (chan_ust_created
) {
1430 struct ltt_ust_channel
*uchan
=
1431 trace_ust_find_channel_by_name(
1432 session
->ust_session
->domain_global
.channels
,
1433 DEFAULT_CHANNEL_NAME
);
1434 /* Created previously, this should NOT fail. */
1436 /* Remove from the channel list of the session. */
1437 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1439 trace_ust_destroy_channel(uchan
);
1444 static int validate_event_name(const char *name
)
1447 const char *c
= name
;
1448 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1449 bool null_terminated
= false;
1452 * Make sure that unescaped wildcards are only used as the last
1453 * character of the event name.
1455 while (c
< event_name_end
) {
1458 null_terminated
= true;
1464 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1465 /* Wildcard is not the last character */
1466 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1475 if (!ret
&& !null_terminated
) {
1476 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1481 static inline bool name_starts_with(const char *name
, const char *prefix
)
1483 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1485 return !strncmp(name
, prefix
, max_cmp_len
);
1488 /* Perform userspace-specific event name validation */
1489 static int validate_ust_event_name(const char *name
)
1499 * Check name against all internal UST event component namespaces used
1502 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1503 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1504 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1513 * Internal version of cmd_enable_event() with a supplemental
1514 * "internal_event" flag which is used to enable internal events which should
1515 * be hidden from clients. Such events are used in the agent implementation to
1516 * enable the events through which all "agent" events are funeled.
1518 static int _cmd_enable_event(struct ltt_session
*session
,
1519 struct lttng_domain
*domain
,
1520 char *channel_name
, struct lttng_event
*event
,
1521 char *filter_expression
,
1522 struct lttng_filter_bytecode
*filter
,
1523 struct lttng_event_exclusion
*exclusion
,
1524 int wpipe
, bool internal_event
)
1526 int ret
, channel_created
= 0;
1527 struct lttng_channel
*attr
;
1531 assert(channel_name
);
1533 /* If we have a filter, we must have its filter expression */
1534 assert(!(!!filter_expression
^ !!filter
));
1536 DBG("Enable event command for event \'%s\'", event
->name
);
1540 ret
= validate_event_name(event
->name
);
1545 switch (domain
->type
) {
1546 case LTTNG_DOMAIN_KERNEL
:
1548 struct ltt_kernel_channel
*kchan
;
1551 * If a non-default channel has been created in the
1552 * session, explicitely require that -c chan_name needs
1555 if (session
->kernel_session
->has_non_default_channel
1556 && channel_name
[0] == '\0') {
1557 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1561 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1562 session
->kernel_session
);
1563 if (kchan
== NULL
) {
1564 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1565 LTTNG_BUFFER_GLOBAL
);
1567 ret
= LTTNG_ERR_FATAL
;
1570 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1572 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1573 if (ret
!= LTTNG_OK
) {
1579 channel_created
= 1;
1582 /* Get the newly created kernel channel pointer */
1583 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1584 session
->kernel_session
);
1585 if (kchan
== NULL
) {
1586 /* This sould not happen... */
1587 ret
= LTTNG_ERR_FATAL
;
1591 switch (event
->type
) {
1592 case LTTNG_EVENT_ALL
:
1594 char *filter_expression_a
= NULL
;
1595 struct lttng_filter_bytecode
*filter_a
= NULL
;
1598 * We need to duplicate filter_expression and filter,
1599 * because ownership is passed to first enable
1602 if (filter_expression
) {
1603 filter_expression_a
= strdup(filter_expression
);
1604 if (!filter_expression_a
) {
1605 ret
= LTTNG_ERR_FATAL
;
1610 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1612 free(filter_expression_a
);
1613 ret
= LTTNG_ERR_FATAL
;
1616 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1618 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1619 ret
= event_kernel_enable_event(kchan
, event
,
1620 filter_expression
, filter
);
1621 /* We have passed ownership */
1622 filter_expression
= NULL
;
1624 if (ret
!= LTTNG_OK
) {
1625 if (channel_created
) {
1626 /* Let's not leak a useless channel. */
1627 kernel_destroy_channel(kchan
);
1629 free(filter_expression_a
);
1633 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1634 ret
= event_kernel_enable_event(kchan
, event
,
1635 filter_expression_a
, filter_a
);
1636 /* We have passed ownership */
1637 filter_expression_a
= NULL
;
1639 if (ret
!= LTTNG_OK
) {
1644 case LTTNG_EVENT_PROBE
:
1645 case LTTNG_EVENT_FUNCTION
:
1646 case LTTNG_EVENT_FUNCTION_ENTRY
:
1647 case LTTNG_EVENT_TRACEPOINT
:
1648 ret
= event_kernel_enable_event(kchan
, event
,
1649 filter_expression
, filter
);
1650 /* We have passed ownership */
1651 filter_expression
= NULL
;
1653 if (ret
!= LTTNG_OK
) {
1654 if (channel_created
) {
1655 /* Let's not leak a useless channel. */
1656 kernel_destroy_channel(kchan
);
1661 case LTTNG_EVENT_SYSCALL
:
1662 ret
= event_kernel_enable_event(kchan
, event
,
1663 filter_expression
, filter
);
1664 /* We have passed ownership */
1665 filter_expression
= NULL
;
1667 if (ret
!= LTTNG_OK
) {
1672 ret
= LTTNG_ERR_UNK
;
1676 kernel_wait_quiescent(kernel_tracer_fd
);
1679 case LTTNG_DOMAIN_UST
:
1681 struct ltt_ust_channel
*uchan
;
1682 struct ltt_ust_session
*usess
= session
->ust_session
;
1687 * If a non-default channel has been created in the
1688 * session, explicitely require that -c chan_name needs
1691 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1692 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1696 /* Get channel from global UST domain */
1697 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1699 if (uchan
== NULL
) {
1700 /* Create default channel */
1701 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1702 usess
->buffer_type
);
1704 ret
= LTTNG_ERR_FATAL
;
1707 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1709 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1710 if (ret
!= LTTNG_OK
) {
1716 /* Get the newly created channel reference back */
1717 uchan
= trace_ust_find_channel_by_name(
1718 usess
->domain_global
.channels
, channel_name
);
1722 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1724 * Don't allow users to add UST events to channels which
1725 * are assigned to a userspace subdomain (JUL, Log4J,
1728 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1732 if (!internal_event
) {
1734 * Ensure the event name is not reserved for internal
1737 ret
= validate_ust_event_name(event
->name
);
1739 WARN("Userspace event name %s failed validation.",
1741 event
->name
: "NULL");
1742 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1747 /* At this point, the session and channel exist on the tracer */
1748 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1749 filter_expression
, filter
, exclusion
,
1751 /* We have passed ownership */
1752 filter_expression
= NULL
;
1755 if (ret
!= LTTNG_OK
) {
1760 case LTTNG_DOMAIN_LOG4J
:
1761 case LTTNG_DOMAIN_JUL
:
1762 case LTTNG_DOMAIN_PYTHON
:
1764 const char *default_event_name
, *default_chan_name
;
1766 struct lttng_event uevent
;
1767 struct lttng_domain tmp_dom
;
1768 struct ltt_ust_session
*usess
= session
->ust_session
;
1772 agt
= trace_ust_find_agent(usess
, domain
->type
);
1774 agt
= agent_create(domain
->type
);
1776 ret
= LTTNG_ERR_NOMEM
;
1779 agent_add(agt
, usess
->agents
);
1782 /* Create the default tracepoint. */
1783 memset(&uevent
, 0, sizeof(uevent
));
1784 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1785 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1786 default_event_name
= event_get_default_agent_ust_name(
1788 if (!default_event_name
) {
1789 ret
= LTTNG_ERR_FATAL
;
1792 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1793 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1796 * The domain type is changed because we are about to enable the
1797 * default channel and event for the JUL domain that are hardcoded.
1798 * This happens in the UST domain.
1800 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1801 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1803 switch (domain
->type
) {
1804 case LTTNG_DOMAIN_LOG4J
:
1805 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1807 case LTTNG_DOMAIN_JUL
:
1808 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1810 case LTTNG_DOMAIN_PYTHON
:
1811 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1814 /* The switch/case we are in makes this impossible */
1819 char *filter_expression_copy
= NULL
;
1820 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1823 const size_t filter_size
= sizeof(
1824 struct lttng_filter_bytecode
)
1827 filter_copy
= zmalloc(filter_size
);
1829 ret
= LTTNG_ERR_NOMEM
;
1832 memcpy(filter_copy
, filter
, filter_size
);
1834 filter_expression_copy
=
1835 strdup(filter_expression
);
1836 if (!filter_expression
) {
1837 ret
= LTTNG_ERR_NOMEM
;
1840 if (!filter_expression_copy
|| !filter_copy
) {
1841 free(filter_expression_copy
);
1847 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1848 (char *) default_chan_name
,
1849 &uevent
, filter_expression_copy
,
1850 filter_copy
, NULL
, wpipe
);
1853 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1857 /* The wild card * means that everything should be enabled. */
1858 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1859 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1862 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1866 filter_expression
= NULL
;
1867 if (ret
!= LTTNG_OK
) {
1874 ret
= LTTNG_ERR_UND
;
1881 free(filter_expression
);
1889 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1890 * We own filter, exclusion, and filter_expression.
1892 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1893 char *channel_name
, struct lttng_event
*event
,
1894 char *filter_expression
,
1895 struct lttng_filter_bytecode
*filter
,
1896 struct lttng_event_exclusion
*exclusion
,
1899 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1900 filter_expression
, filter
, exclusion
, wpipe
, false);
1904 * Enable an event which is internal to LTTng. An internal should
1905 * never be made visible to clients and are immune to checks such as
1908 static int cmd_enable_event_internal(struct ltt_session
*session
,
1909 struct lttng_domain
*domain
,
1910 char *channel_name
, struct lttng_event
*event
,
1911 char *filter_expression
,
1912 struct lttng_filter_bytecode
*filter
,
1913 struct lttng_event_exclusion
*exclusion
,
1916 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1917 filter_expression
, filter
, exclusion
, wpipe
, true);
1921 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1923 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1924 struct lttng_event
**events
)
1927 ssize_t nb_events
= 0;
1930 case LTTNG_DOMAIN_KERNEL
:
1931 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1932 if (nb_events
< 0) {
1933 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1937 case LTTNG_DOMAIN_UST
:
1938 nb_events
= ust_app_list_events(events
);
1939 if (nb_events
< 0) {
1940 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1944 case LTTNG_DOMAIN_LOG4J
:
1945 case LTTNG_DOMAIN_JUL
:
1946 case LTTNG_DOMAIN_PYTHON
:
1947 nb_events
= agent_list_events(events
, domain
);
1948 if (nb_events
< 0) {
1949 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1954 ret
= LTTNG_ERR_UND
;
1961 /* Return negative value to differentiate return code */
1966 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1968 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
1969 struct lttng_event_field
**fields
)
1972 ssize_t nb_fields
= 0;
1975 case LTTNG_DOMAIN_UST
:
1976 nb_fields
= ust_app_list_event_fields(fields
);
1977 if (nb_fields
< 0) {
1978 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1982 case LTTNG_DOMAIN_KERNEL
:
1983 default: /* fall-through */
1984 ret
= LTTNG_ERR_UND
;
1991 /* Return negative value to differentiate return code */
1995 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1997 return syscall_table_list(events
);
2001 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2003 * Called with session lock held.
2005 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2006 enum lttng_domain_type domain
, int32_t **pids
)
2009 ssize_t nr_pids
= 0;
2012 case LTTNG_DOMAIN_KERNEL
:
2014 struct ltt_kernel_session
*ksess
;
2016 ksess
= session
->kernel_session
;
2017 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2019 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2024 case LTTNG_DOMAIN_UST
:
2026 struct ltt_ust_session
*usess
;
2028 usess
= session
->ust_session
;
2029 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2031 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2036 case LTTNG_DOMAIN_LOG4J
:
2037 case LTTNG_DOMAIN_JUL
:
2038 case LTTNG_DOMAIN_PYTHON
:
2040 ret
= LTTNG_ERR_UND
;
2047 /* Return negative value to differentiate return code */
2052 * Command LTTNG_START_TRACE processed by the client thread.
2054 * Called with session mutex held.
2056 int cmd_start_trace(struct ltt_session
*session
)
2059 unsigned long nb_chan
= 0;
2060 struct ltt_kernel_session
*ksession
;
2061 struct ltt_ust_session
*usess
;
2065 /* Ease our life a bit ;) */
2066 ksession
= session
->kernel_session
;
2067 usess
= session
->ust_session
;
2069 /* Is the session already started? */
2070 if (session
->active
) {
2071 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2076 * Starting a session without channel is useless since after that it's not
2077 * possible to enable channel thus inform the client.
2079 if (usess
&& usess
->domain_global
.channels
) {
2080 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2083 nb_chan
+= ksession
->channel_count
;
2086 ret
= LTTNG_ERR_NO_CHANNEL
;
2090 /* Kernel tracing */
2091 if (ksession
!= NULL
) {
2092 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2093 if (ret
!= LTTNG_OK
) {
2098 /* Flag session that trace should start automatically */
2101 * Even though the start trace might fail, flag this session active so
2102 * other application coming in are started by default.
2106 ret
= ust_app_start_trace_all(usess
);
2108 ret
= LTTNG_ERR_UST_START_FAIL
;
2113 /* Flag this after a successful start. */
2114 session
->has_been_started
= 1;
2115 session
->active
= 1;
2124 * Command LTTNG_STOP_TRACE processed by the client thread.
2126 int cmd_stop_trace(struct ltt_session
*session
)
2129 struct ltt_kernel_channel
*kchan
;
2130 struct ltt_kernel_session
*ksession
;
2131 struct ltt_ust_session
*usess
;
2136 ksession
= session
->kernel_session
;
2137 usess
= session
->ust_session
;
2139 /* Session is not active. Skip everythong and inform the client. */
2140 if (!session
->active
) {
2141 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2146 if (ksession
&& ksession
->active
) {
2147 DBG("Stop kernel tracing");
2149 /* Flush metadata if exist */
2150 if (ksession
->metadata_stream_fd
>= 0) {
2151 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2153 ERR("Kernel metadata flush failed");
2157 /* Flush all buffers before stopping */
2158 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2159 ret
= kernel_flush_buffer(kchan
);
2161 ERR("Kernel flush buffer error");
2165 ret
= kernel_stop_session(ksession
);
2167 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2171 kernel_wait_quiescent(kernel_tracer_fd
);
2173 ksession
->active
= 0;
2176 if (usess
&& usess
->active
) {
2178 * Even though the stop trace might fail, flag this session inactive so
2179 * other application coming in are not started by default.
2183 ret
= ust_app_stop_trace_all(usess
);
2185 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2190 /* Flag inactive after a successful stop. */
2191 session
->active
= 0;
2199 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2201 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2202 struct lttng_uri
*uris
)
2205 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2206 struct ltt_ust_session
*usess
= session
->ust_session
;
2212 /* Can't set consumer URI if the session is active. */
2213 if (session
->active
) {
2214 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2218 /* Set the "global" consumer URIs */
2219 for (i
= 0; i
< nb_uri
; i
++) {
2220 ret
= add_uri_to_consumer(session
->consumer
,
2221 &uris
[i
], 0, session
->name
);
2222 if (ret
!= LTTNG_OK
) {
2227 /* Set UST session URIs */
2228 if (session
->ust_session
) {
2229 for (i
= 0; i
< nb_uri
; i
++) {
2230 ret
= add_uri_to_consumer(
2231 session
->ust_session
->consumer
,
2232 &uris
[i
], LTTNG_DOMAIN_UST
,
2234 if (ret
!= LTTNG_OK
) {
2240 /* Set kernel session URIs */
2241 if (session
->kernel_session
) {
2242 for (i
= 0; i
< nb_uri
; i
++) {
2243 ret
= add_uri_to_consumer(
2244 session
->kernel_session
->consumer
,
2245 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2247 if (ret
!= LTTNG_OK
) {
2254 * Make sure to set the session in output mode after we set URI since a
2255 * session can be created without URL (thus flagged in no output mode).
2257 session
->output_traces
= 1;
2259 ksess
->output_traces
= 1;
2263 usess
->output_traces
= 1;
2274 * Command LTTNG_CREATE_SESSION processed by the client thread.
2276 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2277 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2280 struct ltt_session
*session
;
2286 * Verify if the session already exist
2288 * XXX: There is no need for the session lock list here since the caller
2289 * (process_client_msg) is holding it. We might want to change that so a
2290 * single command does not lock the entire session list.
2292 session
= session_find_by_name(name
);
2293 if (session
!= NULL
) {
2294 ret
= LTTNG_ERR_EXIST_SESS
;
2298 /* Create tracing session in the registry */
2299 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2300 LTTNG_SOCK_GET_GID_CRED(creds
));
2301 if (ret
!= LTTNG_OK
) {
2306 * Get the newly created session pointer back
2308 * XXX: There is no need for the session lock list here since the caller
2309 * (process_client_msg) is holding it. We might want to change that so a
2310 * single command does not lock the entire session list.
2312 session
= session_find_by_name(name
);
2315 session
->live_timer
= live_timer
;
2316 /* Create default consumer output for the session not yet created. */
2317 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2318 if (session
->consumer
== NULL
) {
2319 ret
= LTTNG_ERR_FATAL
;
2320 goto consumer_error
;
2324 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2325 if (ret
!= LTTNG_OK
) {
2326 goto consumer_error
;
2328 session
->output_traces
= 1;
2330 session
->output_traces
= 0;
2331 DBG2("Session %s created with no output", session
->name
);
2334 session
->consumer
->enabled
= 1;
2339 session_destroy(session
);
2346 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2348 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2349 size_t nb_uri
, lttng_sock_cred
*creds
)
2352 struct ltt_session
*session
;
2353 struct snapshot_output
*new_output
= NULL
;
2359 * Create session in no output mode with URIs set to NULL. The uris we've
2360 * received are for a default snapshot output if one.
2362 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2363 if (ret
!= LTTNG_OK
) {
2367 /* Get the newly created session pointer back. This should NEVER fail. */
2368 session
= session_find_by_name(name
);
2371 /* Flag session for snapshot mode. */
2372 session
->snapshot_mode
= 1;
2374 /* Skip snapshot output creation if no URI is given. */
2379 new_output
= snapshot_output_alloc();
2381 ret
= LTTNG_ERR_NOMEM
;
2382 goto error_snapshot_alloc
;
2385 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2386 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2388 if (ret
== -ENOMEM
) {
2389 ret
= LTTNG_ERR_NOMEM
;
2391 ret
= LTTNG_ERR_INVALID
;
2393 goto error_snapshot
;
2397 snapshot_add_output(&session
->snapshot
, new_output
);
2404 snapshot_output_destroy(new_output
);
2405 error_snapshot_alloc
:
2406 session_destroy(session
);
2412 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2414 * Called with session lock held.
2416 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2419 struct ltt_ust_session
*usess
;
2420 struct ltt_kernel_session
*ksess
;
2425 usess
= session
->ust_session
;
2426 ksess
= session
->kernel_session
;
2428 /* Clean kernel session teardown */
2429 kernel_destroy_session(ksess
);
2431 /* UST session teardown */
2433 /* Close any relayd session */
2434 consumer_output_send_destroy_relayd(usess
->consumer
);
2436 /* Destroy every UST application related to this session. */
2437 ret
= ust_app_destroy_trace_all(usess
);
2439 ERR("Error in ust_app_destroy_trace_all");
2442 /* Clean up the rest. */
2443 trace_ust_destroy_session(usess
);
2447 * Must notify the kernel thread here to update it's poll set in order to
2448 * remove the channel(s)' fd just destroyed.
2450 ret
= notify_thread_pipe(wpipe
);
2452 PERROR("write kernel poll pipe");
2455 ret
= session_destroy(session
);
2461 * Command LTTNG_CALIBRATE processed by the client thread.
2463 int cmd_calibrate(enum lttng_domain_type domain
,
2464 struct lttng_calibrate
*calibrate
)
2469 case LTTNG_DOMAIN_KERNEL
:
2471 struct lttng_kernel_calibrate kcalibrate
;
2473 switch (calibrate
->type
) {
2474 case LTTNG_CALIBRATE_FUNCTION
:
2476 /* Default and only possible calibrate option. */
2477 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2481 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2483 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2488 case LTTNG_DOMAIN_UST
:
2490 struct lttng_ust_calibrate ucalibrate
;
2492 switch (calibrate
->type
) {
2493 case LTTNG_CALIBRATE_FUNCTION
:
2495 /* Default and only possible calibrate option. */
2496 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2500 ret
= ust_app_calibrate_glb(&ucalibrate
);
2502 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2508 ret
= LTTNG_ERR_UND
;
2519 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2521 int cmd_register_consumer(struct ltt_session
*session
,
2522 enum lttng_domain_type domain
, const char *sock_path
,
2523 struct consumer_data
*cdata
)
2526 struct consumer_socket
*socket
= NULL
;
2533 case LTTNG_DOMAIN_KERNEL
:
2535 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2539 /* Can't register a consumer if there is already one */
2540 if (ksess
->consumer_fds_sent
!= 0) {
2541 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2545 sock
= lttcomm_connect_unix_sock(sock_path
);
2547 ret
= LTTNG_ERR_CONNECT_FAIL
;
2550 cdata
->cmd_sock
= sock
;
2552 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2553 if (socket
== NULL
) {
2556 PERROR("close register consumer");
2558 cdata
->cmd_sock
= -1;
2559 ret
= LTTNG_ERR_FATAL
;
2563 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2564 if (socket
->lock
== NULL
) {
2565 PERROR("zmalloc pthread mutex");
2566 ret
= LTTNG_ERR_FATAL
;
2569 pthread_mutex_init(socket
->lock
, NULL
);
2570 socket
->registered
= 1;
2573 consumer_add_socket(socket
, ksess
->consumer
);
2576 pthread_mutex_lock(&cdata
->pid_mutex
);
2578 pthread_mutex_unlock(&cdata
->pid_mutex
);
2583 /* TODO: Userspace tracing */
2584 ret
= LTTNG_ERR_UND
;
2592 consumer_destroy_socket(socket
);
2598 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2600 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2601 struct lttng_domain
**domains
)
2606 struct lttng_ht_iter iter
;
2608 if (session
->kernel_session
!= NULL
) {
2609 DBG3("Listing domains found kernel domain");
2613 if (session
->ust_session
!= NULL
) {
2614 DBG3("Listing domains found UST global domain");
2618 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2620 if (agt
->being_used
) {
2631 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2632 if (*domains
== NULL
) {
2633 ret
= LTTNG_ERR_FATAL
;
2637 if (session
->kernel_session
!= NULL
) {
2638 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2640 /* Kernel session buffer type is always GLOBAL */
2641 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2646 if (session
->ust_session
!= NULL
) {
2647 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2648 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2652 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2654 if (agt
->being_used
) {
2655 (*domains
)[index
].type
= agt
->domain
;
2656 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2666 /* Return negative value to differentiate return code */
2672 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2674 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2675 struct ltt_session
*session
, struct lttng_channel
**channels
)
2678 ssize_t nb_chan
= 0;
2681 case LTTNG_DOMAIN_KERNEL
:
2682 if (session
->kernel_session
!= NULL
) {
2683 nb_chan
= session
->kernel_session
->channel_count
;
2685 DBG3("Number of kernel channels %zd", nb_chan
);
2687 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2690 case LTTNG_DOMAIN_UST
:
2691 if (session
->ust_session
!= NULL
) {
2693 nb_chan
= lttng_ht_get_count(
2694 session
->ust_session
->domain_global
.channels
);
2697 DBG3("Number of UST global channels %zd", nb_chan
);
2699 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2704 ret
= LTTNG_ERR_UND
;
2709 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2710 if (*channels
== NULL
) {
2711 ret
= LTTNG_ERR_FATAL
;
2715 list_lttng_channels(domain
, session
, *channels
);
2721 /* Return negative value to differentiate return code */
2726 * Command LTTNG_LIST_EVENTS processed by the client thread.
2728 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2729 struct ltt_session
*session
, char *channel_name
,
2730 struct lttng_event
**events
)
2733 ssize_t nb_event
= 0;
2736 case LTTNG_DOMAIN_KERNEL
:
2737 if (session
->kernel_session
!= NULL
) {
2738 nb_event
= list_lttng_kernel_events(channel_name
,
2739 session
->kernel_session
, events
);
2742 case LTTNG_DOMAIN_UST
:
2744 if (session
->ust_session
!= NULL
) {
2745 nb_event
= list_lttng_ust_global_events(channel_name
,
2746 &session
->ust_session
->domain_global
, events
);
2750 case LTTNG_DOMAIN_LOG4J
:
2751 case LTTNG_DOMAIN_JUL
:
2752 case LTTNG_DOMAIN_PYTHON
:
2753 if (session
->ust_session
) {
2754 struct lttng_ht_iter iter
;
2758 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2759 &iter
.iter
, agt
, node
.node
) {
2760 nb_event
= list_lttng_agent_events(agt
, events
);
2766 ret
= LTTNG_ERR_UND
;
2773 /* Return negative value to differentiate return code */
2778 * Using the session list, filled a lttng_session array to send back to the
2779 * client for session listing.
2781 * The session list lock MUST be acquired before calling this function. Use
2782 * session_lock_list() and session_unlock_list().
2784 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2789 struct ltt_session
*session
;
2790 struct ltt_session_list
*list
= session_get_list();
2792 DBG("Getting all available session for UID %d GID %d",
2795 * Iterate over session list and append data after the control struct in
2798 cds_list_for_each_entry(session
, &list
->head
, list
) {
2800 * Only list the sessions the user can control.
2802 if (!session_access_ok(session
, uid
, gid
)) {
2806 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2807 struct ltt_ust_session
*usess
= session
->ust_session
;
2809 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2810 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2811 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2812 ret
= build_network_session_path(sessions
[i
].path
,
2813 sizeof(sessions
[i
].path
), session
);
2815 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2816 session
->consumer
->dst
.trace_path
);
2819 PERROR("snprintf session path");
2823 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2824 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2825 sessions
[i
].enabled
= session
->active
;
2826 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2827 sessions
[i
].live_timer_interval
= session
->live_timer
;
2833 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2834 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2836 int cmd_data_pending(struct ltt_session
*session
)
2839 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2840 struct ltt_ust_session
*usess
= session
->ust_session
;
2844 /* Session MUST be stopped to ask for data availability. */
2845 if (session
->active
) {
2846 ret
= LTTNG_ERR_SESSION_STARTED
;
2850 * If stopped, just make sure we've started before else the above call
2851 * will always send that there is data pending.
2853 * The consumer assumes that when the data pending command is received,
2854 * the trace has been started before or else no output data is written
2855 * by the streams which is a condition for data pending. So, this is
2856 * *VERY* important that we don't ask the consumer before a start
2859 if (!session
->has_been_started
) {
2865 if (ksess
&& ksess
->consumer
) {
2866 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2868 /* Data is still being extracted for the kernel. */
2873 if (usess
&& usess
->consumer
) {
2874 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2876 /* Data is still being extracted for the kernel. */
2881 /* Data is ready to be read by a viewer */
2889 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2891 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2893 int cmd_snapshot_add_output(struct ltt_session
*session
,
2894 struct lttng_snapshot_output
*output
, uint32_t *id
)
2897 struct snapshot_output
*new_output
;
2902 DBG("Cmd snapshot add output for session %s", session
->name
);
2905 * Permission denied to create an output if the session is not
2906 * set in no output mode.
2908 if (session
->output_traces
) {
2909 ret
= LTTNG_ERR_EPERM
;
2913 /* Only one output is allowed until we have the "tee" feature. */
2914 if (session
->snapshot
.nb_output
== 1) {
2915 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2919 new_output
= snapshot_output_alloc();
2921 ret
= LTTNG_ERR_NOMEM
;
2925 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2926 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2927 &session
->snapshot
);
2929 if (ret
== -ENOMEM
) {
2930 ret
= LTTNG_ERR_NOMEM
;
2932 ret
= LTTNG_ERR_INVALID
;
2938 snapshot_add_output(&session
->snapshot
, new_output
);
2940 *id
= new_output
->id
;
2947 snapshot_output_destroy(new_output
);
2953 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2955 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2957 int cmd_snapshot_del_output(struct ltt_session
*session
,
2958 struct lttng_snapshot_output
*output
)
2961 struct snapshot_output
*sout
= NULL
;
2969 * Permission denied to create an output if the session is not
2970 * set in no output mode.
2972 if (session
->output_traces
) {
2973 ret
= LTTNG_ERR_EPERM
;
2978 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2980 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2981 } else if (*output
->name
!= '\0') {
2982 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2984 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2987 ret
= LTTNG_ERR_INVALID
;
2991 snapshot_delete_output(&session
->snapshot
, sout
);
2992 snapshot_output_destroy(sout
);
3001 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3003 * If no output is available, outputs is untouched and 0 is returned.
3005 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3007 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3008 struct lttng_snapshot_output
**outputs
)
3011 struct lttng_snapshot_output
*list
= NULL
;
3012 struct lttng_ht_iter iter
;
3013 struct snapshot_output
*output
;
3018 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3021 * Permission denied to create an output if the session is not
3022 * set in no output mode.
3024 if (session
->output_traces
) {
3025 ret
= -LTTNG_ERR_EPERM
;
3029 if (session
->snapshot
.nb_output
== 0) {
3034 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3036 ret
= -LTTNG_ERR_NOMEM
;
3040 /* Copy list from session to the new list object. */
3042 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3043 output
, node
.node
) {
3044 assert(output
->consumer
);
3045 list
[idx
].id
= output
->id
;
3046 list
[idx
].max_size
= output
->max_size
;
3047 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3048 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3049 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3050 sizeof(list
[idx
].ctrl_url
));
3053 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3054 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3056 ret
= -LTTNG_ERR_NOMEM
;
3061 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3062 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3064 ret
= -LTTNG_ERR_NOMEM
;
3073 ret
= session
->snapshot
.nb_output
;
3081 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3082 * snapshot output is *not* set with a remote destination.
3084 * Return 0 on success or a LTTNG_ERR code.
3086 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3087 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3090 struct lttng_ht_iter iter
;
3091 struct consumer_socket
*socket
;
3094 assert(snap_output
);
3097 DBG2("Set relayd object from snapshot output");
3099 /* Ignore if snapshot consumer output is not network. */
3100 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3105 * For each consumer socket, create and send the relayd object of the
3109 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3110 socket
, node
.node
) {
3111 ret
= send_consumer_relayd_sockets(0, session
->id
,
3112 snap_output
->consumer
, socket
,
3113 session
->name
, session
->hostname
,
3114 session
->live_timer
);
3115 if (ret
!= LTTNG_OK
) {
3127 * Record a kernel snapshot.
3129 * Return LTTNG_OK on success or a LTTNG_ERR code.
3131 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3132 struct snapshot_output
*output
, struct ltt_session
*session
,
3133 int wait
, uint64_t nb_packets_per_stream
)
3141 /* Get the datetime for the snapshot output directory. */
3142 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3143 sizeof(output
->datetime
));
3145 ret
= LTTNG_ERR_INVALID
;
3150 * Copy kernel session sockets so we can communicate with the right
3151 * consumer for the snapshot record command.
3153 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3155 ret
= LTTNG_ERR_NOMEM
;
3159 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3160 if (ret
!= LTTNG_OK
) {
3161 goto error_snapshot
;
3164 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3165 if (ret
!= LTTNG_OK
) {
3166 goto error_snapshot
;
3173 /* Clean up copied sockets so this output can use some other later on. */
3174 consumer_destroy_output_sockets(output
->consumer
);
3181 * Record a UST snapshot.
3183 * Return 0 on success or a LTTNG_ERR error code.
3185 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3186 struct snapshot_output
*output
, struct ltt_session
*session
,
3187 int wait
, uint64_t nb_packets_per_stream
)
3195 /* Get the datetime for the snapshot output directory. */
3196 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3197 sizeof(output
->datetime
));
3199 ret
= LTTNG_ERR_INVALID
;
3204 * Copy UST session sockets so we can communicate with the right
3205 * consumer for the snapshot record command.
3207 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3209 ret
= LTTNG_ERR_NOMEM
;
3213 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3214 if (ret
!= LTTNG_OK
) {
3215 goto error_snapshot
;
3218 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3222 ret
= LTTNG_ERR_INVALID
;
3225 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3228 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3231 goto error_snapshot
;
3237 /* Clean up copied sockets so this output can use some other later on. */
3238 consumer_destroy_output_sockets(output
->consumer
);
3244 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3245 uint64_t cur_nr_packets
)
3247 uint64_t tot_size
= 0;
3249 if (session
->kernel_session
) {
3250 struct ltt_kernel_channel
*chan
;
3251 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3253 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3254 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3256 * Don't take channel into account if we
3257 * already grab all its packets.
3261 tot_size
+= chan
->channel
->attr
.subbuf_size
3262 * chan
->stream_count
;
3266 if (session
->ust_session
) {
3267 struct ltt_ust_session
*usess
= session
->ust_session
;
3269 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3277 * Calculate the number of packets we can grab from each stream that
3278 * fits within the overall snapshot max size.
3280 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3281 * the number of packets per stream.
3283 * TODO: this approach is not perfect: we consider the worse case
3284 * (packet filling the sub-buffers) as an upper bound, but we could do
3285 * better if we do this calculation while we actually grab the packet
3286 * content: we would know how much padding we don't actually store into
3289 * This algorithm is currently bounded by the number of packets per
3292 * Since we call this algorithm before actually grabbing the data, it's
3293 * an approximation: for instance, applications could appear/disappear
3294 * in between this call and actually grabbing data.
3297 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3300 uint64_t cur_nb_packets
= 0;
3303 return 0; /* Infinite */
3306 size_left
= max_size
;
3308 uint64_t one_more_packet_tot_size
;
3310 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3312 if (!one_more_packet_tot_size
) {
3313 /* We are already grabbing all packets. */
3316 size_left
-= one_more_packet_tot_size
;
3317 if (size_left
< 0) {
3322 if (!cur_nb_packets
) {
3323 /* Not enough room to grab one packet of each stream, error. */
3326 return cur_nb_packets
;
3330 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3332 * The wait parameter is ignored so this call always wait for the snapshot to
3333 * complete before returning.
3335 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3337 int cmd_snapshot_record(struct ltt_session
*session
,
3338 struct lttng_snapshot_output
*output
, int wait
)
3341 unsigned int use_tmp_output
= 0;
3342 struct snapshot_output tmp_output
;
3343 unsigned int snapshot_success
= 0;
3348 DBG("Cmd snapshot record for session %s", session
->name
);
3351 * Permission denied to create an output if the session is not
3352 * set in no output mode.
3354 if (session
->output_traces
) {
3355 ret
= LTTNG_ERR_EPERM
;
3359 /* The session needs to be started at least once. */
3360 if (!session
->has_been_started
) {
3361 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3365 /* Use temporary output for the session. */
3366 if (*output
->ctrl_url
!= '\0') {
3367 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3368 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3371 if (ret
== -ENOMEM
) {
3372 ret
= LTTNG_ERR_NOMEM
;
3374 ret
= LTTNG_ERR_INVALID
;
3378 /* Use the global session count for the temporary snapshot. */
3379 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3383 if (session
->kernel_session
) {
3384 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3386 if (use_tmp_output
) {
3387 int64_t nb_packets_per_stream
;
3389 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3390 tmp_output
.max_size
);
3391 if (nb_packets_per_stream
< 0) {
3392 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3395 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3396 wait
, nb_packets_per_stream
);
3397 if (ret
!= LTTNG_OK
) {
3400 snapshot_success
= 1;
3402 struct snapshot_output
*sout
;
3403 struct lttng_ht_iter iter
;
3406 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3407 &iter
.iter
, sout
, node
.node
) {
3408 int64_t nb_packets_per_stream
;
3411 * Make a local copy of the output and assign the possible
3412 * temporary value given by the caller.
3414 memset(&tmp_output
, 0, sizeof(tmp_output
));
3415 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3417 if (output
->max_size
!= (uint64_t) -1ULL) {
3418 tmp_output
.max_size
= output
->max_size
;
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
;
3428 /* Use temporary name. */
3429 if (*output
->name
!= '\0') {
3430 strncpy(tmp_output
.name
, output
->name
,
3431 sizeof(tmp_output
.name
));
3434 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3436 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3437 session
, wait
, nb_packets_per_stream
);
3438 if (ret
!= LTTNG_OK
) {
3442 snapshot_success
= 1;
3448 if (session
->ust_session
) {
3449 struct ltt_ust_session
*usess
= session
->ust_session
;
3451 if (use_tmp_output
) {
3452 int64_t nb_packets_per_stream
;
3454 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3455 tmp_output
.max_size
);
3456 if (nb_packets_per_stream
< 0) {
3457 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3460 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3461 wait
, nb_packets_per_stream
);
3462 if (ret
!= LTTNG_OK
) {
3465 snapshot_success
= 1;
3467 struct snapshot_output
*sout
;
3468 struct lttng_ht_iter iter
;
3471 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3472 &iter
.iter
, sout
, node
.node
) {
3473 int64_t nb_packets_per_stream
;
3476 * Make a local copy of the output and assign the possible
3477 * temporary value given by the caller.
3479 memset(&tmp_output
, 0, sizeof(tmp_output
));
3480 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3482 if (output
->max_size
!= (uint64_t) -1ULL) {
3483 tmp_output
.max_size
= output
->max_size
;
3486 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3487 tmp_output
.max_size
);
3488 if (nb_packets_per_stream
< 0) {
3489 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3494 /* Use temporary name. */
3495 if (*output
->name
!= '\0') {
3496 strncpy(tmp_output
.name
, output
->name
,
3497 sizeof(tmp_output
.name
));
3500 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3502 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3503 wait
, nb_packets_per_stream
);
3504 if (ret
!= LTTNG_OK
) {
3508 snapshot_success
= 1;
3514 if (snapshot_success
) {
3515 session
->snapshot
.nb_snapshot
++;
3517 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3525 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3527 int cmd_set_session_shm_path(struct ltt_session
*session
,
3528 const char *shm_path
)
3534 * Can only set shm path before session is started.
3536 if (session
->has_been_started
) {
3537 return LTTNG_ERR_SESSION_STARTED
;
3540 strncpy(session
->shm_path
, shm_path
,
3541 sizeof(session
->shm_path
));
3542 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3548 * Init command subsystem.
3553 * Set network sequence index to 1 for streams to match a relayd
3554 * socket on the consumer side.
3556 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3557 relayd_net_seq_idx
= 1;
3558 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3560 DBG("Command subsystem initialized");