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 case LTTNG_EVENT_TRACEPOINT
:
1229 case LTTNG_EVENT_SYSCALL
:
1230 case LTTNG_EVENT_PROBE
:
1231 case LTTNG_EVENT_FUNCTION
:
1232 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1233 if (event_name
[0] == '\0') {
1234 ret
= event_kernel_disable_event(kchan
,
1237 ret
= event_kernel_disable_event(kchan
,
1238 event_name
, event
->type
);
1240 if (ret
!= LTTNG_OK
) {
1245 ret
= LTTNG_ERR_UNK
;
1249 kernel_wait_quiescent(kernel_tracer_fd
);
1252 case LTTNG_DOMAIN_UST
:
1254 struct ltt_ust_channel
*uchan
;
1255 struct ltt_ust_session
*usess
;
1257 usess
= session
->ust_session
;
1259 if (validate_ust_event_name(event_name
)) {
1260 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1265 * If a non-default channel has been created in the
1266 * session, explicitly require that -c chan_name needs
1269 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1270 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1274 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1276 if (uchan
== NULL
) {
1277 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1281 switch (event
->type
) {
1282 case LTTNG_EVENT_ALL
:
1283 if (strlen(event
->name
) == 1 &&
1284 !strncmp(event
->name
, "*", 1)) {
1285 ret
= event_ust_disable_all_tracepoints(usess
,
1288 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1291 if (ret
!= LTTNG_OK
) {
1296 ret
= LTTNG_ERR_UNK
;
1300 DBG3("Disable UST event %s in channel %s completed", event_name
,
1304 case LTTNG_DOMAIN_LOG4J
:
1305 case LTTNG_DOMAIN_JUL
:
1306 case LTTNG_DOMAIN_PYTHON
:
1309 struct ltt_ust_session
*usess
= session
->ust_session
;
1313 switch (event
->type
) {
1314 case LTTNG_EVENT_ALL
:
1317 ret
= LTTNG_ERR_UNK
;
1321 agt
= trace_ust_find_agent(usess
, domain
);
1323 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1326 /* The wild card * means that everything should be disabled. */
1327 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1328 ret
= event_agent_disable_all(usess
, agt
);
1330 ret
= event_agent_disable(usess
, agt
, event_name
);
1332 if (ret
!= LTTNG_OK
) {
1339 ret
= LTTNG_ERR_UND
;
1352 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1354 int cmd_add_context(struct ltt_session
*session
, enum lttng_domain_type domain
,
1355 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1357 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1360 case LTTNG_DOMAIN_KERNEL
:
1361 assert(session
->kernel_session
);
1363 if (session
->kernel_session
->channel_count
== 0) {
1364 /* Create default channel */
1365 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1366 if (ret
!= LTTNG_OK
) {
1369 chan_kern_created
= 1;
1371 /* Add kernel context to kernel tracer */
1372 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1373 if (ret
!= LTTNG_OK
) {
1377 case LTTNG_DOMAIN_UST
:
1379 struct ltt_ust_session
*usess
= session
->ust_session
;
1380 unsigned int chan_count
;
1384 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1385 if (chan_count
== 0) {
1386 struct lttng_channel
*attr
;
1387 /* Create default channel */
1388 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1390 ret
= LTTNG_ERR_FATAL
;
1394 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1395 if (ret
!= LTTNG_OK
) {
1400 chan_ust_created
= 1;
1403 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1404 if (ret
!= LTTNG_OK
) {
1410 ret
= LTTNG_ERR_UND
;
1417 if (chan_kern_created
) {
1418 struct ltt_kernel_channel
*kchan
=
1419 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1420 session
->kernel_session
);
1421 /* Created previously, this should NOT fail. */
1423 kernel_destroy_channel(kchan
);
1426 if (chan_ust_created
) {
1427 struct ltt_ust_channel
*uchan
=
1428 trace_ust_find_channel_by_name(
1429 session
->ust_session
->domain_global
.channels
,
1430 DEFAULT_CHANNEL_NAME
);
1431 /* Created previously, this should NOT fail. */
1433 /* Remove from the channel list of the session. */
1434 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1436 trace_ust_destroy_channel(uchan
);
1441 static int validate_event_name(const char *name
)
1444 const char *c
= name
;
1445 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1446 bool null_terminated
= false;
1449 * Make sure that unescaped wildcards are only used as the last
1450 * character of the event name.
1452 while (c
< event_name_end
) {
1455 null_terminated
= true;
1461 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1462 /* Wildcard is not the last character */
1463 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1472 if (!ret
&& !null_terminated
) {
1473 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1478 static inline bool name_starts_with(const char *name
, const char *prefix
)
1480 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1482 return !strncmp(name
, prefix
, max_cmp_len
);
1485 /* Perform userspace-specific event name validation */
1486 static int validate_ust_event_name(const char *name
)
1496 * Check name against all internal UST event component namespaces used
1499 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1500 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1501 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1510 * Internal version of cmd_enable_event() with a supplemental
1511 * "internal_event" flag which is used to enable internal events which should
1512 * be hidden from clients. Such events are used in the agent implementation to
1513 * enable the events through which all "agent" events are funeled.
1515 static int _cmd_enable_event(struct ltt_session
*session
,
1516 struct lttng_domain
*domain
,
1517 char *channel_name
, struct lttng_event
*event
,
1518 char *filter_expression
,
1519 struct lttng_filter_bytecode
*filter
,
1520 struct lttng_event_exclusion
*exclusion
,
1521 int wpipe
, bool internal_event
)
1523 int ret
, channel_created
= 0;
1524 struct lttng_channel
*attr
;
1528 assert(channel_name
);
1530 /* If we have a filter, we must have its filter expression */
1531 assert(!(!!filter_expression
^ !!filter
));
1533 DBG("Enable event command for event \'%s\'", event
->name
);
1537 ret
= validate_event_name(event
->name
);
1542 switch (domain
->type
) {
1543 case LTTNG_DOMAIN_KERNEL
:
1545 struct ltt_kernel_channel
*kchan
;
1548 * If a non-default channel has been created in the
1549 * session, explicitely require that -c chan_name needs
1552 if (session
->kernel_session
->has_non_default_channel
1553 && channel_name
[0] == '\0') {
1554 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1558 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1559 session
->kernel_session
);
1560 if (kchan
== NULL
) {
1561 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1562 LTTNG_BUFFER_GLOBAL
);
1564 ret
= LTTNG_ERR_FATAL
;
1567 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1569 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1570 if (ret
!= LTTNG_OK
) {
1576 channel_created
= 1;
1579 /* Get the newly created kernel channel pointer */
1580 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1581 session
->kernel_session
);
1582 if (kchan
== NULL
) {
1583 /* This sould not happen... */
1584 ret
= LTTNG_ERR_FATAL
;
1588 switch (event
->type
) {
1589 case LTTNG_EVENT_ALL
:
1591 char *filter_expression_a
= NULL
;
1592 struct lttng_filter_bytecode
*filter_a
= NULL
;
1595 * We need to duplicate filter_expression and filter,
1596 * because ownership is passed to first enable
1599 if (filter_expression
) {
1600 filter_expression_a
= strdup(filter_expression
);
1601 if (!filter_expression_a
) {
1602 ret
= LTTNG_ERR_FATAL
;
1607 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1609 free(filter_expression_a
);
1610 ret
= LTTNG_ERR_FATAL
;
1613 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1615 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
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
);
1626 free(filter_expression_a
);
1630 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1631 ret
= event_kernel_enable_event(kchan
, event
,
1632 filter_expression_a
, filter_a
);
1633 /* We have passed ownership */
1634 filter_expression_a
= NULL
;
1636 if (ret
!= LTTNG_OK
) {
1641 case LTTNG_EVENT_PROBE
:
1642 case LTTNG_EVENT_FUNCTION
:
1643 case LTTNG_EVENT_FUNCTION_ENTRY
:
1644 case LTTNG_EVENT_TRACEPOINT
:
1645 ret
= event_kernel_enable_event(kchan
, event
,
1646 filter_expression
, filter
);
1647 /* We have passed ownership */
1648 filter_expression
= NULL
;
1650 if (ret
!= LTTNG_OK
) {
1651 if (channel_created
) {
1652 /* Let's not leak a useless channel. */
1653 kernel_destroy_channel(kchan
);
1658 case LTTNG_EVENT_SYSCALL
:
1659 ret
= event_kernel_enable_event(kchan
, event
,
1660 filter_expression
, filter
);
1661 /* We have passed ownership */
1662 filter_expression
= NULL
;
1664 if (ret
!= LTTNG_OK
) {
1669 ret
= LTTNG_ERR_UNK
;
1673 kernel_wait_quiescent(kernel_tracer_fd
);
1676 case LTTNG_DOMAIN_UST
:
1678 struct ltt_ust_channel
*uchan
;
1679 struct ltt_ust_session
*usess
= session
->ust_session
;
1684 * If a non-default channel has been created in the
1685 * session, explicitely require that -c chan_name needs
1688 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1689 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1693 /* Get channel from global UST domain */
1694 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1696 if (uchan
== NULL
) {
1697 /* Create default channel */
1698 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1699 usess
->buffer_type
);
1701 ret
= LTTNG_ERR_FATAL
;
1704 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1706 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1707 if (ret
!= LTTNG_OK
) {
1713 /* Get the newly created channel reference back */
1714 uchan
= trace_ust_find_channel_by_name(
1715 usess
->domain_global
.channels
, channel_name
);
1719 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1721 * Don't allow users to add UST events to channels which
1722 * are assigned to a userspace subdomain (JUL, Log4J,
1725 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1729 if (!internal_event
) {
1731 * Ensure the event name is not reserved for internal
1734 ret
= validate_ust_event_name(event
->name
);
1736 WARN("Userspace event name %s failed validation.",
1738 event
->name
: "NULL");
1739 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1744 /* At this point, the session and channel exist on the tracer */
1745 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1746 filter_expression
, filter
, exclusion
,
1748 /* We have passed ownership */
1749 filter_expression
= NULL
;
1752 if (ret
!= LTTNG_OK
) {
1757 case LTTNG_DOMAIN_LOG4J
:
1758 case LTTNG_DOMAIN_JUL
:
1759 case LTTNG_DOMAIN_PYTHON
:
1761 const char *default_event_name
, *default_chan_name
;
1763 struct lttng_event uevent
;
1764 struct lttng_domain tmp_dom
;
1765 struct ltt_ust_session
*usess
= session
->ust_session
;
1769 agt
= trace_ust_find_agent(usess
, domain
->type
);
1771 agt
= agent_create(domain
->type
);
1773 ret
= LTTNG_ERR_NOMEM
;
1776 agent_add(agt
, usess
->agents
);
1779 /* Create the default tracepoint. */
1780 memset(&uevent
, 0, sizeof(uevent
));
1781 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1782 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1783 default_event_name
= event_get_default_agent_ust_name(
1785 if (!default_event_name
) {
1786 ret
= LTTNG_ERR_FATAL
;
1789 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1790 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1793 * The domain type is changed because we are about to enable the
1794 * default channel and event for the JUL domain that are hardcoded.
1795 * This happens in the UST domain.
1797 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1798 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1800 switch (domain
->type
) {
1801 case LTTNG_DOMAIN_LOG4J
:
1802 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1804 case LTTNG_DOMAIN_JUL
:
1805 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1807 case LTTNG_DOMAIN_PYTHON
:
1808 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1811 /* The switch/case we are in makes this impossible */
1816 char *filter_expression_copy
= NULL
;
1817 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1820 const size_t filter_size
= sizeof(
1821 struct lttng_filter_bytecode
)
1824 filter_copy
= zmalloc(filter_size
);
1826 ret
= LTTNG_ERR_NOMEM
;
1829 memcpy(filter_copy
, filter
, filter_size
);
1831 filter_expression_copy
=
1832 strdup(filter_expression
);
1833 if (!filter_expression
) {
1834 ret
= LTTNG_ERR_NOMEM
;
1837 if (!filter_expression_copy
|| !filter_copy
) {
1838 free(filter_expression_copy
);
1844 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1845 (char *) default_chan_name
,
1846 &uevent
, filter_expression_copy
,
1847 filter_copy
, NULL
, wpipe
);
1850 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1854 /* The wild card * means that everything should be enabled. */
1855 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1856 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1859 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1863 filter_expression
= NULL
;
1864 if (ret
!= LTTNG_OK
) {
1871 ret
= LTTNG_ERR_UND
;
1878 free(filter_expression
);
1886 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1887 * We own filter, exclusion, and filter_expression.
1889 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1890 char *channel_name
, struct lttng_event
*event
,
1891 char *filter_expression
,
1892 struct lttng_filter_bytecode
*filter
,
1893 struct lttng_event_exclusion
*exclusion
,
1896 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1897 filter_expression
, filter
, exclusion
, wpipe
, false);
1901 * Enable an event which is internal to LTTng. An internal should
1902 * never be made visible to clients and are immune to checks such as
1905 static int cmd_enable_event_internal(struct ltt_session
*session
,
1906 struct lttng_domain
*domain
,
1907 char *channel_name
, struct lttng_event
*event
,
1908 char *filter_expression
,
1909 struct lttng_filter_bytecode
*filter
,
1910 struct lttng_event_exclusion
*exclusion
,
1913 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1914 filter_expression
, filter
, exclusion
, wpipe
, true);
1918 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1920 ssize_t
cmd_list_tracepoints(enum lttng_domain_type domain
,
1921 struct lttng_event
**events
)
1924 ssize_t nb_events
= 0;
1927 case LTTNG_DOMAIN_KERNEL
:
1928 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1929 if (nb_events
< 0) {
1930 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1934 case LTTNG_DOMAIN_UST
:
1935 nb_events
= ust_app_list_events(events
);
1936 if (nb_events
< 0) {
1937 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1941 case LTTNG_DOMAIN_LOG4J
:
1942 case LTTNG_DOMAIN_JUL
:
1943 case LTTNG_DOMAIN_PYTHON
:
1944 nb_events
= agent_list_events(events
, domain
);
1945 if (nb_events
< 0) {
1946 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1951 ret
= LTTNG_ERR_UND
;
1958 /* Return negative value to differentiate return code */
1963 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1965 ssize_t
cmd_list_tracepoint_fields(enum lttng_domain_type domain
,
1966 struct lttng_event_field
**fields
)
1969 ssize_t nb_fields
= 0;
1972 case LTTNG_DOMAIN_UST
:
1973 nb_fields
= ust_app_list_event_fields(fields
);
1974 if (nb_fields
< 0) {
1975 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1979 case LTTNG_DOMAIN_KERNEL
:
1980 default: /* fall-through */
1981 ret
= LTTNG_ERR_UND
;
1988 /* Return negative value to differentiate return code */
1992 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1994 return syscall_table_list(events
);
1998 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2000 * Called with session lock held.
2002 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
2003 enum lttng_domain_type domain
, int32_t **pids
)
2006 ssize_t nr_pids
= 0;
2009 case LTTNG_DOMAIN_KERNEL
:
2011 struct ltt_kernel_session
*ksess
;
2013 ksess
= session
->kernel_session
;
2014 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
2016 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2021 case LTTNG_DOMAIN_UST
:
2023 struct ltt_ust_session
*usess
;
2025 usess
= session
->ust_session
;
2026 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2028 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2033 case LTTNG_DOMAIN_LOG4J
:
2034 case LTTNG_DOMAIN_JUL
:
2035 case LTTNG_DOMAIN_PYTHON
:
2037 ret
= LTTNG_ERR_UND
;
2044 /* Return negative value to differentiate return code */
2049 * Command LTTNG_START_TRACE processed by the client thread.
2051 * Called with session mutex held.
2053 int cmd_start_trace(struct ltt_session
*session
)
2056 unsigned long nb_chan
= 0;
2057 struct ltt_kernel_session
*ksession
;
2058 struct ltt_ust_session
*usess
;
2062 /* Ease our life a bit ;) */
2063 ksession
= session
->kernel_session
;
2064 usess
= session
->ust_session
;
2066 /* Is the session already started? */
2067 if (session
->active
) {
2068 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2073 * Starting a session without channel is useless since after that it's not
2074 * possible to enable channel thus inform the client.
2076 if (usess
&& usess
->domain_global
.channels
) {
2077 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2080 nb_chan
+= ksession
->channel_count
;
2083 ret
= LTTNG_ERR_NO_CHANNEL
;
2087 /* Kernel tracing */
2088 if (ksession
!= NULL
) {
2089 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2090 if (ret
!= LTTNG_OK
) {
2095 /* Flag session that trace should start automatically */
2098 * Even though the start trace might fail, flag this session active so
2099 * other application coming in are started by default.
2103 ret
= ust_app_start_trace_all(usess
);
2105 ret
= LTTNG_ERR_UST_START_FAIL
;
2110 /* Flag this after a successful start. */
2111 session
->has_been_started
= 1;
2112 session
->active
= 1;
2121 * Command LTTNG_STOP_TRACE processed by the client thread.
2123 int cmd_stop_trace(struct ltt_session
*session
)
2126 struct ltt_kernel_channel
*kchan
;
2127 struct ltt_kernel_session
*ksession
;
2128 struct ltt_ust_session
*usess
;
2133 ksession
= session
->kernel_session
;
2134 usess
= session
->ust_session
;
2136 /* Session is not active. Skip everythong and inform the client. */
2137 if (!session
->active
) {
2138 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2143 if (ksession
&& ksession
->active
) {
2144 DBG("Stop kernel tracing");
2146 /* Flush metadata if exist */
2147 if (ksession
->metadata_stream_fd
>= 0) {
2148 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2150 ERR("Kernel metadata flush failed");
2154 /* Flush all buffers before stopping */
2155 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2156 ret
= kernel_flush_buffer(kchan
);
2158 ERR("Kernel flush buffer error");
2162 ret
= kernel_stop_session(ksession
);
2164 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2168 kernel_wait_quiescent(kernel_tracer_fd
);
2170 ksession
->active
= 0;
2173 if (usess
&& usess
->active
) {
2175 * Even though the stop trace might fail, flag this session inactive so
2176 * other application coming in are not started by default.
2180 ret
= ust_app_stop_trace_all(usess
);
2182 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2187 /* Flag inactive after a successful stop. */
2188 session
->active
= 0;
2196 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2198 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2199 struct lttng_uri
*uris
)
2202 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2203 struct ltt_ust_session
*usess
= session
->ust_session
;
2209 /* Can't set consumer URI if the session is active. */
2210 if (session
->active
) {
2211 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2215 /* Set the "global" consumer URIs */
2216 for (i
= 0; i
< nb_uri
; i
++) {
2217 ret
= add_uri_to_consumer(session
->consumer
,
2218 &uris
[i
], 0, session
->name
);
2219 if (ret
!= LTTNG_OK
) {
2224 /* Set UST session URIs */
2225 if (session
->ust_session
) {
2226 for (i
= 0; i
< nb_uri
; i
++) {
2227 ret
= add_uri_to_consumer(
2228 session
->ust_session
->consumer
,
2229 &uris
[i
], LTTNG_DOMAIN_UST
,
2231 if (ret
!= LTTNG_OK
) {
2237 /* Set kernel session URIs */
2238 if (session
->kernel_session
) {
2239 for (i
= 0; i
< nb_uri
; i
++) {
2240 ret
= add_uri_to_consumer(
2241 session
->kernel_session
->consumer
,
2242 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2244 if (ret
!= LTTNG_OK
) {
2251 * Make sure to set the session in output mode after we set URI since a
2252 * session can be created without URL (thus flagged in no output mode).
2254 session
->output_traces
= 1;
2256 ksess
->output_traces
= 1;
2260 usess
->output_traces
= 1;
2271 * Command LTTNG_CREATE_SESSION processed by the client thread.
2273 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2274 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2277 struct ltt_session
*session
;
2283 * Verify if the session already exist
2285 * XXX: There is no need for the session lock list here since the caller
2286 * (process_client_msg) is holding it. We might want to change that so a
2287 * single command does not lock the entire session list.
2289 session
= session_find_by_name(name
);
2290 if (session
!= NULL
) {
2291 ret
= LTTNG_ERR_EXIST_SESS
;
2295 /* Create tracing session in the registry */
2296 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2297 LTTNG_SOCK_GET_GID_CRED(creds
));
2298 if (ret
!= LTTNG_OK
) {
2303 * Get the newly created session pointer back
2305 * XXX: There is no need for the session lock list here since the caller
2306 * (process_client_msg) is holding it. We might want to change that so a
2307 * single command does not lock the entire session list.
2309 session
= session_find_by_name(name
);
2312 session
->live_timer
= live_timer
;
2313 /* Create default consumer output for the session not yet created. */
2314 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2315 if (session
->consumer
== NULL
) {
2316 ret
= LTTNG_ERR_FATAL
;
2317 goto consumer_error
;
2321 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2322 if (ret
!= LTTNG_OK
) {
2323 goto consumer_error
;
2325 session
->output_traces
= 1;
2327 session
->output_traces
= 0;
2328 DBG2("Session %s created with no output", session
->name
);
2331 session
->consumer
->enabled
= 1;
2336 session_destroy(session
);
2343 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2345 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2346 size_t nb_uri
, lttng_sock_cred
*creds
)
2349 struct ltt_session
*session
;
2350 struct snapshot_output
*new_output
= NULL
;
2356 * Create session in no output mode with URIs set to NULL. The uris we've
2357 * received are for a default snapshot output if one.
2359 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2360 if (ret
!= LTTNG_OK
) {
2364 /* Get the newly created session pointer back. This should NEVER fail. */
2365 session
= session_find_by_name(name
);
2368 /* Flag session for snapshot mode. */
2369 session
->snapshot_mode
= 1;
2371 /* Skip snapshot output creation if no URI is given. */
2376 new_output
= snapshot_output_alloc();
2378 ret
= LTTNG_ERR_NOMEM
;
2379 goto error_snapshot_alloc
;
2382 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2383 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2385 if (ret
== -ENOMEM
) {
2386 ret
= LTTNG_ERR_NOMEM
;
2388 ret
= LTTNG_ERR_INVALID
;
2390 goto error_snapshot
;
2394 snapshot_add_output(&session
->snapshot
, new_output
);
2401 snapshot_output_destroy(new_output
);
2402 error_snapshot_alloc
:
2403 session_destroy(session
);
2409 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2411 * Called with session lock held.
2413 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2416 struct ltt_ust_session
*usess
;
2417 struct ltt_kernel_session
*ksess
;
2422 usess
= session
->ust_session
;
2423 ksess
= session
->kernel_session
;
2425 /* Clean kernel session teardown */
2426 kernel_destroy_session(ksess
);
2428 /* UST session teardown */
2430 /* Close any relayd session */
2431 consumer_output_send_destroy_relayd(usess
->consumer
);
2433 /* Destroy every UST application related to this session. */
2434 ret
= ust_app_destroy_trace_all(usess
);
2436 ERR("Error in ust_app_destroy_trace_all");
2439 /* Clean up the rest. */
2440 trace_ust_destroy_session(usess
);
2444 * Must notify the kernel thread here to update it's poll set in order to
2445 * remove the channel(s)' fd just destroyed.
2447 ret
= notify_thread_pipe(wpipe
);
2449 PERROR("write kernel poll pipe");
2452 ret
= session_destroy(session
);
2458 * Command LTTNG_CALIBRATE processed by the client thread.
2460 int cmd_calibrate(enum lttng_domain_type domain
,
2461 struct lttng_calibrate
*calibrate
)
2466 case LTTNG_DOMAIN_KERNEL
:
2468 struct lttng_kernel_calibrate kcalibrate
;
2470 switch (calibrate
->type
) {
2471 case LTTNG_CALIBRATE_FUNCTION
:
2473 /* Default and only possible calibrate option. */
2474 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2478 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2480 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2485 case LTTNG_DOMAIN_UST
:
2487 struct lttng_ust_calibrate ucalibrate
;
2489 switch (calibrate
->type
) {
2490 case LTTNG_CALIBRATE_FUNCTION
:
2492 /* Default and only possible calibrate option. */
2493 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2497 ret
= ust_app_calibrate_glb(&ucalibrate
);
2499 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2505 ret
= LTTNG_ERR_UND
;
2516 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2518 int cmd_register_consumer(struct ltt_session
*session
,
2519 enum lttng_domain_type domain
, const char *sock_path
,
2520 struct consumer_data
*cdata
)
2523 struct consumer_socket
*socket
= NULL
;
2530 case LTTNG_DOMAIN_KERNEL
:
2532 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2536 /* Can't register a consumer if there is already one */
2537 if (ksess
->consumer_fds_sent
!= 0) {
2538 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2542 sock
= lttcomm_connect_unix_sock(sock_path
);
2544 ret
= LTTNG_ERR_CONNECT_FAIL
;
2547 cdata
->cmd_sock
= sock
;
2549 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2550 if (socket
== NULL
) {
2553 PERROR("close register consumer");
2555 cdata
->cmd_sock
= -1;
2556 ret
= LTTNG_ERR_FATAL
;
2560 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2561 if (socket
->lock
== NULL
) {
2562 PERROR("zmalloc pthread mutex");
2563 ret
= LTTNG_ERR_FATAL
;
2566 pthread_mutex_init(socket
->lock
, NULL
);
2567 socket
->registered
= 1;
2570 consumer_add_socket(socket
, ksess
->consumer
);
2573 pthread_mutex_lock(&cdata
->pid_mutex
);
2575 pthread_mutex_unlock(&cdata
->pid_mutex
);
2580 /* TODO: Userspace tracing */
2581 ret
= LTTNG_ERR_UND
;
2589 consumer_destroy_socket(socket
);
2595 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2597 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2598 struct lttng_domain
**domains
)
2603 struct lttng_ht_iter iter
;
2605 if (session
->kernel_session
!= NULL
) {
2606 DBG3("Listing domains found kernel domain");
2610 if (session
->ust_session
!= NULL
) {
2611 DBG3("Listing domains found UST global domain");
2615 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2617 if (agt
->being_used
) {
2628 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2629 if (*domains
== NULL
) {
2630 ret
= LTTNG_ERR_FATAL
;
2634 if (session
->kernel_session
!= NULL
) {
2635 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2637 /* Kernel session buffer type is always GLOBAL */
2638 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2643 if (session
->ust_session
!= NULL
) {
2644 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2645 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2649 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2651 if (agt
->being_used
) {
2652 (*domains
)[index
].type
= agt
->domain
;
2653 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2663 /* Return negative value to differentiate return code */
2669 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2671 ssize_t
cmd_list_channels(enum lttng_domain_type domain
,
2672 struct ltt_session
*session
, struct lttng_channel
**channels
)
2675 ssize_t nb_chan
= 0;
2678 case LTTNG_DOMAIN_KERNEL
:
2679 if (session
->kernel_session
!= NULL
) {
2680 nb_chan
= session
->kernel_session
->channel_count
;
2682 DBG3("Number of kernel channels %zd", nb_chan
);
2684 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2687 case LTTNG_DOMAIN_UST
:
2688 if (session
->ust_session
!= NULL
) {
2690 nb_chan
= lttng_ht_get_count(
2691 session
->ust_session
->domain_global
.channels
);
2694 DBG3("Number of UST global channels %zd", nb_chan
);
2696 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2701 ret
= LTTNG_ERR_UND
;
2706 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2707 if (*channels
== NULL
) {
2708 ret
= LTTNG_ERR_FATAL
;
2712 list_lttng_channels(domain
, session
, *channels
);
2718 /* Return negative value to differentiate return code */
2723 * Command LTTNG_LIST_EVENTS processed by the client thread.
2725 ssize_t
cmd_list_events(enum lttng_domain_type domain
,
2726 struct ltt_session
*session
, char *channel_name
,
2727 struct lttng_event
**events
)
2730 ssize_t nb_event
= 0;
2733 case LTTNG_DOMAIN_KERNEL
:
2734 if (session
->kernel_session
!= NULL
) {
2735 nb_event
= list_lttng_kernel_events(channel_name
,
2736 session
->kernel_session
, events
);
2739 case LTTNG_DOMAIN_UST
:
2741 if (session
->ust_session
!= NULL
) {
2742 nb_event
= list_lttng_ust_global_events(channel_name
,
2743 &session
->ust_session
->domain_global
, events
);
2747 case LTTNG_DOMAIN_LOG4J
:
2748 case LTTNG_DOMAIN_JUL
:
2749 case LTTNG_DOMAIN_PYTHON
:
2750 if (session
->ust_session
) {
2751 struct lttng_ht_iter iter
;
2755 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2756 &iter
.iter
, agt
, node
.node
) {
2757 if (agt
->domain
== domain
) {
2758 nb_event
= list_lttng_agent_events(
2767 ret
= LTTNG_ERR_UND
;
2774 /* Return negative value to differentiate return code */
2779 * Using the session list, filled a lttng_session array to send back to the
2780 * client for session listing.
2782 * The session list lock MUST be acquired before calling this function. Use
2783 * session_lock_list() and session_unlock_list().
2785 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2790 struct ltt_session
*session
;
2791 struct ltt_session_list
*list
= session_get_list();
2793 DBG("Getting all available session for UID %d GID %d",
2796 * Iterate over session list and append data after the control struct in
2799 cds_list_for_each_entry(session
, &list
->head
, list
) {
2801 * Only list the sessions the user can control.
2803 if (!session_access_ok(session
, uid
, gid
)) {
2807 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2808 struct ltt_ust_session
*usess
= session
->ust_session
;
2810 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2811 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2812 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2813 ret
= build_network_session_path(sessions
[i
].path
,
2814 sizeof(sessions
[i
].path
), session
);
2816 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2817 session
->consumer
->dst
.trace_path
);
2820 PERROR("snprintf session path");
2824 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2825 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2826 sessions
[i
].enabled
= session
->active
;
2827 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2828 sessions
[i
].live_timer_interval
= session
->live_timer
;
2834 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2835 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2837 int cmd_data_pending(struct ltt_session
*session
)
2840 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2841 struct ltt_ust_session
*usess
= session
->ust_session
;
2845 /* Session MUST be stopped to ask for data availability. */
2846 if (session
->active
) {
2847 ret
= LTTNG_ERR_SESSION_STARTED
;
2851 * If stopped, just make sure we've started before else the above call
2852 * will always send that there is data pending.
2854 * The consumer assumes that when the data pending command is received,
2855 * the trace has been started before or else no output data is written
2856 * by the streams which is a condition for data pending. So, this is
2857 * *VERY* important that we don't ask the consumer before a start
2860 if (!session
->has_been_started
) {
2866 if (ksess
&& ksess
->consumer
) {
2867 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2869 /* Data is still being extracted for the kernel. */
2874 if (usess
&& usess
->consumer
) {
2875 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2877 /* Data is still being extracted for the kernel. */
2882 /* Data is ready to be read by a viewer */
2890 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2892 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2894 int cmd_snapshot_add_output(struct ltt_session
*session
,
2895 struct lttng_snapshot_output
*output
, uint32_t *id
)
2898 struct snapshot_output
*new_output
;
2903 DBG("Cmd snapshot add output for session %s", session
->name
);
2906 * Permission denied to create an output if the session is not
2907 * set in no output mode.
2909 if (session
->output_traces
) {
2910 ret
= LTTNG_ERR_EPERM
;
2914 /* Only one output is allowed until we have the "tee" feature. */
2915 if (session
->snapshot
.nb_output
== 1) {
2916 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2920 new_output
= snapshot_output_alloc();
2922 ret
= LTTNG_ERR_NOMEM
;
2926 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2927 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2928 &session
->snapshot
);
2930 if (ret
== -ENOMEM
) {
2931 ret
= LTTNG_ERR_NOMEM
;
2933 ret
= LTTNG_ERR_INVALID
;
2939 snapshot_add_output(&session
->snapshot
, new_output
);
2941 *id
= new_output
->id
;
2948 snapshot_output_destroy(new_output
);
2954 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2956 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2958 int cmd_snapshot_del_output(struct ltt_session
*session
,
2959 struct lttng_snapshot_output
*output
)
2962 struct snapshot_output
*sout
= NULL
;
2970 * Permission denied to create an output if the session is not
2971 * set in no output mode.
2973 if (session
->output_traces
) {
2974 ret
= LTTNG_ERR_EPERM
;
2979 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2981 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2982 } else if (*output
->name
!= '\0') {
2983 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2985 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2988 ret
= LTTNG_ERR_INVALID
;
2992 snapshot_delete_output(&session
->snapshot
, sout
);
2993 snapshot_output_destroy(sout
);
3002 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3004 * If no output is available, outputs is untouched and 0 is returned.
3006 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3008 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
3009 struct lttng_snapshot_output
**outputs
)
3012 struct lttng_snapshot_output
*list
= NULL
;
3013 struct lttng_ht_iter iter
;
3014 struct snapshot_output
*output
;
3019 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3022 * Permission denied to create an output if the session is not
3023 * set in no output mode.
3025 if (session
->output_traces
) {
3026 ret
= -LTTNG_ERR_EPERM
;
3030 if (session
->snapshot
.nb_output
== 0) {
3035 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3037 ret
= -LTTNG_ERR_NOMEM
;
3041 /* Copy list from session to the new list object. */
3043 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3044 output
, node
.node
) {
3045 assert(output
->consumer
);
3046 list
[idx
].id
= output
->id
;
3047 list
[idx
].max_size
= output
->max_size
;
3048 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3049 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3050 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3051 sizeof(list
[idx
].ctrl_url
));
3054 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3055 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3057 ret
= -LTTNG_ERR_NOMEM
;
3062 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3063 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3065 ret
= -LTTNG_ERR_NOMEM
;
3074 ret
= session
->snapshot
.nb_output
;
3082 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3083 * snapshot output is *not* set with a remote destination.
3085 * Return 0 on success or a LTTNG_ERR code.
3087 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3088 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3091 struct lttng_ht_iter iter
;
3092 struct consumer_socket
*socket
;
3095 assert(snap_output
);
3098 DBG2("Set relayd object from snapshot output");
3100 /* Ignore if snapshot consumer output is not network. */
3101 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3106 * For each consumer socket, create and send the relayd object of the
3110 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3111 socket
, node
.node
) {
3112 ret
= send_consumer_relayd_sockets(0, session
->id
,
3113 snap_output
->consumer
, socket
,
3114 session
->name
, session
->hostname
,
3115 session
->live_timer
);
3116 if (ret
!= LTTNG_OK
) {
3128 * Record a kernel snapshot.
3130 * Return LTTNG_OK on success or a LTTNG_ERR code.
3132 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3133 struct snapshot_output
*output
, struct ltt_session
*session
,
3134 int wait
, uint64_t nb_packets_per_stream
)
3142 /* Get the datetime for the snapshot output directory. */
3143 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3144 sizeof(output
->datetime
));
3146 ret
= LTTNG_ERR_INVALID
;
3151 * Copy kernel session sockets so we can communicate with the right
3152 * consumer for the snapshot record command.
3154 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3156 ret
= LTTNG_ERR_NOMEM
;
3160 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3161 if (ret
!= LTTNG_OK
) {
3162 goto error_snapshot
;
3165 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3166 if (ret
!= LTTNG_OK
) {
3167 goto error_snapshot
;
3174 /* Clean up copied sockets so this output can use some other later on. */
3175 consumer_destroy_output_sockets(output
->consumer
);
3182 * Record a UST snapshot.
3184 * Return 0 on success or a LTTNG_ERR error code.
3186 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3187 struct snapshot_output
*output
, struct ltt_session
*session
,
3188 int wait
, uint64_t nb_packets_per_stream
)
3196 /* Get the datetime for the snapshot output directory. */
3197 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3198 sizeof(output
->datetime
));
3200 ret
= LTTNG_ERR_INVALID
;
3205 * Copy UST session sockets so we can communicate with the right
3206 * consumer for the snapshot record command.
3208 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3210 ret
= LTTNG_ERR_NOMEM
;
3214 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3215 if (ret
!= LTTNG_OK
) {
3216 goto error_snapshot
;
3219 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3223 ret
= LTTNG_ERR_INVALID
;
3226 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3229 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3232 goto error_snapshot
;
3238 /* Clean up copied sockets so this output can use some other later on. */
3239 consumer_destroy_output_sockets(output
->consumer
);
3245 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3246 uint64_t cur_nr_packets
)
3248 uint64_t tot_size
= 0;
3250 if (session
->kernel_session
) {
3251 struct ltt_kernel_channel
*chan
;
3252 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3254 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3255 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3257 * Don't take channel into account if we
3258 * already grab all its packets.
3262 tot_size
+= chan
->channel
->attr
.subbuf_size
3263 * chan
->stream_count
;
3267 if (session
->ust_session
) {
3268 struct ltt_ust_session
*usess
= session
->ust_session
;
3270 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3278 * Calculate the number of packets we can grab from each stream that
3279 * fits within the overall snapshot max size.
3281 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3282 * the number of packets per stream.
3284 * TODO: this approach is not perfect: we consider the worse case
3285 * (packet filling the sub-buffers) as an upper bound, but we could do
3286 * better if we do this calculation while we actually grab the packet
3287 * content: we would know how much padding we don't actually store into
3290 * This algorithm is currently bounded by the number of packets per
3293 * Since we call this algorithm before actually grabbing the data, it's
3294 * an approximation: for instance, applications could appear/disappear
3295 * in between this call and actually grabbing data.
3298 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3301 uint64_t cur_nb_packets
= 0;
3304 return 0; /* Infinite */
3307 size_left
= max_size
;
3309 uint64_t one_more_packet_tot_size
;
3311 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3313 if (!one_more_packet_tot_size
) {
3314 /* We are already grabbing all packets. */
3317 size_left
-= one_more_packet_tot_size
;
3318 if (size_left
< 0) {
3323 if (!cur_nb_packets
) {
3324 /* Not enough room to grab one packet of each stream, error. */
3327 return cur_nb_packets
;
3331 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3333 * The wait parameter is ignored so this call always wait for the snapshot to
3334 * complete before returning.
3336 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3338 int cmd_snapshot_record(struct ltt_session
*session
,
3339 struct lttng_snapshot_output
*output
, int wait
)
3342 unsigned int use_tmp_output
= 0;
3343 struct snapshot_output tmp_output
;
3344 unsigned int snapshot_success
= 0;
3349 DBG("Cmd snapshot record for session %s", session
->name
);
3352 * Permission denied to create an output if the session is not
3353 * set in no output mode.
3355 if (session
->output_traces
) {
3356 ret
= LTTNG_ERR_EPERM
;
3360 /* The session needs to be started at least once. */
3361 if (!session
->has_been_started
) {
3362 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3366 /* Use temporary output for the session. */
3367 if (*output
->ctrl_url
!= '\0') {
3368 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3369 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3372 if (ret
== -ENOMEM
) {
3373 ret
= LTTNG_ERR_NOMEM
;
3375 ret
= LTTNG_ERR_INVALID
;
3379 /* Use the global session count for the temporary snapshot. */
3380 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3384 if (session
->kernel_session
) {
3385 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3387 if (use_tmp_output
) {
3388 int64_t nb_packets_per_stream
;
3390 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3391 tmp_output
.max_size
);
3392 if (nb_packets_per_stream
< 0) {
3393 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3396 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3397 wait
, nb_packets_per_stream
);
3398 if (ret
!= LTTNG_OK
) {
3401 snapshot_success
= 1;
3403 struct snapshot_output
*sout
;
3404 struct lttng_ht_iter iter
;
3407 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3408 &iter
.iter
, sout
, node
.node
) {
3409 int64_t nb_packets_per_stream
;
3412 * Make a local copy of the output and assign the possible
3413 * temporary value given by the caller.
3415 memset(&tmp_output
, 0, sizeof(tmp_output
));
3416 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3418 if (output
->max_size
!= (uint64_t) -1ULL) {
3419 tmp_output
.max_size
= output
->max_size
;
3422 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3423 tmp_output
.max_size
);
3424 if (nb_packets_per_stream
< 0) {
3425 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3429 /* Use temporary name. */
3430 if (*output
->name
!= '\0') {
3431 strncpy(tmp_output
.name
, output
->name
,
3432 sizeof(tmp_output
.name
));
3435 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3437 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3438 session
, wait
, nb_packets_per_stream
);
3439 if (ret
!= LTTNG_OK
) {
3443 snapshot_success
= 1;
3449 if (session
->ust_session
) {
3450 struct ltt_ust_session
*usess
= session
->ust_session
;
3452 if (use_tmp_output
) {
3453 int64_t nb_packets_per_stream
;
3455 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3456 tmp_output
.max_size
);
3457 if (nb_packets_per_stream
< 0) {
3458 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3461 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3462 wait
, nb_packets_per_stream
);
3463 if (ret
!= LTTNG_OK
) {
3466 snapshot_success
= 1;
3468 struct snapshot_output
*sout
;
3469 struct lttng_ht_iter iter
;
3472 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3473 &iter
.iter
, sout
, node
.node
) {
3474 int64_t nb_packets_per_stream
;
3477 * Make a local copy of the output and assign the possible
3478 * temporary value given by the caller.
3480 memset(&tmp_output
, 0, sizeof(tmp_output
));
3481 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3483 if (output
->max_size
!= (uint64_t) -1ULL) {
3484 tmp_output
.max_size
= output
->max_size
;
3487 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3488 tmp_output
.max_size
);
3489 if (nb_packets_per_stream
< 0) {
3490 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3495 /* Use temporary name. */
3496 if (*output
->name
!= '\0') {
3497 strncpy(tmp_output
.name
, output
->name
,
3498 sizeof(tmp_output
.name
));
3501 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3503 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3504 wait
, nb_packets_per_stream
);
3505 if (ret
!= LTTNG_OK
) {
3509 snapshot_success
= 1;
3515 if (snapshot_success
) {
3516 session
->snapshot
.nb_snapshot
++;
3518 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3526 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3528 int cmd_set_session_shm_path(struct ltt_session
*session
,
3529 const char *shm_path
)
3535 * Can only set shm path before session is started.
3537 if (session
->has_been_started
) {
3538 return LTTNG_ERR_SESSION_STARTED
;
3541 strncpy(session
->shm_path
, shm_path
,
3542 sizeof(session
->shm_path
));
3543 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3549 * Init command subsystem.
3554 * Set network sequence index to 1 for streams to match a relayd
3555 * socket on the consumer side.
3557 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3558 relayd_net_seq_idx
= 1;
3559 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3561 DBG("Command subsystem initialized");