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.
1307 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1308 char *channel_name
, struct lttng_event
*event
,
1309 char *filter_expression
,
1310 struct lttng_filter_bytecode
*filter
,
1311 struct lttng_event_exclusion
*exclusion
,
1314 int ret
, channel_created
= 0;
1315 struct lttng_channel
*attr
;
1319 assert(channel_name
);
1323 switch (domain
->type
) {
1324 case LTTNG_DOMAIN_KERNEL
:
1326 struct ltt_kernel_channel
*kchan
;
1329 * If a non-default channel has been created in the
1330 * session, explicitely require that -c chan_name needs
1333 if (session
->kernel_session
->has_non_default_channel
1334 && channel_name
[0] == '\0') {
1335 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1339 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1340 session
->kernel_session
);
1341 if (kchan
== NULL
) {
1342 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1343 LTTNG_BUFFER_GLOBAL
);
1345 ret
= LTTNG_ERR_FATAL
;
1348 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1350 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1351 if (ret
!= LTTNG_OK
) {
1357 channel_created
= 1;
1360 /* Get the newly created kernel channel pointer */
1361 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1362 session
->kernel_session
);
1363 if (kchan
== NULL
) {
1364 /* This sould not happen... */
1365 ret
= LTTNG_ERR_FATAL
;
1369 ret
= event_kernel_enable_tracepoint(kchan
, event
);
1370 if (ret
!= LTTNG_OK
) {
1371 if (channel_created
) {
1372 /* Let's not leak a useless channel. */
1373 kernel_destroy_channel(kchan
);
1378 kernel_wait_quiescent(kernel_tracer_fd
);
1381 case LTTNG_DOMAIN_UST
:
1383 struct ltt_ust_channel
*uchan
;
1384 struct ltt_ust_session
*usess
= session
->ust_session
;
1389 * If a non-default channel has been created in the
1390 * session, explicitely require that -c chan_name needs
1393 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1394 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1398 /* Get channel from global UST domain */
1399 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1401 if (uchan
== NULL
) {
1402 /* Create default channel */
1403 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1404 usess
->buffer_type
);
1406 ret
= LTTNG_ERR_FATAL
;
1409 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1411 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1412 if (ret
!= LTTNG_OK
) {
1418 /* Get the newly created channel reference back */
1419 uchan
= trace_ust_find_channel_by_name(
1420 usess
->domain_global
.channels
, channel_name
);
1424 /* At this point, the session and channel exist on the tracer */
1425 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1426 filter_expression
, filter
, exclusion
);
1427 if (ret
!= LTTNG_OK
) {
1432 case LTTNG_DOMAIN_JUL
:
1434 struct lttng_event uevent
;
1435 struct lttng_domain tmp_dom
;
1436 struct ltt_ust_session
*usess
= session
->ust_session
;
1440 /* Create the default JUL tracepoint. */
1441 memset(&uevent
, 0, sizeof(uevent
));
1442 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1443 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1445 strncpy(uevent
.name
, DEFAULT_SYS_JUL_EVENT_NAME
,
1446 sizeof(uevent
.name
));
1448 strncpy(uevent
.name
, DEFAULT_USER_JUL_EVENT_NAME
,
1449 sizeof(uevent
.name
));
1451 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1454 * The domain type is changed because we are about to enable the
1455 * default channel and event for the JUL domain that are hardcoded.
1456 * This happens in the UST domain.
1458 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1459 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1461 ret
= cmd_enable_event(session
, &tmp_dom
, DEFAULT_JUL_CHANNEL_NAME
,
1462 &uevent
, filter_expression
, filter
, NULL
, wpipe
);
1463 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1467 /* The wild card * means that everything should be enabled. */
1468 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1469 ret
= event_jul_enable_all(usess
, event
, filter
);
1471 ret
= event_jul_enable(usess
, event
, filter
);
1473 if (ret
!= LTTNG_OK
) {
1480 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1481 case LTTNG_DOMAIN_UST_PID
:
1482 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1485 ret
= LTTNG_ERR_UND
;
1497 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
1499 int cmd_enable_event_all(struct ltt_session
*session
,
1500 struct lttng_domain
*domain
, char *channel_name
, int event_type
,
1501 char *filter_expression
,
1502 struct lttng_filter_bytecode
*filter
, int wpipe
)
1505 struct lttng_channel
*attr
;
1508 assert(channel_name
);
1512 switch (domain
->type
) {
1513 case LTTNG_DOMAIN_KERNEL
:
1515 struct ltt_kernel_channel
*kchan
;
1517 assert(session
->kernel_session
);
1520 * If a non-default channel has been created in the
1521 * session, explicitely require that -c chan_name needs
1524 if (session
->kernel_session
->has_non_default_channel
1525 && channel_name
[0] == '\0') {
1526 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1530 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1531 session
->kernel_session
);
1532 if (kchan
== NULL
) {
1533 /* Create default channel */
1534 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1535 LTTNG_BUFFER_GLOBAL
);
1537 ret
= LTTNG_ERR_FATAL
;
1540 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1542 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1543 if (ret
!= LTTNG_OK
) {
1549 /* Get the newly created kernel channel pointer */
1550 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1551 session
->kernel_session
);
1555 switch (event_type
) {
1556 case LTTNG_EVENT_SYSCALL
:
1557 ret
= event_kernel_enable_all_syscalls(kchan
, kernel_tracer_fd
);
1559 case LTTNG_EVENT_TRACEPOINT
:
1561 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
1562 * events already registered to the channel.
1564 ret
= event_kernel_enable_all_tracepoints(kchan
, kernel_tracer_fd
);
1566 case LTTNG_EVENT_ALL
:
1567 /* Enable syscalls and tracepoints */
1568 ret
= event_kernel_enable_all(kchan
, kernel_tracer_fd
);
1571 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
1575 /* Manage return value */
1576 if (ret
!= LTTNG_OK
) {
1578 * On error, cmd_enable_channel call will take care of destroying
1579 * the created channel if it was needed.
1584 kernel_wait_quiescent(kernel_tracer_fd
);
1587 case LTTNG_DOMAIN_UST
:
1589 struct ltt_ust_channel
*uchan
;
1590 struct ltt_ust_session
*usess
= session
->ust_session
;
1595 * If a non-default channel has been created in the
1596 * session, explicitely require that -c chan_name needs
1599 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1600 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1604 /* Get channel from global UST domain */
1605 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1607 if (uchan
== NULL
) {
1608 /* Create default channel */
1609 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1610 usess
->buffer_type
);
1612 ret
= LTTNG_ERR_FATAL
;
1615 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1617 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1618 if (ret
!= LTTNG_OK
) {
1624 /* Get the newly created channel reference back */
1625 uchan
= trace_ust_find_channel_by_name(
1626 usess
->domain_global
.channels
, channel_name
);
1630 /* At this point, the session and channel exist on the tracer */
1632 switch (event_type
) {
1633 case LTTNG_EVENT_ALL
:
1634 case LTTNG_EVENT_TRACEPOINT
:
1635 ret
= event_ust_enable_all_tracepoints(usess
, uchan
,
1636 filter_expression
, filter
);
1637 if (ret
!= LTTNG_OK
) {
1642 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
1646 /* Manage return value */
1647 if (ret
!= LTTNG_OK
) {
1653 case LTTNG_DOMAIN_JUL
:
1655 struct lttng_event uevent
, event
;
1656 struct lttng_domain tmp_dom
;
1657 struct ltt_ust_session
*usess
= session
->ust_session
;
1661 /* Create the default JUL tracepoint. */
1662 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1663 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1665 strncpy(uevent
.name
, DEFAULT_SYS_JUL_EVENT_NAME
,
1666 sizeof(uevent
.name
));
1668 strncpy(uevent
.name
, DEFAULT_USER_JUL_EVENT_NAME
,
1669 sizeof(uevent
.name
));
1671 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1674 * The domain type is changed because we are about to enable the
1675 * default channel and event for the JUL domain that are hardcoded.
1676 * This happens in the UST domain.
1678 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1679 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1681 ret
= cmd_enable_event(session
, &tmp_dom
, DEFAULT_JUL_CHANNEL_NAME
,
1682 &uevent
, NULL
, NULL
, NULL
, wpipe
);
1683 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1687 event
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
1688 event
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1689 strncpy(event
.name
, "*", sizeof(event
.name
));
1690 event
.name
[sizeof(event
.name
) - 1] = '\0';
1692 ret
= event_jul_enable_all(usess
, &event
, filter
);
1693 if (ret
!= LTTNG_OK
) {
1700 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1701 case LTTNG_DOMAIN_UST_PID
:
1702 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1705 ret
= LTTNG_ERR_UND
;
1718 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1720 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1723 ssize_t nb_events
= 0;
1726 case LTTNG_DOMAIN_KERNEL
:
1727 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1728 if (nb_events
< 0) {
1729 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1733 case LTTNG_DOMAIN_UST
:
1734 nb_events
= ust_app_list_events(events
);
1735 if (nb_events
< 0) {
1736 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1740 case LTTNG_DOMAIN_JUL
:
1741 nb_events
= jul_list_events(events
);
1742 if (nb_events
< 0) {
1743 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1748 ret
= LTTNG_ERR_UND
;
1755 /* Return negative value to differentiate return code */
1760 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1762 ssize_t
cmd_list_tracepoint_fields(int domain
,
1763 struct lttng_event_field
**fields
)
1766 ssize_t nb_fields
= 0;
1769 case LTTNG_DOMAIN_UST
:
1770 nb_fields
= ust_app_list_event_fields(fields
);
1771 if (nb_fields
< 0) {
1772 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1776 case LTTNG_DOMAIN_KERNEL
:
1777 default: /* fall-through */
1778 ret
= LTTNG_ERR_UND
;
1785 /* Return negative value to differentiate return code */
1790 * Command LTTNG_START_TRACE processed by the client thread.
1792 int cmd_start_trace(struct ltt_session
*session
)
1795 unsigned long nb_chan
= 0;
1796 struct ltt_kernel_session
*ksession
;
1797 struct ltt_ust_session
*usess
;
1801 /* Ease our life a bit ;) */
1802 ksession
= session
->kernel_session
;
1803 usess
= session
->ust_session
;
1805 /* Is the session already started? */
1806 if (session
->active
) {
1807 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1812 * Starting a session without channel is useless since after that it's not
1813 * possible to enable channel thus inform the client.
1815 if (usess
&& usess
->domain_global
.channels
) {
1817 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
1821 nb_chan
+= ksession
->channel_count
;
1824 ret
= LTTNG_ERR_NO_CHANNEL
;
1828 /* Kernel tracing */
1829 if (ksession
!= NULL
) {
1830 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
1831 if (ret
!= LTTNG_OK
) {
1836 /* Flag session that trace should start automatically */
1839 * Even though the start trace might fail, flag this session active so
1840 * other application coming in are started by default.
1844 ret
= ust_app_start_trace_all(usess
);
1846 ret
= LTTNG_ERR_UST_START_FAIL
;
1851 /* Flag this after a successful start. */
1852 session
->has_been_started
= 1;
1853 session
->active
= 1;
1862 * Command LTTNG_STOP_TRACE processed by the client thread.
1864 int cmd_stop_trace(struct ltt_session
*session
)
1867 struct ltt_kernel_channel
*kchan
;
1868 struct ltt_kernel_session
*ksession
;
1869 struct ltt_ust_session
*usess
;
1874 ksession
= session
->kernel_session
;
1875 usess
= session
->ust_session
;
1877 /* Session is not active. Skip everythong and inform the client. */
1878 if (!session
->active
) {
1879 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
1884 if (ksession
&& ksession
->active
) {
1885 DBG("Stop kernel tracing");
1887 /* Flush metadata if exist */
1888 if (ksession
->metadata_stream_fd
>= 0) {
1889 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
1891 ERR("Kernel metadata flush failed");
1895 /* Flush all buffers before stopping */
1896 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
1897 ret
= kernel_flush_buffer(kchan
);
1899 ERR("Kernel flush buffer error");
1903 ret
= kernel_stop_session(ksession
);
1905 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1909 kernel_wait_quiescent(kernel_tracer_fd
);
1911 ksession
->active
= 0;
1914 if (usess
&& usess
->active
) {
1916 * Even though the stop trace might fail, flag this session inactive so
1917 * other application coming in are not started by default.
1921 ret
= ust_app_stop_trace_all(usess
);
1923 ret
= LTTNG_ERR_UST_STOP_FAIL
;
1928 /* Flag inactive after a successful stop. */
1929 session
->active
= 0;
1937 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
1939 int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
1940 size_t nb_uri
, struct lttng_uri
*uris
)
1943 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
1944 struct ltt_ust_session
*usess
= session
->ust_session
;
1945 struct consumer_output
*consumer
= NULL
;
1951 /* Can't set consumer URI if the session is active. */
1952 if (session
->active
) {
1953 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1958 * This case switch makes sure the domain session has a temporary consumer
1959 * so the URL can be set.
1963 /* Code flow error. A session MUST always have a consumer object */
1964 assert(session
->consumer
);
1966 * The URL will be added to the tracing session consumer instead of a
1967 * specific domain consumer.
1969 consumer
= session
->consumer
;
1971 case LTTNG_DOMAIN_KERNEL
:
1972 /* Code flow error if we don't have a kernel session here. */
1974 assert(ksess
->consumer
);
1975 consumer
= ksess
->consumer
;
1977 case LTTNG_DOMAIN_UST
:
1978 /* Code flow error if we don't have a kernel session here. */
1980 assert(usess
->consumer
);
1981 consumer
= usess
->consumer
;
1985 for (i
= 0; i
< nb_uri
; i
++) {
1986 ret
= add_uri_to_consumer(consumer
, &uris
[i
], domain
, session
->name
);
1987 if (ret
!= LTTNG_OK
) {
1993 * Make sure to set the session in output mode after we set URI since a
1994 * session can be created without URL (thus flagged in no output mode).
1996 session
->output_traces
= 1;
1998 ksess
->output_traces
= 1;
2000 usess
->output_traces
= 1;
2011 * Command LTTNG_CREATE_SESSION processed by the client thread.
2013 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2014 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2017 struct ltt_session
*session
;
2023 * Verify if the session already exist
2025 * XXX: There is no need for the session lock list here since the caller
2026 * (process_client_msg) is holding it. We might want to change that so a
2027 * single command does not lock the entire session list.
2029 session
= session_find_by_name(name
);
2030 if (session
!= NULL
) {
2031 ret
= LTTNG_ERR_EXIST_SESS
;
2035 /* Create tracing session in the registry */
2036 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2037 LTTNG_SOCK_GET_GID_CRED(creds
));
2038 if (ret
!= LTTNG_OK
) {
2043 * Get the newly created session pointer back
2045 * XXX: There is no need for the session lock list here since the caller
2046 * (process_client_msg) is holding it. We might want to change that so a
2047 * single command does not lock the entire session list.
2049 session
= session_find_by_name(name
);
2052 session
->live_timer
= live_timer
;
2053 /* Create default consumer output for the session not yet created. */
2054 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2055 if (session
->consumer
== NULL
) {
2056 ret
= LTTNG_ERR_FATAL
;
2057 goto consumer_error
;
2061 ret
= cmd_set_consumer_uri(0, session
, nb_uri
, uris
);
2062 if (ret
!= LTTNG_OK
) {
2063 goto consumer_error
;
2065 session
->output_traces
= 1;
2067 session
->output_traces
= 0;
2068 DBG2("Session %s created with no output", session
->name
);
2071 session
->consumer
->enabled
= 1;
2076 session_destroy(session
);
2083 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2085 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2086 size_t nb_uri
, lttng_sock_cred
*creds
)
2089 struct ltt_session
*session
;
2090 struct snapshot_output
*new_output
= NULL
;
2096 * Create session in no output mode with URIs set to NULL. The uris we've
2097 * received are for a default snapshot output if one.
2099 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2100 if (ret
!= LTTNG_OK
) {
2104 /* Get the newly created session pointer back. This should NEVER fail. */
2105 session
= session_find_by_name(name
);
2108 /* Flag session for snapshot mode. */
2109 session
->snapshot_mode
= 1;
2111 /* Skip snapshot output creation if no URI is given. */
2116 new_output
= snapshot_output_alloc();
2118 ret
= LTTNG_ERR_NOMEM
;
2119 goto error_snapshot_alloc
;
2122 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2123 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2125 if (ret
== -ENOMEM
) {
2126 ret
= LTTNG_ERR_NOMEM
;
2128 ret
= LTTNG_ERR_INVALID
;
2130 goto error_snapshot
;
2134 snapshot_add_output(&session
->snapshot
, new_output
);
2141 snapshot_output_destroy(new_output
);
2142 error_snapshot_alloc
:
2143 session_destroy(session
);
2149 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2151 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2154 struct ltt_ust_session
*usess
;
2155 struct ltt_kernel_session
*ksess
;
2160 usess
= session
->ust_session
;
2161 ksess
= session
->kernel_session
;
2163 /* Clean kernel session teardown */
2164 kernel_destroy_session(ksess
);
2166 /* UST session teardown */
2168 /* Close any relayd session */
2169 consumer_output_send_destroy_relayd(usess
->consumer
);
2171 /* Destroy every UST application related to this session. */
2172 ret
= ust_app_destroy_trace_all(usess
);
2174 ERR("Error in ust_app_destroy_trace_all");
2177 /* Clean up the rest. */
2178 trace_ust_destroy_session(usess
);
2182 * Must notify the kernel thread here to update it's poll set in order to
2183 * remove the channel(s)' fd just destroyed.
2185 ret
= notify_thread_pipe(wpipe
);
2187 PERROR("write kernel poll pipe");
2190 ret
= session_destroy(session
);
2196 * Command LTTNG_CALIBRATE processed by the client thread.
2198 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2203 case LTTNG_DOMAIN_KERNEL
:
2205 struct lttng_kernel_calibrate kcalibrate
;
2207 switch (calibrate
->type
) {
2208 case LTTNG_CALIBRATE_FUNCTION
:
2210 /* Default and only possible calibrate option. */
2211 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2215 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2217 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2222 case LTTNG_DOMAIN_UST
:
2224 struct lttng_ust_calibrate ucalibrate
;
2226 switch (calibrate
->type
) {
2227 case LTTNG_CALIBRATE_FUNCTION
:
2229 /* Default and only possible calibrate option. */
2230 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2234 ret
= ust_app_calibrate_glb(&ucalibrate
);
2236 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2242 ret
= LTTNG_ERR_UND
;
2253 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2255 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2256 const char *sock_path
, struct consumer_data
*cdata
)
2259 struct consumer_socket
*socket
= NULL
;
2266 case LTTNG_DOMAIN_KERNEL
:
2268 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2272 /* Can't register a consumer if there is already one */
2273 if (ksess
->consumer_fds_sent
!= 0) {
2274 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2278 sock
= lttcomm_connect_unix_sock(sock_path
);
2280 ret
= LTTNG_ERR_CONNECT_FAIL
;
2283 cdata
->cmd_sock
= sock
;
2285 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2286 if (socket
== NULL
) {
2289 PERROR("close register consumer");
2291 cdata
->cmd_sock
= -1;
2292 ret
= LTTNG_ERR_FATAL
;
2296 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2297 if (socket
->lock
== NULL
) {
2298 PERROR("zmalloc pthread mutex");
2299 ret
= LTTNG_ERR_FATAL
;
2302 pthread_mutex_init(socket
->lock
, NULL
);
2303 socket
->registered
= 1;
2306 consumer_add_socket(socket
, ksess
->consumer
);
2309 pthread_mutex_lock(&cdata
->pid_mutex
);
2311 pthread_mutex_unlock(&cdata
->pid_mutex
);
2316 /* TODO: Userspace tracing */
2317 ret
= LTTNG_ERR_UND
;
2325 consumer_destroy_socket(socket
);
2331 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2333 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2334 struct lttng_domain
**domains
)
2339 if (session
->kernel_session
!= NULL
) {
2340 DBG3("Listing domains found kernel domain");
2344 if (session
->ust_session
!= NULL
) {
2345 DBG3("Listing domains found UST global domain");
2348 if (session
->ust_session
->domain_jul
.being_used
) {
2353 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2354 if (*domains
== NULL
) {
2355 ret
= LTTNG_ERR_FATAL
;
2359 if (session
->kernel_session
!= NULL
) {
2360 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2364 if (session
->ust_session
!= NULL
) {
2365 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2366 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2369 if (session
->ust_session
->domain_jul
.being_used
) {
2370 (*domains
)[index
].type
= LTTNG_DOMAIN_JUL
;
2371 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2379 /* Return negative value to differentiate return code */
2385 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2387 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2388 struct lttng_channel
**channels
)
2391 ssize_t nb_chan
= 0;
2394 case LTTNG_DOMAIN_KERNEL
:
2395 if (session
->kernel_session
!= NULL
) {
2396 nb_chan
= session
->kernel_session
->channel_count
;
2398 DBG3("Number of kernel channels %zd", nb_chan
);
2400 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2403 case LTTNG_DOMAIN_UST
:
2404 if (session
->ust_session
!= NULL
) {
2405 nb_chan
= lttng_ht_get_count(
2406 session
->ust_session
->domain_global
.channels
);
2408 DBG3("Number of UST global channels %zd", nb_chan
);
2410 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2415 ret
= LTTNG_ERR_UND
;
2420 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2421 if (*channels
== NULL
) {
2422 ret
= LTTNG_ERR_FATAL
;
2426 list_lttng_channels(domain
, session
, *channels
);
2432 /* Return negative value to differentiate return code */
2437 * Command LTTNG_LIST_EVENTS processed by the client thread.
2439 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2440 char *channel_name
, struct lttng_event
**events
)
2443 ssize_t nb_event
= 0;
2446 case LTTNG_DOMAIN_KERNEL
:
2447 if (session
->kernel_session
!= NULL
) {
2448 nb_event
= list_lttng_kernel_events(channel_name
,
2449 session
->kernel_session
, events
);
2452 case LTTNG_DOMAIN_UST
:
2454 if (session
->ust_session
!= NULL
) {
2455 nb_event
= list_lttng_ust_global_events(channel_name
,
2456 &session
->ust_session
->domain_global
, events
);
2460 case LTTNG_DOMAIN_JUL
:
2461 if (session
->ust_session
) {
2462 nb_event
= list_lttng_jul_events(
2463 &session
->ust_session
->domain_jul
, events
);
2467 ret
= LTTNG_ERR_UND
;
2474 /* Return negative value to differentiate return code */
2479 * Using the session list, filled a lttng_session array to send back to the
2480 * client for session listing.
2482 * The session list lock MUST be acquired before calling this function. Use
2483 * session_lock_list() and session_unlock_list().
2485 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2490 struct ltt_session
*session
;
2491 struct ltt_session_list
*list
= session_get_list();
2493 DBG("Getting all available session for UID %d GID %d",
2496 * Iterate over session list and append data after the control struct in
2499 cds_list_for_each_entry(session
, &list
->head
, list
) {
2501 * Only list the sessions the user can control.
2503 if (!session_access_ok(session
, uid
, gid
)) {
2507 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2508 struct ltt_ust_session
*usess
= session
->ust_session
;
2510 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2511 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2512 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2513 ret
= build_network_session_path(sessions
[i
].path
,
2514 sizeof(sessions
[i
].path
), session
);
2516 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2517 session
->consumer
->dst
.trace_path
);
2520 PERROR("snprintf session path");
2524 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2525 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2526 sessions
[i
].enabled
= session
->active
;
2527 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2528 sessions
[i
].live_timer_interval
= session
->live_timer
;
2534 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2535 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2537 int cmd_data_pending(struct ltt_session
*session
)
2540 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2541 struct ltt_ust_session
*usess
= session
->ust_session
;
2545 /* Session MUST be stopped to ask for data availability. */
2546 if (session
->active
) {
2547 ret
= LTTNG_ERR_SESSION_STARTED
;
2551 * If stopped, just make sure we've started before else the above call
2552 * will always send that there is data pending.
2554 * The consumer assumes that when the data pending command is received,
2555 * the trace has been started before or else no output data is written
2556 * by the streams which is a condition for data pending. So, this is
2557 * *VERY* important that we don't ask the consumer before a start
2560 if (!session
->has_been_started
) {
2566 if (ksess
&& ksess
->consumer
) {
2567 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2569 /* Data is still being extracted for the kernel. */
2574 if (usess
&& usess
->consumer
) {
2575 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2577 /* Data is still being extracted for the kernel. */
2582 /* Data is ready to be read by a viewer */
2590 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2592 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2594 int cmd_snapshot_add_output(struct ltt_session
*session
,
2595 struct lttng_snapshot_output
*output
, uint32_t *id
)
2598 struct snapshot_output
*new_output
;
2603 DBG("Cmd snapshot add output for session %s", session
->name
);
2606 * Permission denied to create an output if the session is not
2607 * set in no output mode.
2609 if (session
->output_traces
) {
2610 ret
= LTTNG_ERR_EPERM
;
2614 /* Only one output is allowed until we have the "tee" feature. */
2615 if (session
->snapshot
.nb_output
== 1) {
2616 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2620 new_output
= snapshot_output_alloc();
2622 ret
= LTTNG_ERR_NOMEM
;
2626 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2627 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2628 &session
->snapshot
);
2630 if (ret
== -ENOMEM
) {
2631 ret
= LTTNG_ERR_NOMEM
;
2633 ret
= LTTNG_ERR_INVALID
;
2639 snapshot_add_output(&session
->snapshot
, new_output
);
2641 *id
= new_output
->id
;
2648 snapshot_output_destroy(new_output
);
2654 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2656 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2658 int cmd_snapshot_del_output(struct ltt_session
*session
,
2659 struct lttng_snapshot_output
*output
)
2662 struct snapshot_output
*sout
= NULL
;
2670 * Permission denied to create an output if the session is not
2671 * set in no output mode.
2673 if (session
->output_traces
) {
2674 ret
= LTTNG_ERR_EPERM
;
2679 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2681 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2682 } else if (*output
->name
!= '\0') {
2683 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2685 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2688 ret
= LTTNG_ERR_INVALID
;
2692 snapshot_delete_output(&session
->snapshot
, sout
);
2693 snapshot_output_destroy(sout
);
2702 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2704 * If no output is available, outputs is untouched and 0 is returned.
2706 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2708 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2709 struct lttng_snapshot_output
**outputs
)
2712 struct lttng_snapshot_output
*list
;
2713 struct lttng_ht_iter iter
;
2714 struct snapshot_output
*output
;
2719 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2722 * Permission denied to create an output if the session is not
2723 * set in no output mode.
2725 if (session
->output_traces
) {
2726 ret
= LTTNG_ERR_EPERM
;
2730 if (session
->snapshot
.nb_output
== 0) {
2735 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2737 ret
= LTTNG_ERR_NOMEM
;
2741 /* Copy list from session to the new list object. */
2742 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2743 output
, node
.node
) {
2744 assert(output
->consumer
);
2745 list
[idx
].id
= output
->id
;
2746 list
[idx
].max_size
= output
->max_size
;
2747 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2748 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2749 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2750 sizeof(list
[idx
].ctrl_url
));
2753 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2754 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2756 ret
= LTTNG_ERR_NOMEM
;
2761 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
2762 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
2764 ret
= LTTNG_ERR_NOMEM
;
2772 return session
->snapshot
.nb_output
;
2781 * Send relayd sockets from snapshot output to consumer. Ignore request if the
2782 * snapshot output is *not* set with a remote destination.
2784 * Return 0 on success or a LTTNG_ERR code.
2786 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
2787 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
2790 struct lttng_ht_iter iter
;
2791 struct consumer_socket
*socket
;
2794 assert(snap_output
);
2797 DBG2("Set relayd object from snapshot output");
2799 /* Ignore if snapshot consumer output is not network. */
2800 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
2805 * For each consumer socket, create and send the relayd object of the
2809 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
2810 socket
, node
.node
) {
2811 ret
= send_consumer_relayd_sockets(0, session
->id
,
2812 snap_output
->consumer
, socket
,
2813 session
->name
, session
->hostname
,
2814 session
->live_timer
);
2815 if (ret
!= LTTNG_OK
) {
2827 * Record a kernel snapshot.
2829 * Return LTTNG_OK on success or a LTTNG_ERR code.
2831 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
2832 struct snapshot_output
*output
, struct ltt_session
*session
,
2833 int wait
, uint64_t max_stream_size
)
2841 /* Get the datetime for the snapshot output directory. */
2842 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
2843 sizeof(output
->datetime
));
2845 ret
= LTTNG_ERR_INVALID
;
2850 * Copy kernel session sockets so we can communicate with the right
2851 * consumer for the snapshot record command.
2853 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
2855 ret
= LTTNG_ERR_NOMEM
;
2859 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
2860 if (ret
!= LTTNG_OK
) {
2861 goto error_snapshot
;
2864 ret
= kernel_snapshot_record(ksess
, output
, wait
, max_stream_size
);
2865 if (ret
!= LTTNG_OK
) {
2866 goto error_snapshot
;
2872 /* Clean up copied sockets so this output can use some other later on. */
2873 consumer_destroy_output_sockets(output
->consumer
);
2879 * Record a UST snapshot.
2881 * Return 0 on success or a LTTNG_ERR error code.
2883 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
2884 struct snapshot_output
*output
, struct ltt_session
*session
,
2885 int wait
, uint64_t max_stream_size
)
2893 /* Get the datetime for the snapshot output directory. */
2894 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
2895 sizeof(output
->datetime
));
2897 ret
= LTTNG_ERR_INVALID
;
2902 * Copy UST session sockets so we can communicate with the right
2903 * consumer for the snapshot record command.
2905 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
2907 ret
= LTTNG_ERR_NOMEM
;
2911 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
2912 if (ret
!= LTTNG_OK
) {
2913 goto error_snapshot
;
2916 ret
= ust_app_snapshot_record(usess
, output
, wait
, max_stream_size
);
2920 ret
= LTTNG_ERR_INVALID
;
2923 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
2926 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
2929 goto error_snapshot
;
2935 /* Clean up copied sockets so this output can use some other later on. */
2936 consumer_destroy_output_sockets(output
->consumer
);
2942 * Return the biggest subbuffer size of all channels in the given session.
2944 static uint64_t get_session_max_subbuf_size(struct ltt_session
*session
)
2946 uint64_t max_size
= 0;
2950 if (session
->kernel_session
) {
2951 struct ltt_kernel_channel
*chan
;
2952 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2955 * For each channel, add to the max size the size of each subbuffer
2956 * multiplied by their sized.
2958 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
2959 if (chan
->channel
->attr
.subbuf_size
> max_size
) {
2960 max_size
= chan
->channel
->attr
.subbuf_size
;
2965 if (session
->ust_session
) {
2966 struct lttng_ht_iter iter
;
2967 struct ltt_ust_channel
*uchan
;
2968 struct ltt_ust_session
*usess
= session
->ust_session
;
2970 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
2972 if (uchan
->attr
.subbuf_size
> max_size
) {
2973 max_size
= uchan
->attr
.subbuf_size
;
2982 * Returns the total number of streams for a session or a negative value
2985 static unsigned int get_session_nb_streams(struct ltt_session
*session
)
2987 unsigned int total_streams
= 0;
2989 if (session
->kernel_session
) {
2990 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2992 total_streams
+= ksess
->stream_count_global
;
2995 if (session
->ust_session
) {
2996 struct ltt_ust_session
*usess
= session
->ust_session
;
2998 total_streams
+= ust_app_get_nb_stream(usess
);
3001 return total_streams
;
3005 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3007 * The wait parameter is ignored so this call always wait for the snapshot to
3008 * complete before returning.
3010 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3012 int cmd_snapshot_record(struct ltt_session
*session
,
3013 struct lttng_snapshot_output
*output
, int wait
)
3016 unsigned int use_tmp_output
= 0;
3017 struct snapshot_output tmp_output
;
3018 unsigned int nb_streams
, snapshot_success
= 0;
3019 uint64_t session_max_size
= 0, max_stream_size
= 0;
3023 DBG("Cmd snapshot record for session %s", session
->name
);
3026 * Permission denied to create an output if the session is not
3027 * set in no output mode.
3029 if (session
->output_traces
) {
3030 ret
= LTTNG_ERR_EPERM
;
3034 /* The session needs to be started at least once. */
3035 if (!session
->has_been_started
) {
3036 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3040 /* Use temporary output for the session. */
3041 if (output
&& *output
->ctrl_url
!= '\0') {
3042 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3043 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3046 if (ret
== -ENOMEM
) {
3047 ret
= LTTNG_ERR_NOMEM
;
3049 ret
= LTTNG_ERR_INVALID
;
3053 /* Use the global session count for the temporary snapshot. */
3054 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3059 * Get the session maximum size for a snapshot meaning it will compute the
3060 * size of all streams from all domain.
3062 max_stream_size
= get_session_max_subbuf_size(session
);
3064 nb_streams
= get_session_nb_streams(session
);
3067 * The maximum size of the snapshot is the number of streams multiplied
3068 * by the biggest subbuf size of all channels in a session which is the
3069 * maximum stream size available for each stream. The session max size
3070 * is now checked against the snapshot max size value given by the user
3071 * and if lower, an error is returned.
3073 session_max_size
= max_stream_size
* nb_streams
;
3076 DBG3("Snapshot max size is %" PRIu64
" for max stream size of %" PRIu64
,
3077 session_max_size
, max_stream_size
);
3080 * If we use a temporary output, check right away if the max size fits else
3081 * for each output the max size will be checked.
3083 if (use_tmp_output
&&
3084 (tmp_output
.max_size
!= 0 &&
3085 tmp_output
.max_size
< session_max_size
)) {
3086 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3090 if (session
->kernel_session
) {
3091 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3093 if (use_tmp_output
) {
3094 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3095 wait
, max_stream_size
);
3096 if (ret
!= LTTNG_OK
) {
3099 snapshot_success
= 1;
3101 struct snapshot_output
*sout
;
3102 struct lttng_ht_iter iter
;
3105 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3106 &iter
.iter
, sout
, node
.node
) {
3108 * Make a local copy of the output and assign the possible
3109 * temporary value given by the caller.
3111 memset(&tmp_output
, 0, sizeof(tmp_output
));
3112 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3114 /* Use temporary max size. */
3115 if (output
->max_size
!= (uint64_t) -1ULL) {
3116 tmp_output
.max_size
= output
->max_size
;
3119 if (tmp_output
.max_size
!= 0 &&
3120 tmp_output
.max_size
< session_max_size
) {
3122 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3126 /* Use temporary name. */
3127 if (*output
->name
!= '\0') {
3128 strncpy(tmp_output
.name
, output
->name
,
3129 sizeof(tmp_output
.name
));
3132 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3134 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3135 session
, wait
, max_stream_size
);
3136 if (ret
!= LTTNG_OK
) {
3140 snapshot_success
= 1;
3146 if (session
->ust_session
) {
3147 struct ltt_ust_session
*usess
= session
->ust_session
;
3149 if (use_tmp_output
) {
3150 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3151 wait
, max_stream_size
);
3152 if (ret
!= LTTNG_OK
) {
3155 snapshot_success
= 1;
3157 struct snapshot_output
*sout
;
3158 struct lttng_ht_iter iter
;
3161 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3162 &iter
.iter
, sout
, node
.node
) {
3164 * Make a local copy of the output and assign the possible
3165 * temporary value given by the caller.
3167 memset(&tmp_output
, 0, sizeof(tmp_output
));
3168 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3170 /* Use temporary max size. */
3171 if (output
->max_size
!= (uint64_t) -1ULL) {
3172 tmp_output
.max_size
= output
->max_size
;
3175 if (tmp_output
.max_size
!= 0 &&
3176 tmp_output
.max_size
< session_max_size
) {
3178 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3182 /* Use temporary name. */
3183 if (*output
->name
!= '\0') {
3184 strncpy(tmp_output
.name
, output
->name
,
3185 sizeof(tmp_output
.name
));
3188 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3190 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3191 wait
, max_stream_size
);
3192 if (ret
!= LTTNG_OK
) {
3196 snapshot_success
= 1;
3202 if (snapshot_success
) {
3203 session
->snapshot
.nb_snapshot
++;
3205 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3213 * Init command subsystem.
3218 * Set network sequence index to 1 for streams to match a relayd
3219 * socket on the consumer side.
3221 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3222 relayd_net_seq_idx
= 1;
3223 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3225 DBG("Command subsystem initialized");