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"
45 * Used to keep a unique index for each relayd socket created where this value
46 * is associated with streams on the consumer so it can match the right relayd
47 * to send to. It must be accessed with the relayd_net_seq_idx_lock
50 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 static uint64_t relayd_net_seq_idx
;
54 * Both functions below are special case for the Kernel domain when
55 * enabling/disabling all events.
58 int enable_kevent_all(struct ltt_session
*session
,
59 struct lttng_domain
*domain
, char *channel_name
,
60 struct lttng_event
*event
,
61 char *filter_expression
,
62 struct lttng_filter_bytecode
*filter
, int wpipe
);
64 int disable_kevent_all(struct ltt_session
*session
, int domain
,
66 struct lttng_event
*event
);
69 * Create a session path used by list_lttng_sessions for the case that the
70 * session consumer is on the network.
72 static int build_network_session_path(char *dst
, size_t size
,
73 struct ltt_session
*session
)
75 int ret
, kdata_port
, udata_port
;
76 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
77 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
82 memset(tmp_urls
, 0, sizeof(tmp_urls
));
83 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
85 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
87 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
88 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
89 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
92 if (session
->ust_session
&& session
->ust_session
->consumer
) {
93 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
94 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
97 if (uuri
== NULL
&& kuri
== NULL
) {
98 uri
= &session
->consumer
->dst
.net
.control
;
99 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
100 } else if (kuri
&& uuri
) {
101 ret
= uri_compare(kuri
, uuri
);
105 /* Build uuri URL string */
106 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
113 } else if (kuri
&& uuri
== NULL
) {
115 } else if (uuri
&& kuri
== NULL
) {
119 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
125 * Do we have a UST url set. If yes, this means we have both kernel and UST
128 if (*tmp_uurl
!= '\0') {
129 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
130 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
133 if (kuri
|| (!kuri
&& !uuri
)) {
136 /* No kernel URI, use the UST port. */
139 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
147 * Fill lttng_channel array of all channels.
149 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
150 struct lttng_channel
*channels
)
153 struct ltt_kernel_channel
*kchan
;
155 DBG("Listing channels for session %s", session
->name
);
158 case LTTNG_DOMAIN_KERNEL
:
159 /* Kernel channels */
160 if (session
->kernel_session
!= NULL
) {
161 cds_list_for_each_entry(kchan
,
162 &session
->kernel_session
->channel_list
.head
, list
) {
163 /* Copy lttng_channel struct to array */
164 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
165 channels
[i
].enabled
= kchan
->enabled
;
170 case LTTNG_DOMAIN_UST
:
172 struct lttng_ht_iter iter
;
173 struct ltt_ust_channel
*uchan
;
176 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
177 &iter
.iter
, uchan
, node
.node
) {
178 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
179 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
180 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
181 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
182 channels
[i
].attr
.switch_timer_interval
=
183 uchan
->attr
.switch_timer_interval
;
184 channels
[i
].attr
.read_timer_interval
=
185 uchan
->attr
.read_timer_interval
;
186 channels
[i
].enabled
= uchan
->enabled
;
187 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
188 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
189 switch (uchan
->attr
.output
) {
192 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
206 * Create a list of agent domain events.
208 * Return number of events in list on success or else a negative value.
210 static int list_lttng_agent_events(struct agent
*agt
,
211 struct lttng_event
**events
)
214 unsigned int nb_event
= 0;
215 struct agent_event
*event
;
216 struct lttng_event
*tmp_events
;
217 struct lttng_ht_iter iter
;
222 DBG3("Listing agent events");
225 nb_event
= lttng_ht_get_count(agt
->events
);
232 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
234 PERROR("zmalloc agent events session");
235 ret
= -LTTNG_ERR_FATAL
;
240 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
241 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
242 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
243 tmp_events
[i
].enabled
= event
->enabled
;
244 tmp_events
[i
].loglevel
= event
->loglevel
;
245 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
250 *events
= tmp_events
;
254 assert(nb_event
== i
);
259 * Create a list of ust global domain events.
261 static int list_lttng_ust_global_events(char *channel_name
,
262 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
265 unsigned int nb_event
= 0;
266 struct lttng_ht_iter iter
;
267 struct lttng_ht_node_str
*node
;
268 struct ltt_ust_channel
*uchan
;
269 struct ltt_ust_event
*uevent
;
270 struct lttng_event
*tmp
;
272 DBG("Listing UST global events for channel %s", channel_name
);
276 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
277 node
= lttng_ht_iter_get_node_str(&iter
);
279 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
283 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
285 nb_event
+= lttng_ht_get_count(uchan
->events
);
292 DBG3("Listing UST global %d events", nb_event
);
294 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
296 ret
= LTTNG_ERR_FATAL
;
300 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
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
;
384 switch (event
->event
->instrumentation
) {
385 case LTTNG_KERNEL_TRACEPOINT
:
386 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
388 case LTTNG_KERNEL_KRETPROBE
:
389 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
390 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
391 sizeof(struct lttng_kernel_kprobe
));
393 case LTTNG_KERNEL_KPROBE
:
394 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
395 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
396 sizeof(struct lttng_kernel_kprobe
));
398 case LTTNG_KERNEL_FUNCTION
:
399 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
400 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
401 sizeof(struct lttng_kernel_function
));
403 case LTTNG_KERNEL_NOOP
:
404 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
406 case LTTNG_KERNEL_SYSCALL
:
407 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
409 case LTTNG_KERNEL_ALL
:
420 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
432 /* Negate the error code to differentiate the size from an error */
437 * Add URI so the consumer output object. Set the correct path depending on the
438 * domain adding the default trace directory.
440 static int add_uri_to_consumer(struct consumer_output
*consumer
,
441 struct lttng_uri
*uri
, int domain
, const char *session_name
)
444 const char *default_trace_dir
;
448 if (consumer
== NULL
) {
449 DBG("No consumer detected. Don't add URI. Stopping.");
450 ret
= LTTNG_ERR_NO_CONSUMER
;
455 case LTTNG_DOMAIN_KERNEL
:
456 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
458 case LTTNG_DOMAIN_UST
:
459 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
463 * This case is possible is we try to add the URI to the global tracing
464 * session consumer object which in this case there is no subdir.
466 default_trace_dir
= "";
469 switch (uri
->dtype
) {
472 DBG2("Setting network URI to consumer");
474 if (consumer
->type
== CONSUMER_DST_NET
) {
475 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
476 consumer
->dst
.net
.control_isset
) ||
477 (uri
->stype
== LTTNG_STREAM_DATA
&&
478 consumer
->dst
.net
.data_isset
)) {
479 ret
= LTTNG_ERR_URL_EXIST
;
483 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
486 consumer
->type
= CONSUMER_DST_NET
;
488 /* Set URI into consumer output object */
489 ret
= consumer_set_network_uri(consumer
, uri
);
493 } else if (ret
== 1) {
495 * URI was the same in the consumer so we do not append the subdir
496 * again so to not duplicate output dir.
502 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
503 ret
= consumer_set_subdir(consumer
, session_name
);
505 ret
= LTTNG_ERR_FATAL
;
510 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
511 /* On a new subdir, reappend the default trace dir. */
512 strncat(consumer
->subdir
, default_trace_dir
,
513 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
514 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
519 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
520 memset(consumer
->dst
.trace_path
, 0,
521 sizeof(consumer
->dst
.trace_path
));
522 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
523 sizeof(consumer
->dst
.trace_path
));
524 /* Append default trace dir */
525 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
526 sizeof(consumer
->dst
.trace_path
) -
527 strlen(consumer
->dst
.trace_path
) - 1);
528 /* Flag consumer as local. */
529 consumer
->type
= CONSUMER_DST_LOCAL
;
540 * Init tracing by creating trace directory and sending fds kernel consumer.
542 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
545 struct lttng_ht_iter iter
;
546 struct consumer_socket
*socket
;
552 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
553 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
555 pthread_mutex_lock(socket
->lock
);
556 ret
= kernel_consumer_send_session(socket
, session
);
557 pthread_mutex_unlock(socket
->lock
);
559 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
571 * Create a socket to the relayd using the URI.
573 * On success, the relayd_sock pointer is set to the created socket.
574 * Else, it's stays untouched and a lttcomm error code is returned.
576 static int create_connect_relayd(struct lttng_uri
*uri
,
577 struct lttcomm_relayd_sock
**relayd_sock
)
580 struct lttcomm_relayd_sock
*rsock
;
582 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
583 RELAYD_VERSION_COMM_MINOR
);
585 ret
= LTTNG_ERR_FATAL
;
590 * Connect to relayd so we can proceed with a session creation. This call
591 * can possibly block for an arbitrary amount of time to set the health
592 * state to be in poll execution.
595 ret
= relayd_connect(rsock
);
598 ERR("Unable to reach lttng-relayd");
599 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
603 /* Create socket for control stream. */
604 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
605 DBG3("Creating relayd stream socket from URI");
607 /* Check relayd version */
608 ret
= relayd_version_check(rsock
);
610 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
613 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
614 DBG3("Creating relayd data socket from URI");
616 /* Command is not valid */
617 ERR("Relayd invalid stream type: %d", uri
->stype
);
618 ret
= LTTNG_ERR_INVALID
;
622 *relayd_sock
= rsock
;
627 /* The returned value is not useful since we are on an error path. */
628 (void) relayd_close(rsock
);
636 * Connect to the relayd using URI and send the socket to the right consumer.
638 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
639 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
640 struct consumer_socket
*consumer_sock
,
641 char *session_name
, char *hostname
, int session_live_timer
)
644 struct lttcomm_relayd_sock
*rsock
= NULL
;
646 /* Connect to relayd and make version check if uri is the control. */
647 ret
= create_connect_relayd(relayd_uri
, &rsock
);
648 if (ret
!= LTTNG_OK
) {
653 /* Set the network sequence index if not set. */
654 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
655 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
657 * Increment net_seq_idx because we are about to transfer the
658 * new relayd socket to the consumer.
659 * Assign unique key so the consumer can match streams.
661 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
662 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
665 /* Send relayd socket to consumer. */
666 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
667 relayd_uri
->stype
, session_id
,
668 session_name
, hostname
, session_live_timer
);
670 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
674 /* Flag that the corresponding socket was sent. */
675 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
676 consumer_sock
->control_sock_sent
= 1;
677 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
678 consumer_sock
->data_sock_sent
= 1;
684 * Close socket which was dup on the consumer side. The session daemon does
685 * NOT keep track of the relayd socket(s) once transfer to the consumer.
689 (void) relayd_close(rsock
);
693 if (ret
!= LTTNG_OK
) {
695 * The consumer output for this session should not be used anymore
696 * since the relayd connection failed thus making any tracing or/and
697 * streaming not usable.
699 consumer
->enabled
= 0;
705 * Send both relayd sockets to a specific consumer and domain. This is a
706 * helper function to facilitate sending the information to the consumer for a
709 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
710 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
711 char *session_name
, char *hostname
, int session_live_timer
)
718 /* Sending control relayd socket. */
719 if (!sock
->control_sock_sent
) {
720 ret
= send_consumer_relayd_socket(domain
, session_id
,
721 &consumer
->dst
.net
.control
, consumer
, sock
,
722 session_name
, hostname
, session_live_timer
);
723 if (ret
!= LTTNG_OK
) {
728 /* Sending data relayd socket. */
729 if (!sock
->data_sock_sent
) {
730 ret
= send_consumer_relayd_socket(domain
, session_id
,
731 &consumer
->dst
.net
.data
, consumer
, sock
,
732 session_name
, hostname
, session_live_timer
);
733 if (ret
!= LTTNG_OK
) {
743 * Setup relayd connections for a tracing session. First creates the socket to
744 * the relayd and send them to the right domain consumer. Consumer type MUST be
747 int cmd_setup_relayd(struct ltt_session
*session
)
750 struct ltt_ust_session
*usess
;
751 struct ltt_kernel_session
*ksess
;
752 struct consumer_socket
*socket
;
753 struct lttng_ht_iter iter
;
757 usess
= session
->ust_session
;
758 ksess
= session
->kernel_session
;
760 DBG("Setting relayd for session %s", session
->name
);
764 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
765 && usess
->consumer
->enabled
) {
766 /* For each consumer socket, send relayd sockets */
767 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
769 pthread_mutex_lock(socket
->lock
);
770 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
771 usess
->consumer
, socket
,
772 session
->name
, session
->hostname
,
773 session
->live_timer
);
774 pthread_mutex_unlock(socket
->lock
);
775 if (ret
!= LTTNG_OK
) {
778 /* Session is now ready for network streaming. */
779 session
->net_handle
= 1;
783 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
784 && ksess
->consumer
->enabled
) {
785 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
787 pthread_mutex_lock(socket
->lock
);
788 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
789 ksess
->consumer
, socket
,
790 session
->name
, session
->hostname
,
791 session
->live_timer
);
792 pthread_mutex_unlock(socket
->lock
);
793 if (ret
!= LTTNG_OK
) {
796 /* Session is now ready for network streaming. */
797 session
->net_handle
= 1;
807 * Start a kernel session by opening all necessary streams.
809 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
812 struct ltt_kernel_channel
*kchan
;
814 /* Open kernel metadata */
815 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
816 ret
= kernel_open_metadata(ksess
);
818 ret
= LTTNG_ERR_KERN_META_FAIL
;
823 /* Open kernel metadata stream */
824 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
825 ret
= kernel_open_metadata_stream(ksess
);
827 ERR("Kernel create metadata stream failed");
828 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
833 /* For each channel */
834 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
835 if (kchan
->stream_count
== 0) {
836 ret
= kernel_open_channel_stream(kchan
);
838 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
841 /* Update the stream global counter */
842 ksess
->stream_count_global
+= ret
;
846 /* Setup kernel consumer socket and send fds to it */
847 ret
= init_kernel_tracing(ksess
);
849 ret
= LTTNG_ERR_KERN_START_FAIL
;
853 /* This start the kernel tracing */
854 ret
= kernel_start_session(ksess
);
856 ret
= LTTNG_ERR_KERN_START_FAIL
;
860 /* Quiescent wait after starting trace */
861 kernel_wait_quiescent(kernel_tracer_fd
);
872 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
874 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
878 struct ltt_ust_session
*usess
;
880 usess
= session
->ust_session
;
885 case LTTNG_DOMAIN_KERNEL
:
887 ret
= channel_kernel_disable(session
->kernel_session
,
889 if (ret
!= LTTNG_OK
) {
893 kernel_wait_quiescent(kernel_tracer_fd
);
896 case LTTNG_DOMAIN_UST
:
898 struct ltt_ust_channel
*uchan
;
899 struct lttng_ht
*chan_ht
;
901 chan_ht
= usess
->domain_global
.channels
;
903 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
905 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
909 ret
= channel_ust_disable(usess
, uchan
);
910 if (ret
!= LTTNG_OK
) {
916 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
928 * Command LTTNG_TRACK_PID processed by the client thread.
930 * Called with session lock held.
932 int cmd_track_pid(struct ltt_session
*session
, int domain
, int pid
)
939 case LTTNG_DOMAIN_KERNEL
:
941 struct ltt_kernel_session
*ksess
;
943 ksess
= session
->kernel_session
;
945 ret
= kernel_track_pid(ksess
, pid
);
946 if (ret
!= LTTNG_OK
) {
950 kernel_wait_quiescent(kernel_tracer_fd
);
953 case LTTNG_DOMAIN_UST
:
955 struct ltt_ust_session
*usess
;
957 usess
= session
->ust_session
;
959 ret
= trace_ust_track_pid(usess
, pid
);
960 if (ret
!= LTTNG_OK
) {
966 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
978 * Command LTTNG_UNTRACK_PID processed by the client thread.
980 * Called with session lock held.
982 int cmd_untrack_pid(struct ltt_session
*session
, int domain
, int pid
)
989 case LTTNG_DOMAIN_KERNEL
:
991 struct ltt_kernel_session
*ksess
;
993 ksess
= session
->kernel_session
;
995 ret
= kernel_untrack_pid(ksess
, pid
);
996 if (ret
!= LTTNG_OK
) {
1000 kernel_wait_quiescent(kernel_tracer_fd
);
1003 case LTTNG_DOMAIN_UST
:
1005 struct ltt_ust_session
*usess
;
1007 usess
= session
->ust_session
;
1009 ret
= trace_ust_untrack_pid(usess
, pid
);
1010 if (ret
!= LTTNG_OK
) {
1016 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1028 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1030 * The wpipe arguments is used as a notifier for the kernel thread.
1032 int cmd_enable_channel(struct ltt_session
*session
,
1033 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1036 struct ltt_ust_session
*usess
= session
->ust_session
;
1037 struct lttng_ht
*chan_ht
;
1044 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1046 /* Validate channel name */
1047 if (attr
->name
[0] == '.' ||
1048 memchr(attr
->name
, '/', len
) != NULL
) {
1049 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1053 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1058 * Don't try to enable a channel if the session has been started at
1059 * some point in time before. The tracer does not allow it.
1061 if (session
->has_been_started
) {
1062 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1067 * If the session is a live session, remove the switch timer, the
1068 * live timer does the same thing but sends also synchronisation
1069 * beacons for inactive streams.
1071 if (session
->live_timer
> 0) {
1072 attr
->attr
.live_timer_interval
= session
->live_timer
;
1073 attr
->attr
.switch_timer_interval
= 0;
1077 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1078 * mode and with less than 2 subbuf so block it right away and send back an
1079 * invalid attribute error.
1081 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1082 ret
= LTTNG_ERR_INVALID
;
1086 switch (domain
->type
) {
1087 case LTTNG_DOMAIN_KERNEL
:
1089 struct ltt_kernel_channel
*kchan
;
1091 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1092 session
->kernel_session
);
1093 if (kchan
== NULL
) {
1094 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1095 if (attr
->name
[0] != '\0') {
1096 session
->kernel_session
->has_non_default_channel
= 1;
1099 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1102 if (ret
!= LTTNG_OK
) {
1106 kernel_wait_quiescent(kernel_tracer_fd
);
1109 case LTTNG_DOMAIN_UST
:
1111 struct ltt_ust_channel
*uchan
;
1113 chan_ht
= usess
->domain_global
.channels
;
1115 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1116 if (uchan
== NULL
) {
1117 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1118 if (attr
->name
[0] != '\0') {
1119 usess
->has_non_default_channel
= 1;
1122 ret
= channel_ust_enable(usess
, uchan
);
1127 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1139 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1141 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1143 struct lttng_event
*event
)
1148 DBG("Disable event command for event \'%s\'", event
->name
);
1150 event_name
= event
->name
;
1152 /* Error out on unhandled search criteria */
1153 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1154 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1155 return LTTNG_ERR_UNK
;
1157 /* Special handling for kernel domain all events. */
1158 if (domain
== LTTNG_DOMAIN_KERNEL
&& !strcmp(event_name
, "*")) {
1159 return disable_kevent_all(session
, domain
, channel_name
, event
);
1165 case LTTNG_DOMAIN_KERNEL
:
1167 struct ltt_kernel_channel
*kchan
;
1168 struct ltt_kernel_session
*ksess
;
1170 ksess
= session
->kernel_session
;
1173 * If a non-default channel has been created in the
1174 * session, explicitely require that -c chan_name needs
1177 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1178 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1182 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1183 if (kchan
== NULL
) {
1184 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1188 switch (event
->type
) {
1189 case LTTNG_EVENT_ALL
:
1190 case LTTNG_EVENT_TRACEPOINT
:
1191 ret
= event_kernel_disable_tracepoint(kchan
, event_name
);
1192 if (ret
!= LTTNG_OK
) {
1196 case LTTNG_EVENT_SYSCALL
:
1197 ret
= event_kernel_disable_syscall(kchan
, event_name
);
1198 if (ret
!= LTTNG_OK
) {
1203 ret
= LTTNG_ERR_UNK
;
1207 kernel_wait_quiescent(kernel_tracer_fd
);
1210 case LTTNG_DOMAIN_UST
:
1212 struct ltt_ust_channel
*uchan
;
1213 struct ltt_ust_session
*usess
;
1215 usess
= session
->ust_session
;
1218 * If a non-default channel has been created in the
1219 * session, explicitely require that -c chan_name needs
1222 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1223 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1227 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1229 if (uchan
== NULL
) {
1230 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1234 switch (event
->type
) {
1235 case LTTNG_EVENT_ALL
:
1236 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1237 if (ret
!= LTTNG_OK
) {
1242 ret
= LTTNG_ERR_UNK
;
1246 DBG3("Disable UST event %s in channel %s completed", event_name
,
1250 case LTTNG_DOMAIN_LOG4J
:
1251 case LTTNG_DOMAIN_JUL
:
1252 case LTTNG_DOMAIN_PYTHON
:
1255 struct ltt_ust_session
*usess
= session
->ust_session
;
1259 switch (event
->type
) {
1260 case LTTNG_EVENT_ALL
:
1263 ret
= LTTNG_ERR_UNK
;
1267 agt
= trace_ust_find_agent(usess
, domain
);
1269 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1272 /* The wild card * means that everything should be disabled. */
1273 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1274 ret
= event_agent_disable_all(usess
, agt
);
1276 ret
= event_agent_disable(usess
, agt
, event_name
);
1278 if (ret
!= LTTNG_OK
) {
1285 ret
= LTTNG_ERR_UND
;
1297 * Command LTTNG_DISABLE_EVENT for event "*" processed by the client thread.
1300 int disable_kevent_all(struct ltt_session
*session
, int domain
,
1302 struct lttng_event
*event
)
1309 case LTTNG_DOMAIN_KERNEL
:
1311 struct ltt_kernel_session
*ksess
;
1312 struct ltt_kernel_channel
*kchan
;
1314 ksess
= session
->kernel_session
;
1317 * If a non-default channel has been created in the
1318 * session, explicitely require that -c chan_name needs
1321 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1322 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1326 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1327 if (kchan
== NULL
) {
1328 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1332 switch (event
->type
) {
1333 case LTTNG_EVENT_ALL
:
1334 ret
= event_kernel_disable_all(kchan
);
1335 if (ret
!= LTTNG_OK
) {
1339 case LTTNG_EVENT_SYSCALL
:
1340 ret
= event_kernel_disable_syscall(kchan
, "");
1341 if (ret
!= LTTNG_OK
) {
1346 ret
= LTTNG_ERR_UNK
;
1350 kernel_wait_quiescent(kernel_tracer_fd
);
1354 ret
= LTTNG_ERR_UND
;
1366 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1368 int cmd_add_context(struct ltt_session
*session
, int domain
,
1369 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1371 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1374 case LTTNG_DOMAIN_KERNEL
:
1375 assert(session
->kernel_session
);
1377 if (session
->kernel_session
->channel_count
== 0) {
1378 /* Create default channel */
1379 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1380 if (ret
!= LTTNG_OK
) {
1383 chan_kern_created
= 1;
1385 /* Add kernel context to kernel tracer */
1386 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1387 if (ret
!= LTTNG_OK
) {
1391 case LTTNG_DOMAIN_UST
:
1393 struct ltt_ust_session
*usess
= session
->ust_session
;
1394 unsigned int chan_count
;
1398 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1399 if (chan_count
== 0) {
1400 struct lttng_channel
*attr
;
1401 /* Create default channel */
1402 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1404 ret
= LTTNG_ERR_FATAL
;
1408 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1409 if (ret
!= LTTNG_OK
) {
1414 chan_ust_created
= 1;
1417 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1418 if (ret
!= LTTNG_OK
) {
1424 ret
= LTTNG_ERR_UND
;
1431 if (chan_kern_created
) {
1432 struct ltt_kernel_channel
*kchan
=
1433 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1434 session
->kernel_session
);
1435 /* Created previously, this should NOT fail. */
1437 kernel_destroy_channel(kchan
);
1440 if (chan_ust_created
) {
1441 struct ltt_ust_channel
*uchan
=
1442 trace_ust_find_channel_by_name(
1443 session
->ust_session
->domain_global
.channels
,
1444 DEFAULT_CHANNEL_NAME
);
1445 /* Created previously, this should NOT fail. */
1447 /* Remove from the channel list of the session. */
1448 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1450 trace_ust_destroy_channel(uchan
);
1455 static int validate_event_name(const char *name
)
1458 const char *c
= name
;
1459 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1462 * Make sure that unescaped wildcards are only used as the last
1463 * character of the event name.
1465 while (c
< event_name_end
) {
1473 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1474 /* Wildcard is not the last character */
1475 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1488 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1489 * We own filter, exclusion, and filter_expression.
1491 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1492 char *channel_name
, struct lttng_event
*event
,
1493 char *filter_expression
,
1494 struct lttng_filter_bytecode
*filter
,
1495 struct lttng_event_exclusion
*exclusion
,
1498 int ret
, channel_created
= 0;
1499 struct lttng_channel
*attr
;
1503 assert(channel_name
);
1505 DBG("Enable event command for event \'%s\'", event
->name
);
1507 /* Special handling for kernel domain all events. */
1508 if (domain
->type
== LTTNG_DOMAIN_KERNEL
&& !strcmp(event
->name
, "*")) {
1509 return enable_kevent_all(session
, domain
, channel_name
, event
,
1510 filter_expression
, filter
, wpipe
);
1513 ret
= validate_event_name(event
->name
);
1520 switch (domain
->type
) {
1521 case LTTNG_DOMAIN_KERNEL
:
1523 struct ltt_kernel_channel
*kchan
;
1526 * If a non-default channel has been created in the
1527 * session, explicitely require that -c chan_name needs
1530 if (session
->kernel_session
->has_non_default_channel
1531 && channel_name
[0] == '\0') {
1532 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1536 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1537 session
->kernel_session
);
1538 if (kchan
== NULL
) {
1539 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1540 LTTNG_BUFFER_GLOBAL
);
1542 ret
= LTTNG_ERR_FATAL
;
1545 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1547 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1548 if (ret
!= LTTNG_OK
) {
1554 channel_created
= 1;
1557 /* Get the newly created kernel channel pointer */
1558 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1559 session
->kernel_session
);
1560 if (kchan
== NULL
) {
1561 /* This sould not happen... */
1562 ret
= LTTNG_ERR_FATAL
;
1566 switch (event
->type
) {
1567 case LTTNG_EVENT_ALL
:
1568 case LTTNG_EVENT_PROBE
:
1569 case LTTNG_EVENT_FUNCTION
:
1570 case LTTNG_EVENT_FUNCTION_ENTRY
:
1571 case LTTNG_EVENT_TRACEPOINT
:
1572 ret
= event_kernel_enable_tracepoint(kchan
, event
);
1573 if (ret
!= LTTNG_OK
) {
1574 if (channel_created
) {
1575 /* Let's not leak a useless channel. */
1576 kernel_destroy_channel(kchan
);
1581 case LTTNG_EVENT_SYSCALL
:
1582 ret
= event_kernel_enable_syscall(kchan
, event
->name
);
1583 if (ret
!= LTTNG_OK
) {
1588 ret
= LTTNG_ERR_UNK
;
1592 kernel_wait_quiescent(kernel_tracer_fd
);
1595 case LTTNG_DOMAIN_UST
:
1597 struct ltt_ust_channel
*uchan
;
1598 struct ltt_ust_session
*usess
= session
->ust_session
;
1603 * If a non-default channel has been created in the
1604 * session, explicitely require that -c chan_name needs
1607 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1608 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1612 /* Get channel from global UST domain */
1613 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1615 if (uchan
== NULL
) {
1616 /* Create default channel */
1617 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1618 usess
->buffer_type
);
1620 ret
= LTTNG_ERR_FATAL
;
1623 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1625 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1626 if (ret
!= LTTNG_OK
) {
1632 /* Get the newly created channel reference back */
1633 uchan
= trace_ust_find_channel_by_name(
1634 usess
->domain_global
.channels
, channel_name
);
1638 /* At this point, the session and channel exist on the tracer */
1639 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1640 filter_expression
, filter
, exclusion
);
1641 /* We have passed ownership */
1642 filter_expression
= NULL
;
1645 if (ret
!= LTTNG_OK
) {
1650 case LTTNG_DOMAIN_LOG4J
:
1651 case LTTNG_DOMAIN_JUL
:
1652 case LTTNG_DOMAIN_PYTHON
:
1654 const char *default_event_name
, *default_chan_name
;
1656 struct lttng_event uevent
;
1657 struct lttng_domain tmp_dom
;
1658 struct ltt_ust_session
*usess
= session
->ust_session
;
1662 agt
= trace_ust_find_agent(usess
, domain
->type
);
1664 agt
= agent_create(domain
->type
);
1666 ret
= -LTTNG_ERR_NOMEM
;
1669 agent_add(agt
, usess
->agents
);
1672 /* Create the default tracepoint. */
1673 memset(&uevent
, 0, sizeof(uevent
));
1674 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1675 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1676 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1677 if (!default_event_name
) {
1678 ret
= -LTTNG_ERR_FATAL
;
1681 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1682 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1685 * The domain type is changed because we are about to enable the
1686 * default channel and event for the JUL domain that are hardcoded.
1687 * This happens in the UST domain.
1689 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1690 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1692 switch (domain
->type
) {
1693 case LTTNG_DOMAIN_LOG4J
:
1694 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1696 case LTTNG_DOMAIN_JUL
:
1697 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1699 case LTTNG_DOMAIN_PYTHON
:
1700 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1703 /* The switch/case we are in should avoid this else big problem */
1708 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1711 filter_copy
= zmalloc(
1712 sizeof(struct lttng_filter_bytecode
)
1718 memcpy(filter_copy
, filter
,
1719 sizeof(struct lttng_filter_bytecode
)
1723 ret
= cmd_enable_event(session
, &tmp_dom
,
1724 (char *) default_chan_name
,
1725 &uevent
, filter_expression
, filter_copy
,
1727 /* We have passed ownership */
1728 filter_expression
= NULL
;
1731 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1735 /* The wild card * means that everything should be enabled. */
1736 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1737 ret
= event_agent_enable_all(usess
, agt
, event
, filter
);
1740 ret
= event_agent_enable(usess
, agt
, event
, filter
);
1743 if (ret
!= LTTNG_OK
) {
1750 ret
= LTTNG_ERR_UND
;
1757 free(filter_expression
);
1765 * Command LTTNG_ENABLE_EVENT for event "*" processed by the client thread.
1768 int enable_kevent_all(struct ltt_session
*session
,
1769 struct lttng_domain
*domain
, char *channel_name
,
1770 struct lttng_event
*event
,
1771 char *filter_expression
,
1772 struct lttng_filter_bytecode
*filter
, int wpipe
)
1775 struct lttng_channel
*attr
;
1778 assert(channel_name
);
1782 switch (domain
->type
) {
1783 case LTTNG_DOMAIN_KERNEL
:
1785 struct ltt_kernel_channel
*kchan
;
1787 assert(session
->kernel_session
);
1790 * If a non-default channel has been created in the
1791 * session, explicitely require that -c chan_name needs
1794 if (session
->kernel_session
->has_non_default_channel
1795 && channel_name
[0] == '\0') {
1796 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1800 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1801 session
->kernel_session
);
1802 if (kchan
== NULL
) {
1803 /* Create default channel */
1804 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1805 LTTNG_BUFFER_GLOBAL
);
1807 ret
= LTTNG_ERR_FATAL
;
1810 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1812 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1813 if (ret
!= LTTNG_OK
) {
1819 /* Get the newly created kernel channel pointer */
1820 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1821 session
->kernel_session
);
1825 switch (event
->type
) {
1826 case LTTNG_EVENT_SYSCALL
:
1827 ret
= event_kernel_enable_syscall(kchan
, "");
1828 if (ret
!= LTTNG_OK
) {
1832 case LTTNG_EVENT_TRACEPOINT
:
1834 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
1835 * events already registered to the channel.
1837 ret
= event_kernel_enable_all_tracepoints(kchan
, kernel_tracer_fd
);
1839 case LTTNG_EVENT_ALL
:
1840 /* Enable syscalls and tracepoints */
1841 ret
= event_kernel_enable_all(kchan
, kernel_tracer_fd
);
1844 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
1848 /* Manage return value */
1849 if (ret
!= LTTNG_OK
) {
1851 * On error, cmd_enable_channel call will take care of destroying
1852 * the created channel if it was needed.
1857 kernel_wait_quiescent(kernel_tracer_fd
);
1861 ret
= LTTNG_ERR_UND
;
1874 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1876 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1879 ssize_t nb_events
= 0;
1882 case LTTNG_DOMAIN_KERNEL
:
1883 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1884 if (nb_events
< 0) {
1885 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1889 case LTTNG_DOMAIN_UST
:
1890 nb_events
= ust_app_list_events(events
);
1891 if (nb_events
< 0) {
1892 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1896 case LTTNG_DOMAIN_LOG4J
:
1897 case LTTNG_DOMAIN_JUL
:
1898 case LTTNG_DOMAIN_PYTHON
:
1899 nb_events
= agent_list_events(events
, domain
);
1900 if (nb_events
< 0) {
1901 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1906 ret
= LTTNG_ERR_UND
;
1913 /* Return negative value to differentiate return code */
1918 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1920 ssize_t
cmd_list_tracepoint_fields(int domain
,
1921 struct lttng_event_field
**fields
)
1924 ssize_t nb_fields
= 0;
1927 case LTTNG_DOMAIN_UST
:
1928 nb_fields
= ust_app_list_event_fields(fields
);
1929 if (nb_fields
< 0) {
1930 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1934 case LTTNG_DOMAIN_KERNEL
:
1935 default: /* fall-through */
1936 ret
= LTTNG_ERR_UND
;
1943 /* Return negative value to differentiate return code */
1947 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1949 return syscall_table_list(events
);
1953 * Command LTTNG_START_TRACE processed by the client thread.
1955 * Called with session mutex held.
1957 int cmd_start_trace(struct ltt_session
*session
)
1960 unsigned long nb_chan
= 0;
1961 struct ltt_kernel_session
*ksession
;
1962 struct ltt_ust_session
*usess
;
1966 /* Ease our life a bit ;) */
1967 ksession
= session
->kernel_session
;
1968 usess
= session
->ust_session
;
1970 /* Is the session already started? */
1971 if (session
->active
) {
1972 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1977 * Starting a session without channel is useless since after that it's not
1978 * possible to enable channel thus inform the client.
1980 if (usess
&& usess
->domain_global
.channels
) {
1982 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
1986 nb_chan
+= ksession
->channel_count
;
1989 ret
= LTTNG_ERR_NO_CHANNEL
;
1993 /* Kernel tracing */
1994 if (ksession
!= NULL
) {
1995 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
1996 if (ret
!= LTTNG_OK
) {
2001 /* Flag session that trace should start automatically */
2004 * Even though the start trace might fail, flag this session active so
2005 * other application coming in are started by default.
2009 ret
= ust_app_start_trace_all(usess
);
2011 ret
= LTTNG_ERR_UST_START_FAIL
;
2016 /* Flag this after a successful start. */
2017 session
->has_been_started
= 1;
2018 session
->active
= 1;
2027 * Command LTTNG_STOP_TRACE processed by the client thread.
2029 int cmd_stop_trace(struct ltt_session
*session
)
2032 struct ltt_kernel_channel
*kchan
;
2033 struct ltt_kernel_session
*ksession
;
2034 struct ltt_ust_session
*usess
;
2039 ksession
= session
->kernel_session
;
2040 usess
= session
->ust_session
;
2042 /* Session is not active. Skip everythong and inform the client. */
2043 if (!session
->active
) {
2044 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2049 if (ksession
&& ksession
->active
) {
2050 DBG("Stop kernel tracing");
2052 /* Flush metadata if exist */
2053 if (ksession
->metadata_stream_fd
>= 0) {
2054 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2056 ERR("Kernel metadata flush failed");
2060 /* Flush all buffers before stopping */
2061 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2062 ret
= kernel_flush_buffer(kchan
);
2064 ERR("Kernel flush buffer error");
2068 ret
= kernel_stop_session(ksession
);
2070 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2074 kernel_wait_quiescent(kernel_tracer_fd
);
2076 ksession
->active
= 0;
2079 if (usess
&& usess
->active
) {
2081 * Even though the stop trace might fail, flag this session inactive so
2082 * other application coming in are not started by default.
2086 ret
= ust_app_stop_trace_all(usess
);
2088 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2093 /* Flag inactive after a successful stop. */
2094 session
->active
= 0;
2102 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2104 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2105 struct lttng_uri
*uris
)
2108 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2109 struct ltt_ust_session
*usess
= session
->ust_session
;
2115 /* Can't set consumer URI if the session is active. */
2116 if (session
->active
) {
2117 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2121 /* Set the "global" consumer URIs */
2122 for (i
= 0; i
< nb_uri
; i
++) {
2123 ret
= add_uri_to_consumer(session
->consumer
,
2124 &uris
[i
], 0, session
->name
);
2125 if (ret
!= LTTNG_OK
) {
2130 /* Set UST session URIs */
2131 if (session
->ust_session
) {
2132 for (i
= 0; i
< nb_uri
; i
++) {
2133 ret
= add_uri_to_consumer(
2134 session
->ust_session
->consumer
,
2135 &uris
[i
], LTTNG_DOMAIN_UST
,
2137 if (ret
!= LTTNG_OK
) {
2143 /* Set kernel session URIs */
2144 if (session
->kernel_session
) {
2145 for (i
= 0; i
< nb_uri
; i
++) {
2146 ret
= add_uri_to_consumer(
2147 session
->kernel_session
->consumer
,
2148 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2150 if (ret
!= LTTNG_OK
) {
2157 * Make sure to set the session in output mode after we set URI since a
2158 * session can be created without URL (thus flagged in no output mode).
2160 session
->output_traces
= 1;
2162 ksess
->output_traces
= 1;
2166 usess
->output_traces
= 1;
2177 * Command LTTNG_CREATE_SESSION processed by the client thread.
2179 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2180 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2183 struct ltt_session
*session
;
2189 * Verify if the session already exist
2191 * XXX: There is no need for the session lock list here since the caller
2192 * (process_client_msg) is holding it. We might want to change that so a
2193 * single command does not lock the entire session list.
2195 session
= session_find_by_name(name
);
2196 if (session
!= NULL
) {
2197 ret
= LTTNG_ERR_EXIST_SESS
;
2201 /* Create tracing session in the registry */
2202 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2203 LTTNG_SOCK_GET_GID_CRED(creds
));
2204 if (ret
!= LTTNG_OK
) {
2209 * Get the newly created session pointer back
2211 * XXX: There is no need for the session lock list here since the caller
2212 * (process_client_msg) is holding it. We might want to change that so a
2213 * single command does not lock the entire session list.
2215 session
= session_find_by_name(name
);
2218 session
->live_timer
= live_timer
;
2219 /* Create default consumer output for the session not yet created. */
2220 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2221 if (session
->consumer
== NULL
) {
2222 ret
= LTTNG_ERR_FATAL
;
2223 goto consumer_error
;
2227 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2228 if (ret
!= LTTNG_OK
) {
2229 goto consumer_error
;
2231 session
->output_traces
= 1;
2233 session
->output_traces
= 0;
2234 DBG2("Session %s created with no output", session
->name
);
2237 session
->consumer
->enabled
= 1;
2242 session_destroy(session
);
2249 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2251 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2252 size_t nb_uri
, lttng_sock_cred
*creds
)
2255 struct ltt_session
*session
;
2256 struct snapshot_output
*new_output
= NULL
;
2262 * Create session in no output mode with URIs set to NULL. The uris we've
2263 * received are for a default snapshot output if one.
2265 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2266 if (ret
!= LTTNG_OK
) {
2270 /* Get the newly created session pointer back. This should NEVER fail. */
2271 session
= session_find_by_name(name
);
2274 /* Flag session for snapshot mode. */
2275 session
->snapshot_mode
= 1;
2277 /* Skip snapshot output creation if no URI is given. */
2282 new_output
= snapshot_output_alloc();
2284 ret
= LTTNG_ERR_NOMEM
;
2285 goto error_snapshot_alloc
;
2288 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2289 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2291 if (ret
== -ENOMEM
) {
2292 ret
= LTTNG_ERR_NOMEM
;
2294 ret
= LTTNG_ERR_INVALID
;
2296 goto error_snapshot
;
2300 snapshot_add_output(&session
->snapshot
, new_output
);
2307 snapshot_output_destroy(new_output
);
2308 error_snapshot_alloc
:
2309 session_destroy(session
);
2315 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2317 * Called with session lock held.
2319 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2322 struct ltt_ust_session
*usess
;
2323 struct ltt_kernel_session
*ksess
;
2328 usess
= session
->ust_session
;
2329 ksess
= session
->kernel_session
;
2331 /* Clean kernel session teardown */
2332 kernel_destroy_session(ksess
);
2334 /* UST session teardown */
2336 /* Close any relayd session */
2337 consumer_output_send_destroy_relayd(usess
->consumer
);
2339 /* Destroy every UST application related to this session. */
2340 ret
= ust_app_destroy_trace_all(usess
);
2342 ERR("Error in ust_app_destroy_trace_all");
2345 /* Clean up the rest. */
2346 trace_ust_destroy_session(usess
);
2350 * Must notify the kernel thread here to update it's poll set in order to
2351 * remove the channel(s)' fd just destroyed.
2353 ret
= notify_thread_pipe(wpipe
);
2355 PERROR("write kernel poll pipe");
2358 ret
= session_destroy(session
);
2364 * Command LTTNG_CALIBRATE processed by the client thread.
2366 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2371 case LTTNG_DOMAIN_KERNEL
:
2373 struct lttng_kernel_calibrate kcalibrate
;
2375 switch (calibrate
->type
) {
2376 case LTTNG_CALIBRATE_FUNCTION
:
2378 /* Default and only possible calibrate option. */
2379 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2383 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2385 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2390 case LTTNG_DOMAIN_UST
:
2392 struct lttng_ust_calibrate ucalibrate
;
2394 switch (calibrate
->type
) {
2395 case LTTNG_CALIBRATE_FUNCTION
:
2397 /* Default and only possible calibrate option. */
2398 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2402 ret
= ust_app_calibrate_glb(&ucalibrate
);
2404 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2410 ret
= LTTNG_ERR_UND
;
2421 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2423 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2424 const char *sock_path
, struct consumer_data
*cdata
)
2427 struct consumer_socket
*socket
= NULL
;
2434 case LTTNG_DOMAIN_KERNEL
:
2436 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2440 /* Can't register a consumer if there is already one */
2441 if (ksess
->consumer_fds_sent
!= 0) {
2442 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2446 sock
= lttcomm_connect_unix_sock(sock_path
);
2448 ret
= LTTNG_ERR_CONNECT_FAIL
;
2451 cdata
->cmd_sock
= sock
;
2453 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2454 if (socket
== NULL
) {
2457 PERROR("close register consumer");
2459 cdata
->cmd_sock
= -1;
2460 ret
= LTTNG_ERR_FATAL
;
2464 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2465 if (socket
->lock
== NULL
) {
2466 PERROR("zmalloc pthread mutex");
2467 ret
= LTTNG_ERR_FATAL
;
2470 pthread_mutex_init(socket
->lock
, NULL
);
2471 socket
->registered
= 1;
2474 consumer_add_socket(socket
, ksess
->consumer
);
2477 pthread_mutex_lock(&cdata
->pid_mutex
);
2479 pthread_mutex_unlock(&cdata
->pid_mutex
);
2484 /* TODO: Userspace tracing */
2485 ret
= LTTNG_ERR_UND
;
2493 consumer_destroy_socket(socket
);
2499 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2501 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2502 struct lttng_domain
**domains
)
2507 struct lttng_ht_iter iter
;
2509 if (session
->kernel_session
!= NULL
) {
2510 DBG3("Listing domains found kernel domain");
2514 if (session
->ust_session
!= NULL
) {
2515 DBG3("Listing domains found UST global domain");
2519 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2521 if (agt
->being_used
) {
2532 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2533 if (*domains
== NULL
) {
2534 ret
= LTTNG_ERR_FATAL
;
2538 if (session
->kernel_session
!= NULL
) {
2539 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2543 if (session
->ust_session
!= NULL
) {
2544 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2545 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2549 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2551 if (agt
->being_used
) {
2552 (*domains
)[index
].type
= agt
->domain
;
2553 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2563 /* Return negative value to differentiate return code */
2569 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2571 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2572 struct lttng_channel
**channels
)
2575 ssize_t nb_chan
= 0;
2578 case LTTNG_DOMAIN_KERNEL
:
2579 if (session
->kernel_session
!= NULL
) {
2580 nb_chan
= session
->kernel_session
->channel_count
;
2582 DBG3("Number of kernel channels %zd", nb_chan
);
2584 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2587 case LTTNG_DOMAIN_UST
:
2588 if (session
->ust_session
!= NULL
) {
2590 nb_chan
= lttng_ht_get_count(
2591 session
->ust_session
->domain_global
.channels
);
2594 DBG3("Number of UST global channels %zd", nb_chan
);
2596 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2601 ret
= LTTNG_ERR_UND
;
2606 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2607 if (*channels
== NULL
) {
2608 ret
= LTTNG_ERR_FATAL
;
2612 list_lttng_channels(domain
, session
, *channels
);
2618 /* Return negative value to differentiate return code */
2623 * Command LTTNG_LIST_EVENTS processed by the client thread.
2625 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2626 char *channel_name
, struct lttng_event
**events
)
2629 ssize_t nb_event
= 0;
2632 case LTTNG_DOMAIN_KERNEL
:
2633 if (session
->kernel_session
!= NULL
) {
2634 nb_event
= list_lttng_kernel_events(channel_name
,
2635 session
->kernel_session
, events
);
2638 case LTTNG_DOMAIN_UST
:
2640 if (session
->ust_session
!= NULL
) {
2641 nb_event
= list_lttng_ust_global_events(channel_name
,
2642 &session
->ust_session
->domain_global
, events
);
2646 case LTTNG_DOMAIN_LOG4J
:
2647 case LTTNG_DOMAIN_JUL
:
2648 case LTTNG_DOMAIN_PYTHON
:
2649 if (session
->ust_session
) {
2650 struct lttng_ht_iter iter
;
2654 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2655 &iter
.iter
, agt
, node
.node
) {
2656 nb_event
= list_lttng_agent_events(agt
, events
);
2662 ret
= LTTNG_ERR_UND
;
2669 /* Return negative value to differentiate return code */
2674 * Using the session list, filled a lttng_session array to send back to the
2675 * client for session listing.
2677 * The session list lock MUST be acquired before calling this function. Use
2678 * session_lock_list() and session_unlock_list().
2680 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2685 struct ltt_session
*session
;
2686 struct ltt_session_list
*list
= session_get_list();
2688 DBG("Getting all available session for UID %d GID %d",
2691 * Iterate over session list and append data after the control struct in
2694 cds_list_for_each_entry(session
, &list
->head
, list
) {
2696 * Only list the sessions the user can control.
2698 if (!session_access_ok(session
, uid
, gid
)) {
2702 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2703 struct ltt_ust_session
*usess
= session
->ust_session
;
2705 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2706 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2707 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2708 ret
= build_network_session_path(sessions
[i
].path
,
2709 sizeof(sessions
[i
].path
), session
);
2711 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2712 session
->consumer
->dst
.trace_path
);
2715 PERROR("snprintf session path");
2719 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2720 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2721 sessions
[i
].enabled
= session
->active
;
2722 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2723 sessions
[i
].live_timer_interval
= session
->live_timer
;
2729 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2730 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2732 int cmd_data_pending(struct ltt_session
*session
)
2735 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2736 struct ltt_ust_session
*usess
= session
->ust_session
;
2740 /* Session MUST be stopped to ask for data availability. */
2741 if (session
->active
) {
2742 ret
= LTTNG_ERR_SESSION_STARTED
;
2746 * If stopped, just make sure we've started before else the above call
2747 * will always send that there is data pending.
2749 * The consumer assumes that when the data pending command is received,
2750 * the trace has been started before or else no output data is written
2751 * by the streams which is a condition for data pending. So, this is
2752 * *VERY* important that we don't ask the consumer before a start
2755 if (!session
->has_been_started
) {
2761 if (ksess
&& ksess
->consumer
) {
2762 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2764 /* Data is still being extracted for the kernel. */
2769 if (usess
&& usess
->consumer
) {
2770 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2772 /* Data is still being extracted for the kernel. */
2777 /* Data is ready to be read by a viewer */
2785 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2787 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2789 int cmd_snapshot_add_output(struct ltt_session
*session
,
2790 struct lttng_snapshot_output
*output
, uint32_t *id
)
2793 struct snapshot_output
*new_output
;
2798 DBG("Cmd snapshot add output for session %s", session
->name
);
2801 * Permission denied to create an output if the session is not
2802 * set in no output mode.
2804 if (session
->output_traces
) {
2805 ret
= LTTNG_ERR_EPERM
;
2809 /* Only one output is allowed until we have the "tee" feature. */
2810 if (session
->snapshot
.nb_output
== 1) {
2811 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2815 new_output
= snapshot_output_alloc();
2817 ret
= LTTNG_ERR_NOMEM
;
2821 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2822 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2823 &session
->snapshot
);
2825 if (ret
== -ENOMEM
) {
2826 ret
= LTTNG_ERR_NOMEM
;
2828 ret
= LTTNG_ERR_INVALID
;
2834 snapshot_add_output(&session
->snapshot
, new_output
);
2836 *id
= new_output
->id
;
2843 snapshot_output_destroy(new_output
);
2849 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2851 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2853 int cmd_snapshot_del_output(struct ltt_session
*session
,
2854 struct lttng_snapshot_output
*output
)
2857 struct snapshot_output
*sout
= NULL
;
2865 * Permission denied to create an output if the session is not
2866 * set in no output mode.
2868 if (session
->output_traces
) {
2869 ret
= LTTNG_ERR_EPERM
;
2874 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2876 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2877 } else if (*output
->name
!= '\0') {
2878 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2880 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2883 ret
= LTTNG_ERR_INVALID
;
2887 snapshot_delete_output(&session
->snapshot
, sout
);
2888 snapshot_output_destroy(sout
);
2897 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2899 * If no output is available, outputs is untouched and 0 is returned.
2901 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2903 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2904 struct lttng_snapshot_output
**outputs
)
2907 struct lttng_snapshot_output
*list
= NULL
;
2908 struct lttng_ht_iter iter
;
2909 struct snapshot_output
*output
;
2914 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2917 * Permission denied to create an output if the session is not
2918 * set in no output mode.
2920 if (session
->output_traces
) {
2921 ret
= -LTTNG_ERR_EPERM
;
2925 if (session
->snapshot
.nb_output
== 0) {
2930 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2932 ret
= -LTTNG_ERR_NOMEM
;
2936 /* Copy list from session to the new list object. */
2938 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2939 output
, node
.node
) {
2940 assert(output
->consumer
);
2941 list
[idx
].id
= output
->id
;
2942 list
[idx
].max_size
= output
->max_size
;
2943 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2944 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2945 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2946 sizeof(list
[idx
].ctrl_url
));
2949 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2950 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2952 ret
= -LTTNG_ERR_NOMEM
;
2957 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
2958 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
2960 ret
= -LTTNG_ERR_NOMEM
;
2969 ret
= session
->snapshot
.nb_output
;
2977 * Send relayd sockets from snapshot output to consumer. Ignore request if the
2978 * snapshot output is *not* set with a remote destination.
2980 * Return 0 on success or a LTTNG_ERR code.
2982 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
2983 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
2986 struct lttng_ht_iter iter
;
2987 struct consumer_socket
*socket
;
2990 assert(snap_output
);
2993 DBG2("Set relayd object from snapshot output");
2995 /* Ignore if snapshot consumer output is not network. */
2996 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3001 * For each consumer socket, create and send the relayd object of the
3005 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3006 socket
, node
.node
) {
3007 ret
= send_consumer_relayd_sockets(0, session
->id
,
3008 snap_output
->consumer
, socket
,
3009 session
->name
, session
->hostname
,
3010 session
->live_timer
);
3011 if (ret
!= LTTNG_OK
) {
3023 * Record a kernel snapshot.
3025 * Return LTTNG_OK on success or a LTTNG_ERR code.
3027 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3028 struct snapshot_output
*output
, struct ltt_session
*session
,
3029 int wait
, uint64_t nb_packets_per_stream
)
3037 /* Get the datetime for the snapshot output directory. */
3038 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3039 sizeof(output
->datetime
));
3041 ret
= LTTNG_ERR_INVALID
;
3046 * Copy kernel session sockets so we can communicate with the right
3047 * consumer for the snapshot record command.
3049 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3051 ret
= LTTNG_ERR_NOMEM
;
3055 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3056 if (ret
!= LTTNG_OK
) {
3057 goto error_snapshot
;
3060 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3061 if (ret
!= LTTNG_OK
) {
3062 goto error_snapshot
;
3069 /* Clean up copied sockets so this output can use some other later on. */
3070 consumer_destroy_output_sockets(output
->consumer
);
3077 * Record a UST snapshot.
3079 * Return 0 on success or a LTTNG_ERR error code.
3081 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3082 struct snapshot_output
*output
, struct ltt_session
*session
,
3083 int wait
, uint64_t nb_packets_per_stream
)
3091 /* Get the datetime for the snapshot output directory. */
3092 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
3093 sizeof(output
->datetime
));
3095 ret
= LTTNG_ERR_INVALID
;
3100 * Copy UST session sockets so we can communicate with the right
3101 * consumer for the snapshot record command.
3103 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3105 ret
= LTTNG_ERR_NOMEM
;
3109 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3110 if (ret
!= LTTNG_OK
) {
3111 goto error_snapshot
;
3114 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3118 ret
= LTTNG_ERR_INVALID
;
3121 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3124 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3127 goto error_snapshot
;
3133 /* Clean up copied sockets so this output can use some other later on. */
3134 consumer_destroy_output_sockets(output
->consumer
);
3140 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3141 uint64_t cur_nr_packets
)
3143 uint64_t tot_size
= 0;
3145 if (session
->kernel_session
) {
3146 struct ltt_kernel_channel
*chan
;
3147 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3149 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3150 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3152 * Don't take channel into account if we
3153 * already grab all its packets.
3157 tot_size
+= chan
->channel
->attr
.subbuf_size
3158 * chan
->stream_count
;
3162 if (session
->ust_session
) {
3163 struct ltt_ust_session
*usess
= session
->ust_session
;
3165 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3173 * Calculate the number of packets we can grab from each stream that
3174 * fits within the overall snapshot max size.
3176 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3177 * the number of packets per stream.
3179 * TODO: this approach is not perfect: we consider the worse case
3180 * (packet filling the sub-buffers) as an upper bound, but we could do
3181 * better if we do this calculation while we actually grab the packet
3182 * content: we would know how much padding we don't actually store into
3185 * This algorithm is currently bounded by the number of packets per
3188 * Since we call this algorithm before actually grabbing the data, it's
3189 * an approximation: for instance, applications could appear/disappear
3190 * in between this call and actually grabbing data.
3193 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3196 uint64_t cur_nb_packets
= 0;
3199 return 0; /* Infinite */
3202 size_left
= max_size
;
3204 uint64_t one_more_packet_tot_size
;
3206 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3208 if (!one_more_packet_tot_size
) {
3209 /* We are already grabbing all packets. */
3212 size_left
-= one_more_packet_tot_size
;
3213 if (size_left
< 0) {
3218 if (!cur_nb_packets
) {
3219 /* Not enough room to grab one packet of each stream, error. */
3222 return cur_nb_packets
;
3226 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3228 * The wait parameter is ignored so this call always wait for the snapshot to
3229 * complete before returning.
3231 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3233 int cmd_snapshot_record(struct ltt_session
*session
,
3234 struct lttng_snapshot_output
*output
, int wait
)
3237 unsigned int use_tmp_output
= 0;
3238 struct snapshot_output tmp_output
;
3239 unsigned int snapshot_success
= 0;
3244 DBG("Cmd snapshot record for session %s", session
->name
);
3247 * Permission denied to create an output if the session is not
3248 * set in no output mode.
3250 if (session
->output_traces
) {
3251 ret
= LTTNG_ERR_EPERM
;
3255 /* The session needs to be started at least once. */
3256 if (!session
->has_been_started
) {
3257 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3261 /* Use temporary output for the session. */
3262 if (*output
->ctrl_url
!= '\0') {
3263 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3264 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3267 if (ret
== -ENOMEM
) {
3268 ret
= LTTNG_ERR_NOMEM
;
3270 ret
= LTTNG_ERR_INVALID
;
3274 /* Use the global session count for the temporary snapshot. */
3275 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3279 if (session
->kernel_session
) {
3280 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3282 if (use_tmp_output
) {
3283 int64_t nb_packets_per_stream
;
3285 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3286 tmp_output
.max_size
);
3287 if (nb_packets_per_stream
< 0) {
3288 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3291 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3292 wait
, nb_packets_per_stream
);
3293 if (ret
!= LTTNG_OK
) {
3296 snapshot_success
= 1;
3298 struct snapshot_output
*sout
;
3299 struct lttng_ht_iter iter
;
3302 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3303 &iter
.iter
, sout
, node
.node
) {
3304 int64_t nb_packets_per_stream
;
3307 * Make a local copy of the output and assign the possible
3308 * temporary value given by the caller.
3310 memset(&tmp_output
, 0, sizeof(tmp_output
));
3311 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3313 if (output
->max_size
!= (uint64_t) -1ULL) {
3314 tmp_output
.max_size
= output
->max_size
;
3317 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3318 tmp_output
.max_size
);
3319 if (nb_packets_per_stream
< 0) {
3320 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3324 /* Use temporary name. */
3325 if (*output
->name
!= '\0') {
3326 strncpy(tmp_output
.name
, output
->name
,
3327 sizeof(tmp_output
.name
));
3330 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3332 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3333 session
, wait
, nb_packets_per_stream
);
3334 if (ret
!= LTTNG_OK
) {
3338 snapshot_success
= 1;
3344 if (session
->ust_session
) {
3345 struct ltt_ust_session
*usess
= session
->ust_session
;
3347 if (use_tmp_output
) {
3348 int64_t nb_packets_per_stream
;
3350 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3351 tmp_output
.max_size
);
3352 if (nb_packets_per_stream
< 0) {
3353 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3356 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3357 wait
, nb_packets_per_stream
);
3358 if (ret
!= LTTNG_OK
) {
3361 snapshot_success
= 1;
3363 struct snapshot_output
*sout
;
3364 struct lttng_ht_iter iter
;
3367 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3368 &iter
.iter
, sout
, node
.node
) {
3369 int64_t nb_packets_per_stream
;
3372 * Make a local copy of the output and assign the possible
3373 * temporary value given by the caller.
3375 memset(&tmp_output
, 0, sizeof(tmp_output
));
3376 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3378 if (output
->max_size
!= (uint64_t) -1ULL) {
3379 tmp_output
.max_size
= output
->max_size
;
3382 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3383 tmp_output
.max_size
);
3384 if (nb_packets_per_stream
< 0) {
3385 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3390 /* Use temporary name. */
3391 if (*output
->name
!= '\0') {
3392 strncpy(tmp_output
.name
, output
->name
,
3393 sizeof(tmp_output
.name
));
3396 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3398 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3399 wait
, nb_packets_per_stream
);
3400 if (ret
!= LTTNG_OK
) {
3404 snapshot_success
= 1;
3410 if (snapshot_success
) {
3411 session
->snapshot
.nb_snapshot
++;
3413 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3421 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3423 int cmd_set_session_shm_path(struct ltt_session
*session
,
3424 const char *shm_path
)
3430 * Can only set shm path before session is started.
3432 if (session
->has_been_started
) {
3433 return LTTNG_ERR_SESSION_STARTED
;
3436 strncpy(session
->shm_path
, shm_path
,
3437 sizeof(session
->shm_path
));
3438 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3444 * Init command subsystem.
3449 * Set network sequence index to 1 for streams to match a relayd
3450 * socket on the consumer side.
3452 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3453 relayd_net_seq_idx
= 1;
3454 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3456 DBG("Command subsystem initialized");