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 agent domain events.
190 * Return number of events in list on success or else a negative value.
192 static int list_lttng_agent_events(struct agent
*agt
,
193 struct lttng_event
**events
)
196 unsigned int nb_event
= 0;
197 struct agent_event
*event
;
198 struct lttng_event
*tmp_events
;
199 struct lttng_ht_iter iter
;
204 DBG3("Listing agent events");
206 nb_event
= lttng_ht_get_count(agt
->events
);
212 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
214 PERROR("zmalloc agent events session");
215 ret
= -LTTNG_ERR_FATAL
;
220 cds_lfht_for_each_entry(agt
->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_LOG4J
:
1075 case LTTNG_DOMAIN_JUL
:
1078 struct ltt_ust_session
*usess
= session
->ust_session
;
1082 agt
= trace_ust_find_agent(usess
, domain
);
1084 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1088 ret
= event_agent_disable(usess
, agt
, event_name
);
1089 if (ret
!= LTTNG_OK
) {
1096 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1097 case LTTNG_DOMAIN_UST_PID
:
1098 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1101 ret
= LTTNG_ERR_UND
;
1113 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
1115 int cmd_disable_event_all(struct ltt_session
*session
, int domain
,
1123 case LTTNG_DOMAIN_KERNEL
:
1125 struct ltt_kernel_session
*ksess
;
1126 struct ltt_kernel_channel
*kchan
;
1128 ksess
= session
->kernel_session
;
1131 * If a non-default channel has been created in the
1132 * session, explicitely require that -c chan_name needs
1135 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1136 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1140 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1141 if (kchan
== NULL
) {
1142 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1146 ret
= event_kernel_disable_all(kchan
);
1147 if (ret
!= LTTNG_OK
) {
1151 kernel_wait_quiescent(kernel_tracer_fd
);
1154 case LTTNG_DOMAIN_UST
:
1156 struct ltt_ust_session
*usess
;
1157 struct ltt_ust_channel
*uchan
;
1159 usess
= session
->ust_session
;
1162 * If a non-default channel has been created in the
1163 * session, explicitely require that -c chan_name needs
1166 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1167 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1171 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1173 if (uchan
== NULL
) {
1174 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1178 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1183 DBG3("Disable all UST events in channel %s completed", channel_name
);
1187 case LTTNG_DOMAIN_LOG4J
:
1188 case LTTNG_DOMAIN_JUL
:
1191 struct ltt_ust_session
*usess
= session
->ust_session
;
1195 agt
= trace_ust_find_agent(usess
, domain
);
1197 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1201 ret
= event_agent_disable_all(usess
, agt
);
1202 if (ret
!= LTTNG_OK
) {
1209 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1210 case LTTNG_DOMAIN_UST_PID
:
1211 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1214 ret
= LTTNG_ERR_UND
;
1226 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1228 int cmd_add_context(struct ltt_session
*session
, int domain
,
1229 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1231 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1234 case LTTNG_DOMAIN_KERNEL
:
1235 assert(session
->kernel_session
);
1237 if (session
->kernel_session
->channel_count
== 0) {
1238 /* Create default channel */
1239 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1240 if (ret
!= LTTNG_OK
) {
1243 chan_kern_created
= 1;
1245 /* Add kernel context to kernel tracer */
1246 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1247 if (ret
!= LTTNG_OK
) {
1251 case LTTNG_DOMAIN_UST
:
1253 struct ltt_ust_session
*usess
= session
->ust_session
;
1254 unsigned int chan_count
;
1258 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1259 if (chan_count
== 0) {
1260 struct lttng_channel
*attr
;
1261 /* Create default channel */
1262 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1264 ret
= LTTNG_ERR_FATAL
;
1268 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1269 if (ret
!= LTTNG_OK
) {
1274 chan_ust_created
= 1;
1277 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1278 if (ret
!= LTTNG_OK
) {
1284 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1285 case LTTNG_DOMAIN_UST_PID
:
1286 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1289 ret
= LTTNG_ERR_UND
;
1296 if (chan_kern_created
) {
1297 struct ltt_kernel_channel
*kchan
=
1298 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1299 session
->kernel_session
);
1300 /* Created previously, this should NOT fail. */
1302 kernel_destroy_channel(kchan
);
1305 if (chan_ust_created
) {
1306 struct ltt_ust_channel
*uchan
=
1307 trace_ust_find_channel_by_name(
1308 session
->ust_session
->domain_global
.channels
,
1309 DEFAULT_CHANNEL_NAME
);
1310 /* Created previously, this should NOT fail. */
1312 /* Remove from the channel list of the session. */
1313 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1315 trace_ust_destroy_channel(uchan
);
1320 static int validate_event_name(const char *name
)
1323 const char *c
= name
;
1324 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1327 * Make sure that unescaped wildcards are only used as the last
1328 * character of the event name.
1330 while (c
< event_name_end
) {
1338 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1339 /* Wildcard is not the last character */
1340 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1353 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1355 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1356 char *channel_name
, struct lttng_event
*event
,
1357 char *filter_expression
,
1358 struct lttng_filter_bytecode
*filter
,
1359 struct lttng_event_exclusion
*exclusion
,
1362 int ret
, channel_created
= 0;
1363 struct lttng_channel
*attr
;
1367 assert(channel_name
);
1369 ret
= validate_event_name(event
->name
);
1376 switch (domain
->type
) {
1377 case LTTNG_DOMAIN_KERNEL
:
1379 struct ltt_kernel_channel
*kchan
;
1382 * If a non-default channel has been created in the
1383 * session, explicitely require that -c chan_name needs
1386 if (session
->kernel_session
->has_non_default_channel
1387 && channel_name
[0] == '\0') {
1388 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1392 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1393 session
->kernel_session
);
1394 if (kchan
== NULL
) {
1395 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1396 LTTNG_BUFFER_GLOBAL
);
1398 ret
= LTTNG_ERR_FATAL
;
1401 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1403 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1404 if (ret
!= LTTNG_OK
) {
1410 channel_created
= 1;
1413 /* Get the newly created kernel channel pointer */
1414 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1415 session
->kernel_session
);
1416 if (kchan
== NULL
) {
1417 /* This sould not happen... */
1418 ret
= LTTNG_ERR_FATAL
;
1422 ret
= event_kernel_enable_tracepoint(kchan
, event
);
1423 if (ret
!= LTTNG_OK
) {
1424 if (channel_created
) {
1425 /* Let's not leak a useless channel. */
1426 kernel_destroy_channel(kchan
);
1431 kernel_wait_quiescent(kernel_tracer_fd
);
1434 case LTTNG_DOMAIN_UST
:
1436 struct ltt_ust_channel
*uchan
;
1437 struct ltt_ust_session
*usess
= session
->ust_session
;
1442 * If a non-default channel has been created in the
1443 * session, explicitely require that -c chan_name needs
1446 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1447 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1451 /* Get channel from global UST domain */
1452 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1454 if (uchan
== NULL
) {
1455 /* Create default channel */
1456 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1457 usess
->buffer_type
);
1459 ret
= LTTNG_ERR_FATAL
;
1462 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1464 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1465 if (ret
!= LTTNG_OK
) {
1471 /* Get the newly created channel reference back */
1472 uchan
= trace_ust_find_channel_by_name(
1473 usess
->domain_global
.channels
, channel_name
);
1477 /* At this point, the session and channel exist on the tracer */
1478 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1479 filter_expression
, filter
, exclusion
);
1480 if (ret
!= LTTNG_OK
) {
1485 case LTTNG_DOMAIN_LOG4J
:
1486 case LTTNG_DOMAIN_JUL
:
1489 struct lttng_event uevent
;
1490 struct lttng_domain tmp_dom
;
1491 struct ltt_ust_session
*usess
= session
->ust_session
;
1495 agt
= trace_ust_find_agent(usess
, domain
->type
);
1497 agt
= agent_create(domain
->type
);
1499 ret
= -LTTNG_ERR_NOMEM
;
1502 agent_add(agt
, usess
->agents
);
1505 /* Create the default tracepoint. */
1506 memset(&uevent
, 0, sizeof(uevent
));
1507 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1508 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1510 strncpy(uevent
.name
, DEFAULT_SYS_JUL_EVENT_NAME
,
1511 sizeof(uevent
.name
));
1513 strncpy(uevent
.name
, DEFAULT_USER_JUL_EVENT_NAME
,
1514 sizeof(uevent
.name
));
1516 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1519 * The domain type is changed because we are about to enable the
1520 * default channel and event for the JUL domain that are hardcoded.
1521 * This happens in the UST domain.
1523 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1524 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1526 ret
= cmd_enable_event(session
, &tmp_dom
, DEFAULT_JUL_CHANNEL_NAME
,
1527 &uevent
, filter_expression
, filter
, NULL
, wpipe
);
1528 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1532 /* The wild card * means that everything should be enabled. */
1533 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1534 ret
= event_agent_enable_all(usess
, agt
, event
, filter
);
1536 ret
= event_agent_enable(usess
, agt
, event
, filter
);
1538 if (ret
!= LTTNG_OK
) {
1545 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1546 case LTTNG_DOMAIN_UST_PID
:
1547 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1550 ret
= LTTNG_ERR_UND
;
1562 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
1564 int cmd_enable_event_all(struct ltt_session
*session
,
1565 struct lttng_domain
*domain
, char *channel_name
, int event_type
,
1566 char *filter_expression
,
1567 struct lttng_filter_bytecode
*filter
, int wpipe
)
1570 struct lttng_channel
*attr
;
1573 assert(channel_name
);
1577 switch (domain
->type
) {
1578 case LTTNG_DOMAIN_KERNEL
:
1580 struct ltt_kernel_channel
*kchan
;
1582 assert(session
->kernel_session
);
1585 * If a non-default channel has been created in the
1586 * session, explicitely require that -c chan_name needs
1589 if (session
->kernel_session
->has_non_default_channel
1590 && channel_name
[0] == '\0') {
1591 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1595 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1596 session
->kernel_session
);
1597 if (kchan
== NULL
) {
1598 /* Create default channel */
1599 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1600 LTTNG_BUFFER_GLOBAL
);
1602 ret
= LTTNG_ERR_FATAL
;
1605 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1607 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1608 if (ret
!= LTTNG_OK
) {
1614 /* Get the newly created kernel channel pointer */
1615 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1616 session
->kernel_session
);
1620 switch (event_type
) {
1621 case LTTNG_EVENT_SYSCALL
:
1622 ret
= event_kernel_enable_all_syscalls(kchan
, kernel_tracer_fd
);
1624 case LTTNG_EVENT_TRACEPOINT
:
1626 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
1627 * events already registered to the channel.
1629 ret
= event_kernel_enable_all_tracepoints(kchan
, kernel_tracer_fd
);
1631 case LTTNG_EVENT_ALL
:
1632 /* Enable syscalls and tracepoints */
1633 ret
= event_kernel_enable_all(kchan
, kernel_tracer_fd
);
1636 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
1640 /* Manage return value */
1641 if (ret
!= LTTNG_OK
) {
1643 * On error, cmd_enable_channel call will take care of destroying
1644 * the created channel if it was needed.
1649 kernel_wait_quiescent(kernel_tracer_fd
);
1652 case LTTNG_DOMAIN_UST
:
1654 struct ltt_ust_channel
*uchan
;
1655 struct ltt_ust_session
*usess
= session
->ust_session
;
1660 * If a non-default channel has been created in the
1661 * session, explicitely require that -c chan_name needs
1664 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1665 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1669 /* Get channel from global UST domain */
1670 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1672 if (uchan
== NULL
) {
1673 /* Create default channel */
1674 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1675 usess
->buffer_type
);
1677 ret
= LTTNG_ERR_FATAL
;
1680 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1682 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1683 if (ret
!= LTTNG_OK
) {
1689 /* Get the newly created channel reference back */
1690 uchan
= trace_ust_find_channel_by_name(
1691 usess
->domain_global
.channels
, channel_name
);
1695 /* At this point, the session and channel exist on the tracer */
1697 switch (event_type
) {
1698 case LTTNG_EVENT_ALL
:
1699 case LTTNG_EVENT_TRACEPOINT
:
1700 ret
= event_ust_enable_all_tracepoints(usess
, uchan
,
1701 filter_expression
, filter
);
1702 if (ret
!= LTTNG_OK
) {
1707 ret
= LTTNG_ERR_UST_ENABLE_FAIL
;
1711 /* Manage return value */
1712 if (ret
!= LTTNG_OK
) {
1718 case LTTNG_DOMAIN_LOG4J
:
1719 case LTTNG_DOMAIN_JUL
:
1722 struct lttng_event uevent
, event
;
1723 struct lttng_domain tmp_dom
;
1724 struct ltt_ust_session
*usess
= session
->ust_session
;
1728 agt
= trace_ust_find_agent(usess
, domain
->type
);
1730 agt
= agent_create(domain
->type
);
1732 ret
= -LTTNG_ERR_NOMEM
;
1735 agent_add(agt
, usess
->agents
);
1738 /* Create the default tracepoint. */
1739 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1740 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1742 strncpy(uevent
.name
, DEFAULT_SYS_JUL_EVENT_NAME
,
1743 sizeof(uevent
.name
));
1745 strncpy(uevent
.name
, DEFAULT_USER_JUL_EVENT_NAME
,
1746 sizeof(uevent
.name
));
1748 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1751 * The domain type is changed because we are about to enable the
1752 * default channel and event for the JUL domain that are hardcoded.
1753 * This happens in the UST domain.
1755 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1756 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1758 ret
= cmd_enable_event(session
, &tmp_dom
, DEFAULT_JUL_CHANNEL_NAME
,
1759 &uevent
, NULL
, NULL
, NULL
, wpipe
);
1760 if (ret
!= LTTNG_OK
&& ret
!= LTTNG_ERR_UST_EVENT_ENABLED
) {
1764 event
.loglevel
= LTTNG_LOGLEVEL_JUL_ALL
;
1765 event
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1766 strncpy(event
.name
, "*", sizeof(event
.name
));
1767 event
.name
[sizeof(event
.name
) - 1] = '\0';
1769 ret
= event_agent_enable_all(usess
, agt
, &event
, filter
);
1770 if (ret
!= LTTNG_OK
) {
1777 case LTTNG_DOMAIN_UST_EXEC_NAME
:
1778 case LTTNG_DOMAIN_UST_PID
:
1779 case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN
:
1782 ret
= LTTNG_ERR_UND
;
1795 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1797 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1800 ssize_t nb_events
= 0;
1803 case LTTNG_DOMAIN_KERNEL
:
1804 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1805 if (nb_events
< 0) {
1806 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1810 case LTTNG_DOMAIN_UST
:
1811 nb_events
= ust_app_list_events(events
);
1812 if (nb_events
< 0) {
1813 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1817 case LTTNG_DOMAIN_LOG4J
:
1818 case LTTNG_DOMAIN_JUL
:
1819 nb_events
= agent_list_events(events
);
1820 if (nb_events
< 0) {
1821 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1826 ret
= LTTNG_ERR_UND
;
1833 /* Return negative value to differentiate return code */
1838 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1840 ssize_t
cmd_list_tracepoint_fields(int domain
,
1841 struct lttng_event_field
**fields
)
1844 ssize_t nb_fields
= 0;
1847 case LTTNG_DOMAIN_UST
:
1848 nb_fields
= ust_app_list_event_fields(fields
);
1849 if (nb_fields
< 0) {
1850 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1854 case LTTNG_DOMAIN_KERNEL
:
1855 default: /* fall-through */
1856 ret
= LTTNG_ERR_UND
;
1863 /* Return negative value to differentiate return code */
1868 * Command LTTNG_START_TRACE processed by the client thread.
1870 int cmd_start_trace(struct ltt_session
*session
)
1873 unsigned long nb_chan
= 0;
1874 struct ltt_kernel_session
*ksession
;
1875 struct ltt_ust_session
*usess
;
1879 /* Ease our life a bit ;) */
1880 ksession
= session
->kernel_session
;
1881 usess
= session
->ust_session
;
1883 /* Is the session already started? */
1884 if (session
->active
) {
1885 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1890 * Starting a session without channel is useless since after that it's not
1891 * possible to enable channel thus inform the client.
1893 if (usess
&& usess
->domain_global
.channels
) {
1894 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
1897 nb_chan
+= ksession
->channel_count
;
1900 ret
= LTTNG_ERR_NO_CHANNEL
;
1904 /* Kernel tracing */
1905 if (ksession
!= NULL
) {
1906 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
1907 if (ret
!= LTTNG_OK
) {
1912 /* Flag session that trace should start automatically */
1915 * Even though the start trace might fail, flag this session active so
1916 * other application coming in are started by default.
1920 ret
= ust_app_start_trace_all(usess
);
1922 ret
= LTTNG_ERR_UST_START_FAIL
;
1927 /* Flag this after a successful start. */
1928 session
->has_been_started
= 1;
1929 session
->active
= 1;
1938 * Command LTTNG_STOP_TRACE processed by the client thread.
1940 int cmd_stop_trace(struct ltt_session
*session
)
1943 struct ltt_kernel_channel
*kchan
;
1944 struct ltt_kernel_session
*ksession
;
1945 struct ltt_ust_session
*usess
;
1950 ksession
= session
->kernel_session
;
1951 usess
= session
->ust_session
;
1953 /* Session is not active. Skip everythong and inform the client. */
1954 if (!session
->active
) {
1955 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
1960 if (ksession
&& ksession
->active
) {
1961 DBG("Stop kernel tracing");
1963 /* Flush metadata if exist */
1964 if (ksession
->metadata_stream_fd
>= 0) {
1965 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
1967 ERR("Kernel metadata flush failed");
1971 /* Flush all buffers before stopping */
1972 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
1973 ret
= kernel_flush_buffer(kchan
);
1975 ERR("Kernel flush buffer error");
1979 ret
= kernel_stop_session(ksession
);
1981 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
1985 kernel_wait_quiescent(kernel_tracer_fd
);
1987 ksession
->active
= 0;
1990 if (usess
&& usess
->active
) {
1992 * Even though the stop trace might fail, flag this session inactive so
1993 * other application coming in are not started by default.
1997 ret
= ust_app_stop_trace_all(usess
);
1999 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2004 /* Flag inactive after a successful stop. */
2005 session
->active
= 0;
2013 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2015 int cmd_set_consumer_uri(int domain
, struct ltt_session
*session
,
2016 size_t nb_uri
, struct lttng_uri
*uris
)
2019 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2020 struct ltt_ust_session
*usess
= session
->ust_session
;
2021 struct consumer_output
*consumer
= NULL
;
2027 /* Can't set consumer URI if the session is active. */
2028 if (session
->active
) {
2029 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2034 * This case switch makes sure the domain session has a temporary consumer
2035 * so the URL can be set.
2039 /* Code flow error. A session MUST always have a consumer object */
2040 assert(session
->consumer
);
2042 * The URL will be added to the tracing session consumer instead of a
2043 * specific domain consumer.
2045 consumer
= session
->consumer
;
2047 case LTTNG_DOMAIN_KERNEL
:
2048 /* Code flow error if we don't have a kernel session here. */
2050 assert(ksess
->consumer
);
2051 consumer
= ksess
->consumer
;
2053 case LTTNG_DOMAIN_UST
:
2054 /* Code flow error if we don't have a kernel session here. */
2056 assert(usess
->consumer
);
2057 consumer
= usess
->consumer
;
2061 for (i
= 0; i
< nb_uri
; i
++) {
2062 ret
= add_uri_to_consumer(consumer
, &uris
[i
], domain
, session
->name
);
2063 if (ret
!= LTTNG_OK
) {
2069 * Make sure to set the session in output mode after we set URI since a
2070 * session can be created without URL (thus flagged in no output mode).
2072 session
->output_traces
= 1;
2074 ksess
->output_traces
= 1;
2076 usess
->output_traces
= 1;
2087 * Command LTTNG_CREATE_SESSION processed by the client thread.
2089 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2090 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2093 struct ltt_session
*session
;
2099 * Verify if the session already exist
2101 * XXX: There is no need for the session lock list here since the caller
2102 * (process_client_msg) is holding it. We might want to change that so a
2103 * single command does not lock the entire session list.
2105 session
= session_find_by_name(name
);
2106 if (session
!= NULL
) {
2107 ret
= LTTNG_ERR_EXIST_SESS
;
2111 /* Create tracing session in the registry */
2112 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2113 LTTNG_SOCK_GET_GID_CRED(creds
));
2114 if (ret
!= LTTNG_OK
) {
2119 * Get the newly created session pointer back
2121 * XXX: There is no need for the session lock list here since the caller
2122 * (process_client_msg) is holding it. We might want to change that so a
2123 * single command does not lock the entire session list.
2125 session
= session_find_by_name(name
);
2128 session
->live_timer
= live_timer
;
2129 /* Create default consumer output for the session not yet created. */
2130 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2131 if (session
->consumer
== NULL
) {
2132 ret
= LTTNG_ERR_FATAL
;
2133 goto consumer_error
;
2137 ret
= cmd_set_consumer_uri(0, session
, nb_uri
, uris
);
2138 if (ret
!= LTTNG_OK
) {
2139 goto consumer_error
;
2141 session
->output_traces
= 1;
2143 session
->output_traces
= 0;
2144 DBG2("Session %s created with no output", session
->name
);
2147 session
->consumer
->enabled
= 1;
2152 session_destroy(session
);
2159 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2161 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2162 size_t nb_uri
, lttng_sock_cred
*creds
)
2165 struct ltt_session
*session
;
2166 struct snapshot_output
*new_output
= NULL
;
2172 * Create session in no output mode with URIs set to NULL. The uris we've
2173 * received are for a default snapshot output if one.
2175 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, -1);
2176 if (ret
!= LTTNG_OK
) {
2180 /* Get the newly created session pointer back. This should NEVER fail. */
2181 session
= session_find_by_name(name
);
2184 /* Flag session for snapshot mode. */
2185 session
->snapshot_mode
= 1;
2187 /* Skip snapshot output creation if no URI is given. */
2192 new_output
= snapshot_output_alloc();
2194 ret
= LTTNG_ERR_NOMEM
;
2195 goto error_snapshot_alloc
;
2198 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2199 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2201 if (ret
== -ENOMEM
) {
2202 ret
= LTTNG_ERR_NOMEM
;
2204 ret
= LTTNG_ERR_INVALID
;
2206 goto error_snapshot
;
2210 snapshot_add_output(&session
->snapshot
, new_output
);
2217 snapshot_output_destroy(new_output
);
2218 error_snapshot_alloc
:
2219 session_destroy(session
);
2225 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2227 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2230 struct ltt_ust_session
*usess
;
2231 struct ltt_kernel_session
*ksess
;
2236 usess
= session
->ust_session
;
2237 ksess
= session
->kernel_session
;
2239 /* Clean kernel session teardown */
2240 kernel_destroy_session(ksess
);
2242 /* UST session teardown */
2244 /* Close any relayd session */
2245 consumer_output_send_destroy_relayd(usess
->consumer
);
2247 /* Destroy every UST application related to this session. */
2248 ret
= ust_app_destroy_trace_all(usess
);
2250 ERR("Error in ust_app_destroy_trace_all");
2253 /* Clean up the rest. */
2254 trace_ust_destroy_session(usess
);
2258 * Must notify the kernel thread here to update it's poll set in order to
2259 * remove the channel(s)' fd just destroyed.
2261 ret
= notify_thread_pipe(wpipe
);
2263 PERROR("write kernel poll pipe");
2266 ret
= session_destroy(session
);
2272 * Command LTTNG_CALIBRATE processed by the client thread.
2274 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2279 case LTTNG_DOMAIN_KERNEL
:
2281 struct lttng_kernel_calibrate kcalibrate
;
2283 switch (calibrate
->type
) {
2284 case LTTNG_CALIBRATE_FUNCTION
:
2286 /* Default and only possible calibrate option. */
2287 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2291 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2293 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2298 case LTTNG_DOMAIN_UST
:
2300 struct lttng_ust_calibrate ucalibrate
;
2302 switch (calibrate
->type
) {
2303 case LTTNG_CALIBRATE_FUNCTION
:
2305 /* Default and only possible calibrate option. */
2306 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2310 ret
= ust_app_calibrate_glb(&ucalibrate
);
2312 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2318 ret
= LTTNG_ERR_UND
;
2329 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2331 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2332 const char *sock_path
, struct consumer_data
*cdata
)
2335 struct consumer_socket
*socket
= NULL
;
2342 case LTTNG_DOMAIN_KERNEL
:
2344 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2348 /* Can't register a consumer if there is already one */
2349 if (ksess
->consumer_fds_sent
!= 0) {
2350 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2354 sock
= lttcomm_connect_unix_sock(sock_path
);
2356 ret
= LTTNG_ERR_CONNECT_FAIL
;
2359 cdata
->cmd_sock
= sock
;
2361 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2362 if (socket
== NULL
) {
2365 PERROR("close register consumer");
2367 cdata
->cmd_sock
= -1;
2368 ret
= LTTNG_ERR_FATAL
;
2372 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2373 if (socket
->lock
== NULL
) {
2374 PERROR("zmalloc pthread mutex");
2375 ret
= LTTNG_ERR_FATAL
;
2378 pthread_mutex_init(socket
->lock
, NULL
);
2379 socket
->registered
= 1;
2382 consumer_add_socket(socket
, ksess
->consumer
);
2385 pthread_mutex_lock(&cdata
->pid_mutex
);
2387 pthread_mutex_unlock(&cdata
->pid_mutex
);
2392 /* TODO: Userspace tracing */
2393 ret
= LTTNG_ERR_UND
;
2401 consumer_destroy_socket(socket
);
2407 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2409 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2410 struct lttng_domain
**domains
)
2415 struct lttng_ht_iter iter
;
2417 if (session
->kernel_session
!= NULL
) {
2418 DBG3("Listing domains found kernel domain");
2422 if (session
->ust_session
!= NULL
) {
2423 DBG3("Listing domains found UST global domain");
2426 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2428 if (agt
->being_used
) {
2434 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2435 if (*domains
== NULL
) {
2436 ret
= LTTNG_ERR_FATAL
;
2440 if (session
->kernel_session
!= NULL
) {
2441 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2445 if (session
->ust_session
!= NULL
) {
2446 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2447 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2450 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2452 if (agt
->being_used
) {
2453 (*domains
)[index
].type
= agt
->domain
;
2454 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2463 /* Return negative value to differentiate return code */
2469 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2471 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2472 struct lttng_channel
**channels
)
2475 ssize_t nb_chan
= 0;
2478 case LTTNG_DOMAIN_KERNEL
:
2479 if (session
->kernel_session
!= NULL
) {
2480 nb_chan
= session
->kernel_session
->channel_count
;
2482 DBG3("Number of kernel channels %zd", nb_chan
);
2484 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2487 case LTTNG_DOMAIN_UST
:
2488 if (session
->ust_session
!= NULL
) {
2489 nb_chan
= lttng_ht_get_count(
2490 session
->ust_session
->domain_global
.channels
);
2492 DBG3("Number of UST global channels %zd", nb_chan
);
2494 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2499 ret
= LTTNG_ERR_UND
;
2504 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2505 if (*channels
== NULL
) {
2506 ret
= LTTNG_ERR_FATAL
;
2510 list_lttng_channels(domain
, session
, *channels
);
2513 /* Ret value was set in the domain switch case */
2520 /* Return negative value to differentiate return code */
2525 * Command LTTNG_LIST_EVENTS processed by the client thread.
2527 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2528 char *channel_name
, struct lttng_event
**events
)
2531 ssize_t nb_event
= 0;
2534 case LTTNG_DOMAIN_KERNEL
:
2535 if (session
->kernel_session
!= NULL
) {
2536 nb_event
= list_lttng_kernel_events(channel_name
,
2537 session
->kernel_session
, events
);
2540 case LTTNG_DOMAIN_UST
:
2542 if (session
->ust_session
!= NULL
) {
2543 nb_event
= list_lttng_ust_global_events(channel_name
,
2544 &session
->ust_session
->domain_global
, events
);
2548 case LTTNG_DOMAIN_LOG4J
:
2549 case LTTNG_DOMAIN_JUL
:
2550 if (session
->ust_session
) {
2551 struct lttng_ht_iter iter
;
2554 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2555 &iter
.iter
, agt
, node
.node
) {
2556 nb_event
= list_lttng_agent_events(agt
, events
);
2561 ret
= LTTNG_ERR_UND
;
2568 /* Return negative value to differentiate return code */
2573 * Using the session list, filled a lttng_session array to send back to the
2574 * client for session listing.
2576 * The session list lock MUST be acquired before calling this function. Use
2577 * session_lock_list() and session_unlock_list().
2579 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2584 struct ltt_session
*session
;
2585 struct ltt_session_list
*list
= session_get_list();
2587 DBG("Getting all available session for UID %d GID %d",
2590 * Iterate over session list and append data after the control struct in
2593 cds_list_for_each_entry(session
, &list
->head
, list
) {
2595 * Only list the sessions the user can control.
2597 if (!session_access_ok(session
, uid
, gid
)) {
2601 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2602 struct ltt_ust_session
*usess
= session
->ust_session
;
2604 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2605 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2606 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2607 ret
= build_network_session_path(sessions
[i
].path
,
2608 sizeof(sessions
[i
].path
), session
);
2610 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2611 session
->consumer
->dst
.trace_path
);
2614 PERROR("snprintf session path");
2618 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2619 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2620 sessions
[i
].enabled
= session
->active
;
2621 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2622 sessions
[i
].live_timer_interval
= session
->live_timer
;
2628 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2629 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2631 int cmd_data_pending(struct ltt_session
*session
)
2634 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2635 struct ltt_ust_session
*usess
= session
->ust_session
;
2639 /* Session MUST be stopped to ask for data availability. */
2640 if (session
->active
) {
2641 ret
= LTTNG_ERR_SESSION_STARTED
;
2645 * If stopped, just make sure we've started before else the above call
2646 * will always send that there is data pending.
2648 * The consumer assumes that when the data pending command is received,
2649 * the trace has been started before or else no output data is written
2650 * by the streams which is a condition for data pending. So, this is
2651 * *VERY* important that we don't ask the consumer before a start
2654 if (!session
->has_been_started
) {
2660 if (ksess
&& ksess
->consumer
) {
2661 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2663 /* Data is still being extracted for the kernel. */
2668 if (usess
&& usess
->consumer
) {
2669 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2671 /* Data is still being extracted for the kernel. */
2676 /* Data is ready to be read by a viewer */
2684 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2686 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2688 int cmd_snapshot_add_output(struct ltt_session
*session
,
2689 struct lttng_snapshot_output
*output
, uint32_t *id
)
2692 struct snapshot_output
*new_output
;
2697 DBG("Cmd snapshot add output for session %s", session
->name
);
2700 * Permission denied to create an output if the session is not
2701 * set in no output mode.
2703 if (session
->output_traces
) {
2704 ret
= LTTNG_ERR_EPERM
;
2708 /* Only one output is allowed until we have the "tee" feature. */
2709 if (session
->snapshot
.nb_output
== 1) {
2710 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2714 new_output
= snapshot_output_alloc();
2716 ret
= LTTNG_ERR_NOMEM
;
2720 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2721 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2722 &session
->snapshot
);
2724 if (ret
== -ENOMEM
) {
2725 ret
= LTTNG_ERR_NOMEM
;
2727 ret
= LTTNG_ERR_INVALID
;
2733 snapshot_add_output(&session
->snapshot
, new_output
);
2735 *id
= new_output
->id
;
2742 snapshot_output_destroy(new_output
);
2748 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2750 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2752 int cmd_snapshot_del_output(struct ltt_session
*session
,
2753 struct lttng_snapshot_output
*output
)
2756 struct snapshot_output
*sout
= NULL
;
2764 * Permission denied to create an output if the session is not
2765 * set in no output mode.
2767 if (session
->output_traces
) {
2768 ret
= LTTNG_ERR_EPERM
;
2773 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2775 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2776 } else if (*output
->name
!= '\0') {
2777 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2779 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2782 ret
= LTTNG_ERR_INVALID
;
2786 snapshot_delete_output(&session
->snapshot
, sout
);
2787 snapshot_output_destroy(sout
);
2796 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2798 * If no output is available, outputs is untouched and 0 is returned.
2800 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2802 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2803 struct lttng_snapshot_output
**outputs
)
2806 struct lttng_snapshot_output
*list
;
2807 struct lttng_ht_iter iter
;
2808 struct snapshot_output
*output
;
2813 DBG("Cmd snapshot list outputs for session %s", session
->name
);
2816 * Permission denied to create an output if the session is not
2817 * set in no output mode.
2819 if (session
->output_traces
) {
2820 ret
= LTTNG_ERR_EPERM
;
2824 if (session
->snapshot
.nb_output
== 0) {
2829 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
2831 ret
= LTTNG_ERR_NOMEM
;
2835 /* Copy list from session to the new list object. */
2836 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
2837 output
, node
.node
) {
2838 assert(output
->consumer
);
2839 list
[idx
].id
= output
->id
;
2840 list
[idx
].max_size
= output
->max_size
;
2841 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
2842 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
2843 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
2844 sizeof(list
[idx
].ctrl_url
));
2847 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
2848 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
2850 ret
= LTTNG_ERR_NOMEM
;
2855 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
2856 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
2858 ret
= LTTNG_ERR_NOMEM
;
2866 return session
->snapshot
.nb_output
;
2875 * Send relayd sockets from snapshot output to consumer. Ignore request if the
2876 * snapshot output is *not* set with a remote destination.
2878 * Return 0 on success or a LTTNG_ERR code.
2880 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
2881 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
2884 struct lttng_ht_iter iter
;
2885 struct consumer_socket
*socket
;
2888 assert(snap_output
);
2891 DBG2("Set relayd object from snapshot output");
2893 /* Ignore if snapshot consumer output is not network. */
2894 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
2899 * For each consumer socket, create and send the relayd object of the
2903 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
2904 socket
, node
.node
) {
2905 ret
= send_consumer_relayd_sockets(0, session
->id
,
2906 snap_output
->consumer
, socket
,
2907 session
->name
, session
->hostname
,
2908 session
->live_timer
);
2909 if (ret
!= LTTNG_OK
) {
2921 * Record a kernel snapshot.
2923 * Return LTTNG_OK on success or a LTTNG_ERR code.
2925 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
2926 struct snapshot_output
*output
, struct ltt_session
*session
,
2927 int wait
, uint64_t max_stream_size
)
2935 /* Get the datetime for the snapshot output directory. */
2936 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
2937 sizeof(output
->datetime
));
2939 ret
= LTTNG_ERR_INVALID
;
2944 * Copy kernel session sockets so we can communicate with the right
2945 * consumer for the snapshot record command.
2947 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
2949 ret
= LTTNG_ERR_NOMEM
;
2953 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
2954 if (ret
!= LTTNG_OK
) {
2955 goto error_snapshot
;
2958 ret
= kernel_snapshot_record(ksess
, output
, wait
, max_stream_size
);
2959 if (ret
!= LTTNG_OK
) {
2960 goto error_snapshot
;
2966 /* Clean up copied sockets so this output can use some other later on. */
2967 consumer_destroy_output_sockets(output
->consumer
);
2973 * Record a UST snapshot.
2975 * Return 0 on success or a LTTNG_ERR error code.
2977 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
2978 struct snapshot_output
*output
, struct ltt_session
*session
,
2979 int wait
, uint64_t max_stream_size
)
2987 /* Get the datetime for the snapshot output directory. */
2988 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", output
->datetime
,
2989 sizeof(output
->datetime
));
2991 ret
= LTTNG_ERR_INVALID
;
2996 * Copy UST session sockets so we can communicate with the right
2997 * consumer for the snapshot record command.
2999 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3001 ret
= LTTNG_ERR_NOMEM
;
3005 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3006 if (ret
!= LTTNG_OK
) {
3007 goto error_snapshot
;
3010 ret
= ust_app_snapshot_record(usess
, output
, wait
, max_stream_size
);
3014 ret
= LTTNG_ERR_INVALID
;
3017 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3020 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3023 goto error_snapshot
;
3029 /* Clean up copied sockets so this output can use some other later on. */
3030 consumer_destroy_output_sockets(output
->consumer
);
3036 * Return the biggest subbuffer size of all channels in the given session.
3038 static uint64_t get_session_max_subbuf_size(struct ltt_session
*session
)
3040 uint64_t max_size
= 0;
3044 if (session
->kernel_session
) {
3045 struct ltt_kernel_channel
*chan
;
3046 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3049 * For each channel, add to the max size the size of each subbuffer
3050 * multiplied by their sized.
3052 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3053 if (chan
->channel
->attr
.subbuf_size
> max_size
) {
3054 max_size
= chan
->channel
->attr
.subbuf_size
;
3059 if (session
->ust_session
) {
3060 struct lttng_ht_iter iter
;
3061 struct ltt_ust_channel
*uchan
;
3062 struct ltt_ust_session
*usess
= session
->ust_session
;
3064 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
3066 if (uchan
->attr
.subbuf_size
> max_size
) {
3067 max_size
= uchan
->attr
.subbuf_size
;
3076 * Returns the total number of streams for a session or a negative value
3079 static unsigned int get_session_nb_streams(struct ltt_session
*session
)
3081 unsigned int total_streams
= 0;
3083 if (session
->kernel_session
) {
3084 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3086 total_streams
+= ksess
->stream_count_global
;
3089 if (session
->ust_session
) {
3090 struct ltt_ust_session
*usess
= session
->ust_session
;
3092 total_streams
+= ust_app_get_nb_stream(usess
);
3095 return total_streams
;
3099 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3101 * The wait parameter is ignored so this call always wait for the snapshot to
3102 * complete before returning.
3104 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3106 int cmd_snapshot_record(struct ltt_session
*session
,
3107 struct lttng_snapshot_output
*output
, int wait
)
3110 unsigned int use_tmp_output
= 0;
3111 struct snapshot_output tmp_output
;
3112 unsigned int nb_streams
, snapshot_success
= 0;
3113 uint64_t session_max_size
= 0, max_stream_size
= 0;
3117 DBG("Cmd snapshot record for session %s", session
->name
);
3120 * Permission denied to create an output if the session is not
3121 * set in no output mode.
3123 if (session
->output_traces
) {
3124 ret
= LTTNG_ERR_EPERM
;
3128 /* The session needs to be started at least once. */
3129 if (!session
->has_been_started
) {
3130 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3134 /* Use temporary output for the session. */
3135 if (output
&& *output
->ctrl_url
!= '\0') {
3136 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3137 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3140 if (ret
== -ENOMEM
) {
3141 ret
= LTTNG_ERR_NOMEM
;
3143 ret
= LTTNG_ERR_INVALID
;
3147 /* Use the global session count for the temporary snapshot. */
3148 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3153 * Get the session maximum size for a snapshot meaning it will compute the
3154 * size of all streams from all domain.
3156 max_stream_size
= get_session_max_subbuf_size(session
);
3158 nb_streams
= get_session_nb_streams(session
);
3161 * The maximum size of the snapshot is the number of streams multiplied
3162 * by the biggest subbuf size of all channels in a session which is the
3163 * maximum stream size available for each stream. The session max size
3164 * is now checked against the snapshot max size value given by the user
3165 * and if lower, an error is returned.
3167 session_max_size
= max_stream_size
* nb_streams
;
3170 DBG3("Snapshot max size is %" PRIu64
" for max stream size of %" PRIu64
,
3171 session_max_size
, max_stream_size
);
3174 * If we use a temporary output, check right away if the max size fits else
3175 * for each output the max size will be checked.
3177 if (use_tmp_output
&&
3178 (tmp_output
.max_size
!= 0 &&
3179 tmp_output
.max_size
< session_max_size
)) {
3180 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3184 if (session
->kernel_session
) {
3185 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3187 if (use_tmp_output
) {
3188 ret
= record_kernel_snapshot(ksess
, &tmp_output
, session
,
3189 wait
, max_stream_size
);
3190 if (ret
!= LTTNG_OK
) {
3193 snapshot_success
= 1;
3195 struct snapshot_output
*sout
;
3196 struct lttng_ht_iter iter
;
3199 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3200 &iter
.iter
, sout
, node
.node
) {
3202 * Make a local copy of the output and assign the possible
3203 * temporary value given by the caller.
3205 memset(&tmp_output
, 0, sizeof(tmp_output
));
3206 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3208 /* Use temporary max size. */
3209 if (output
->max_size
!= (uint64_t) -1ULL) {
3210 tmp_output
.max_size
= output
->max_size
;
3213 if (tmp_output
.max_size
!= 0 &&
3214 tmp_output
.max_size
< session_max_size
) {
3216 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3220 /* Use temporary name. */
3221 if (*output
->name
!= '\0') {
3222 strncpy(tmp_output
.name
, output
->name
,
3223 sizeof(tmp_output
.name
));
3226 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3228 ret
= record_kernel_snapshot(ksess
, &tmp_output
,
3229 session
, wait
, max_stream_size
);
3230 if (ret
!= LTTNG_OK
) {
3234 snapshot_success
= 1;
3240 if (session
->ust_session
) {
3241 struct ltt_ust_session
*usess
= session
->ust_session
;
3243 if (use_tmp_output
) {
3244 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3245 wait
, max_stream_size
);
3246 if (ret
!= LTTNG_OK
) {
3249 snapshot_success
= 1;
3251 struct snapshot_output
*sout
;
3252 struct lttng_ht_iter iter
;
3255 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3256 &iter
.iter
, sout
, node
.node
) {
3258 * Make a local copy of the output and assign the possible
3259 * temporary value given by the caller.
3261 memset(&tmp_output
, 0, sizeof(tmp_output
));
3262 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3264 /* Use temporary max size. */
3265 if (output
->max_size
!= (uint64_t) -1ULL) {
3266 tmp_output
.max_size
= output
->max_size
;
3269 if (tmp_output
.max_size
!= 0 &&
3270 tmp_output
.max_size
< session_max_size
) {
3272 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3276 /* Use temporary name. */
3277 if (*output
->name
!= '\0') {
3278 strncpy(tmp_output
.name
, output
->name
,
3279 sizeof(tmp_output
.name
));
3282 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3284 ret
= record_ust_snapshot(usess
, &tmp_output
, session
,
3285 wait
, max_stream_size
);
3286 if (ret
!= LTTNG_OK
) {
3290 snapshot_success
= 1;
3296 if (snapshot_success
) {
3297 session
->snapshot
.nb_snapshot
++;
3299 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3307 * Init command subsystem.
3312 * Set network sequence index to 1 for streams to match a relayd
3313 * socket on the consumer side.
3315 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3316 relayd_net_seq_idx
= 1;
3317 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3319 DBG("Command subsystem initialized");