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.
21 #include <urcu/list.h>
22 #include <urcu/uatomic.h>
24 #include <common/defaults.h>
25 #include <common/common.h>
26 #include <common/sessiond-comm/sessiond-comm.h>
27 #include <common/relayd/relayd.h>
28 #include <common/utils.h>
33 #include "health-sessiond.h"
35 #include "kernel-consumer.h"
36 #include "lttng-sessiond.h"
42 * Used to keep a unique index for each relayd socket created where this value
43 * is associated with streams on the consumer so it can match the right relayd
44 * to send to. It must be accessed with the relayd_net_seq_idx_lock
47 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
48 static uint64_t relayd_net_seq_idx
;
51 * Create a session path used by list_lttng_sessions for the case that the
52 * session consumer is on the network.
54 static int build_network_session_path(char *dst
, size_t size
,
55 struct ltt_session
*session
)
57 int ret
, kdata_port
, udata_port
;
58 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
59 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
64 memset(tmp_urls
, 0, sizeof(tmp_urls
));
65 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
67 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
69 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
70 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
71 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
74 if (session
->ust_session
&& session
->ust_session
->consumer
) {
75 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
76 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
79 if (uuri
== NULL
&& kuri
== NULL
) {
80 uri
= &session
->consumer
->dst
.net
.control
;
81 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
82 } else if (kuri
&& uuri
) {
83 ret
= uri_compare(kuri
, uuri
);
87 /* Build uuri URL string */
88 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
95 } else if (kuri
&& uuri
== NULL
) {
97 } else if (uuri
&& kuri
== NULL
) {
101 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
107 * Do we have a UST url set. If yes, this means we have both kernel and UST
110 if (*tmp_uurl
!= '\0') {
111 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
112 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
115 if (kuri
|| (!kuri
&& !uuri
)) {
118 /* No kernel URI, use the UST port. */
121 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
129 * Fill lttng_channel array of all channels.
131 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
132 struct lttng_channel
*channels
)
135 struct ltt_kernel_channel
*kchan
;
137 DBG("Listing channels for session %s", session
->name
);
140 case LTTNG_DOMAIN_KERNEL
:
141 /* Kernel channels */
142 if (session
->kernel_session
!= NULL
) {
143 cds_list_for_each_entry(kchan
,
144 &session
->kernel_session
->channel_list
.head
, list
) {
145 /* Copy lttng_channel struct to array */
146 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
147 channels
[i
].enabled
= kchan
->enabled
;
152 case LTTNG_DOMAIN_UST
:
154 struct lttng_ht_iter iter
;
155 struct ltt_ust_channel
*uchan
;
158 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
159 &iter
.iter
, uchan
, node
.node
) {
160 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
161 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
162 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
163 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
164 channels
[i
].attr
.switch_timer_interval
=
165 uchan
->attr
.switch_timer_interval
;
166 channels
[i
].attr
.read_timer_interval
=
167 uchan
->attr
.read_timer_interval
;
168 channels
[i
].enabled
= uchan
->enabled
;
169 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
170 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
171 switch (uchan
->attr
.output
) {
174 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
188 * Create a list of JUL domain events.
190 * Return number of events in list on success or else a negative value.
192 static int list_lttng_jul_events(struct jul_domain
*dom
,
193 struct lttng_event
**events
)
196 unsigned int nb_event
= 0;
197 struct jul_event
*event
;
198 struct lttng_event
*tmp_events
;
199 struct lttng_ht_iter iter
;
204 DBG3("Listing JUL events");
206 nb_event
= lttng_ht_get_count(dom
->events
);
212 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
214 PERROR("zmalloc JUL events session");
215 ret
= -LTTNG_ERR_FATAL
;
220 cds_lfht_for_each_entry(dom
->events
->ht
, &iter
.iter
, event
, node
.node
) {
221 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
222 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
223 tmp_events
[i
].enabled
= event
->enabled
;
224 tmp_events
[i
].loglevel
= event
->loglevel
;
225 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
230 *events
= tmp_events
;
234 assert(nb_event
== i
);
239 * Create a list of ust global domain events.
241 static int list_lttng_ust_global_events(char *channel_name
,
242 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
245 unsigned int nb_event
= 0;
246 struct lttng_ht_iter iter
;
247 struct lttng_ht_node_str
*node
;
248 struct ltt_ust_channel
*uchan
;
249 struct ltt_ust_event
*uevent
;
250 struct lttng_event
*tmp
;
252 DBG("Listing UST global events for channel %s", channel_name
);
256 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
257 node
= lttng_ht_iter_get_node_str(&iter
);
259 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
263 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
265 nb_event
+= lttng_ht_get_count(uchan
->events
);
272 DBG3("Listing UST global %d events", nb_event
);
274 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
276 ret
= LTTNG_ERR_FATAL
;
280 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
281 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
282 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
283 tmp
[i
].enabled
= uevent
->enabled
;
285 switch (uevent
->attr
.instrumentation
) {
286 case LTTNG_UST_TRACEPOINT
:
287 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
289 case LTTNG_UST_PROBE
:
290 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
292 case LTTNG_UST_FUNCTION
:
293 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
297 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
298 switch (uevent
->attr
.loglevel_type
) {
299 case LTTNG_UST_LOGLEVEL_ALL
:
300 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
302 case LTTNG_UST_LOGLEVEL_RANGE
:
303 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
305 case LTTNG_UST_LOGLEVEL_SINGLE
:
306 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
309 if (uevent
->filter
) {
312 if (uevent
->exclusion
) {
313 tmp
[i
].exclusion
= 1;
327 * Fill lttng_event array of all kernel events in the channel.
329 static int list_lttng_kernel_events(char *channel_name
,
330 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
333 unsigned int nb_event
;
334 struct ltt_kernel_event
*event
;
335 struct ltt_kernel_channel
*kchan
;
337 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
339 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
343 nb_event
= kchan
->event_count
;
345 DBG("Listing events for channel %s", kchan
->channel
->name
);
351 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
352 if (*events
== NULL
) {
353 ret
= LTTNG_ERR_FATAL
;
357 /* Kernel channels */
358 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
359 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
360 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
361 (*events
)[i
].enabled
= event
->enabled
;
363 switch (event
->event
->instrumentation
) {
364 case LTTNG_KERNEL_TRACEPOINT
:
365 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
367 case LTTNG_KERNEL_KRETPROBE
:
368 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
369 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
370 sizeof(struct lttng_kernel_kprobe
));
372 case LTTNG_KERNEL_KPROBE
:
373 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
374 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
375 sizeof(struct lttng_kernel_kprobe
));
377 case LTTNG_KERNEL_FUNCTION
:
378 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
379 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
380 sizeof(struct lttng_kernel_function
));
382 case LTTNG_KERNEL_NOOP
:
383 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
385 case LTTNG_KERNEL_SYSCALL
:
386 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
388 case LTTNG_KERNEL_ALL
:
399 /* Negate the error code to differentiate the size from an error */
404 * Add URI so the consumer output object. Set the correct path depending on the
405 * domain adding the default trace directory.
407 static int add_uri_to_consumer(struct consumer_output
*consumer
,
408 struct lttng_uri
*uri
, int domain
, const char *session_name
)
411 const char *default_trace_dir
;
415 if (consumer
== NULL
) {
416 DBG("No consumer detected. Don't add URI. Stopping.");
417 ret
= LTTNG_ERR_NO_CONSUMER
;
422 case LTTNG_DOMAIN_KERNEL
:
423 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
425 case LTTNG_DOMAIN_UST
:
426 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
430 * This case is possible is we try to add the URI to the global tracing
431 * session consumer object which in this case there is no subdir.
433 default_trace_dir
= "";
436 switch (uri
->dtype
) {
439 DBG2("Setting network URI to consumer");
441 if (consumer
->type
== CONSUMER_DST_NET
) {
442 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
443 consumer
->dst
.net
.control_isset
) ||
444 (uri
->stype
== LTTNG_STREAM_DATA
&&
445 consumer
->dst
.net
.data_isset
)) {
446 ret
= LTTNG_ERR_URL_EXIST
;
450 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
453 consumer
->type
= CONSUMER_DST_NET
;
455 /* Set URI into consumer output object */
456 ret
= consumer_set_network_uri(consumer
, uri
);
460 } else if (ret
== 1) {
462 * URI was the same in the consumer so we do not append the subdir
463 * again so to not duplicate output dir.
469 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
470 ret
= consumer_set_subdir(consumer
, session_name
);
472 ret
= LTTNG_ERR_FATAL
;
477 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
478 /* On a new subdir, reappend the default trace dir. */
479 strncat(consumer
->subdir
, default_trace_dir
,
480 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
481 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
486 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
487 memset(consumer
->dst
.trace_path
, 0,
488 sizeof(consumer
->dst
.trace_path
));
489 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
490 sizeof(consumer
->dst
.trace_path
));
491 /* Append default trace dir */
492 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
493 sizeof(consumer
->dst
.trace_path
) -
494 strlen(consumer
->dst
.trace_path
) - 1);
495 /* Flag consumer as local. */
496 consumer
->type
= CONSUMER_DST_LOCAL
;
507 * Init tracing by creating trace directory and sending fds kernel consumer.
509 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
512 struct lttng_ht_iter iter
;
513 struct consumer_socket
*socket
;
519 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
520 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
522 pthread_mutex_lock(socket
->lock
);
523 ret
= kernel_consumer_send_session(socket
, session
);
524 pthread_mutex_unlock(socket
->lock
);
526 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
538 * Create a socket to the relayd using the URI.
540 * On success, the relayd_sock pointer is set to the created socket.
541 * Else, it's stays untouched and a lttcomm error code is returned.
543 static int create_connect_relayd(struct lttng_uri
*uri
,
544 struct lttcomm_relayd_sock
**relayd_sock
)
547 struct lttcomm_relayd_sock
*rsock
;
549 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
550 RELAYD_VERSION_COMM_MINOR
);
552 ret
= LTTNG_ERR_FATAL
;
557 * Connect to relayd so we can proceed with a session creation. This call
558 * can possibly block for an arbitrary amount of time to set the health
559 * state to be in poll execution.
562 ret
= relayd_connect(rsock
);
565 ERR("Unable to reach lttng-relayd");
566 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
570 /* Create socket for control stream. */
571 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
572 DBG3("Creating relayd stream socket from URI");
574 /* Check relayd version */
575 ret
= relayd_version_check(rsock
);
577 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
580 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
581 DBG3("Creating relayd data socket from URI");
583 /* Command is not valid */
584 ERR("Relayd invalid stream type: %d", uri
->stype
);
585 ret
= LTTNG_ERR_INVALID
;
589 *relayd_sock
= rsock
;
594 /* The returned value is not useful since we are on an error path. */
595 (void) relayd_close(rsock
);
603 * Connect to the relayd using URI and send the socket to the right consumer.
605 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
606 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
607 struct consumer_socket
*consumer_sock
,
608 char *session_name
, char *hostname
, int session_live_timer
)
611 struct lttcomm_relayd_sock
*rsock
= NULL
;
613 /* Connect to relayd and make version check if uri is the control. */
614 ret
= create_connect_relayd(relayd_uri
, &rsock
);
615 if (ret
!= LTTNG_OK
) {
620 /* Set the network sequence index if not set. */
621 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
622 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
624 * Increment net_seq_idx because we are about to transfer the
625 * new relayd socket to the consumer.
626 * Assign unique key so the consumer can match streams.
628 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
629 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
632 /* Send relayd socket to consumer. */
633 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
634 relayd_uri
->stype
, session_id
,
635 session_name
, hostname
, session_live_timer
);
637 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
641 /* Flag that the corresponding socket was sent. */
642 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
643 consumer_sock
->control_sock_sent
= 1;
644 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
645 consumer_sock
->data_sock_sent
= 1;
651 * Close socket which was dup on the consumer side. The session daemon does
652 * NOT keep track of the relayd socket(s) once transfer to the consumer.
656 (void) relayd_close(rsock
);
660 if (ret
!= LTTNG_OK
) {
662 * The consumer output for this session should not be used anymore
663 * since the relayd connection failed thus making any tracing or/and
664 * streaming not usable.
666 consumer
->enabled
= 0;
672 * Send both relayd sockets to a specific consumer and domain. This is a
673 * helper function to facilitate sending the information to the consumer for a
676 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
677 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
678 char *session_name
, char *hostname
, int session_live_timer
)
685 /* Sending control relayd socket. */
686 if (!sock
->control_sock_sent
) {
687 ret
= send_consumer_relayd_socket(domain
, session_id
,
688 &consumer
->dst
.net
.control
, consumer
, sock
,
689 session_name
, hostname
, session_live_timer
);
690 if (ret
!= LTTNG_OK
) {
695 /* Sending data relayd socket. */
696 if (!sock
->data_sock_sent
) {
697 ret
= send_consumer_relayd_socket(domain
, session_id
,
698 &consumer
->dst
.net
.data
, consumer
, sock
,
699 session_name
, hostname
, session_live_timer
);
700 if (ret
!= LTTNG_OK
) {
710 * Setup relayd connections for a tracing session. First creates the socket to
711 * the relayd and send them to the right domain consumer. Consumer type MUST be
714 int cmd_setup_relayd(struct ltt_session
*session
)
717 struct ltt_ust_session
*usess
;
718 struct ltt_kernel_session
*ksess
;
719 struct consumer_socket
*socket
;
720 struct lttng_ht_iter iter
;
724 usess
= session
->ust_session
;
725 ksess
= session
->kernel_session
;
727 DBG("Setting relayd for session %s", session
->name
);
731 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
732 && usess
->consumer
->enabled
) {
733 /* For each consumer socket, send relayd sockets */
734 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
736 pthread_mutex_lock(socket
->lock
);
737 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
738 usess
->consumer
, socket
,
739 session
->name
, session
->hostname
,
740 session
->live_timer
);
741 pthread_mutex_unlock(socket
->lock
);
742 if (ret
!= LTTNG_OK
) {
745 /* Session is now ready for network streaming. */
746 session
->net_handle
= 1;
750 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
751 && ksess
->consumer
->enabled
) {
752 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
754 pthread_mutex_lock(socket
->lock
);
755 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
756 ksess
->consumer
, socket
,
757 session
->name
, session
->hostname
,
758 session
->live_timer
);
759 pthread_mutex_unlock(socket
->lock
);
760 if (ret
!= LTTNG_OK
) {
763 /* Session is now ready for network streaming. */
764 session
->net_handle
= 1;
774 * Start a kernel session by opening all necessary streams.
776 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
779 struct ltt_kernel_channel
*kchan
;
781 /* Open kernel metadata */
782 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
783 ret
= kernel_open_metadata(ksess
);
785 ret
= LTTNG_ERR_KERN_META_FAIL
;
790 /* Open kernel metadata stream */
791 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
792 ret
= kernel_open_metadata_stream(ksess
);
794 ERR("Kernel create metadata stream failed");
795 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
800 /* For each channel */
801 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
802 if (kchan
->stream_count
== 0) {
803 ret
= kernel_open_channel_stream(kchan
);
805 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
808 /* Update the stream global counter */
809 ksess
->stream_count_global
+= ret
;
813 /* Setup kernel consumer socket and send fds to it */
814 ret
= init_kernel_tracing(ksess
);
816 ret
= LTTNG_ERR_KERN_START_FAIL
;
820 /* This start the kernel tracing */
821 ret
= kernel_start_session(ksess
);
823 ret
= LTTNG_ERR_KERN_START_FAIL
;
827 /* Quiescent wait after starting trace */
828 kernel_wait_quiescent(kernel_tracer_fd
);
839 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
841 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
845 struct ltt_ust_session
*usess
;
847 usess
= session
->ust_session
;
852 case LTTNG_DOMAIN_KERNEL
:
854 ret
= channel_kernel_disable(session
->kernel_session
,
856 if (ret
!= LTTNG_OK
) {
860 kernel_wait_quiescent(kernel_tracer_fd
);
863 case LTTNG_DOMAIN_UST
:
865 struct ltt_ust_channel
*uchan
;
866 struct lttng_ht
*chan_ht
;
868 chan_ht
= usess
->domain_global
.channels
;
870 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
872 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
876 ret
= channel_ust_disable(usess
, uchan
);
877 if (ret
!= LTTNG_OK
) {
883 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
884 case LTTNG_DOMAIN_UST_EXEC_NAME
:
885 case LTTNG_DOMAIN_UST_PID
:
888 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
900 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
902 * The wpipe arguments is used as a notifier for the kernel thread.
904 int cmd_enable_channel(struct ltt_session
*session
,
905 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
908 struct ltt_ust_session
*usess
= session
->ust_session
;
909 struct lttng_ht
*chan_ht
;
915 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
920 * Don't try to enable a channel if the session has been started at
921 * some point in time before. The tracer does not allow it.
923 if (session
->has_been_started
) {
924 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
929 * If the session is a live session, remove the switch timer, the
930 * live timer does the same thing but sends also synchronisation
931 * beacons for inactive streams.
933 if (session
->live_timer
> 0) {
934 attr
->attr
.live_timer_interval
= session
->live_timer
;
935 attr
->attr
.switch_timer_interval
= 0;
939 * The ringbuffer (both in user space and kernel) behave badly in overwrite
940 * mode and with less than 2 subbuf so block it right away and send back an
941 * invalid attribute error.
943 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
944 ret
= LTTNG_ERR_INVALID
;
948 switch (domain
->type
) {
949 case LTTNG_DOMAIN_KERNEL
:
951 struct ltt_kernel_channel
*kchan
;
953 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
954 session
->kernel_session
);
956 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
957 if (attr
->name
[0] != '\0') {
958 session
->kernel_session
->has_non_default_channel
= 1;
961 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
964 if (ret
!= LTTNG_OK
) {
968 kernel_wait_quiescent(kernel_tracer_fd
);
971 case LTTNG_DOMAIN_UST
:
973 struct ltt_ust_channel
*uchan
;
975 chan_ht
= usess
->domain_global
.channels
;
977 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
979 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
980 if (attr
->name
[0] != '\0') {
981 usess
->has_non_default_channel
= 1;
984 ret
= channel_ust_enable(usess
, uchan
);
989 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1000 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1002 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1003 char *channel_name
, char *event_name
)
1010 case LTTNG_DOMAIN_KERNEL
:
1012 struct ltt_kernel_channel
*kchan
;
1013 struct ltt_kernel_session
*ksess
;
1015 ksess
= session
->kernel_session
;
1018 * If a non-default channel has been created in the
1019 * session, explicitely require that -c chan_name needs
1022 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1023 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1027 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1028 if (kchan
== NULL
) {
1029 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1033 ret
= event_kernel_disable_tracepoint(kchan
, event_name
);
1034 if (ret
!= LTTNG_OK
) {
1038 kernel_wait_quiescent(kernel_tracer_fd
);
1041 case LTTNG_DOMAIN_UST
:
1043 struct ltt_ust_channel
*uchan
;
1044 struct ltt_ust_session
*usess
;
1046 usess
= session
->ust_session
;
1049 * If a non-default channel has been created in the
1050 * session, explicitely require that -c chan_name needs
1053 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1054 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1058 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1060 if (uchan
== NULL
) {
1061 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1065 ret
= event_ust_disable_tracepoint(usess
, uchan
, event_name
);
1066 if (ret
!= LTTNG_OK
) {
1070 DBG3("Disable UST event %s in channel %s completed", event_name
,
1074 case LTTNG_DOMAIN_JUL
:
1076 struct ltt_ust_session
*usess
= session
->ust_session
;
1080 ret
= event_jul_disable(usess
, event_name
);
1081 if (ret
!= LTTNG_OK
) {
1088 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1089 case LTTNG_DOMAIN_UST_PID
:
1090 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1093 ret
= LTTNG_ERR_UND
;
1105 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
1107 int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
1115 case LTTNG_DOMAIN_KERNEL
:
1117 struct ltt_kernel_session
*ksess
;
1118 struct ltt_kernel_channel
*kchan
;
1120 ksess
= session
->kernel_session
;
1123 * If a non-default channel has been created in the
1124 * session, explicitely require that -c chan_name needs
1127 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1128 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1132 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1133 if (kchan
== NULL
) {
1134 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1138 ret
= event_kernel_disable_all(kchan
);
1139 if (ret
!= LTTNG_OK
) {
1143 kernel_wait_quiescent(kernel_tracer_fd
);
1146 case LTTNG_DOMAIN_UST
:
1148 struct ltt_ust_session
*usess
;
1149 struct ltt_ust_channel
*uchan
;
1151 usess
= session
->ust_session
;
1154 * If a non-default channel has been created in the
1155 * session, explicitely require that -c chan_name needs
1158 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1159 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1163 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1165 if (uchan
== NULL
) {
1166 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1170 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1175 DBG3("Disable all UST events in channel %s completed", channel_name
);
1179 case LTTNG_DOMAIN_JUL
:
1181 struct ltt_ust_session
*usess
= session
->ust_session
;
1185 ret
= event_jul_disable_all(usess
);
1186 if (ret
!= LTTNG_OK
) {
1193 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1194 case LTTNG_DOMAIN_UST_PID
:
1195 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1198 ret
= LTTNG_ERR_UND
;
1210 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1212 int cmd_add_context(struct ltt_session
*session
, int domain
,
1213 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1215 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1218 case LTTNG_DOMAIN_KERNEL
:
1219 assert(session
->kernel_session
);
1221 if (session
->kernel_session
->channel_count
== 0) {
1222 /* Create default channel */
1223 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1224 if (ret
!= LTTNG_OK
) {
1227 chan_kern_created
= 1;
1229 /* Add kernel context to kernel tracer */
1230 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1231 if (ret
!= LTTNG_OK
) {
1235 case LTTNG_DOMAIN_UST
:
1237 struct ltt_ust_session
*usess
= session
->ust_session
;
1238 unsigned int chan_count
;
1242 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1243 if (chan_count
== 0) {
1244 struct lttng_channel
*attr
;
1245 /* Create default channel */
1246 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1248 ret
= LTTNG_ERR_FATAL
;
1252 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1253 if (ret
!= LTTNG_OK
) {
1258 chan_ust_created
= 1;
1261 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1262 if (ret
!= LTTNG_OK
) {
1268 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1269 case LTTNG_DOMAIN_UST_PID
:
1270 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1273 ret
= LTTNG_ERR_UND
;
1280 if (chan_kern_created
) {
1281 struct ltt_kernel_channel
*kchan
=
1282 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1283 session
->kernel_session
);
1284 /* Created previously, this should NOT fail. */
1286 kernel_destroy_channel(kchan
);
1289 if (chan_ust_created
) {
1290 struct ltt_ust_channel
*uchan
=
1291 trace_ust_find_channel_by_name(
1292 session
->ust_session
->domain_global
.channels
,
1293 DEFAULT_CHANNEL_NAME
);
1294 /* Created previously, this should NOT fail. */
1296 /* Remove from the channel list of the session. */
1297 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1299 trace_ust_destroy_channel(uchan
);
1305 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1306 * We own filter, exclusion, and filter_expression.
1308 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1309 char *channel_name
, struct lttng_event
*event
,
1310 char *filter_expression
,
1311 struct lttng_filter_bytecode
*filter
,
1312 struct lttng_event_exclusion
*exclusion
,
1315 int ret
, channel_created
= 0;
1316 struct lttng_channel
*attr
;
1320 assert(channel_name
);
1324 switch (domain
->type
) {
1325 case LTTNG_DOMAIN_KERNEL
:
1327 struct ltt_kernel_channel
*kchan
;
1330 * If a non-default channel has been created in the
1331 * session, explicitely require that -c chan_name needs
1334 if (session
->kernel_session
->has_non_default_channel
1335 && channel_name
[0] == '\0') {
1336 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1340 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1341 session
->kernel_session
);
1342 if (kchan
== NULL
) {
1343 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1344 LTTNG_BUFFER_GLOBAL
);
1346 ret
= LTTNG_ERR_FATAL
;
1349 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1351 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1352 if (ret
!= LTTNG_OK
) {
1358 channel_created
= 1;
1361 /* Get the newly created kernel channel pointer */
1362 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1363 session
->kernel_session
);
1364 if (kchan
== NULL
) {
1365 /* This sould not happen... */
1366 ret
= LTTNG_ERR_FATAL
;
1370 ret
= event_kernel_enable_tracepoint(kchan
, event
);
1371 if (ret
!= LTTNG_OK
) {
1372 if (channel_created
) {
1373 /* Let's not leak a useless channel. */
1374 kernel_destroy_channel(kchan
);
1379 kernel_wait_quiescent(kernel_tracer_fd
);
1382 case LTTNG_DOMAIN_UST
:
1384 struct ltt_ust_channel
*uchan
;
1385 struct ltt_ust_session
*usess
= session
->ust_session
;
1390 * If a non-default channel has been created in the
1391 * session, explicitely require that -c chan_name needs
1394 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1395 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1399 /* Get channel from global UST domain */
1400 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1402 if (uchan
== NULL
) {
1403 /* Create default channel */
1404 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1405 usess
->buffer_type
);
1407 ret
= LTTNG_ERR_FATAL
;
1410 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1412 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1413 if (ret
!= LTTNG_OK
) {
1419 /* Get the newly created channel reference back */
1420 uchan
= trace_ust_find_channel_by_name(
1421 usess
->domain_global
.channels
, channel_name
);
1425 /* At this point, the session and channel exist on the tracer */
1426 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1427 filter_expression
, filter
, exclusion
);
1428 /* We have passed ownership */
1429 filter_expression
= NULL
;
1432 if (ret
!= LTTNG_OK
) {
1437 case LTTNG_DOMAIN_JUL
:
1439 struct lttng_event uevent
;
1440 struct lttng_domain tmp_dom
;
1441 struct ltt_ust_session
*usess
= session
->ust_session
;
1445 /* Create the default JUL tracepoint. */
1446 memset(&uevent
, 0, sizeof(uevent
));
1447 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1448 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1450 strncpy(uevent
.name
, DEFAULT_SYS_JUL_EVENT_NAME
,
1451 sizeof(uevent
.name
));
1453 strncpy(uevent
.name
, DEFAULT_USER_JUL_EVENT_NAME
,
1454 sizeof(uevent
.name
));
1456 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1459 * The domain type is changed because we are about to enable the
1460 * default channel and event for the JUL domain that are hardcoded.
1461 * This happens in the UST domain.
1463 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1464 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1466 ret
= cmd_enable_event(session
, &tmp_dom
, DEFAULT_JUL_CHANNEL_NAME
,
1467 &uevent
, filter_expression
, filter
, NULL
, wpipe
);
1468 /* We have passed ownership */
1469 filter_expression
= NULL
;
1471 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1475 /* The wild card * means that everything should be enabled. */
1476 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1477 ret
= event_jul_enable_all(usess
, event
, filter
);
1479 ret
= event_jul_enable(usess
, event
, filter
);
1481 if (ret
!= LTTNG_OK
) {
1488 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1489 case LTTNG_DOMAIN_UST_PID
:
1490 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1493 ret
= LTTNG_ERR_UND
;
1500 free(filter_expression
);
1508 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
1510 int cmd_enable_event_all(struct ltt_session
*session
,
1511 struct lttng_domain
*domain
, char *channel_name
, int event_type
,
1512 char *filter_expression
,
1513 struct lttng_filter_bytecode
*filter
, int wpipe
)
1516 struct lttng_channel
*attr
;
1519 assert(channel_name
);
1523 switch (domain
->type
) {
1524 case LTTNG_DOMAIN_KERNEL
:
1526 struct ltt_kernel_channel
*kchan
;
1528 assert(session
->kernel_session
);
1531 * If a non-default channel has been created in the
1532 * session, explicitely require that -c chan_name needs
1535 if (session
->kernel_session
->has_non_default_channel
1536 && channel_name
[0] == '\0') {
1537 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1541 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1542 session
->kernel_session
);
1543 if (kchan
== NULL
) {
1544 /* Create default channel */
1545 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1546 LTTNG_BUFFER_GLOBAL
);
1548 ret
= LTTNG_ERR_FATAL
;
1551 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1553 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1554 if (ret
!= LTTNG_OK
) {
1560 /* Get the newly created kernel channel pointer */
1561 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1562 session
->kernel_session
);
1566 switch (event_type
) {
1567 case LTTNG_EVENT_SYSCALL
:
1568 ret
= event_kernel_enable_all_syscalls(kchan
, kernel_tracer_fd
);
1570 case LTTNG_EVENT_TRACEPOINT
:
1572 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
1573 * events already registered to the channel.
1575 ret
= event_kernel_enable_all_tracepoints(kchan
, kernel_tracer_fd
);
1577 case LTTNG_EVENT_ALL
:
1578 /* Enable syscalls and tracepoints */
1579 ret
= event_kernel_enable_all(kchan
, kernel_tracer_fd
);
1582 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
1586 /* Manage return value */
1587 if (ret
!= LTTNG_OK
) {
1589 * On error, cmd_enable_channel call will take care of destroying
1590 * the created channel if it was needed.
1595 kernel_wait_quiescent(kernel_tracer_fd
);
1598 case LTTNG_DOMAIN_UST
:
1600 struct ltt_ust_channel
*uchan
;
1601 struct ltt_ust_session
*usess
= session
->ust_session
;
1606 * If a non-default channel has been created in the
1607 * session, explicitely require that -c chan_name needs
1610 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1611 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1615 /* Get channel from global UST domain */
1616 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1618 if (uchan
== NULL
) {
1619 /* Create default channel */
1620 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1621 usess
->buffer_type
);
1623 ret
= LTTNG_ERR_FATAL
;
1626 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1628 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1629 if (ret
!= LTTNG_OK
) {
1635 /* Get the newly created channel reference back */
1636 uchan
= trace_ust_find_channel_by_name(
1637 usess
->domain_global
.channels
, channel_name
);
1641 /* At this point, the session and channel exist on the tracer */
1643 switch (event_type
) {
1644 case LTTNG_EVENT_ALL
:
1645 case LTTNG_EVENT_TRACEPOINT
:
1646 ret
= event_ust_enable_all_tracepoints(usess
, uchan
,
1647 filter_expression
, filter
);
1648 if (ret
!= LTTNG_OK
) {
1653 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
1657 /* Manage return value */
1658 if (ret
!= LTTNG_OK
) {
1664 case LTTNG_DOMAIN_JUL
:
1666 struct lttng_event uevent
, event
;
1667 struct lttng_domain tmp_dom
;
1668 struct ltt_ust_session
*usess
= session
->ust_session
;
1672 /* Create the default JUL tracepoint. */
1673 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1674 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1676 strncpy(uevent
.name
, DEFAULT_SYS_JUL_EVENT_NAME
,
1677 sizeof(uevent
.name
));
1679 strncpy(uevent
.name
, DEFAULT_USER_JUL_EVENT_NAME
,
1680 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 ret
= cmd_enable_event(session
, &tmp_dom
, DEFAULT_JUL_CHANNEL_NAME
,
1693 &uevent
, NULL
, NULL
, NULL
, wpipe
);
1694 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1698 event
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
1699 event
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1700 strncpy(event
.name
, "*", sizeof(event
.name
));
1701 event
.name
[sizeof(event
.name
) - 1] = '\0';
1703 ret
= event_jul_enable_all(usess
, &event
, filter
);
1704 if (ret
!= LTTNG_OK
) {
1711 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1712 case LTTNG_DOMAIN_UST_PID
:
1713 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1716 ret
= LTTNG_ERR_UND
;
1729 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1731 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1734 ssize_t nb_events
= 0;
1737 case LTTNG_DOMAIN_KERNEL
:
1738 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1739 if (nb_events
< 0) {
1740 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1744 case LTTNG_DOMAIN_UST
:
1745 nb_events
= ust_app_list_events(events
);
1746 if (nb_events
< 0) {
1747 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1751 case LTTNG_DOMAIN_JUL
:
1752 nb_events
= jul_list_events(events
);
1753 if (nb_events
< 0) {
1754 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1759 ret
= LTTNG_ERR_UND
;
1766 /* Return negative value to differentiate return code */
1771 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1773 ssize_t
cmd_list_tracepoint_fields(int domain
,
1774 struct lttng_event_field
**fields
)
1777 ssize_t nb_fields
= 0;
1780 case LTTNG_DOMAIN_UST
:
1781 nb_fields
= ust_app_list_event_fields(fields
);
1782 if (nb_fields
< 0) {
1783 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1787 case LTTNG_DOMAIN_KERNEL
:
1788 default: /* fall-through */
1789 ret
= LTTNG_ERR_UND
;
1796 /* Return negative value to differentiate return code */
1801 * Command LTTNG_START_TRACE processed by the client thread.
1803 int cmd_start_trace(struct ltt_session
*session
)
1806 unsigned long nb_chan
= 0;
1807 struct ltt_kernel_session
*ksession
;
1808 struct ltt_ust_session
*usess
;
1812 /* Ease our life a bit ;) */
1813 ksession
= session
->kernel_session
;
1814 usess
= session
->ust_session
;
1816 /* Is the session already started? */
1817 if (session
->active
) {
1818 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1823 * Starting a session without channel is useless since after that it's not
1824 * possible to enable channel thus inform the client.
1826 if (usess
&& usess
->domain_global
.channels
) {
1828 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
1832 nb_chan
+= ksession
->channel_count
;
1835 ret
= LTTNG_ERR_NO_CHANNEL
;
1839 /* Kernel tracing */
1840 if (ksession
!= NULL
) {
1841 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
1842 if (ret
!= LTTNG_OK
) {
1847 /* Flag session that trace should start automatically */
1850 * Even though the start trace might fail, flag this session active so
1851 * other application coming in are started by default.
1855 ret
= ust_app_start_trace_all(usess
);
1857 ret
= LTTNG_ERR_UST_START_FAIL
;
1862 /* Flag this after a successful start. */
1863 session
->has_been_started
= 1;
1864 session
->active
= 1;
1873 * Command LTTNG_STOP_TRACE processed by the client thread.
1875 int cmd_stop_trace(struct ltt_session
*session
)
1878 struct ltt_kernel_channel
*kchan
;
1879 struct ltt_kernel_session
*ksession
;
1880 struct ltt_ust_session
*usess
;
1885 ksession
= session
->kernel_session
;
1886 usess
= session
->ust_session
;
1888 /* Session is not active. Skip everythong and inform the client. */
1889 if (!session
->active
) {
1890 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
1895 if (ksession
&& ksession
->active
) {
1896 DBG("Stop kernel tracing");
1898 /* Flush metadata if exist */
1899 if (ksession
->metadata_stream_fd
>= 0) {
1900 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
1902 ERR("Kernel metadata flush failed");
1906 /* Flush all buffers before stopping */
1907 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
1908 ret
= kernel_flush_buffer(kchan
);
1910 ERR("Kernel flush buffer error");
1914 ret
= kernel_stop_session(ksession
);
1916 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1920 kernel_wait_quiescent(kernel_tracer_fd
);
1922 ksession
->active
= 0;
1925 if (usess
&& usess
->active
) {
1927 * Even though the stop trace might fail, flag this session inactive so
1928 * other application coming in are not started by default.
1932 ret
= ust_app_stop_trace_all(usess
);
1934 ret
= LTTNG_ERR_UST_STOP_FAIL
;
1939 /* Flag inactive after a successful stop. */
1940 session
->active
= 0;
1948 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
1950 int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
1951 size_t nb_uri
, struct lttng_uri
*uris
)
1954 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
1955 struct ltt_ust_session
*usess
= session
->ust_session
;
1956 struct consumer_output
*consumer
= NULL
;
1962 /* Can't set consumer URI if the session is active. */
1963 if (session
->active
) {
1964 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1969 * This case switch makes sure the domain session has a temporary consumer
1970 * so the URL can be set.
1974 /* Code flow error. A session MUST always have a consumer object */
1975 assert(session
->consumer
);
1977 * The URL will be added to the tracing session consumer instead of a
1978 * specific domain consumer.
1980 consumer
= session
->consumer
;
1982 case LTTNG_DOMAIN_KERNEL
:
1983 /* Code flow error if we don't have a kernel session here. */
1985 assert(ksess
->consumer
);
1986 consumer
= ksess
->consumer
;
1988 case LTTNG_DOMAIN_UST
:
1989 /* Code flow error if we don't have a kernel session here. */
1991 assert(usess
->consumer
);
1992 consumer
= usess
->consumer
;
1996 for (i
= 0; i
< nb_uri
; i
++) {
1997 ret
= add_uri_to_consumer(consumer
, &uris
[i
], domain
, session
->name
);
1998 if (ret
!= LTTNG_OK
) {
2004 * Make sure to set the session in output mode after we set URI since a
2005 * session can be created without URL (thus flagged in no output mode).
2007 session
->output_traces
= 1;
2009 ksess
->output_traces
= 1;
2011 usess
->output_traces
= 1;
2022 * Command LTTNG_CREATE_SESSION processed by the client thread.
2024 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2025 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2028 struct ltt_session
*session
;
2034 * Verify if the session already exist
2036 * XXX: There is no need for the session lock list here since the caller
2037 * (process_client_msg) is holding it. We might want to change that so a
2038 * single command does not lock the entire session list.
2040 session
= session_find_by_name(name
);
2041 if (session
!= NULL
) {
2042 ret
= LTTNG_ERR_EXIST_SESS
;
2046 /* Create tracing session in the registry */
2047 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2048 LTTNG_SOCK_GET_GID_CRED(creds
));
2049 if (ret
!= LTTNG_OK
) {
2054 * Get the newly created session pointer back
2056 * XXX: There is no need for the session lock list here since the caller
2057 * (process_client_msg) is holding it. We might want to change that so a
2058 * single command does not lock the entire session list.
2060 session
= session_find_by_name(name
);
2063 session
->live_timer
= live_timer
;
2064 /* Create default consumer output for the session not yet created. */
2065 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2066 if (session
->consumer
== NULL
) {
2067 ret
= LTTNG_ERR_FATAL
;
2068 goto consumer_error
;
2072 ret
= cmd_set_consumer_uri(0, session
, nb_uri
, uris
);
2073 if (ret
!= LTTNG_OK
) {
2074 goto consumer_error
;
2076 session
->output_traces
= 1;
2078 session
->output_traces
= 0;
2079 DBG2("Session %s created with no output", session
->name
);
2082 session
->consumer
->enabled
= 1;
2087 session_destroy(session
);
2094 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2096 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2097 size_t nb_uri
, lttng_sock_cred
*creds
)
2100 struct ltt_session
*session
;
2101 struct snapshot_output
*new_output
= NULL
;
2107 * Create session in no output mode with URIs set to NULL. The uris we've
2108 * received are for a default snapshot output if one.
2110 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2111 if (ret
!= LTTNG_OK
) {
2115 /* Get the newly created session pointer back. This should NEVER fail. */
2116 session
= session_find_by_name(name
);
2119 /* Flag session for snapshot mode. */
2120 session
->snapshot_mode
= 1;
2122 /* Skip snapshot output creation if no URI is given. */
2127 new_output
= snapshot_output_alloc();
2129 ret
= LTTNG_ERR_NOMEM
;
2130 goto error_snapshot_alloc
;
2133 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2134 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2136 if (ret
== -ENOMEM
) {
2137 ret
= LTTNG_ERR_NOMEM
;
2139 ret
= LTTNG_ERR_INVALID
;
2141 goto error_snapshot
;
2145 snapshot_add_output(&session
->snapshot
, new_output
);
2152 snapshot_output_destroy(new_output
);
2153 error_snapshot_alloc
:
2154 session_destroy(session
);
2160 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2162 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2165 struct ltt_ust_session
*usess
;
2166 struct ltt_kernel_session
*ksess
;
2171 usess
= session
->ust_session
;
2172 ksess
= session
->kernel_session
;
2174 /* Clean kernel session teardown */
2175 kernel_destroy_session(ksess
);
2177 /* UST session teardown */
2179 /* Close any relayd session */
2180 consumer_output_send_destroy_relayd(usess
->consumer
);
2182 /* Destroy every UST application related to this session. */
2183 ret
= ust_app_destroy_trace_all(usess
);
2185 ERR("Error in ust_app_destroy_trace_all");
2188 /* Clean up the rest. */
2189 trace_ust_destroy_session(usess
);
2193 * Must notify the kernel thread here to update it's poll set in order to
2194 * remove the channel(s)' fd just destroyed.
2196 ret
= notify_thread_pipe(wpipe
);
2198 PERROR("write kernel poll pipe");
2201 ret
= session_destroy(session
);
2207 * Command LTTNG_CALIBRATE processed by the client thread.
2209 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2214 case LTTNG_DOMAIN_KERNEL
:
2216 struct lttng_kernel_calibrate kcalibrate
;
2218 switch (calibrate
->type
) {
2219 case LTTNG_CALIBRATE_FUNCTION
:
2221 /* Default and only possible calibrate option. */
2222 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2226 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2228 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2233 case LTTNG_DOMAIN_UST
:
2235 struct lttng_ust_calibrate ucalibrate
;
2237 switch (calibrate
->type
) {
2238 case LTTNG_CALIBRATE_FUNCTION
:
2240 /* Default and only possible calibrate option. */
2241 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2245 ret
= ust_app_calibrate_glb(&ucalibrate
);
2247 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2253 ret
= LTTNG_ERR_UND
;
2264 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2266 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2267 const char *sock_path
, struct consumer_data
*cdata
)
2270 struct consumer_socket
*socket
= NULL
;
2277 case LTTNG_DOMAIN_KERNEL
:
2279 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2283 /* Can't register a consumer if there is already one */
2284 if (ksess
->consumer_fds_sent
!= 0) {
2285 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2289 sock
= lttcomm_connect_unix_sock(sock_path
);
2291 ret
= LTTNG_ERR_CONNECT_FAIL
;
2294 cdata
->cmd_sock
= sock
;
2296 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2297 if (socket
== NULL
) {
2300 PERROR("close register consumer");
2302 cdata
->cmd_sock
= -1;
2303 ret
= LTTNG_ERR_FATAL
;
2307 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2308 if (socket
->lock
== NULL
) {
2309 PERROR("zmalloc pthread mutex");
2310 ret
= LTTNG_ERR_FATAL
;
2313 pthread_mutex_init(socket
->lock
, NULL
);
2314 socket
->registered
= 1;
2317 consumer_add_socket(socket
, ksess
->consumer
);
2320 pthread_mutex_lock(&cdata
->pid_mutex
);
2322 pthread_mutex_unlock(&cdata
->pid_mutex
);
2327 /* TODO: Userspace tracing */
2328 ret
= LTTNG_ERR_UND
;
2336 consumer_destroy_socket(socket
);
2342 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2344 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2345 struct lttng_domain
**domains
)
2350 if (session
->kernel_session
!= NULL
) {
2351 DBG3("Listing domains found kernel domain");
2355 if (session
->ust_session
!= NULL
) {
2356 DBG3("Listing domains found UST global domain");
2359 if (session
->ust_session
->domain_jul
.being_used
) {
2364 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2365 if (*domains
== NULL
) {
2366 ret
= LTTNG_ERR_FATAL
;
2370 if (session
->kernel_session
!= NULL
) {
2371 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2375 if (session
->ust_session
!= NULL
) {
2376 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2377 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2380 if (session
->ust_session
->domain_jul
.being_used
) {
2381 (*domains
)[index
].type
= LTTNG_DOMAIN_JUL
;
2382 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2390 /* Return negative value to differentiate return code */
2396 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2398 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2399 struct lttng_channel
**channels
)
2402 ssize_t nb_chan
= 0;
2405 case LTTNG_DOMAIN_KERNEL
:
2406 if (session
->kernel_session
!= NULL
) {
2407 nb_chan
= session
->kernel_session
->channel_count
;
2409 DBG3("Number of kernel channels %zd", nb_chan
);
2411 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2414 case LTTNG_DOMAIN_UST
:
2415 if (session
->ust_session
!= NULL
) {
2417 nb_chan
= lttng_ht_get_count(
2418 session
->ust_session
->domain_global
.channels
);
2421 DBG3("Number of UST global channels %zd", nb_chan
);
2423 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2428 ret
= LTTNG_ERR_UND
;
2433 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2434 if (*channels
== NULL
) {
2435 ret
= LTTNG_ERR_FATAL
;
2439 list_lttng_channels(domain
, session
, *channels
);
2445 /* Return negative value to differentiate return code */
2450 * Command LTTNG_LIST_EVENTS processed by the client thread.
2452 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2453 char *channel_name
, struct lttng_event
**events
)
2456 ssize_t nb_event
= 0;
2459 case LTTNG_DOMAIN_KERNEL
:
2460 if (session
->kernel_session
!= NULL
) {
2461 nb_event
= list_lttng_kernel_events(channel_name
,
2462 session
->kernel_session
, events
);
2465 case LTTNG_DOMAIN_UST
:
2467 if (session
->ust_session
!= NULL
) {
2468 nb_event
= list_lttng_ust_global_events(channel_name
,
2469 &session
->ust_session
->domain_global
, events
);
2473 case LTTNG_DOMAIN_JUL
:
2474 if (session
->ust_session
) {
2475 nb_event
= list_lttng_jul_events(
2476 &session
->ust_session
->domain_jul
, events
);
2480 ret
= LTTNG_ERR_UND
;
2487 /* Return negative value to differentiate return code */
2492 * Using the session list, filled a lttng_session array to send back to the
2493 * client for session listing.
2495 * The session list lock MUST be acquired before calling this function. Use
2496 * session_lock_list() and session_unlock_list().
2498 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2503 struct ltt_session
*session
;
2504 struct ltt_session_list
*list
= session_get_list();
2506 DBG("Getting all available session for UID %d GID %d",
2509 * Iterate over session list and append data after the control struct in
2512 cds_list_for_each_entry(session
, &list
->head
, list
) {
2514 * Only list the sessions the user can control.
2516 if (!session_access_ok(session
, uid
, gid
)) {
2520 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2521 struct ltt_ust_session
*usess
= session
->ust_session
;
2523 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2524 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2525 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2526 ret
= build_network_session_path(sessions
[i
].path
,
2527 sizeof(sessions
[i
].path
), session
);
2529 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2530 session
->consumer
->dst
.trace_path
);
2533 PERROR("snprintf session path");
2537 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2538 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2539 sessions
[i
].enabled
= session
->active
;
2540 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2541 sessions
[i
].live_timer_interval
= session
->live_timer
;
2547 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2548 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2550 int cmd_data_pending(struct ltt_session
*session
)
2553 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2554 struct ltt_ust_session
*usess
= session
->ust_session
;
2558 /* Session MUST be stopped to ask for data availability. */
2559 if (session
->active
) {
2560 ret
= LTTNG_ERR_SESSION_STARTED
;
2564 * If stopped, just make sure we've started before else the above call
2565 * will always send that there is data pending.
2567 * The consumer assumes that when the data pending command is received,
2568 * the trace has been started before or else no output data is written
2569 * by the streams which is a condition for data pending. So, this is
2570 * *VERY* important that we don't ask the consumer before a start
2573 if (!session
->has_been_started
) {
2579 if (ksess
&& ksess
->consumer
) {
2580 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2582 /* Data is still being extracted for the kernel. */
2587 if (usess
&& usess
->consumer
) {
2588 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2590 /* Data is still being extracted for the kernel. */
2595 /* Data is ready to be read by a viewer */
2603 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2605 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2607 int cmd_snapshot_add_output(struct ltt_session
*session
,
2608 struct lttng_snapshot_output
*output
, uint32_t *id
)
2611 struct snapshot_output
*new_output
;
2616 DBG("Cmd snapshot add output for session %s", session
->name
);
2619 * Permission denied to create an output if the session is not
2620 * set in no output mode.
2622 if (session
->output_traces
) {
2623 ret
= LTTNG_ERR_EPERM
;
2627 /* Only one output is allowed until we have the "tee" feature. */
2628 if (session
->snapshot
.nb_output
== 1) {
2629 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2633 new_output
= snapshot_output_alloc();
2635 ret
= LTTNG_ERR_NOMEM
;
2639 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2640 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2641 &session
->snapshot
);
2643 if (ret
== -ENOMEM
) {
2644 ret
= LTTNG_ERR_NOMEM
;
2646 ret
= LTTNG_ERR_INVALID
;
2652 snapshot_add_output(&session
->snapshot
, new_output
);
2654 *id
= new_output
->id
;
2661 snapshot_output_destroy(new_output
);
2667 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2669 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2671 int cmd_snapshot_del_output(struct ltt_session
*session
,
2672 struct lttng_snapshot_output
*output
)
2675 struct snapshot_output
*sout
= NULL
;
2683 * Permission denied to create an output if the session is not
2684 * set in no output mode.
2686 if (session
->output_traces
) {
2687 ret
= LTTNG_ERR_EPERM
;
2692 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2694 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2695 } else if (*output
->name
!= '\0') {
2696 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2698 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2701 ret
= LTTNG_ERR_INVALID
;
2705 snapshot_delete_output(&session
->snapshot
, sout
);
2706 snapshot_output_destroy(sout
);
2715 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2717 * If no output is available, outputs is untouched and 0 is returned.
2719 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2721 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2722 struct lttng_snapshot_output
**outputs
)
2725 struct lttng_snapshot_output
*list
= NULL
;
2726 struct lttng_ht_iter iter
;
2727 struct snapshot_output
*output
;
2732 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2735 * Permission denied to create an output if the session is not
2736 * set in no output mode.
2738 if (session
->output_traces
) {
2739 ret
= -LTTNG_ERR_EPERM
;
2743 if (session
->snapshot
.nb_output
== 0) {
2748 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2750 ret
= -LTTNG_ERR_NOMEM
;
2754 /* Copy list from session to the new list object. */
2756 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2757 output
, node
.node
) {
2758 assert(output
->consumer
);
2759 list
[idx
].id
= output
->id
;
2760 list
[idx
].max_size
= output
->max_size
;
2761 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2762 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2763 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2764 sizeof(list
[idx
].ctrl_url
));
2767 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2768 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2770 ret
= -LTTNG_ERR_NOMEM
;
2775 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
2776 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
2778 ret
= -LTTNG_ERR_NOMEM
;
2787 ret
= session
->snapshot
.nb_output
;
2795 * Send relayd sockets from snapshot output to consumer. Ignore request if the
2796 * snapshot output is *not* set with a remote destination.
2798 * Return 0 on success or a LTTNG_ERR code.
2800 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
2801 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
2804 struct lttng_ht_iter iter
;
2805 struct consumer_socket
*socket
;
2808 assert(snap_output
);
2811 DBG2("Set relayd object from snapshot output");
2813 /* Ignore if snapshot consumer output is not network. */
2814 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
2819 * For each consumer socket, create and send the relayd object of the
2823 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
2824 socket
, node
.node
) {
2825 ret
= send_consumer_relayd_sockets(0, session
->id
,
2826 snap_output
->consumer
, socket
,
2827 session
->name
, session
->hostname
,
2828 session
->live_timer
);
2829 if (ret
!= LTTNG_OK
) {
2841 * Record a kernel snapshot.
2843 * Return LTTNG_OK on success or a LTTNG_ERR code.
2845 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
2846 struct snapshot_output
*output
, struct ltt_session
*session
,
2847 int wait
, uint64_t max_stream_size
)
2855 /* Get the datetime for the snapshot output directory. */
2856 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
2857 sizeof(output
->datetime
));
2859 ret
= LTTNG_ERR_INVALID
;
2864 * Copy kernel session sockets so we can communicate with the right
2865 * consumer for the snapshot record command.
2867 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
2869 ret
= LTTNG_ERR_NOMEM
;
2873 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
2874 if (ret
!= LTTNG_OK
) {
2875 goto error_snapshot
;
2878 ret
= kernel_snapshot_record(ksess
, output
, wait
, max_stream_size
);
2879 if (ret
!= LTTNG_OK
) {
2880 goto error_snapshot
;
2886 /* Clean up copied sockets so this output can use some other later on. */
2887 consumer_destroy_output_sockets(output
->consumer
);
2893 * Record a UST snapshot.
2895 * Return 0 on success or a LTTNG_ERR error code.
2897 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
2898 struct snapshot_output
*output
, struct ltt_session
*session
,
2899 int wait
, uint64_t max_stream_size
)
2907 /* Get the datetime for the snapshot output directory. */
2908 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
2909 sizeof(output
->datetime
));
2911 ret
= LTTNG_ERR_INVALID
;
2916 * Copy UST session sockets so we can communicate with the right
2917 * consumer for the snapshot record command.
2919 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
2921 ret
= LTTNG_ERR_NOMEM
;
2925 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
2926 if (ret
!= LTTNG_OK
) {
2927 goto error_snapshot
;
2930 ret
= ust_app_snapshot_record(usess
, output
, wait
, max_stream_size
);
2934 ret
= LTTNG_ERR_INVALID
;
2937 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
2940 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
2943 goto error_snapshot
;
2949 /* Clean up copied sockets so this output can use some other later on. */
2950 consumer_destroy_output_sockets(output
->consumer
);
2956 * Return the biggest subbuffer size of all channels in the given session.
2958 static uint64_t get_session_max_subbuf_size(struct ltt_session
*session
)
2960 uint64_t max_size
= 0;
2964 if (session
->kernel_session
) {
2965 struct ltt_kernel_channel
*chan
;
2966 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2969 * For each channel, add to the max size the size of each subbuffer
2970 * multiplied by their sized.
2972 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
2973 if (chan
->channel
->attr
.subbuf_size
> max_size
) {
2974 max_size
= chan
->channel
->attr
.subbuf_size
;
2979 if (session
->ust_session
) {
2980 struct lttng_ht_iter iter
;
2981 struct ltt_ust_channel
*uchan
;
2982 struct ltt_ust_session
*usess
= session
->ust_session
;
2985 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
2987 if (uchan
->attr
.subbuf_size
> max_size
) {
2988 max_size
= uchan
->attr
.subbuf_size
;
2998 * Returns the total number of streams for a session or a negative value
3001 static unsigned int get_session_nb_streams(struct ltt_session
*session
)
3003 unsigned int total_streams
= 0;
3005 if (session
->kernel_session
) {
3006 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3008 total_streams
+= ksess
->stream_count_global
;
3011 if (session
->ust_session
) {
3012 struct ltt_ust_session
*usess
= session
->ust_session
;
3014 total_streams
+= ust_app_get_nb_stream(usess
);
3017 return total_streams
;
3021 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3023 * The wait parameter is ignored so this call always wait for the snapshot to
3024 * complete before returning.
3026 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3028 int cmd_snapshot_record(struct ltt_session
*session
,
3029 struct lttng_snapshot_output
*output
, int wait
)
3032 unsigned int use_tmp_output
= 0;
3033 struct snapshot_output tmp_output
;
3034 unsigned int nb_streams
, snapshot_success
= 0;
3035 uint64_t session_max_size
= 0, max_stream_size
= 0;
3039 DBG("Cmd snapshot record for session %s", session
->name
);
3042 * Permission denied to create an output if the session is not
3043 * set in no output mode.
3045 if (session
->output_traces
) {
3046 ret
= LTTNG_ERR_EPERM
;
3050 /* The session needs to be started at least once. */
3051 if (!session
->has_been_started
) {
3052 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3056 /* Use temporary output for the session. */
3057 if (output
&& *output
->ctrl_url
!= '\0') {
3058 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3059 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3062 if (ret
== -ENOMEM
) {
3063 ret
= LTTNG_ERR_NOMEM
;
3065 ret
= LTTNG_ERR_INVALID
;
3069 /* Use the global session count for the temporary snapshot. */
3070 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3075 * Get the session maximum size for a snapshot meaning it will compute the
3076 * size of all streams from all domain.
3078 max_stream_size
= get_session_max_subbuf_size(session
);
3080 nb_streams
= get_session_nb_streams(session
);
3083 * The maximum size of the snapshot is the number of streams multiplied
3084 * by the biggest subbuf size of all channels in a session which is the
3085 * maximum stream size available for each stream. The session max size
3086 * is now checked against the snapshot max size value given by the user
3087 * and if lower, an error is returned.
3089 session_max_size
= max_stream_size
* nb_streams
;
3092 DBG3("Snapshot max size is %" PRIu64
" for max stream size of %" PRIu64
,
3093 session_max_size
, max_stream_size
);
3096 * If we use a temporary output, check right away if the max size fits else
3097 * for each output the max size will be checked.
3099 if (use_tmp_output
&&
3100 (tmp_output
.max_size
!= 0 &&
3101 tmp_output
.max_size
< session_max_size
)) {
3102 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3106 if (session
->kernel_session
) {
3107 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3109 if (use_tmp_output
) {
3110 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3111 wait
, max_stream_size
);
3112 if (ret
!= LTTNG_OK
) {
3115 snapshot_success
= 1;
3117 struct snapshot_output
*sout
;
3118 struct lttng_ht_iter iter
;
3121 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3122 &iter
.iter
, sout
, node
.node
) {
3124 * Make a local copy of the output and assign the possible
3125 * temporary value given by the caller.
3127 memset(&tmp_output
, 0, sizeof(tmp_output
));
3128 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3130 /* Use temporary max size. */
3131 if (output
->max_size
!= (uint64_t) -1ULL) {
3132 tmp_output
.max_size
= output
->max_size
;
3135 if (tmp_output
.max_size
!= 0 &&
3136 tmp_output
.max_size
< session_max_size
) {
3138 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3142 /* Use temporary name. */
3143 if (*output
->name
!= '\0') {
3144 strncpy(tmp_output
.name
, output
->name
,
3145 sizeof(tmp_output
.name
));
3148 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3150 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3151 session
, wait
, max_stream_size
);
3152 if (ret
!= LTTNG_OK
) {
3156 snapshot_success
= 1;
3162 if (session
->ust_session
) {
3163 struct ltt_ust_session
*usess
= session
->ust_session
;
3165 if (use_tmp_output
) {
3166 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3167 wait
, max_stream_size
);
3168 if (ret
!= LTTNG_OK
) {
3171 snapshot_success
= 1;
3173 struct snapshot_output
*sout
;
3174 struct lttng_ht_iter iter
;
3177 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3178 &iter
.iter
, sout
, node
.node
) {
3180 * Make a local copy of the output and assign the possible
3181 * temporary value given by the caller.
3183 memset(&tmp_output
, 0, sizeof(tmp_output
));
3184 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3186 /* Use temporary max size. */
3187 if (output
->max_size
!= (uint64_t) -1ULL) {
3188 tmp_output
.max_size
= output
->max_size
;
3191 if (tmp_output
.max_size
!= 0 &&
3192 tmp_output
.max_size
< session_max_size
) {
3194 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3198 /* Use temporary name. */
3199 if (*output
->name
!= '\0') {
3200 strncpy(tmp_output
.name
, output
->name
,
3201 sizeof(tmp_output
.name
));
3204 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3206 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3207 wait
, max_stream_size
);
3208 if (ret
!= LTTNG_OK
) {
3212 snapshot_success
= 1;
3218 if (snapshot_success
) {
3219 session
->snapshot
.nb_snapshot
++;
3221 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3229 * Init command subsystem.
3234 * Set network sequence index to 1 for streams to match a relayd
3235 * socket on the consumer side.
3237 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3238 relayd_net_seq_idx
= 1;
3239 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3241 DBG("Command subsystem initialized");