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.
22 #include <urcu/list.h>
23 #include <urcu/uatomic.h>
25 #include <common/defaults.h>
26 #include <common/common.h>
27 #include <common/sessiond-comm/sessiond-comm.h>
28 #include <common/relayd/relayd.h>
29 #include <common/utils.h>
34 #include "health-sessiond.h"
36 #include "kernel-consumer.h"
37 #include "lttng-sessiond.h"
44 * Used to keep a unique index for each relayd socket created where this value
45 * is associated with streams on the consumer so it can match the right relayd
46 * to send to. It must be accessed with the relayd_net_seq_idx_lock
49 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
50 static uint64_t relayd_net_seq_idx
;
53 * Both functions below are special case for the Kernel domain when
54 * enabling/disabling all events.
57 int enable_kevent_all(struct ltt_session
*session
,
58 struct lttng_domain
*domain
, char *channel_name
,
59 struct lttng_event
*event
,
60 char *filter_expression
,
61 struct lttng_filter_bytecode
*filter
, int wpipe
);
63 int disable_kevent_all(struct ltt_session
*session
, int domain
,
65 struct lttng_event
*event
);
68 * Create a session path used by list_lttng_sessions for the case that the
69 * session consumer is on the network.
71 static int build_network_session_path(char *dst
, size_t size
,
72 struct ltt_session
*session
)
74 int ret
, kdata_port
, udata_port
;
75 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
76 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
81 memset(tmp_urls
, 0, sizeof(tmp_urls
));
82 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
84 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
86 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
87 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
88 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
91 if (session
->ust_session
&& session
->ust_session
->consumer
) {
92 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
93 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
96 if (uuri
== NULL
&& kuri
== NULL
) {
97 uri
= &session
->consumer
->dst
.net
.control
;
98 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
99 } else if (kuri
&& uuri
) {
100 ret
= uri_compare(kuri
, uuri
);
104 /* Build uuri URL string */
105 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
112 } else if (kuri
&& uuri
== NULL
) {
114 } else if (uuri
&& kuri
== NULL
) {
118 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
124 * Do we have a UST url set. If yes, this means we have both kernel and UST
127 if (*tmp_uurl
!= '\0') {
128 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
129 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
132 if (kuri
|| (!kuri
&& !uuri
)) {
135 /* No kernel URI, use the UST port. */
138 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
146 * Fill lttng_channel array of all channels.
148 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
149 struct lttng_channel
*channels
)
152 struct ltt_kernel_channel
*kchan
;
154 DBG("Listing channels for session %s", session
->name
);
157 case LTTNG_DOMAIN_KERNEL
:
158 /* Kernel channels */
159 if (session
->kernel_session
!= NULL
) {
160 cds_list_for_each_entry(kchan
,
161 &session
->kernel_session
->channel_list
.head
, list
) {
162 /* Copy lttng_channel struct to array */
163 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
164 channels
[i
].enabled
= kchan
->enabled
;
169 case LTTNG_DOMAIN_UST
:
171 struct lttng_ht_iter iter
;
172 struct ltt_ust_channel
*uchan
;
175 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
176 &iter
.iter
, uchan
, node
.node
) {
177 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
178 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
179 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
180 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
181 channels
[i
].attr
.switch_timer_interval
=
182 uchan
->attr
.switch_timer_interval
;
183 channels
[i
].attr
.read_timer_interval
=
184 uchan
->attr
.read_timer_interval
;
185 channels
[i
].enabled
= uchan
->enabled
;
186 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
187 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
188 switch (uchan
->attr
.output
) {
191 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
205 * Create a list of agent domain events.
207 * Return number of events in list on success or else a negative value.
209 static int list_lttng_agent_events(struct agent
*agt
,
210 struct lttng_event
**events
)
213 unsigned int nb_event
= 0;
214 struct agent_event
*event
;
215 struct lttng_event
*tmp_events
;
216 struct lttng_ht_iter iter
;
221 DBG3("Listing agent events");
224 nb_event
= lttng_ht_get_count(agt
->events
);
231 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
233 PERROR("zmalloc agent events session");
234 ret
= -LTTNG_ERR_FATAL
;
239 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
240 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
241 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
242 tmp_events
[i
].enabled
= event
->enabled
;
243 tmp_events
[i
].loglevel
= event
->loglevel
;
244 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
249 *events
= tmp_events
;
253 assert(nb_event
== i
);
258 * Create a list of ust global domain events.
260 static int list_lttng_ust_global_events(char *channel_name
,
261 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
264 unsigned int nb_event
= 0;
265 struct lttng_ht_iter iter
;
266 struct lttng_ht_node_str
*node
;
267 struct ltt_ust_channel
*uchan
;
268 struct ltt_ust_event
*uevent
;
269 struct lttng_event
*tmp
;
271 DBG("Listing UST global events for channel %s", channel_name
);
275 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
276 node
= lttng_ht_iter_get_node_str(&iter
);
278 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
282 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
284 nb_event
+= lttng_ht_get_count(uchan
->events
);
291 DBG3("Listing UST global %d events", nb_event
);
293 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
295 ret
= LTTNG_ERR_FATAL
;
299 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
300 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
301 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
302 tmp
[i
].enabled
= uevent
->enabled
;
304 switch (uevent
->attr
.instrumentation
) {
305 case LTTNG_UST_TRACEPOINT
:
306 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
308 case LTTNG_UST_PROBE
:
309 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
311 case LTTNG_UST_FUNCTION
:
312 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
316 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
317 switch (uevent
->attr
.loglevel_type
) {
318 case LTTNG_UST_LOGLEVEL_ALL
:
319 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
321 case LTTNG_UST_LOGLEVEL_RANGE
:
322 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
324 case LTTNG_UST_LOGLEVEL_SINGLE
:
325 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
328 if (uevent
->filter
) {
331 if (uevent
->exclusion
) {
332 tmp
[i
].exclusion
= 1;
346 * Fill lttng_event array of all kernel events in the channel.
348 static int list_lttng_kernel_events(char *channel_name
,
349 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
352 unsigned int nb_event
;
353 struct ltt_kernel_event
*event
;
354 struct ltt_kernel_channel
*kchan
;
356 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
358 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
362 nb_event
= kchan
->event_count
;
364 DBG("Listing events for channel %s", kchan
->channel
->name
);
371 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
372 if (*events
== NULL
) {
373 ret
= LTTNG_ERR_FATAL
;
377 /* Kernel channels */
378 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
379 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
380 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
381 (*events
)[i
].enabled
= event
->enabled
;
383 switch (event
->event
->instrumentation
) {
384 case LTTNG_KERNEL_TRACEPOINT
:
385 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
387 case LTTNG_KERNEL_KRETPROBE
:
388 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
389 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
390 sizeof(struct lttng_kernel_kprobe
));
392 case LTTNG_KERNEL_KPROBE
:
393 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
394 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
395 sizeof(struct lttng_kernel_kprobe
));
397 case LTTNG_KERNEL_FUNCTION
:
398 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
399 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
400 sizeof(struct lttng_kernel_function
));
402 case LTTNG_KERNEL_NOOP
:
403 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
405 case LTTNG_KERNEL_SYSCALL
:
406 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
408 case LTTNG_KERNEL_ALL
:
419 new_size
= syscall_list_channel(kchan
, events
, nb_event
);
431 /* Negate the error code to differentiate the size from an error */
436 * Add URI so the consumer output object. Set the correct path depending on the
437 * domain adding the default trace directory.
439 static int add_uri_to_consumer(struct consumer_output
*consumer
,
440 struct lttng_uri
*uri
, int domain
, const char *session_name
)
443 const char *default_trace_dir
;
447 if (consumer
== NULL
) {
448 DBG("No consumer detected. Don't add URI. Stopping.");
449 ret
= LTTNG_ERR_NO_CONSUMER
;
454 case LTTNG_DOMAIN_KERNEL
:
455 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
457 case LTTNG_DOMAIN_UST
:
458 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
462 * This case is possible is we try to add the URI to the global tracing
463 * session consumer object which in this case there is no subdir.
465 default_trace_dir
= "";
468 switch (uri
->dtype
) {
471 DBG2("Setting network URI to consumer");
473 if (consumer
->type
== CONSUMER_DST_NET
) {
474 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
475 consumer
->dst
.net
.control_isset
) ||
476 (uri
->stype
== LTTNG_STREAM_DATA
&&
477 consumer
->dst
.net
.data_isset
)) {
478 ret
= LTTNG_ERR_URL_EXIST
;
482 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
485 consumer
->type
= CONSUMER_DST_NET
;
487 /* Set URI into consumer output object */
488 ret
= consumer_set_network_uri(consumer
, uri
);
492 } else if (ret
== 1) {
494 * URI was the same in the consumer so we do not append the subdir
495 * again so to not duplicate output dir.
501 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
502 ret
= consumer_set_subdir(consumer
, session_name
);
504 ret
= LTTNG_ERR_FATAL
;
509 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
510 /* On a new subdir, reappend the default trace dir. */
511 strncat(consumer
->subdir
, default_trace_dir
,
512 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
513 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
518 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
519 memset(consumer
->dst
.trace_path
, 0,
520 sizeof(consumer
->dst
.trace_path
));
521 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
522 sizeof(consumer
->dst
.trace_path
));
523 /* Append default trace dir */
524 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
525 sizeof(consumer
->dst
.trace_path
) -
526 strlen(consumer
->dst
.trace_path
) - 1);
527 /* Flag consumer as local. */
528 consumer
->type
= CONSUMER_DST_LOCAL
;
539 * Init tracing by creating trace directory and sending fds kernel consumer.
541 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
544 struct lttng_ht_iter iter
;
545 struct consumer_socket
*socket
;
551 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
552 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
554 pthread_mutex_lock(socket
->lock
);
555 ret
= kernel_consumer_send_session(socket
, session
);
556 pthread_mutex_unlock(socket
->lock
);
558 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
570 * Create a socket to the relayd using the URI.
572 * On success, the relayd_sock pointer is set to the created socket.
573 * Else, it's stays untouched and a lttcomm error code is returned.
575 static int create_connect_relayd(struct lttng_uri
*uri
,
576 struct lttcomm_relayd_sock
**relayd_sock
)
579 struct lttcomm_relayd_sock
*rsock
;
581 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
582 RELAYD_VERSION_COMM_MINOR
);
584 ret
= LTTNG_ERR_FATAL
;
589 * Connect to relayd so we can proceed with a session creation. This call
590 * can possibly block for an arbitrary amount of time to set the health
591 * state to be in poll execution.
594 ret
= relayd_connect(rsock
);
597 ERR("Unable to reach lttng-relayd");
598 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
602 /* Create socket for control stream. */
603 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
604 DBG3("Creating relayd stream socket from URI");
606 /* Check relayd version */
607 ret
= relayd_version_check(rsock
);
609 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
612 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
613 DBG3("Creating relayd data socket from URI");
615 /* Command is not valid */
616 ERR("Relayd invalid stream type: %d", uri
->stype
);
617 ret
= LTTNG_ERR_INVALID
;
621 *relayd_sock
= rsock
;
626 /* The returned value is not useful since we are on an error path. */
627 (void) relayd_close(rsock
);
635 * Connect to the relayd using URI and send the socket to the right consumer.
637 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
638 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
639 struct consumer_socket
*consumer_sock
,
640 char *session_name
, char *hostname
, int session_live_timer
)
643 struct lttcomm_relayd_sock
*rsock
= NULL
;
645 /* Connect to relayd and make version check if uri is the control. */
646 ret
= create_connect_relayd(relayd_uri
, &rsock
);
647 if (ret
!= LTTNG_OK
) {
652 /* Set the network sequence index if not set. */
653 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
654 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
656 * Increment net_seq_idx because we are about to transfer the
657 * new relayd socket to the consumer.
658 * Assign unique key so the consumer can match streams.
660 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
661 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
664 /* Send relayd socket to consumer. */
665 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
666 relayd_uri
->stype
, session_id
,
667 session_name
, hostname
, session_live_timer
);
669 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
673 /* Flag that the corresponding socket was sent. */
674 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
675 consumer_sock
->control_sock_sent
= 1;
676 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
677 consumer_sock
->data_sock_sent
= 1;
683 * Close socket which was dup on the consumer side. The session daemon does
684 * NOT keep track of the relayd socket(s) once transfer to the consumer.
688 (void) relayd_close(rsock
);
692 if (ret
!= LTTNG_OK
) {
694 * The consumer output for this session should not be used anymore
695 * since the relayd connection failed thus making any tracing or/and
696 * streaming not usable.
698 consumer
->enabled
= 0;
704 * Send both relayd sockets to a specific consumer and domain. This is a
705 * helper function to facilitate sending the information to the consumer for a
708 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
709 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
710 char *session_name
, char *hostname
, int session_live_timer
)
717 /* Sending control relayd socket. */
718 if (!sock
->control_sock_sent
) {
719 ret
= send_consumer_relayd_socket(domain
, session_id
,
720 &consumer
->dst
.net
.control
, consumer
, sock
,
721 session_name
, hostname
, session_live_timer
);
722 if (ret
!= LTTNG_OK
) {
727 /* Sending data relayd socket. */
728 if (!sock
->data_sock_sent
) {
729 ret
= send_consumer_relayd_socket(domain
, session_id
,
730 &consumer
->dst
.net
.data
, consumer
, sock
,
731 session_name
, hostname
, session_live_timer
);
732 if (ret
!= LTTNG_OK
) {
742 * Setup relayd connections for a tracing session. First creates the socket to
743 * the relayd and send them to the right domain consumer. Consumer type MUST be
746 int cmd_setup_relayd(struct ltt_session
*session
)
749 struct ltt_ust_session
*usess
;
750 struct ltt_kernel_session
*ksess
;
751 struct consumer_socket
*socket
;
752 struct lttng_ht_iter iter
;
756 usess
= session
->ust_session
;
757 ksess
= session
->kernel_session
;
759 DBG("Setting relayd for session %s", session
->name
);
763 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
764 && usess
->consumer
->enabled
) {
765 /* For each consumer socket, send relayd sockets */
766 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
768 pthread_mutex_lock(socket
->lock
);
769 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
770 usess
->consumer
, socket
,
771 session
->name
, session
->hostname
,
772 session
->live_timer
);
773 pthread_mutex_unlock(socket
->lock
);
774 if (ret
!= LTTNG_OK
) {
777 /* Session is now ready for network streaming. */
778 session
->net_handle
= 1;
782 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
783 && ksess
->consumer
->enabled
) {
784 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
786 pthread_mutex_lock(socket
->lock
);
787 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
788 ksess
->consumer
, socket
,
789 session
->name
, session
->hostname
,
790 session
->live_timer
);
791 pthread_mutex_unlock(socket
->lock
);
792 if (ret
!= LTTNG_OK
) {
795 /* Session is now ready for network streaming. */
796 session
->net_handle
= 1;
806 * Start a kernel session by opening all necessary streams.
808 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
811 struct ltt_kernel_channel
*kchan
;
813 /* Open kernel metadata */
814 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
815 ret
= kernel_open_metadata(ksess
);
817 ret
= LTTNG_ERR_KERN_META_FAIL
;
822 /* Open kernel metadata stream */
823 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
824 ret
= kernel_open_metadata_stream(ksess
);
826 ERR("Kernel create metadata stream failed");
827 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
832 /* For each channel */
833 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
834 if (kchan
->stream_count
== 0) {
835 ret
= kernel_open_channel_stream(kchan
);
837 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
840 /* Update the stream global counter */
841 ksess
->stream_count_global
+= ret
;
845 /* Setup kernel consumer socket and send fds to it */
846 ret
= init_kernel_tracing(ksess
);
848 ret
= LTTNG_ERR_KERN_START_FAIL
;
852 /* This start the kernel tracing */
853 ret
= kernel_start_session(ksess
);
855 ret
= LTTNG_ERR_KERN_START_FAIL
;
859 /* Quiescent wait after starting trace */
860 kernel_wait_quiescent(kernel_tracer_fd
);
871 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
873 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
877 struct ltt_ust_session
*usess
;
879 usess
= session
->ust_session
;
884 case LTTNG_DOMAIN_KERNEL
:
886 ret
= channel_kernel_disable(session
->kernel_session
,
888 if (ret
!= LTTNG_OK
) {
892 kernel_wait_quiescent(kernel_tracer_fd
);
895 case LTTNG_DOMAIN_UST
:
897 struct ltt_ust_channel
*uchan
;
898 struct lttng_ht
*chan_ht
;
900 chan_ht
= usess
->domain_global
.channels
;
902 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
904 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
908 ret
= channel_ust_disable(usess
, uchan
);
909 if (ret
!= LTTNG_OK
) {
915 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
916 case LTTNG_DOMAIN_UST_EXEC_NAME
:
917 case LTTNG_DOMAIN_UST_PID
:
920 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
932 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
934 * The wpipe arguments is used as a notifier for the kernel thread.
936 int cmd_enable_channel(struct ltt_session
*session
,
937 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
940 struct ltt_ust_session
*usess
= session
->ust_session
;
941 struct lttng_ht
*chan_ht
;
948 len
= strnlen(attr
->name
, sizeof(attr
->name
));
950 /* Validate channel name */
951 if (attr
->name
[0] == '.' ||
952 memchr(attr
->name
, '/', len
) != NULL
) {
953 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
957 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
962 * Don't try to enable a channel if the session has been started at
963 * some point in time before. The tracer does not allow it.
965 if (session
->has_been_started
) {
966 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
971 * If the session is a live session, remove the switch timer, the
972 * live timer does the same thing but sends also synchronisation
973 * beacons for inactive streams.
975 if (session
->live_timer
> 0) {
976 attr
->attr
.live_timer_interval
= session
->live_timer
;
977 attr
->attr
.switch_timer_interval
= 0;
981 * The ringbuffer (both in user space and kernel) behave badly in overwrite
982 * mode and with less than 2 subbuf so block it right away and send back an
983 * invalid attribute error.
985 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
986 ret
= LTTNG_ERR_INVALID
;
990 switch (domain
->type
) {
991 case LTTNG_DOMAIN_KERNEL
:
993 struct ltt_kernel_channel
*kchan
;
995 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
996 session
->kernel_session
);
998 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
999 if (attr
->name
[0] != '\0') {
1000 session
->kernel_session
->has_non_default_channel
= 1;
1003 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1006 if (ret
!= LTTNG_OK
) {
1010 kernel_wait_quiescent(kernel_tracer_fd
);
1013 case LTTNG_DOMAIN_UST
:
1015 struct ltt_ust_channel
*uchan
;
1017 chan_ht
= usess
->domain_global
.channels
;
1019 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1020 if (uchan
== NULL
) {
1021 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1022 if (attr
->name
[0] != '\0') {
1023 usess
->has_non_default_channel
= 1;
1026 ret
= channel_ust_enable(usess
, uchan
);
1031 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1043 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1045 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1047 struct lttng_event
*event
)
1052 DBG("Disable event command for event \'%s\'", event
->name
);
1054 event_name
= event
->name
;
1056 /* Error out on unhandled search criteria */
1057 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1058 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1059 return LTTNG_ERR_UNK
;
1061 /* Special handling for kernel domain all events. */
1062 if (domain
== LTTNG_DOMAIN_KERNEL
&& !strcmp(event_name
, "*")) {
1063 return disable_kevent_all(session
, domain
, channel_name
, event
);
1069 case LTTNG_DOMAIN_KERNEL
:
1071 struct ltt_kernel_channel
*kchan
;
1072 struct ltt_kernel_session
*ksess
;
1074 ksess
= session
->kernel_session
;
1077 * If a non-default channel has been created in the
1078 * session, explicitely require that -c chan_name needs
1081 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1082 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1086 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1087 if (kchan
== NULL
) {
1088 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1092 switch (event
->type
) {
1093 case LTTNG_EVENT_ALL
:
1094 case LTTNG_EVENT_TRACEPOINT
:
1095 ret
= event_kernel_disable_tracepoint(kchan
, event_name
);
1096 if (ret
!= LTTNG_OK
) {
1100 case LTTNG_EVENT_SYSCALL
:
1101 ret
= event_kernel_disable_syscall(kchan
, event_name
);
1102 if (ret
!= LTTNG_OK
) {
1107 ret
= LTTNG_ERR_UNK
;
1111 kernel_wait_quiescent(kernel_tracer_fd
);
1114 case LTTNG_DOMAIN_UST
:
1116 struct ltt_ust_channel
*uchan
;
1117 struct ltt_ust_session
*usess
;
1119 usess
= session
->ust_session
;
1122 * If a non-default channel has been created in the
1123 * session, explicitely require that -c chan_name needs
1126 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1127 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1131 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1133 if (uchan
== NULL
) {
1134 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1138 switch (event
->type
) {
1139 case LTTNG_EVENT_ALL
:
1140 if (strlen(event
->name
) == 1 &&
1141 !strncmp(event
->name
, "*", 1)) {
1142 ret
= event_ust_disable_all_tracepoints(usess
,
1145 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1148 if (ret
!= LTTNG_OK
) {
1153 ret
= LTTNG_ERR_UNK
;
1157 DBG3("Disable UST event %s in channel %s completed", event_name
,
1161 case LTTNG_DOMAIN_LOG4J
:
1162 case LTTNG_DOMAIN_JUL
:
1165 struct ltt_ust_session
*usess
= session
->ust_session
;
1169 switch (event
->type
) {
1170 case LTTNG_EVENT_ALL
:
1173 ret
= LTTNG_ERR_UNK
;
1177 agt
= trace_ust_find_agent(usess
, domain
);
1179 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1182 /* The wild card * means that everything should be disabled. */
1183 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1184 ret
= event_agent_disable_all(usess
, agt
);
1186 ret
= event_agent_disable(usess
, agt
, event_name
);
1188 if (ret
!= LTTNG_OK
) {
1195 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1196 case LTTNG_DOMAIN_UST_PID
:
1197 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1200 ret
= LTTNG_ERR_UND
;
1212 * Command LTTNG_DISABLE_EVENT for event "*" processed by the client thread.
1215 int disable_kevent_all(struct ltt_session
*session
, int domain
,
1217 struct lttng_event
*event
)
1224 case LTTNG_DOMAIN_KERNEL
:
1226 struct ltt_kernel_session
*ksess
;
1227 struct ltt_kernel_channel
*kchan
;
1229 ksess
= session
->kernel_session
;
1232 * If a non-default channel has been created in the
1233 * session, explicitely require that -c chan_name needs
1236 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1237 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1241 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1242 if (kchan
== NULL
) {
1243 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1247 switch (event
->type
) {
1248 case LTTNG_EVENT_ALL
:
1249 ret
= event_kernel_disable_all(kchan
);
1250 if (ret
!= LTTNG_OK
) {
1254 case LTTNG_EVENT_SYSCALL
:
1255 ret
= event_kernel_disable_syscall(kchan
, "");
1256 if (ret
!= LTTNG_OK
) {
1261 ret
= LTTNG_ERR_UNK
;
1265 kernel_wait_quiescent(kernel_tracer_fd
);
1269 ret
= LTTNG_ERR_UND
;
1281 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1283 int cmd_add_context(struct ltt_session
*session
, int domain
,
1284 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1286 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1289 case LTTNG_DOMAIN_KERNEL
:
1290 assert(session
->kernel_session
);
1292 if (session
->kernel_session
->channel_count
== 0) {
1293 /* Create default channel */
1294 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1295 if (ret
!= LTTNG_OK
) {
1298 chan_kern_created
= 1;
1300 /* Add kernel context to kernel tracer */
1301 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1302 if (ret
!= LTTNG_OK
) {
1306 case LTTNG_DOMAIN_UST
:
1308 struct ltt_ust_session
*usess
= session
->ust_session
;
1309 unsigned int chan_count
;
1313 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1314 if (chan_count
== 0) {
1315 struct lttng_channel
*attr
;
1316 /* Create default channel */
1317 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1319 ret
= LTTNG_ERR_FATAL
;
1323 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1324 if (ret
!= LTTNG_OK
) {
1329 chan_ust_created
= 1;
1332 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1333 if (ret
!= LTTNG_OK
) {
1339 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1340 case LTTNG_DOMAIN_UST_PID
:
1341 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1344 ret
= LTTNG_ERR_UND
;
1351 if (chan_kern_created
) {
1352 struct ltt_kernel_channel
*kchan
=
1353 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1354 session
->kernel_session
);
1355 /* Created previously, this should NOT fail. */
1357 kernel_destroy_channel(kchan
);
1360 if (chan_ust_created
) {
1361 struct ltt_ust_channel
*uchan
=
1362 trace_ust_find_channel_by_name(
1363 session
->ust_session
->domain_global
.channels
,
1364 DEFAULT_CHANNEL_NAME
);
1365 /* Created previously, this should NOT fail. */
1367 /* Remove from the channel list of the session. */
1368 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1370 trace_ust_destroy_channel(uchan
);
1375 static int validate_event_name(const char *name
)
1378 const char *c
= name
;
1379 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1382 * Make sure that unescaped wildcards are only used as the last
1383 * character of the event name.
1385 while (c
< event_name_end
) {
1393 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1394 /* Wildcard is not the last character */
1395 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1408 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1409 * We own filter, exclusion, and filter_expression.
1411 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1412 char *channel_name
, struct lttng_event
*event
,
1413 char *filter_expression
,
1414 struct lttng_filter_bytecode
*filter
,
1415 struct lttng_event_exclusion
*exclusion
,
1418 int ret
, channel_created
= 0;
1419 struct lttng_channel
*attr
;
1423 assert(channel_name
);
1425 DBG("Enable event command for event \'%s\'", event
->name
);
1427 /* Special handling for kernel domain all events. */
1428 if (domain
->type
== LTTNG_DOMAIN_KERNEL
&& !strcmp(event
->name
, "*")) {
1429 return enable_kevent_all(session
, domain
, channel_name
, event
,
1430 filter_expression
, filter
, wpipe
);
1433 ret
= validate_event_name(event
->name
);
1440 switch (domain
->type
) {
1441 case LTTNG_DOMAIN_KERNEL
:
1443 struct ltt_kernel_channel
*kchan
;
1446 * If a non-default channel has been created in the
1447 * session, explicitely require that -c chan_name needs
1450 if (session
->kernel_session
->has_non_default_channel
1451 && channel_name
[0] == '\0') {
1452 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1456 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1457 session
->kernel_session
);
1458 if (kchan
== NULL
) {
1459 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1460 LTTNG_BUFFER_GLOBAL
);
1462 ret
= LTTNG_ERR_FATAL
;
1465 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1467 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1468 if (ret
!= LTTNG_OK
) {
1474 channel_created
= 1;
1477 /* Get the newly created kernel channel pointer */
1478 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1479 session
->kernel_session
);
1480 if (kchan
== NULL
) {
1481 /* This sould not happen... */
1482 ret
= LTTNG_ERR_FATAL
;
1486 switch (event
->type
) {
1487 case LTTNG_EVENT_ALL
:
1488 case LTTNG_EVENT_PROBE
:
1489 case LTTNG_EVENT_FUNCTION
:
1490 case LTTNG_EVENT_FUNCTION_ENTRY
:
1491 case LTTNG_EVENT_TRACEPOINT
:
1492 ret
= event_kernel_enable_tracepoint(kchan
, event
);
1493 if (ret
!= LTTNG_OK
) {
1494 if (channel_created
) {
1495 /* Let's not leak a useless channel. */
1496 kernel_destroy_channel(kchan
);
1501 case LTTNG_EVENT_SYSCALL
:
1502 ret
= event_kernel_enable_syscall(kchan
, event
->name
);
1503 if (ret
!= LTTNG_OK
) {
1508 ret
= LTTNG_ERR_UNK
;
1512 kernel_wait_quiescent(kernel_tracer_fd
);
1515 case LTTNG_DOMAIN_UST
:
1517 struct ltt_ust_channel
*uchan
;
1518 struct ltt_ust_session
*usess
= session
->ust_session
;
1523 * If a non-default channel has been created in the
1524 * session, explicitely require that -c chan_name needs
1527 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1528 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1532 /* Get channel from global UST domain */
1533 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1535 if (uchan
== NULL
) {
1536 /* Create default channel */
1537 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1538 usess
->buffer_type
);
1540 ret
= LTTNG_ERR_FATAL
;
1543 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1545 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1546 if (ret
!= LTTNG_OK
) {
1552 /* Get the newly created channel reference back */
1553 uchan
= trace_ust_find_channel_by_name(
1554 usess
->domain_global
.channels
, channel_name
);
1558 /* At this point, the session and channel exist on the tracer */
1559 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1560 filter_expression
, filter
, exclusion
);
1561 /* We have passed ownership */
1562 filter_expression
= NULL
;
1565 if (ret
!= LTTNG_OK
) {
1570 case LTTNG_DOMAIN_LOG4J
:
1571 case LTTNG_DOMAIN_JUL
:
1573 const char *default_event_name
, *default_chan_name
;
1575 struct lttng_event uevent
;
1576 struct lttng_domain tmp_dom
;
1577 struct ltt_ust_session
*usess
= session
->ust_session
;
1581 agt
= trace_ust_find_agent(usess
, domain
->type
);
1583 agt
= agent_create(domain
->type
);
1585 ret
= LTTNG_ERR_NOMEM
;
1588 agent_add(agt
, usess
->agents
);
1591 /* Create the default tracepoint. */
1592 memset(&uevent
, 0, sizeof(uevent
));
1593 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1594 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1595 default_event_name
= event_get_default_agent_ust_name(domain
->type
);
1596 if (!default_event_name
) {
1597 ret
= LTTNG_ERR_FATAL
;
1600 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1601 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1604 * The domain type is changed because we are about to enable the
1605 * default channel and event for the JUL domain that are hardcoded.
1606 * This happens in the UST domain.
1608 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1609 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1611 if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1612 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1614 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1618 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1619 char *filter_expression_copy
= NULL
;
1622 filter_copy
= zmalloc(
1623 sizeof(struct lttng_filter_bytecode
)
1626 ret
= LTTNG_ERR_NOMEM
;
1630 memcpy(filter_copy
, filter
,
1631 sizeof(struct lttng_filter_bytecode
)
1635 if (filter_expression
) {
1636 filter_expression_copy
=
1637 strdup(filter_expression
);
1638 if (!filter_expression
) {
1639 ret
= LTTNG_ERR_NOMEM
;
1640 goto error_free_copy
;
1644 ret
= cmd_enable_event(session
, &tmp_dom
,
1645 (char *) default_chan_name
,
1646 &uevent
, filter_expression_copy
,
1647 filter_copy
, NULL
, wpipe
);
1649 filter_expression_copy
= NULL
;
1652 free(filter_expression_copy
);
1655 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1659 /* The wild card * means that everything should be enabled. */
1660 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1661 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1665 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1669 if (ret
!= LTTNG_OK
) {
1676 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1677 case LTTNG_DOMAIN_UST_PID
:
1678 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1681 ret
= LTTNG_ERR_UND
;
1688 free(filter_expression
);
1696 * Command LTTNG_ENABLE_EVENT for event "*" processed by the client thread.
1699 int enable_kevent_all(struct ltt_session
*session
,
1700 struct lttng_domain
*domain
, char *channel_name
,
1701 struct lttng_event
*event
,
1702 char *filter_expression
,
1703 struct lttng_filter_bytecode
*filter
, int wpipe
)
1706 struct lttng_channel
*attr
;
1709 assert(channel_name
);
1713 switch (domain
->type
) {
1714 case LTTNG_DOMAIN_KERNEL
:
1716 struct ltt_kernel_channel
*kchan
;
1718 assert(session
->kernel_session
);
1721 * If a non-default channel has been created in the
1722 * session, explicitely require that -c chan_name needs
1725 if (session
->kernel_session
->has_non_default_channel
1726 && channel_name
[0] == '\0') {
1727 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1731 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1732 session
->kernel_session
);
1733 if (kchan
== NULL
) {
1734 /* Create default channel */
1735 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1736 LTTNG_BUFFER_GLOBAL
);
1738 ret
= LTTNG_ERR_FATAL
;
1741 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1743 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1744 if (ret
!= LTTNG_OK
) {
1750 /* Get the newly created kernel channel pointer */
1751 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1752 session
->kernel_session
);
1756 switch (event
->type
) {
1757 case LTTNG_EVENT_SYSCALL
:
1758 ret
= event_kernel_enable_syscall(kchan
, "");
1759 if (ret
!= LTTNG_OK
) {
1763 case LTTNG_EVENT_TRACEPOINT
:
1765 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
1766 * events already registered to the channel.
1768 ret
= event_kernel_enable_all_tracepoints(kchan
, kernel_tracer_fd
);
1770 case LTTNG_EVENT_ALL
:
1771 /* Enable syscalls and tracepoints */
1772 ret
= event_kernel_enable_all(kchan
, kernel_tracer_fd
);
1775 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
1779 /* Manage return value */
1780 if (ret
!= LTTNG_OK
) {
1782 * On error, cmd_enable_channel call will take care of destroying
1783 * the created channel if it was needed.
1788 kernel_wait_quiescent(kernel_tracer_fd
);
1792 ret
= LTTNG_ERR_UND
;
1805 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1807 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1810 ssize_t nb_events
= 0;
1813 case LTTNG_DOMAIN_KERNEL
:
1814 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1815 if (nb_events
< 0) {
1816 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1820 case LTTNG_DOMAIN_UST
:
1821 nb_events
= ust_app_list_events(events
);
1822 if (nb_events
< 0) {
1823 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1827 case LTTNG_DOMAIN_LOG4J
:
1828 case LTTNG_DOMAIN_JUL
:
1829 nb_events
= agent_list_events(events
, domain
);
1830 if (nb_events
< 0) {
1831 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1836 ret
= LTTNG_ERR_UND
;
1843 /* Return negative value to differentiate return code */
1848 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1850 ssize_t
cmd_list_tracepoint_fields(int domain
,
1851 struct lttng_event_field
**fields
)
1854 ssize_t nb_fields
= 0;
1857 case LTTNG_DOMAIN_UST
:
1858 nb_fields
= ust_app_list_event_fields(fields
);
1859 if (nb_fields
< 0) {
1860 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1864 case LTTNG_DOMAIN_KERNEL
:
1865 default: /* fall-through */
1866 ret
= LTTNG_ERR_UND
;
1873 /* Return negative value to differentiate return code */
1877 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1879 return syscall_table_list(events
);
1883 * Command LTTNG_START_TRACE processed by the client thread.
1885 int cmd_start_trace(struct ltt_session
*session
)
1888 unsigned long nb_chan
= 0;
1889 struct ltt_kernel_session
*ksession
;
1890 struct ltt_ust_session
*usess
;
1894 /* Ease our life a bit ;) */
1895 ksession
= session
->kernel_session
;
1896 usess
= session
->ust_session
;
1898 /* Is the session already started? */
1899 if (session
->active
) {
1900 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1905 * Starting a session without channel is useless since after that it's not
1906 * possible to enable channel thus inform the client.
1908 if (usess
&& usess
->domain_global
.channels
) {
1910 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
1914 nb_chan
+= ksession
->channel_count
;
1917 ret
= LTTNG_ERR_NO_CHANNEL
;
1921 /* Kernel tracing */
1922 if (ksession
!= NULL
) {
1923 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
1924 if (ret
!= LTTNG_OK
) {
1929 /* Flag session that trace should start automatically */
1932 * Even though the start trace might fail, flag this session active so
1933 * other application coming in are started by default.
1937 ret
= ust_app_start_trace_all(usess
);
1939 ret
= LTTNG_ERR_UST_START_FAIL
;
1944 /* Flag this after a successful start. */
1945 session
->has_been_started
= 1;
1946 session
->active
= 1;
1955 * Command LTTNG_STOP_TRACE processed by the client thread.
1957 int cmd_stop_trace(struct ltt_session
*session
)
1960 struct ltt_kernel_channel
*kchan
;
1961 struct ltt_kernel_session
*ksession
;
1962 struct ltt_ust_session
*usess
;
1967 ksession
= session
->kernel_session
;
1968 usess
= session
->ust_session
;
1970 /* Session is not active. Skip everythong and inform the client. */
1971 if (!session
->active
) {
1972 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
1977 if (ksession
&& ksession
->active
) {
1978 DBG("Stop kernel tracing");
1980 /* Flush metadata if exist */
1981 if (ksession
->metadata_stream_fd
>= 0) {
1982 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
1984 ERR("Kernel metadata flush failed");
1988 /* Flush all buffers before stopping */
1989 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
1990 ret
= kernel_flush_buffer(kchan
);
1992 ERR("Kernel flush buffer error");
1996 ret
= kernel_stop_session(ksession
);
1998 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2002 kernel_wait_quiescent(kernel_tracer_fd
);
2004 ksession
->active
= 0;
2007 if (usess
&& usess
->active
) {
2009 * Even though the stop trace might fail, flag this session inactive so
2010 * other application coming in are not started by default.
2014 ret
= ust_app_stop_trace_all(usess
);
2016 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2021 /* Flag inactive after a successful stop. */
2022 session
->active
= 0;
2030 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2032 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2033 struct lttng_uri
*uris
)
2036 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2037 struct ltt_ust_session
*usess
= session
->ust_session
;
2043 /* Can't set consumer URI if the session is active. */
2044 if (session
->active
) {
2045 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2049 /* Set the "global" consumer URIs */
2050 for (i
= 0; i
< nb_uri
; i
++) {
2051 ret
= add_uri_to_consumer(session
->consumer
,
2052 &uris
[i
], 0, session
->name
);
2053 if (ret
!= LTTNG_OK
) {
2058 /* Set UST session URIs */
2059 if (session
->ust_session
) {
2060 for (i
= 0; i
< nb_uri
; i
++) {
2061 ret
= add_uri_to_consumer(
2062 session
->ust_session
->consumer
,
2063 &uris
[i
], LTTNG_DOMAIN_UST
,
2065 if (ret
!= LTTNG_OK
) {
2071 /* Set kernel session URIs */
2072 if (session
->kernel_session
) {
2073 for (i
= 0; i
< nb_uri
; i
++) {
2074 ret
= add_uri_to_consumer(
2075 session
->kernel_session
->consumer
,
2076 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2078 if (ret
!= LTTNG_OK
) {
2085 * Make sure to set the session in output mode after we set URI since a
2086 * session can be created without URL (thus flagged in no output mode).
2088 session
->output_traces
= 1;
2090 ksess
->output_traces
= 1;
2094 usess
->output_traces
= 1;
2105 * Command LTTNG_CREATE_SESSION processed by the client thread.
2107 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2108 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2111 struct ltt_session
*session
;
2117 * Verify if the session already exist
2119 * XXX: There is no need for the session lock list here since the caller
2120 * (process_client_msg) is holding it. We might want to change that so a
2121 * single command does not lock the entire session list.
2123 session
= session_find_by_name(name
);
2124 if (session
!= NULL
) {
2125 ret
= LTTNG_ERR_EXIST_SESS
;
2129 /* Create tracing session in the registry */
2130 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2131 LTTNG_SOCK_GET_GID_CRED(creds
));
2132 if (ret
!= LTTNG_OK
) {
2137 * Get the newly created session pointer back
2139 * XXX: There is no need for the session lock list here since the caller
2140 * (process_client_msg) is holding it. We might want to change that so a
2141 * single command does not lock the entire session list.
2143 session
= session_find_by_name(name
);
2146 session
->live_timer
= live_timer
;
2147 /* Create default consumer output for the session not yet created. */
2148 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2149 if (session
->consumer
== NULL
) {
2150 ret
= LTTNG_ERR_FATAL
;
2151 goto consumer_error
;
2155 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2156 if (ret
!= LTTNG_OK
) {
2157 goto consumer_error
;
2159 session
->output_traces
= 1;
2161 session
->output_traces
= 0;
2162 DBG2("Session %s created with no output", session
->name
);
2165 session
->consumer
->enabled
= 1;
2170 session_destroy(session
);
2177 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2179 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2180 size_t nb_uri
, lttng_sock_cred
*creds
)
2183 struct ltt_session
*session
;
2184 struct snapshot_output
*new_output
= NULL
;
2190 * Create session in no output mode with URIs set to NULL. The uris we've
2191 * received are for a default snapshot output if one.
2193 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2194 if (ret
!= LTTNG_OK
) {
2198 /* Get the newly created session pointer back. This should NEVER fail. */
2199 session
= session_find_by_name(name
);
2202 /* Flag session for snapshot mode. */
2203 session
->snapshot_mode
= 1;
2205 /* Skip snapshot output creation if no URI is given. */
2210 new_output
= snapshot_output_alloc();
2212 ret
= LTTNG_ERR_NOMEM
;
2213 goto error_snapshot_alloc
;
2216 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2217 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2219 if (ret
== -ENOMEM
) {
2220 ret
= LTTNG_ERR_NOMEM
;
2222 ret
= LTTNG_ERR_INVALID
;
2224 goto error_snapshot
;
2228 snapshot_add_output(&session
->snapshot
, new_output
);
2235 snapshot_output_destroy(new_output
);
2236 error_snapshot_alloc
:
2237 session_destroy(session
);
2243 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2245 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2248 struct ltt_ust_session
*usess
;
2249 struct ltt_kernel_session
*ksess
;
2254 usess
= session
->ust_session
;
2255 ksess
= session
->kernel_session
;
2257 /* Clean kernel session teardown */
2258 kernel_destroy_session(ksess
);
2260 /* UST session teardown */
2262 /* Close any relayd session */
2263 consumer_output_send_destroy_relayd(usess
->consumer
);
2265 /* Destroy every UST application related to this session. */
2266 ret
= ust_app_destroy_trace_all(usess
);
2268 ERR("Error in ust_app_destroy_trace_all");
2271 /* Clean up the rest. */
2272 trace_ust_destroy_session(usess
);
2276 * Must notify the kernel thread here to update it's poll set in order to
2277 * remove the channel(s)' fd just destroyed.
2279 ret
= notify_thread_pipe(wpipe
);
2281 PERROR("write kernel poll pipe");
2284 ret
= session_destroy(session
);
2290 * Command LTTNG_CALIBRATE processed by the client thread.
2292 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2297 case LTTNG_DOMAIN_KERNEL
:
2299 struct lttng_kernel_calibrate kcalibrate
;
2301 switch (calibrate
->type
) {
2302 case LTTNG_CALIBRATE_FUNCTION
:
2304 /* Default and only possible calibrate option. */
2305 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2309 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2311 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2316 case LTTNG_DOMAIN_UST
:
2318 struct lttng_ust_calibrate ucalibrate
;
2320 switch (calibrate
->type
) {
2321 case LTTNG_CALIBRATE_FUNCTION
:
2323 /* Default and only possible calibrate option. */
2324 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2328 ret
= ust_app_calibrate_glb(&ucalibrate
);
2330 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2336 ret
= LTTNG_ERR_UND
;
2347 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2349 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2350 const char *sock_path
, struct consumer_data
*cdata
)
2353 struct consumer_socket
*socket
= NULL
;
2360 case LTTNG_DOMAIN_KERNEL
:
2362 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2366 /* Can't register a consumer if there is already one */
2367 if (ksess
->consumer_fds_sent
!= 0) {
2368 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2372 sock
= lttcomm_connect_unix_sock(sock_path
);
2374 ret
= LTTNG_ERR_CONNECT_FAIL
;
2377 cdata
->cmd_sock
= sock
;
2379 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2380 if (socket
== NULL
) {
2383 PERROR("close register consumer");
2385 cdata
->cmd_sock
= -1;
2386 ret
= LTTNG_ERR_FATAL
;
2390 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2391 if (socket
->lock
== NULL
) {
2392 PERROR("zmalloc pthread mutex");
2393 ret
= LTTNG_ERR_FATAL
;
2396 pthread_mutex_init(socket
->lock
, NULL
);
2397 socket
->registered
= 1;
2400 consumer_add_socket(socket
, ksess
->consumer
);
2403 pthread_mutex_lock(&cdata
->pid_mutex
);
2405 pthread_mutex_unlock(&cdata
->pid_mutex
);
2410 /* TODO: Userspace tracing */
2411 ret
= LTTNG_ERR_UND
;
2419 consumer_destroy_socket(socket
);
2425 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2427 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2428 struct lttng_domain
**domains
)
2433 struct lttng_ht_iter iter
;
2435 if (session
->kernel_session
!= NULL
) {
2436 DBG3("Listing domains found kernel domain");
2440 if (session
->ust_session
!= NULL
) {
2441 DBG3("Listing domains found UST global domain");
2445 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2447 if (agt
->being_used
) {
2454 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2455 if (*domains
== NULL
) {
2456 ret
= LTTNG_ERR_FATAL
;
2460 if (session
->kernel_session
!= NULL
) {
2461 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2463 /* Kernel session buffer type is always GLOBAL */
2464 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2469 if (session
->ust_session
!= NULL
) {
2470 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2471 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2475 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2477 if (agt
->being_used
) {
2478 (*domains
)[index
].type
= agt
->domain
;
2479 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2489 /* Return negative value to differentiate return code */
2495 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2497 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2498 struct lttng_channel
**channels
)
2501 ssize_t nb_chan
= 0;
2504 case LTTNG_DOMAIN_KERNEL
:
2505 if (session
->kernel_session
!= NULL
) {
2506 nb_chan
= session
->kernel_session
->channel_count
;
2508 DBG3("Number of kernel channels %zd", nb_chan
);
2510 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2513 case LTTNG_DOMAIN_UST
:
2514 if (session
->ust_session
!= NULL
) {
2516 nb_chan
= lttng_ht_get_count(
2517 session
->ust_session
->domain_global
.channels
);
2520 DBG3("Number of UST global channels %zd", nb_chan
);
2522 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2527 ret
= LTTNG_ERR_UND
;
2532 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2533 if (*channels
== NULL
) {
2534 ret
= LTTNG_ERR_FATAL
;
2538 list_lttng_channels(domain
, session
, *channels
);
2544 /* Return negative value to differentiate return code */
2549 * Command LTTNG_LIST_EVENTS processed by the client thread.
2551 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2552 char *channel_name
, struct lttng_event
**events
)
2555 ssize_t nb_event
= 0;
2558 case LTTNG_DOMAIN_KERNEL
:
2559 if (session
->kernel_session
!= NULL
) {
2560 nb_event
= list_lttng_kernel_events(channel_name
,
2561 session
->kernel_session
, events
);
2564 case LTTNG_DOMAIN_UST
:
2566 if (session
->ust_session
!= NULL
) {
2567 nb_event
= list_lttng_ust_global_events(channel_name
,
2568 &session
->ust_session
->domain_global
, events
);
2572 case LTTNG_DOMAIN_LOG4J
:
2573 case LTTNG_DOMAIN_JUL
:
2574 if (session
->ust_session
) {
2575 struct lttng_ht_iter iter
;
2579 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2580 &iter
.iter
, agt
, node
.node
) {
2581 nb_event
= list_lttng_agent_events(agt
, events
);
2587 ret
= LTTNG_ERR_UND
;
2594 /* Return negative value to differentiate return code */
2599 * Using the session list, filled a lttng_session array to send back to the
2600 * client for session listing.
2602 * The session list lock MUST be acquired before calling this function. Use
2603 * session_lock_list() and session_unlock_list().
2605 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2610 struct ltt_session
*session
;
2611 struct ltt_session_list
*list
= session_get_list();
2613 DBG("Getting all available session for UID %d GID %d",
2616 * Iterate over session list and append data after the control struct in
2619 cds_list_for_each_entry(session
, &list
->head
, list
) {
2621 * Only list the sessions the user can control.
2623 if (!session_access_ok(session
, uid
, gid
)) {
2627 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2628 struct ltt_ust_session
*usess
= session
->ust_session
;
2630 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2631 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2632 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2633 ret
= build_network_session_path(sessions
[i
].path
,
2634 sizeof(sessions
[i
].path
), session
);
2636 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2637 session
->consumer
->dst
.trace_path
);
2640 PERROR("snprintf session path");
2644 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2645 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2646 sessions
[i
].enabled
= session
->active
;
2647 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2648 sessions
[i
].live_timer_interval
= session
->live_timer
;
2654 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2655 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2657 int cmd_data_pending(struct ltt_session
*session
)
2660 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2661 struct ltt_ust_session
*usess
= session
->ust_session
;
2665 /* Session MUST be stopped to ask for data availability. */
2666 if (session
->active
) {
2667 ret
= LTTNG_ERR_SESSION_STARTED
;
2671 * If stopped, just make sure we've started before else the above call
2672 * will always send that there is data pending.
2674 * The consumer assumes that when the data pending command is received,
2675 * the trace has been started before or else no output data is written
2676 * by the streams which is a condition for data pending. So, this is
2677 * *VERY* important that we don't ask the consumer before a start
2680 if (!session
->has_been_started
) {
2686 if (ksess
&& ksess
->consumer
) {
2687 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2689 /* Data is still being extracted for the kernel. */
2694 if (usess
&& usess
->consumer
) {
2695 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2697 /* Data is still being extracted for the kernel. */
2702 /* Data is ready to be read by a viewer */
2710 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2712 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2714 int cmd_snapshot_add_output(struct ltt_session
*session
,
2715 struct lttng_snapshot_output
*output
, uint32_t *id
)
2718 struct snapshot_output
*new_output
;
2723 DBG("Cmd snapshot add output for session %s", session
->name
);
2726 * Permission denied to create an output if the session is not
2727 * set in no output mode.
2729 if (session
->output_traces
) {
2730 ret
= LTTNG_ERR_EPERM
;
2734 /* Only one output is allowed until we have the "tee" feature. */
2735 if (session
->snapshot
.nb_output
== 1) {
2736 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2740 new_output
= snapshot_output_alloc();
2742 ret
= LTTNG_ERR_NOMEM
;
2746 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2747 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2748 &session
->snapshot
);
2750 if (ret
== -ENOMEM
) {
2751 ret
= LTTNG_ERR_NOMEM
;
2753 ret
= LTTNG_ERR_INVALID
;
2759 snapshot_add_output(&session
->snapshot
, new_output
);
2761 *id
= new_output
->id
;
2768 snapshot_output_destroy(new_output
);
2774 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2776 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2778 int cmd_snapshot_del_output(struct ltt_session
*session
,
2779 struct lttng_snapshot_output
*output
)
2782 struct snapshot_output
*sout
= NULL
;
2790 * Permission denied to create an output if the session is not
2791 * set in no output mode.
2793 if (session
->output_traces
) {
2794 ret
= LTTNG_ERR_EPERM
;
2799 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2801 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2802 } else if (*output
->name
!= '\0') {
2803 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2805 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2808 ret
= LTTNG_ERR_INVALID
;
2812 snapshot_delete_output(&session
->snapshot
, sout
);
2813 snapshot_output_destroy(sout
);
2822 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2824 * If no output is available, outputs is untouched and 0 is returned.
2826 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2828 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2829 struct lttng_snapshot_output
**outputs
)
2832 struct lttng_snapshot_output
*list
= NULL
;
2833 struct lttng_ht_iter iter
;
2834 struct snapshot_output
*output
;
2839 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2842 * Permission denied to create an output if the session is not
2843 * set in no output mode.
2845 if (session
->output_traces
) {
2846 ret
= -LTTNG_ERR_EPERM
;
2850 if (session
->snapshot
.nb_output
== 0) {
2855 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2857 ret
= -LTTNG_ERR_NOMEM
;
2861 /* Copy list from session to the new list object. */
2863 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2864 output
, node
.node
) {
2865 assert(output
->consumer
);
2866 list
[idx
].id
= output
->id
;
2867 list
[idx
].max_size
= output
->max_size
;
2868 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2869 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2870 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2871 sizeof(list
[idx
].ctrl_url
));
2874 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2875 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2877 ret
= -LTTNG_ERR_NOMEM
;
2882 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
2883 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
2885 ret
= -LTTNG_ERR_NOMEM
;
2894 ret
= session
->snapshot
.nb_output
;
2902 * Send relayd sockets from snapshot output to consumer. Ignore request if the
2903 * snapshot output is *not* set with a remote destination.
2905 * Return 0 on success or a LTTNG_ERR code.
2907 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
2908 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
2911 struct lttng_ht_iter iter
;
2912 struct consumer_socket
*socket
;
2915 assert(snap_output
);
2918 DBG2("Set relayd object from snapshot output");
2920 /* Ignore if snapshot consumer output is not network. */
2921 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
2926 * For each consumer socket, create and send the relayd object of the
2930 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
2931 socket
, node
.node
) {
2932 ret
= send_consumer_relayd_sockets(0, session
->id
,
2933 snap_output
->consumer
, socket
,
2934 session
->name
, session
->hostname
,
2935 session
->live_timer
);
2936 if (ret
!= LTTNG_OK
) {
2948 * Record a kernel snapshot.
2950 * Return LTTNG_OK on success or a LTTNG_ERR code.
2952 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
2953 struct snapshot_output
*output
, struct ltt_session
*session
,
2954 int wait
, uint64_t nb_packets_per_stream
)
2964 * Copy kernel session sockets so we can communicate with the right
2965 * consumer for the snapshot record command.
2967 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
2969 ret
= LTTNG_ERR_NOMEM
;
2973 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
2974 if (ret
!= LTTNG_OK
) {
2975 goto error_snapshot
;
2978 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
2979 if (ret
!= LTTNG_OK
) {
2980 goto error_snapshot
;
2987 /* Clean up copied sockets so this output can use some other later on. */
2988 consumer_destroy_output_sockets(output
->consumer
);
2995 * Record a UST snapshot.
2997 * Return 0 on success or a LTTNG_ERR error code.
2999 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3000 struct snapshot_output
*output
, struct ltt_session
*session
,
3001 int wait
, uint64_t nb_packets_per_stream
)
3010 * Copy UST session sockets so we can communicate with the right
3011 * consumer for the snapshot record command.
3013 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3015 ret
= LTTNG_ERR_NOMEM
;
3019 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3020 if (ret
!= LTTNG_OK
) {
3021 goto error_snapshot
;
3024 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3028 ret
= LTTNG_ERR_INVALID
;
3031 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3034 goto error_snapshot
;
3040 /* Clean up copied sockets so this output can use some other later on. */
3041 consumer_destroy_output_sockets(output
->consumer
);
3047 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3048 uint64_t cur_nr_packets
)
3050 uint64_t tot_size
= 0;
3052 if (session
->kernel_session
) {
3053 struct ltt_kernel_channel
*chan
;
3054 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3056 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3057 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3059 * Don't take channel into account if we
3060 * already grab all its packets.
3064 tot_size
+= chan
->channel
->attr
.subbuf_size
3065 * chan
->stream_count
;
3069 if (session
->ust_session
) {
3070 struct ltt_ust_session
*usess
= session
->ust_session
;
3072 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3080 * Calculate the number of packets we can grab from each stream that
3081 * fits within the overall snapshot max size.
3083 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3084 * the number of packets per stream.
3086 * TODO: this approach is not perfect: we consider the worse case
3087 * (packet filling the sub-buffers) as an upper bound, but we could do
3088 * better if we do this calculation while we actually grab the packet
3089 * content: we would know how much padding we don't actually store into
3092 * This algorithm is currently bounded by the number of packets per
3095 * Since we call this algorithm before actually grabbing the data, it's
3096 * an approximation: for instance, applications could appear/disappear
3097 * in between this call and actually grabbing data.
3100 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3103 uint64_t cur_nb_packets
= 0;
3106 return 0; /* Infinite */
3109 size_left
= max_size
;
3111 uint64_t one_more_packet_tot_size
;
3113 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3115 if (!one_more_packet_tot_size
) {
3116 /* We are already grabbing all packets. */
3119 size_left
-= one_more_packet_tot_size
;
3120 if (size_left
< 0) {
3125 if (!cur_nb_packets
) {
3126 /* Not enough room to grab one packet of each stream, error. */
3129 return cur_nb_packets
;
3133 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3135 * The wait parameter is ignored so this call always wait for the snapshot to
3136 * complete before returning.
3138 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3140 int cmd_snapshot_record(struct ltt_session
*session
,
3141 struct lttng_snapshot_output
*output
, int wait
)
3144 unsigned int use_tmp_output
= 0;
3145 struct snapshot_output tmp_output
;
3146 unsigned int snapshot_success
= 0;
3152 DBG("Cmd snapshot record for session %s", session
->name
);
3154 /* Get the datetime for the snapshot output directory. */
3155 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3158 ret
= LTTNG_ERR_INVALID
;
3163 * Permission denied to create an output if the session is not
3164 * set in no output mode.
3166 if (session
->output_traces
) {
3167 ret
= LTTNG_ERR_EPERM
;
3171 /* The session needs to be started at least once. */
3172 if (!session
->has_been_started
) {
3173 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3177 /* Use temporary output for the session. */
3178 if (*output
->ctrl_url
!= '\0') {
3179 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3180 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3183 if (ret
== -ENOMEM
) {
3184 ret
= LTTNG_ERR_NOMEM
;
3186 ret
= LTTNG_ERR_INVALID
;
3190 /* Use the global session count for the temporary snapshot. */
3191 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3193 /* Use the global datetime */
3194 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3198 if (use_tmp_output
) {
3199 int64_t nb_packets_per_stream
;
3201 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3202 tmp_output
.max_size
);
3203 if (nb_packets_per_stream
< 0) {
3204 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3208 if (session
->kernel_session
) {
3209 ret
= record_kernel_snapshot(session
->kernel_session
,
3210 &tmp_output
, session
,
3211 wait
, nb_packets_per_stream
);
3212 if (ret
!= LTTNG_OK
) {
3217 if (session
->ust_session
) {
3218 ret
= record_ust_snapshot(session
->ust_session
,
3219 &tmp_output
, session
,
3220 wait
, nb_packets_per_stream
);
3221 if (ret
!= LTTNG_OK
) {
3226 snapshot_success
= 1;
3228 struct snapshot_output
*sout
;
3229 struct lttng_ht_iter iter
;
3232 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3233 &iter
.iter
, sout
, node
.node
) {
3234 int64_t nb_packets_per_stream
;
3237 * Make a local copy of the output and assign the possible
3238 * temporary value given by the caller.
3240 memset(&tmp_output
, 0, sizeof(tmp_output
));
3241 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3243 if (output
->max_size
!= (uint64_t) -1ULL) {
3244 tmp_output
.max_size
= output
->max_size
;
3247 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3248 tmp_output
.max_size
);
3249 if (nb_packets_per_stream
< 0) {
3250 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3255 /* Use temporary name. */
3256 if (*output
->name
!= '\0') {
3257 strncpy(tmp_output
.name
, output
->name
,
3258 sizeof(tmp_output
.name
));
3261 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3262 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3264 if (session
->kernel_session
) {
3265 ret
= record_kernel_snapshot(session
->kernel_session
,
3266 &tmp_output
, session
,
3267 wait
, nb_packets_per_stream
);
3268 if (ret
!= LTTNG_OK
) {
3274 if (session
->ust_session
) {
3275 ret
= record_ust_snapshot(session
->ust_session
,
3276 &tmp_output
, session
,
3277 wait
, nb_packets_per_stream
);
3278 if (ret
!= LTTNG_OK
) {
3283 snapshot_success
= 1;
3288 if (snapshot_success
) {
3289 session
->snapshot
.nb_snapshot
++;
3291 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3299 * Init command subsystem.
3304 * Set network sequence index to 1 for streams to match a relayd
3305 * socket on the consumer side.
3307 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3308 relayd_net_seq_idx
= 1;
3309 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3311 DBG("Command subsystem initialized");