2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include <urcu/list.h>
24 #include <urcu/uatomic.h>
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
35 #include "health-sessiond.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
45 * Used to keep a unique index for each relayd socket created where this value
46 * is associated with streams on the consumer so it can match the right relayd
47 * to send to. It must be accessed with the relayd_net_seq_idx_lock
50 static pthread_mutex_t relayd_net_seq_idx_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 static uint64_t relayd_net_seq_idx
;
53 static int validate_event_name(const char *);
54 static int validate_ust_event_name(const char *);
55 static int cmd_enable_event_internal(struct ltt_session
*session
,
56 struct lttng_domain
*domain
,
57 char *channel_name
, struct lttng_event
*event
,
58 char *filter_expression
,
59 struct lttng_filter_bytecode
*filter
,
60 struct lttng_event_exclusion
*exclusion
,
64 * Create a session path used by list_lttng_sessions for the case that the
65 * session consumer is on the network.
67 static int build_network_session_path(char *dst
, size_t size
,
68 struct ltt_session
*session
)
70 int ret
, kdata_port
, udata_port
;
71 struct lttng_uri
*kuri
= NULL
, *uuri
= NULL
, *uri
= NULL
;
72 char tmp_uurl
[PATH_MAX
], tmp_urls
[PATH_MAX
];
77 memset(tmp_urls
, 0, sizeof(tmp_urls
));
78 memset(tmp_uurl
, 0, sizeof(tmp_uurl
));
80 kdata_port
= udata_port
= DEFAULT_NETWORK_DATA_PORT
;
82 if (session
->kernel_session
&& session
->kernel_session
->consumer
) {
83 kuri
= &session
->kernel_session
->consumer
->dst
.net
.control
;
84 kdata_port
= session
->kernel_session
->consumer
->dst
.net
.data
.port
;
87 if (session
->ust_session
&& session
->ust_session
->consumer
) {
88 uuri
= &session
->ust_session
->consumer
->dst
.net
.control
;
89 udata_port
= session
->ust_session
->consumer
->dst
.net
.data
.port
;
92 if (uuri
== NULL
&& kuri
== NULL
) {
93 uri
= &session
->consumer
->dst
.net
.control
;
94 kdata_port
= session
->consumer
->dst
.net
.data
.port
;
95 } else if (kuri
&& uuri
) {
96 ret
= uri_compare(kuri
, uuri
);
100 /* Build uuri URL string */
101 ret
= uri_to_str_url(uuri
, tmp_uurl
, sizeof(tmp_uurl
));
108 } else if (kuri
&& uuri
== NULL
) {
110 } else if (uuri
&& kuri
== NULL
) {
114 ret
= uri_to_str_url(uri
, tmp_urls
, sizeof(tmp_urls
));
120 * Do we have a UST url set. If yes, this means we have both kernel and UST
123 if (*tmp_uurl
!= '\0') {
124 ret
= snprintf(dst
, size
, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
125 tmp_urls
, kdata_port
, tmp_uurl
, udata_port
);
128 if (kuri
|| (!kuri
&& !uuri
)) {
131 /* No kernel URI, use the UST port. */
134 ret
= snprintf(dst
, size
, "%s [data: %d]", tmp_urls
, dport
);
142 * Fill lttng_channel array of all channels.
144 static void list_lttng_channels(int domain
, struct ltt_session
*session
,
145 struct lttng_channel
*channels
)
148 struct ltt_kernel_channel
*kchan
;
150 DBG("Listing channels for session %s", session
->name
);
153 case LTTNG_DOMAIN_KERNEL
:
154 /* Kernel channels */
155 if (session
->kernel_session
!= NULL
) {
156 cds_list_for_each_entry(kchan
,
157 &session
->kernel_session
->channel_list
.head
, list
) {
158 /* Copy lttng_channel struct to array */
159 memcpy(&channels
[i
], kchan
->channel
, sizeof(struct lttng_channel
));
160 channels
[i
].enabled
= kchan
->enabled
;
165 case LTTNG_DOMAIN_UST
:
167 struct lttng_ht_iter iter
;
168 struct ltt_ust_channel
*uchan
;
171 cds_lfht_for_each_entry(session
->ust_session
->domain_global
.channels
->ht
,
172 &iter
.iter
, uchan
, node
.node
) {
173 strncpy(channels
[i
].name
, uchan
->name
, LTTNG_SYMBOL_NAME_LEN
);
174 channels
[i
].attr
.overwrite
= uchan
->attr
.overwrite
;
175 channels
[i
].attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
176 channels
[i
].attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
177 channels
[i
].attr
.switch_timer_interval
=
178 uchan
->attr
.switch_timer_interval
;
179 channels
[i
].attr
.read_timer_interval
=
180 uchan
->attr
.read_timer_interval
;
181 channels
[i
].enabled
= uchan
->enabled
;
182 channels
[i
].attr
.tracefile_size
= uchan
->tracefile_size
;
183 channels
[i
].attr
.tracefile_count
= uchan
->tracefile_count
;
184 switch (uchan
->attr
.output
) {
187 channels
[i
].attr
.output
= LTTNG_EVENT_MMAP
;
201 * Create a list of agent domain events.
203 * Return number of events in list on success or else a negative value.
205 static int list_lttng_agent_events(struct agent
*agt
,
206 struct lttng_event
**events
)
209 unsigned int nb_event
= 0;
210 struct agent_event
*event
;
211 struct lttng_event
*tmp_events
;
212 struct lttng_ht_iter iter
;
217 DBG3("Listing agent events");
220 nb_event
= lttng_ht_get_count(agt
->events
);
227 tmp_events
= zmalloc(nb_event
* sizeof(*tmp_events
));
229 PERROR("zmalloc agent events session");
230 ret
= -LTTNG_ERR_FATAL
;
235 cds_lfht_for_each_entry(agt
->events
->ht
, &iter
.iter
, event
, node
.node
) {
236 strncpy(tmp_events
[i
].name
, event
->name
, sizeof(tmp_events
[i
].name
));
237 tmp_events
[i
].name
[sizeof(tmp_events
[i
].name
) - 1] = '\0';
238 tmp_events
[i
].enabled
= event
->enabled
;
239 tmp_events
[i
].loglevel
= event
->loglevel_value
;
240 tmp_events
[i
].loglevel_type
= event
->loglevel_type
;
245 *events
= tmp_events
;
249 assert(nb_event
== i
);
254 * Create a list of ust global domain events.
256 static int list_lttng_ust_global_events(char *channel_name
,
257 struct ltt_ust_domain_global
*ust_global
, struct lttng_event
**events
)
260 unsigned int nb_event
= 0;
261 struct lttng_ht_iter iter
;
262 struct lttng_ht_node_str
*node
;
263 struct ltt_ust_channel
*uchan
;
264 struct ltt_ust_event
*uevent
;
265 struct lttng_event
*tmp
;
267 DBG("Listing UST global events for channel %s", channel_name
);
271 lttng_ht_lookup(ust_global
->channels
, (void *)channel_name
, &iter
);
272 node
= lttng_ht_iter_get_node_str(&iter
);
274 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
278 uchan
= caa_container_of(&node
->node
, struct ltt_ust_channel
, node
.node
);
280 nb_event
= lttng_ht_get_count(uchan
->events
);
286 DBG3("Listing UST global %d events", nb_event
);
288 tmp
= zmalloc(nb_event
* sizeof(struct lttng_event
));
290 ret
= LTTNG_ERR_FATAL
;
294 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
295 if (uevent
->internal
) {
296 /* This event should remain hidden from clients */
300 strncpy(tmp
[i
].name
, uevent
->attr
.name
, LTTNG_SYMBOL_NAME_LEN
);
301 tmp
[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
302 tmp
[i
].enabled
= uevent
->enabled
;
304 switch (uevent
->attr
.instrumentation
) {
305 case LTTNG_UST_TRACEPOINT
:
306 tmp
[i
].type
= LTTNG_EVENT_TRACEPOINT
;
308 case LTTNG_UST_PROBE
:
309 tmp
[i
].type
= LTTNG_EVENT_PROBE
;
311 case LTTNG_UST_FUNCTION
:
312 tmp
[i
].type
= LTTNG_EVENT_FUNCTION
;
316 tmp
[i
].loglevel
= uevent
->attr
.loglevel
;
317 switch (uevent
->attr
.loglevel_type
) {
318 case LTTNG_UST_LOGLEVEL_ALL
:
319 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
321 case LTTNG_UST_LOGLEVEL_RANGE
:
322 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_RANGE
;
324 case LTTNG_UST_LOGLEVEL_SINGLE
:
325 tmp
[i
].loglevel_type
= LTTNG_EVENT_LOGLEVEL_SINGLE
;
328 if (uevent
->filter
) {
331 if (uevent
->exclusion
) {
332 tmp
[i
].exclusion
= 1;
346 * Fill lttng_event array of all kernel events in the channel.
348 static int list_lttng_kernel_events(char *channel_name
,
349 struct ltt_kernel_session
*kernel_session
, struct lttng_event
**events
)
352 unsigned int nb_event
;
353 struct ltt_kernel_event
*event
;
354 struct ltt_kernel_channel
*kchan
;
356 kchan
= trace_kernel_get_channel_by_name(channel_name
, kernel_session
);
358 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
362 nb_event
= kchan
->event_count
;
364 DBG("Listing events for channel %s", kchan
->channel
->name
);
371 *events
= zmalloc(nb_event
* sizeof(struct lttng_event
));
372 if (*events
== NULL
) {
373 ret
= LTTNG_ERR_FATAL
;
377 /* Kernel channels */
378 cds_list_for_each_entry(event
, &kchan
->events_list
.head
, list
) {
379 strncpy((*events
)[i
].name
, event
->event
->name
, LTTNG_SYMBOL_NAME_LEN
);
380 (*events
)[i
].name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
381 (*events
)[i
].enabled
= event
->enabled
;
382 (*events
)[i
].filter
=
383 (unsigned char) !!event
->filter_expression
;
385 switch (event
->event
->instrumentation
) {
386 case LTTNG_KERNEL_TRACEPOINT
:
387 (*events
)[i
].type
= LTTNG_EVENT_TRACEPOINT
;
389 case LTTNG_KERNEL_KRETPROBE
:
390 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
391 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
392 sizeof(struct lttng_kernel_kprobe
));
394 case LTTNG_KERNEL_KPROBE
:
395 (*events
)[i
].type
= LTTNG_EVENT_PROBE
;
396 memcpy(&(*events
)[i
].attr
.probe
, &event
->event
->u
.kprobe
,
397 sizeof(struct lttng_kernel_kprobe
));
399 case LTTNG_KERNEL_FUNCTION
:
400 (*events
)[i
].type
= LTTNG_EVENT_FUNCTION
;
401 memcpy(&((*events
)[i
].attr
.ftrace
), &event
->event
->u
.ftrace
,
402 sizeof(struct lttng_kernel_function
));
404 case LTTNG_KERNEL_NOOP
:
405 (*events
)[i
].type
= LTTNG_EVENT_NOOP
;
407 case LTTNG_KERNEL_SYSCALL
:
408 (*events
)[i
].type
= LTTNG_EVENT_SYSCALL
;
410 case LTTNG_KERNEL_ALL
:
421 /* Negate the error code to differentiate the size from an error */
426 * Add URI so the consumer output object. Set the correct path depending on the
427 * domain adding the default trace directory.
429 static int add_uri_to_consumer(struct consumer_output
*consumer
,
430 struct lttng_uri
*uri
, int domain
, const char *session_name
)
433 const char *default_trace_dir
;
437 if (consumer
== NULL
) {
438 DBG("No consumer detected. Don't add URI. Stopping.");
439 ret
= LTTNG_ERR_NO_CONSUMER
;
444 case LTTNG_DOMAIN_KERNEL
:
445 default_trace_dir
= DEFAULT_KERNEL_TRACE_DIR
;
447 case LTTNG_DOMAIN_UST
:
448 default_trace_dir
= DEFAULT_UST_TRACE_DIR
;
452 * This case is possible is we try to add the URI to the global tracing
453 * session consumer object which in this case there is no subdir.
455 default_trace_dir
= "";
458 switch (uri
->dtype
) {
461 DBG2("Setting network URI to consumer");
463 if (consumer
->type
== CONSUMER_DST_NET
) {
464 if ((uri
->stype
== LTTNG_STREAM_CONTROL
&&
465 consumer
->dst
.net
.control_isset
) ||
466 (uri
->stype
== LTTNG_STREAM_DATA
&&
467 consumer
->dst
.net
.data_isset
)) {
468 ret
= LTTNG_ERR_URL_EXIST
;
472 memset(&consumer
->dst
.net
, 0, sizeof(consumer
->dst
.net
));
475 consumer
->type
= CONSUMER_DST_NET
;
477 /* Set URI into consumer output object */
478 ret
= consumer_set_network_uri(consumer
, uri
);
482 } else if (ret
== 1) {
484 * URI was the same in the consumer so we do not append the subdir
485 * again so to not duplicate output dir.
491 if (uri
->stype
== LTTNG_STREAM_CONTROL
&& strlen(uri
->subdir
) == 0) {
492 ret
= consumer_set_subdir(consumer
, session_name
);
494 ret
= LTTNG_ERR_FATAL
;
499 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
500 /* On a new subdir, reappend the default trace dir. */
501 strncat(consumer
->subdir
, default_trace_dir
,
502 sizeof(consumer
->subdir
) - strlen(consumer
->subdir
) - 1);
503 DBG3("Append domain trace name to subdir %s", consumer
->subdir
);
508 DBG2("Setting trace directory path from URI to %s", uri
->dst
.path
);
509 memset(consumer
->dst
.trace_path
, 0,
510 sizeof(consumer
->dst
.trace_path
));
511 strncpy(consumer
->dst
.trace_path
, uri
->dst
.path
,
512 sizeof(consumer
->dst
.trace_path
));
513 /* Append default trace dir */
514 strncat(consumer
->dst
.trace_path
, default_trace_dir
,
515 sizeof(consumer
->dst
.trace_path
) -
516 strlen(consumer
->dst
.trace_path
) - 1);
517 /* Flag consumer as local. */
518 consumer
->type
= CONSUMER_DST_LOCAL
;
529 * Init tracing by creating trace directory and sending fds kernel consumer.
531 static int init_kernel_tracing(struct ltt_kernel_session
*session
)
534 struct lttng_ht_iter iter
;
535 struct consumer_socket
*socket
;
541 if (session
->consumer_fds_sent
== 0 && session
->consumer
!= NULL
) {
542 cds_lfht_for_each_entry(session
->consumer
->socks
->ht
, &iter
.iter
,
544 pthread_mutex_lock(socket
->lock
);
545 ret
= kernel_consumer_send_session(socket
, session
);
546 pthread_mutex_unlock(socket
->lock
);
548 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
560 * Create a socket to the relayd using the URI.
562 * On success, the relayd_sock pointer is set to the created socket.
563 * Else, it's stays untouched and a lttcomm error code is returned.
565 static int create_connect_relayd(struct lttng_uri
*uri
,
566 struct lttcomm_relayd_sock
**relayd_sock
)
569 struct lttcomm_relayd_sock
*rsock
;
571 rsock
= lttcomm_alloc_relayd_sock(uri
, RELAYD_VERSION_COMM_MAJOR
,
572 RELAYD_VERSION_COMM_MINOR
);
574 ret
= LTTNG_ERR_FATAL
;
579 * Connect to relayd so we can proceed with a session creation. This call
580 * can possibly block for an arbitrary amount of time to set the health
581 * state to be in poll execution.
584 ret
= relayd_connect(rsock
);
587 ERR("Unable to reach lttng-relayd");
588 ret
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
592 /* Create socket for control stream. */
593 if (uri
->stype
== LTTNG_STREAM_CONTROL
) {
594 DBG3("Creating relayd stream socket from URI");
596 /* Check relayd version */
597 ret
= relayd_version_check(rsock
);
599 ret
= LTTNG_ERR_RELAYD_VERSION_FAIL
;
602 } else if (uri
->stype
== LTTNG_STREAM_DATA
) {
603 DBG3("Creating relayd data socket from URI");
605 /* Command is not valid */
606 ERR("Relayd invalid stream type: %d", uri
->stype
);
607 ret
= LTTNG_ERR_INVALID
;
611 *relayd_sock
= rsock
;
616 /* The returned value is not useful since we are on an error path. */
617 (void) relayd_close(rsock
);
625 * Connect to the relayd using URI and send the socket to the right consumer.
627 static int send_consumer_relayd_socket(int domain
, unsigned int session_id
,
628 struct lttng_uri
*relayd_uri
, struct consumer_output
*consumer
,
629 struct consumer_socket
*consumer_sock
,
630 char *session_name
, char *hostname
, int session_live_timer
)
633 struct lttcomm_relayd_sock
*rsock
= NULL
;
635 /* Connect to relayd and make version check if uri is the control. */
636 ret
= create_connect_relayd(relayd_uri
, &rsock
);
637 if (ret
!= LTTNG_OK
) {
642 /* Set the network sequence index if not set. */
643 if (consumer
->net_seq_index
== (uint64_t) -1ULL) {
644 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
646 * Increment net_seq_idx because we are about to transfer the
647 * new relayd socket to the consumer.
648 * Assign unique key so the consumer can match streams.
650 consumer
->net_seq_index
= ++relayd_net_seq_idx
;
651 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
654 /* Send relayd socket to consumer. */
655 ret
= consumer_send_relayd_socket(consumer_sock
, rsock
, consumer
,
656 relayd_uri
->stype
, session_id
,
657 session_name
, hostname
, session_live_timer
);
659 ret
= LTTNG_ERR_ENABLE_CONSUMER_FAIL
;
663 /* Flag that the corresponding socket was sent. */
664 if (relayd_uri
->stype
== LTTNG_STREAM_CONTROL
) {
665 consumer_sock
->control_sock_sent
= 1;
666 } else if (relayd_uri
->stype
== LTTNG_STREAM_DATA
) {
667 consumer_sock
->data_sock_sent
= 1;
673 * Close socket which was dup on the consumer side. The session daemon does
674 * NOT keep track of the relayd socket(s) once transfer to the consumer.
678 (void) relayd_close(rsock
);
682 if (ret
!= LTTNG_OK
) {
684 * The consumer output for this session should not be used anymore
685 * since the relayd connection failed thus making any tracing or/and
686 * streaming not usable.
688 consumer
->enabled
= 0;
694 * Send both relayd sockets to a specific consumer and domain. This is a
695 * helper function to facilitate sending the information to the consumer for a
698 static int send_consumer_relayd_sockets(int domain
, unsigned int session_id
,
699 struct consumer_output
*consumer
, struct consumer_socket
*sock
,
700 char *session_name
, char *hostname
, int session_live_timer
)
707 /* Sending control relayd socket. */
708 if (!sock
->control_sock_sent
) {
709 ret
= send_consumer_relayd_socket(domain
, session_id
,
710 &consumer
->dst
.net
.control
, consumer
, sock
,
711 session_name
, hostname
, session_live_timer
);
712 if (ret
!= LTTNG_OK
) {
717 /* Sending data relayd socket. */
718 if (!sock
->data_sock_sent
) {
719 ret
= send_consumer_relayd_socket(domain
, session_id
,
720 &consumer
->dst
.net
.data
, consumer
, sock
,
721 session_name
, hostname
, session_live_timer
);
722 if (ret
!= LTTNG_OK
) {
732 * Setup relayd connections for a tracing session. First creates the socket to
733 * the relayd and send them to the right domain consumer. Consumer type MUST be
736 int cmd_setup_relayd(struct ltt_session
*session
)
739 struct ltt_ust_session
*usess
;
740 struct ltt_kernel_session
*ksess
;
741 struct consumer_socket
*socket
;
742 struct lttng_ht_iter iter
;
746 usess
= session
->ust_session
;
747 ksess
= session
->kernel_session
;
749 DBG("Setting relayd for session %s", session
->name
);
753 if (usess
&& usess
->consumer
&& usess
->consumer
->type
== CONSUMER_DST_NET
754 && usess
->consumer
->enabled
) {
755 /* For each consumer socket, send relayd sockets */
756 cds_lfht_for_each_entry(usess
->consumer
->socks
->ht
, &iter
.iter
,
758 pthread_mutex_lock(socket
->lock
);
759 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_UST
, session
->id
,
760 usess
->consumer
, socket
,
761 session
->name
, session
->hostname
,
762 session
->live_timer
);
763 pthread_mutex_unlock(socket
->lock
);
764 if (ret
!= LTTNG_OK
) {
767 /* Session is now ready for network streaming. */
768 session
->net_handle
= 1;
772 if (ksess
&& ksess
->consumer
&& ksess
->consumer
->type
== CONSUMER_DST_NET
773 && ksess
->consumer
->enabled
) {
774 cds_lfht_for_each_entry(ksess
->consumer
->socks
->ht
, &iter
.iter
,
776 pthread_mutex_lock(socket
->lock
);
777 ret
= send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL
, session
->id
,
778 ksess
->consumer
, socket
,
779 session
->name
, session
->hostname
,
780 session
->live_timer
);
781 pthread_mutex_unlock(socket
->lock
);
782 if (ret
!= LTTNG_OK
) {
785 /* Session is now ready for network streaming. */
786 session
->net_handle
= 1;
796 * Start a kernel session by opening all necessary streams.
798 static int start_kernel_session(struct ltt_kernel_session
*ksess
, int wpipe
)
801 struct ltt_kernel_channel
*kchan
;
803 /* Open kernel metadata */
804 if (ksess
->metadata
== NULL
&& ksess
->output_traces
) {
805 ret
= kernel_open_metadata(ksess
);
807 ret
= LTTNG_ERR_KERN_META_FAIL
;
812 /* Open kernel metadata stream */
813 if (ksess
->metadata
&& ksess
->metadata_stream_fd
< 0) {
814 ret
= kernel_open_metadata_stream(ksess
);
816 ERR("Kernel create metadata stream failed");
817 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
822 /* For each channel */
823 cds_list_for_each_entry(kchan
, &ksess
->channel_list
.head
, list
) {
824 if (kchan
->stream_count
== 0) {
825 ret
= kernel_open_channel_stream(kchan
);
827 ret
= LTTNG_ERR_KERN_STREAM_FAIL
;
830 /* Update the stream global counter */
831 ksess
->stream_count_global
+= ret
;
835 /* Setup kernel consumer socket and send fds to it */
836 ret
= init_kernel_tracing(ksess
);
838 ret
= LTTNG_ERR_KERN_START_FAIL
;
842 /* This start the kernel tracing */
843 ret
= kernel_start_session(ksess
);
845 ret
= LTTNG_ERR_KERN_START_FAIL
;
849 /* Quiescent wait after starting trace */
850 kernel_wait_quiescent(kernel_tracer_fd
);
861 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
863 int cmd_disable_channel(struct ltt_session
*session
, int domain
,
867 struct ltt_ust_session
*usess
;
869 usess
= session
->ust_session
;
874 case LTTNG_DOMAIN_KERNEL
:
876 ret
= channel_kernel_disable(session
->kernel_session
,
878 if (ret
!= LTTNG_OK
) {
882 kernel_wait_quiescent(kernel_tracer_fd
);
885 case LTTNG_DOMAIN_UST
:
887 struct ltt_ust_channel
*uchan
;
888 struct lttng_ht
*chan_ht
;
890 chan_ht
= usess
->domain_global
.channels
;
892 uchan
= trace_ust_find_channel_by_name(chan_ht
, channel_name
);
894 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
898 ret
= channel_ust_disable(usess
, uchan
);
899 if (ret
!= LTTNG_OK
) {
905 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
917 * Command LTTNG_TRACK_PID processed by the client thread.
919 * Called with session lock held.
921 int cmd_track_pid(struct ltt_session
*session
, int domain
, int pid
)
928 case LTTNG_DOMAIN_KERNEL
:
930 struct ltt_kernel_session
*ksess
;
932 ksess
= session
->kernel_session
;
934 ret
= kernel_track_pid(ksess
, pid
);
935 if (ret
!= LTTNG_OK
) {
939 kernel_wait_quiescent(kernel_tracer_fd
);
942 case LTTNG_DOMAIN_UST
:
944 struct ltt_ust_session
*usess
;
946 usess
= session
->ust_session
;
948 ret
= trace_ust_track_pid(usess
, pid
);
949 if (ret
!= LTTNG_OK
) {
955 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
967 * Command LTTNG_UNTRACK_PID processed by the client thread.
969 * Called with session lock held.
971 int cmd_untrack_pid(struct ltt_session
*session
, int domain
, int pid
)
978 case LTTNG_DOMAIN_KERNEL
:
980 struct ltt_kernel_session
*ksess
;
982 ksess
= session
->kernel_session
;
984 ret
= kernel_untrack_pid(ksess
, pid
);
985 if (ret
!= LTTNG_OK
) {
989 kernel_wait_quiescent(kernel_tracer_fd
);
992 case LTTNG_DOMAIN_UST
:
994 struct ltt_ust_session
*usess
;
996 usess
= session
->ust_session
;
998 ret
= trace_ust_untrack_pid(usess
, pid
);
999 if (ret
!= LTTNG_OK
) {
1005 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1017 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1019 * The wpipe arguments is used as a notifier for the kernel thread.
1021 int cmd_enable_channel(struct ltt_session
*session
,
1022 struct lttng_domain
*domain
, struct lttng_channel
*attr
, int wpipe
)
1025 struct ltt_ust_session
*usess
= session
->ust_session
;
1026 struct lttng_ht
*chan_ht
;
1033 len
= strnlen(attr
->name
, sizeof(attr
->name
));
1035 /* Validate channel name */
1036 if (attr
->name
[0] == '.' ||
1037 memchr(attr
->name
, '/', len
) != NULL
) {
1038 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1042 DBG("Enabling channel %s for session %s", attr
->name
, session
->name
);
1047 * Don't try to enable a channel if the session has been started at
1048 * some point in time before. The tracer does not allow it.
1050 if (session
->has_been_started
) {
1051 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
1056 * If the session is a live session, remove the switch timer, the
1057 * live timer does the same thing but sends also synchronisation
1058 * beacons for inactive streams.
1060 if (session
->live_timer
> 0) {
1061 attr
->attr
.live_timer_interval
= session
->live_timer
;
1062 attr
->attr
.switch_timer_interval
= 0;
1066 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1067 * mode and with less than 2 subbuf so block it right away and send back an
1068 * invalid attribute error.
1070 if (attr
->attr
.overwrite
&& attr
->attr
.num_subbuf
< 2) {
1071 ret
= LTTNG_ERR_INVALID
;
1075 switch (domain
->type
) {
1076 case LTTNG_DOMAIN_KERNEL
:
1078 struct ltt_kernel_channel
*kchan
;
1080 kchan
= trace_kernel_get_channel_by_name(attr
->name
,
1081 session
->kernel_session
);
1082 if (kchan
== NULL
) {
1083 ret
= channel_kernel_create(session
->kernel_session
, attr
, wpipe
);
1084 if (attr
->name
[0] != '\0') {
1085 session
->kernel_session
->has_non_default_channel
= 1;
1088 ret
= channel_kernel_enable(session
->kernel_session
, kchan
);
1091 if (ret
!= LTTNG_OK
) {
1095 kernel_wait_quiescent(kernel_tracer_fd
);
1098 case LTTNG_DOMAIN_UST
:
1099 case LTTNG_DOMAIN_JUL
:
1100 case LTTNG_DOMAIN_LOG4J
:
1101 case LTTNG_DOMAIN_PYTHON
:
1103 struct ltt_ust_channel
*uchan
;
1108 * Current agent implementation limitations force us to allow
1109 * only one channel at once in "agent" subdomains. Each
1110 * subdomain has a default channel name which must be strictly
1113 if (domain
->type
== LTTNG_DOMAIN_JUL
) {
1114 if (strncmp(attr
->name
, DEFAULT_JUL_CHANNEL_NAME
,
1115 LTTNG_SYMBOL_NAME_LEN
)) {
1116 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1119 } else if (domain
->type
== LTTNG_DOMAIN_LOG4J
) {
1120 if (strncmp(attr
->name
, DEFAULT_LOG4J_CHANNEL_NAME
,
1121 LTTNG_SYMBOL_NAME_LEN
)) {
1122 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1125 } else if (domain
->type
== LTTNG_DOMAIN_PYTHON
) {
1126 if (strncmp(attr
->name
, DEFAULT_PYTHON_CHANNEL_NAME
,
1127 LTTNG_SYMBOL_NAME_LEN
)) {
1128 ret
= LTTNG_ERR_INVALID_CHANNEL_NAME
;
1133 chan_ht
= usess
->domain_global
.channels
;
1135 uchan
= trace_ust_find_channel_by_name(chan_ht
, attr
->name
);
1136 if (uchan
== NULL
) {
1137 ret
= channel_ust_create(usess
, attr
, domain
->buf_type
);
1138 if (attr
->name
[0] != '\0') {
1139 usess
->has_non_default_channel
= 1;
1142 ret
= channel_ust_enable(usess
, uchan
);
1147 ret
= LTTNG_ERR_UNKNOWN_DOMAIN
;
1158 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1160 int cmd_disable_event(struct ltt_session
*session
, int domain
,
1162 struct lttng_event
*event
)
1167 DBG("Disable event command for event \'%s\'", event
->name
);
1169 event_name
= event
->name
;
1170 if (validate_event_name(event_name
)) {
1171 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1175 /* Error out on unhandled search criteria */
1176 if (event
->loglevel_type
|| event
->loglevel
!= -1 || event
->enabled
1177 || event
->pid
|| event
->filter
|| event
->exclusion
) {
1178 ret
= LTTNG_ERR_UNK
;
1185 case LTTNG_DOMAIN_KERNEL
:
1187 struct ltt_kernel_channel
*kchan
;
1188 struct ltt_kernel_session
*ksess
;
1190 ksess
= session
->kernel_session
;
1193 * If a non-default channel has been created in the
1194 * session, explicitely require that -c chan_name needs
1197 if (ksess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1198 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1202 kchan
= trace_kernel_get_channel_by_name(channel_name
, ksess
);
1203 if (kchan
== NULL
) {
1204 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
1208 switch (event
->type
) {
1209 case LTTNG_EVENT_ALL
:
1210 case LTTNG_EVENT_TRACEPOINT
:
1211 case LTTNG_EVENT_SYSCALL
:
1212 case LTTNG_EVENT_PROBE
:
1213 case LTTNG_EVENT_FUNCTION
:
1214 case LTTNG_EVENT_FUNCTION_ENTRY
:/* fall-through */
1215 if (event_name
[0] == '\0') {
1216 ret
= event_kernel_disable_event(kchan
,
1219 ret
= event_kernel_disable_event(kchan
,
1220 event_name
, event
->type
);
1222 if (ret
!= LTTNG_OK
) {
1227 ret
= LTTNG_ERR_UNK
;
1231 kernel_wait_quiescent(kernel_tracer_fd
);
1234 case LTTNG_DOMAIN_UST
:
1236 struct ltt_ust_channel
*uchan
;
1237 struct ltt_ust_session
*usess
;
1239 usess
= session
->ust_session
;
1241 if (validate_ust_event_name(event_name
)) {
1242 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1247 * If a non-default channel has been created in the
1248 * session, explicitly require that -c chan_name needs
1251 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1252 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1256 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1258 if (uchan
== NULL
) {
1259 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1263 switch (event
->type
) {
1264 case LTTNG_EVENT_ALL
:
1266 * An empty event name means that everything
1267 * should be disabled.
1269 if (event
->name
[0] == '\0') {
1270 ret
= event_ust_disable_all_tracepoints(usess
, uchan
);
1272 ret
= event_ust_disable_tracepoint(usess
, uchan
,
1275 if (ret
!= LTTNG_OK
) {
1280 ret
= LTTNG_ERR_UNK
;
1284 DBG3("Disable UST event %s in channel %s completed", event_name
,
1288 case LTTNG_DOMAIN_LOG4J
:
1289 case LTTNG_DOMAIN_JUL
:
1290 case LTTNG_DOMAIN_PYTHON
:
1293 struct ltt_ust_session
*usess
= session
->ust_session
;
1297 switch (event
->type
) {
1298 case LTTNG_EVENT_ALL
:
1301 ret
= LTTNG_ERR_UNK
;
1305 agt
= trace_ust_find_agent(usess
, domain
);
1307 ret
= -LTTNG_ERR_UST_EVENT_NOT_FOUND
;
1311 * An empty event name means that everything
1312 * should be disabled.
1314 if (event
->name
[0] == '\0') {
1315 ret
= event_agent_disable_all(usess
, agt
);
1317 ret
= event_agent_disable(usess
, agt
, event_name
);
1319 if (ret
!= LTTNG_OK
) {
1326 ret
= LTTNG_ERR_UND
;
1339 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1341 int cmd_add_context(struct ltt_session
*session
, int domain
,
1342 char *channel_name
, struct lttng_event_context
*ctx
, int kwpipe
)
1344 int ret
, chan_kern_created
= 0, chan_ust_created
= 0;
1347 case LTTNG_DOMAIN_KERNEL
:
1348 assert(session
->kernel_session
);
1350 if (session
->kernel_session
->channel_count
== 0) {
1351 /* Create default channel */
1352 ret
= channel_kernel_create(session
->kernel_session
, NULL
, kwpipe
);
1353 if (ret
!= LTTNG_OK
) {
1356 chan_kern_created
= 1;
1358 /* Add kernel context to kernel tracer */
1359 ret
= context_kernel_add(session
->kernel_session
, ctx
, channel_name
);
1360 if (ret
!= LTTNG_OK
) {
1364 case LTTNG_DOMAIN_UST
:
1366 struct ltt_ust_session
*usess
= session
->ust_session
;
1367 unsigned int chan_count
;
1371 chan_count
= lttng_ht_get_count(usess
->domain_global
.channels
);
1372 if (chan_count
== 0) {
1373 struct lttng_channel
*attr
;
1374 /* Create default channel */
1375 attr
= channel_new_default_attr(domain
, usess
->buffer_type
);
1377 ret
= LTTNG_ERR_FATAL
;
1381 ret
= channel_ust_create(usess
, attr
, usess
->buffer_type
);
1382 if (ret
!= LTTNG_OK
) {
1387 chan_ust_created
= 1;
1390 ret
= context_ust_add(usess
, domain
, ctx
, channel_name
);
1391 if (ret
!= LTTNG_OK
) {
1397 ret
= LTTNG_ERR_UND
;
1404 if (chan_kern_created
) {
1405 struct ltt_kernel_channel
*kchan
=
1406 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME
,
1407 session
->kernel_session
);
1408 /* Created previously, this should NOT fail. */
1410 kernel_destroy_channel(kchan
);
1413 if (chan_ust_created
) {
1414 struct ltt_ust_channel
*uchan
=
1415 trace_ust_find_channel_by_name(
1416 session
->ust_session
->domain_global
.channels
,
1417 DEFAULT_CHANNEL_NAME
);
1418 /* Created previously, this should NOT fail. */
1420 /* Remove from the channel list of the session. */
1421 trace_ust_delete_channel(session
->ust_session
->domain_global
.channels
,
1423 trace_ust_destroy_channel(uchan
);
1428 static int validate_event_name(const char *name
)
1431 const char *c
= name
;
1432 const char *event_name_end
= c
+ LTTNG_SYMBOL_NAME_LEN
;
1435 * Make sure that unescaped wildcards are only used as the last
1436 * character of the event name.
1438 while (c
< event_name_end
) {
1446 if ((c
+ 1) < event_name_end
&& *(c
+ 1)) {
1447 /* Wildcard is not the last character */
1448 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1460 static inline bool name_starts_with(const char *name
, const char *prefix
)
1462 const size_t max_cmp_len
= min(strlen(prefix
), LTTNG_SYMBOL_NAME_LEN
);
1464 return !strncmp(name
, prefix
, max_cmp_len
);
1467 /* Perform userspace-specific event name validation */
1468 static int validate_ust_event_name(const char *name
)
1478 * Check name against all internal UST event component namespaces used
1481 if (name_starts_with(name
, DEFAULT_JUL_EVENT_COMPONENT
) ||
1482 name_starts_with(name
, DEFAULT_LOG4J_EVENT_COMPONENT
) ||
1483 name_starts_with(name
, DEFAULT_PYTHON_EVENT_COMPONENT
)) {
1492 * Internal version of cmd_enable_event() with a supplemental
1493 * "internal_event" flag which is used to enable internal events which should
1494 * be hidden from clients. Such events are used in the agent implementation to
1495 * enable the events through which all "agent" events are funeled.
1497 static int _cmd_enable_event(struct ltt_session
*session
,
1498 struct lttng_domain
*domain
,
1499 char *channel_name
, struct lttng_event
*event
,
1500 char *filter_expression
,
1501 struct lttng_filter_bytecode
*filter
,
1502 struct lttng_event_exclusion
*exclusion
,
1503 int wpipe
, bool internal_event
)
1505 int ret
, channel_created
= 0;
1506 struct lttng_channel
*attr
;
1510 assert(channel_name
);
1512 DBG("Enable event command for event \'%s\'", event
->name
);
1516 ret
= validate_event_name(event
->name
);
1521 switch (domain
->type
) {
1522 case LTTNG_DOMAIN_KERNEL
:
1524 struct ltt_kernel_channel
*kchan
;
1527 * If a non-default channel has been created in the
1528 * session, explicitely require that -c chan_name needs
1531 if (session
->kernel_session
->has_non_default_channel
1532 && channel_name
[0] == '\0') {
1533 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1537 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1538 session
->kernel_session
);
1539 if (kchan
== NULL
) {
1540 attr
= channel_new_default_attr(LTTNG_DOMAIN_KERNEL
,
1541 LTTNG_BUFFER_GLOBAL
);
1543 ret
= LTTNG_ERR_FATAL
;
1546 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1548 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1549 if (ret
!= LTTNG_OK
) {
1555 channel_created
= 1;
1558 /* Get the newly created kernel channel pointer */
1559 kchan
= trace_kernel_get_channel_by_name(channel_name
,
1560 session
->kernel_session
);
1561 if (kchan
== NULL
) {
1562 /* This sould not happen... */
1563 ret
= LTTNG_ERR_FATAL
;
1567 switch (event
->type
) {
1568 case LTTNG_EVENT_ALL
:
1570 char *filter_expression_a
= NULL
;
1571 struct lttng_filter_bytecode
*filter_a
= NULL
;
1574 * We need to duplicate filter_expression and filter,
1575 * because ownership is passed to first enable
1578 if (filter_expression
) {
1579 filter_expression_a
= strdup(filter_expression
);
1580 if (!filter_expression_a
) {
1581 ret
= LTTNG_ERR_FATAL
;
1586 filter_a
= zmalloc(sizeof(*filter_a
) + filter
->len
);
1588 free(filter_expression_a
);
1589 ret
= LTTNG_ERR_FATAL
;
1592 memcpy(filter_a
, filter
, sizeof(*filter_a
) + filter
->len
);
1594 event
->type
= LTTNG_EVENT_TRACEPOINT
; /* Hack */
1595 ret
= event_kernel_enable_event(kchan
, event
,
1596 filter_expression
, filter
);
1597 /* We have passed ownership */
1598 filter_expression
= NULL
;
1600 if (ret
!= LTTNG_OK
) {
1601 if (channel_created
) {
1602 /* Let's not leak a useless channel. */
1603 kernel_destroy_channel(kchan
);
1605 free(filter_expression_a
);
1609 event
->type
= LTTNG_EVENT_SYSCALL
; /* Hack */
1610 ret
= event_kernel_enable_event(kchan
, event
,
1611 filter_expression_a
, filter_a
);
1612 /* We have passed ownership */
1613 filter_expression_a
= NULL
;
1615 if (ret
!= LTTNG_OK
) {
1620 case LTTNG_EVENT_PROBE
:
1621 case LTTNG_EVENT_FUNCTION
:
1622 case LTTNG_EVENT_FUNCTION_ENTRY
:
1623 case LTTNG_EVENT_TRACEPOINT
:
1624 ret
= event_kernel_enable_event(kchan
, event
,
1625 filter_expression
, filter
);
1626 /* We have passed ownership */
1627 filter_expression
= NULL
;
1629 if (ret
!= LTTNG_OK
) {
1630 if (channel_created
) {
1631 /* Let's not leak a useless channel. */
1632 kernel_destroy_channel(kchan
);
1637 case LTTNG_EVENT_SYSCALL
:
1638 ret
= event_kernel_enable_event(kchan
, event
,
1639 filter_expression
, filter
);
1640 /* We have passed ownership */
1641 filter_expression
= NULL
;
1643 if (ret
!= LTTNG_OK
) {
1648 ret
= LTTNG_ERR_UNK
;
1652 kernel_wait_quiescent(kernel_tracer_fd
);
1655 case LTTNG_DOMAIN_UST
:
1657 struct ltt_ust_channel
*uchan
;
1658 struct ltt_ust_session
*usess
= session
->ust_session
;
1663 * If a non-default channel has been created in the
1664 * session, explicitely require that -c chan_name needs
1667 if (usess
->has_non_default_channel
&& channel_name
[0] == '\0') {
1668 ret
= LTTNG_ERR_NEED_CHANNEL_NAME
;
1672 /* Get channel from global UST domain */
1673 uchan
= trace_ust_find_channel_by_name(usess
->domain_global
.channels
,
1675 if (uchan
== NULL
) {
1676 /* Create default channel */
1677 attr
= channel_new_default_attr(LTTNG_DOMAIN_UST
,
1678 usess
->buffer_type
);
1680 ret
= LTTNG_ERR_FATAL
;
1683 strncpy(attr
->name
, channel_name
, sizeof(attr
->name
));
1685 ret
= cmd_enable_channel(session
, domain
, attr
, wpipe
);
1686 if (ret
!= LTTNG_OK
) {
1692 /* Get the newly created channel reference back */
1693 uchan
= trace_ust_find_channel_by_name(
1694 usess
->domain_global
.channels
, channel_name
);
1698 if (uchan
->domain
!= LTTNG_DOMAIN_UST
&& !internal_event
) {
1700 * Don't allow users to add UST events to channels which
1701 * are assigned to a userspace subdomain (JUL, Log4J,
1704 ret
= LTTNG_ERR_INVALID_CHANNEL_DOMAIN
;
1708 if (!internal_event
) {
1710 * Ensure the event name is not reserved for internal
1713 ret
= validate_ust_event_name(event
->name
);
1715 WARN("Userspace event name %s failed validation.",
1717 event
->name
: "NULL");
1718 ret
= LTTNG_ERR_INVALID_EVENT_NAME
;
1723 /* At this point, the session and channel exist on the tracer */
1724 ret
= event_ust_enable_tracepoint(usess
, uchan
, event
,
1725 filter_expression
, filter
, exclusion
,
1727 /* We have passed ownership */
1728 filter_expression
= NULL
;
1731 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1732 goto already_enabled
;
1733 } else if (ret
!= LTTNG_OK
) {
1738 case LTTNG_DOMAIN_LOG4J
:
1739 case LTTNG_DOMAIN_JUL
:
1740 case LTTNG_DOMAIN_PYTHON
:
1742 const char *default_event_name
, *default_chan_name
;
1744 struct lttng_event uevent
;
1745 struct lttng_domain tmp_dom
;
1746 struct ltt_ust_session
*usess
= session
->ust_session
;
1750 agt
= trace_ust_find_agent(usess
, domain
->type
);
1752 agt
= agent_create(domain
->type
);
1754 ret
= LTTNG_ERR_NOMEM
;
1757 agent_add(agt
, usess
->agents
);
1760 /* Create the default tracepoint. */
1761 memset(&uevent
, 0, sizeof(uevent
));
1762 uevent
.type
= LTTNG_EVENT_TRACEPOINT
;
1763 uevent
.loglevel_type
= LTTNG_EVENT_LOGLEVEL_ALL
;
1764 default_event_name
= event_get_default_agent_ust_name(
1766 if (!default_event_name
) {
1767 ret
= LTTNG_ERR_FATAL
;
1770 strncpy(uevent
.name
, default_event_name
, sizeof(uevent
.name
));
1771 uevent
.name
[sizeof(uevent
.name
) - 1] = '\0';
1774 * The domain type is changed because we are about to enable the
1775 * default channel and event for the JUL domain that are hardcoded.
1776 * This happens in the UST domain.
1778 memcpy(&tmp_dom
, domain
, sizeof(tmp_dom
));
1779 tmp_dom
.type
= LTTNG_DOMAIN_UST
;
1781 switch (domain
->type
) {
1782 case LTTNG_DOMAIN_LOG4J
:
1783 default_chan_name
= DEFAULT_LOG4J_CHANNEL_NAME
;
1785 case LTTNG_DOMAIN_JUL
:
1786 default_chan_name
= DEFAULT_JUL_CHANNEL_NAME
;
1788 case LTTNG_DOMAIN_PYTHON
:
1789 default_chan_name
= DEFAULT_PYTHON_CHANNEL_NAME
;
1792 /* The switch/case we are in should avoid this else big problem */
1797 char *filter_expression_copy
= NULL
;
1798 struct lttng_filter_bytecode
*filter_copy
= NULL
;
1801 const size_t filter_size
= sizeof(
1802 struct lttng_filter_bytecode
)
1805 filter_copy
= zmalloc(filter_size
);
1807 ret
= LTTNG_ERR_NOMEM
;
1810 memcpy(filter_copy
, filter
, filter_size
);
1812 filter_expression_copy
=
1813 strdup(filter_expression
);
1814 if (!filter_expression
) {
1815 ret
= LTTNG_ERR_NOMEM
;
1818 if (!filter_expression_copy
|| !filter_copy
) {
1819 free(filter_expression_copy
);
1825 ret
= cmd_enable_event_internal(session
, &tmp_dom
,
1826 (char *) default_chan_name
,
1827 &uevent
, filter_expression_copy
,
1828 filter_copy
, NULL
, wpipe
);
1831 if (ret
== LTTNG_ERR_UST_EVENT_ENABLED
) {
1832 goto already_enabled
;
1833 } else if (ret
!= LTTNG_OK
) {
1837 /* The wild card * means that everything should be enabled. */
1838 if (strncmp(event
->name
, "*", 1) == 0 && strlen(event
->name
) == 1) {
1839 ret
= event_agent_enable_all(usess
, agt
, event
, filter
,
1842 ret
= event_agent_enable(usess
, agt
, event
, filter
,
1846 filter_expression
= NULL
;
1847 if (ret
!= LTTNG_OK
) {
1854 ret
= LTTNG_ERR_UND
;
1862 free(filter_expression
);
1870 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1871 * We own filter, exclusion, and filter_expression.
1873 int cmd_enable_event(struct ltt_session
*session
, struct lttng_domain
*domain
,
1874 char *channel_name
, struct lttng_event
*event
,
1875 char *filter_expression
,
1876 struct lttng_filter_bytecode
*filter
,
1877 struct lttng_event_exclusion
*exclusion
,
1880 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1881 filter_expression
, filter
, exclusion
, wpipe
, false);
1885 * Enable an event which is internal to LTTng. An internal should
1886 * never be made visible to clients and are immune to checks such as
1889 static int cmd_enable_event_internal(struct ltt_session
*session
,
1890 struct lttng_domain
*domain
,
1891 char *channel_name
, struct lttng_event
*event
,
1892 char *filter_expression
,
1893 struct lttng_filter_bytecode
*filter
,
1894 struct lttng_event_exclusion
*exclusion
,
1897 return _cmd_enable_event(session
, domain
, channel_name
, event
,
1898 filter_expression
, filter
, exclusion
, wpipe
, true);
1902 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1904 ssize_t
cmd_list_tracepoints(int domain
, struct lttng_event
**events
)
1907 ssize_t nb_events
= 0;
1910 case LTTNG_DOMAIN_KERNEL
:
1911 nb_events
= kernel_list_events(kernel_tracer_fd
, events
);
1912 if (nb_events
< 0) {
1913 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
1917 case LTTNG_DOMAIN_UST
:
1918 nb_events
= ust_app_list_events(events
);
1919 if (nb_events
< 0) {
1920 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1924 case LTTNG_DOMAIN_LOG4J
:
1925 case LTTNG_DOMAIN_JUL
:
1926 case LTTNG_DOMAIN_PYTHON
:
1927 nb_events
= agent_list_events(events
, domain
);
1928 if (nb_events
< 0) {
1929 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1934 ret
= LTTNG_ERR_UND
;
1941 /* Return negative value to differentiate return code */
1946 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1948 ssize_t
cmd_list_tracepoint_fields(int domain
,
1949 struct lttng_event_field
**fields
)
1952 ssize_t nb_fields
= 0;
1955 case LTTNG_DOMAIN_UST
:
1956 nb_fields
= ust_app_list_event_fields(fields
);
1957 if (nb_fields
< 0) {
1958 ret
= LTTNG_ERR_UST_LIST_FAIL
;
1962 case LTTNG_DOMAIN_KERNEL
:
1963 default: /* fall-through */
1964 ret
= LTTNG_ERR_UND
;
1971 /* Return negative value to differentiate return code */
1975 ssize_t
cmd_list_syscalls(struct lttng_event
**events
)
1977 return syscall_table_list(events
);
1981 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1983 * Called with session lock held.
1985 ssize_t
cmd_list_tracker_pids(struct ltt_session
*session
,
1986 int domain
, int32_t **pids
)
1989 ssize_t nr_pids
= 0;
1992 case LTTNG_DOMAIN_KERNEL
:
1994 struct ltt_kernel_session
*ksess
;
1996 ksess
= session
->kernel_session
;
1997 nr_pids
= kernel_list_tracker_pids(ksess
, pids
);
1999 ret
= LTTNG_ERR_KERN_LIST_FAIL
;
2004 case LTTNG_DOMAIN_UST
:
2006 struct ltt_ust_session
*usess
;
2008 usess
= session
->ust_session
;
2009 nr_pids
= trace_ust_list_tracker_pids(usess
, pids
);
2011 ret
= LTTNG_ERR_UST_LIST_FAIL
;
2016 case LTTNG_DOMAIN_LOG4J
:
2017 case LTTNG_DOMAIN_JUL
:
2018 case LTTNG_DOMAIN_PYTHON
:
2020 ret
= LTTNG_ERR_UND
;
2027 /* Return negative value to differentiate return code */
2032 * Command LTTNG_START_TRACE processed by the client thread.
2034 * Called with session mutex held.
2036 int cmd_start_trace(struct ltt_session
*session
)
2039 unsigned long nb_chan
= 0;
2040 struct ltt_kernel_session
*ksession
;
2041 struct ltt_ust_session
*usess
;
2045 /* Ease our life a bit ;) */
2046 ksession
= session
->kernel_session
;
2047 usess
= session
->ust_session
;
2049 /* Is the session already started? */
2050 if (session
->active
) {
2051 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2056 * Starting a session without channel is useless since after that it's not
2057 * possible to enable channel thus inform the client.
2059 if (usess
&& usess
->domain_global
.channels
) {
2061 nb_chan
+= lttng_ht_get_count(usess
->domain_global
.channels
);
2065 nb_chan
+= ksession
->channel_count
;
2068 ret
= LTTNG_ERR_NO_CHANNEL
;
2072 /* Kernel tracing */
2073 if (ksession
!= NULL
) {
2074 ret
= start_kernel_session(ksession
, kernel_tracer_fd
);
2075 if (ret
!= LTTNG_OK
) {
2080 /* Flag session that trace should start automatically */
2083 * Even though the start trace might fail, flag this session active so
2084 * other application coming in are started by default.
2088 ret
= ust_app_start_trace_all(usess
);
2090 ret
= LTTNG_ERR_UST_START_FAIL
;
2095 /* Flag this after a successful start. */
2096 session
->has_been_started
= 1;
2097 session
->active
= 1;
2106 * Command LTTNG_STOP_TRACE processed by the client thread.
2108 int cmd_stop_trace(struct ltt_session
*session
)
2111 struct ltt_kernel_channel
*kchan
;
2112 struct ltt_kernel_session
*ksession
;
2113 struct ltt_ust_session
*usess
;
2118 ksession
= session
->kernel_session
;
2119 usess
= session
->ust_session
;
2121 /* Session is not active. Skip everythong and inform the client. */
2122 if (!session
->active
) {
2123 ret
= LTTNG_ERR_TRACE_ALREADY_STOPPED
;
2128 if (ksession
&& ksession
->active
) {
2129 DBG("Stop kernel tracing");
2131 /* Flush metadata if exist */
2132 if (ksession
->metadata_stream_fd
>= 0) {
2133 ret
= kernel_metadata_flush_buffer(ksession
->metadata_stream_fd
);
2135 ERR("Kernel metadata flush failed");
2139 /* Flush all buffers before stopping */
2140 cds_list_for_each_entry(kchan
, &ksession
->channel_list
.head
, list
) {
2141 ret
= kernel_flush_buffer(kchan
);
2143 ERR("Kernel flush buffer error");
2147 ret
= kernel_stop_session(ksession
);
2149 ret
= LTTNG_ERR_KERN_STOP_FAIL
;
2153 kernel_wait_quiescent(kernel_tracer_fd
);
2155 ksession
->active
= 0;
2158 if (usess
&& usess
->active
) {
2160 * Even though the stop trace might fail, flag this session inactive so
2161 * other application coming in are not started by default.
2165 ret
= ust_app_stop_trace_all(usess
);
2167 ret
= LTTNG_ERR_UST_STOP_FAIL
;
2172 /* Flag inactive after a successful stop. */
2173 session
->active
= 0;
2181 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2183 int cmd_set_consumer_uri(struct ltt_session
*session
, size_t nb_uri
,
2184 struct lttng_uri
*uris
)
2187 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2188 struct ltt_ust_session
*usess
= session
->ust_session
;
2194 /* Can't set consumer URI if the session is active. */
2195 if (session
->active
) {
2196 ret
= LTTNG_ERR_TRACE_ALREADY_STARTED
;
2200 /* Set the "global" consumer URIs */
2201 for (i
= 0; i
< nb_uri
; i
++) {
2202 ret
= add_uri_to_consumer(session
->consumer
,
2203 &uris
[i
], 0, session
->name
);
2204 if (ret
!= LTTNG_OK
) {
2209 /* Set UST session URIs */
2210 if (session
->ust_session
) {
2211 for (i
= 0; i
< nb_uri
; i
++) {
2212 ret
= add_uri_to_consumer(
2213 session
->ust_session
->consumer
,
2214 &uris
[i
], LTTNG_DOMAIN_UST
,
2216 if (ret
!= LTTNG_OK
) {
2222 /* Set kernel session URIs */
2223 if (session
->kernel_session
) {
2224 for (i
= 0; i
< nb_uri
; i
++) {
2225 ret
= add_uri_to_consumer(
2226 session
->kernel_session
->consumer
,
2227 &uris
[i
], LTTNG_DOMAIN_KERNEL
,
2229 if (ret
!= LTTNG_OK
) {
2236 * Make sure to set the session in output mode after we set URI since a
2237 * session can be created without URL (thus flagged in no output mode).
2239 session
->output_traces
= 1;
2241 ksess
->output_traces
= 1;
2245 usess
->output_traces
= 1;
2256 * Command LTTNG_CREATE_SESSION processed by the client thread.
2258 int cmd_create_session_uri(char *name
, struct lttng_uri
*uris
,
2259 size_t nb_uri
, lttng_sock_cred
*creds
, unsigned int live_timer
)
2262 struct ltt_session
*session
;
2268 * Verify if the session already exist
2270 * XXX: There is no need for the session lock list here since the caller
2271 * (process_client_msg) is holding it. We might want to change that so a
2272 * single command does not lock the entire session list.
2274 session
= session_find_by_name(name
);
2275 if (session
!= NULL
) {
2276 ret
= LTTNG_ERR_EXIST_SESS
;
2280 /* Create tracing session in the registry */
2281 ret
= session_create(name
, LTTNG_SOCK_GET_UID_CRED(creds
),
2282 LTTNG_SOCK_GET_GID_CRED(creds
));
2283 if (ret
!= LTTNG_OK
) {
2288 * Get the newly created session pointer back
2290 * XXX: There is no need for the session lock list here since the caller
2291 * (process_client_msg) is holding it. We might want to change that so a
2292 * single command does not lock the entire session list.
2294 session
= session_find_by_name(name
);
2297 session
->live_timer
= live_timer
;
2298 /* Create default consumer output for the session not yet created. */
2299 session
->consumer
= consumer_create_output(CONSUMER_DST_LOCAL
);
2300 if (session
->consumer
== NULL
) {
2301 ret
= LTTNG_ERR_FATAL
;
2302 goto consumer_error
;
2306 ret
= cmd_set_consumer_uri(session
, nb_uri
, uris
);
2307 if (ret
!= LTTNG_OK
) {
2308 goto consumer_error
;
2310 session
->output_traces
= 1;
2312 session
->output_traces
= 0;
2313 DBG2("Session %s created with no output", session
->name
);
2316 session
->consumer
->enabled
= 1;
2321 session_destroy(session
);
2328 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2330 int cmd_create_session_snapshot(char *name
, struct lttng_uri
*uris
,
2331 size_t nb_uri
, lttng_sock_cred
*creds
)
2334 struct ltt_session
*session
;
2335 struct snapshot_output
*new_output
= NULL
;
2341 * Create session in no output mode with URIs set to NULL. The uris we've
2342 * received are for a default snapshot output if one.
2344 ret
= cmd_create_session_uri(name
, NULL
, 0, creds
, 0);
2345 if (ret
!= LTTNG_OK
) {
2349 /* Get the newly created session pointer back. This should NEVER fail. */
2350 session
= session_find_by_name(name
);
2353 /* Flag session for snapshot mode. */
2354 session
->snapshot_mode
= 1;
2356 /* Skip snapshot output creation if no URI is given. */
2361 new_output
= snapshot_output_alloc();
2363 ret
= LTTNG_ERR_NOMEM
;
2364 goto error_snapshot_alloc
;
2367 ret
= snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE
, NULL
,
2368 uris
, nb_uri
, session
->consumer
, new_output
, &session
->snapshot
);
2370 if (ret
== -ENOMEM
) {
2371 ret
= LTTNG_ERR_NOMEM
;
2373 ret
= LTTNG_ERR_INVALID
;
2375 goto error_snapshot
;
2379 snapshot_add_output(&session
->snapshot
, new_output
);
2386 snapshot_output_destroy(new_output
);
2387 error_snapshot_alloc
:
2388 session_destroy(session
);
2394 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2396 * Called with session lock held.
2398 int cmd_destroy_session(struct ltt_session
*session
, int wpipe
)
2401 struct ltt_ust_session
*usess
;
2402 struct ltt_kernel_session
*ksess
;
2407 usess
= session
->ust_session
;
2408 ksess
= session
->kernel_session
;
2410 /* Clean kernel session teardown */
2411 kernel_destroy_session(ksess
);
2413 /* UST session teardown */
2415 /* Close any relayd session */
2416 consumer_output_send_destroy_relayd(usess
->consumer
);
2418 /* Destroy every UST application related to this session. */
2419 ret
= ust_app_destroy_trace_all(usess
);
2421 ERR("Error in ust_app_destroy_trace_all");
2424 /* Clean up the rest. */
2425 trace_ust_destroy_session(usess
);
2429 * Must notify the kernel thread here to update it's poll set in order to
2430 * remove the channel(s)' fd just destroyed.
2432 ret
= notify_thread_pipe(wpipe
);
2434 PERROR("write kernel poll pipe");
2437 ret
= session_destroy(session
);
2443 * Command LTTNG_CALIBRATE processed by the client thread.
2445 int cmd_calibrate(int domain
, struct lttng_calibrate
*calibrate
)
2450 case LTTNG_DOMAIN_KERNEL
:
2452 struct lttng_kernel_calibrate kcalibrate
;
2454 switch (calibrate
->type
) {
2455 case LTTNG_CALIBRATE_FUNCTION
:
2457 /* Default and only possible calibrate option. */
2458 kcalibrate
.type
= LTTNG_KERNEL_CALIBRATE_KRETPROBE
;
2462 ret
= kernel_calibrate(kernel_tracer_fd
, &kcalibrate
);
2464 ret
= LTTNG_ERR_KERN_ENABLE_FAIL
;
2469 case LTTNG_DOMAIN_UST
:
2471 struct lttng_ust_calibrate ucalibrate
;
2473 switch (calibrate
->type
) {
2474 case LTTNG_CALIBRATE_FUNCTION
:
2476 /* Default and only possible calibrate option. */
2477 ucalibrate
.type
= LTTNG_UST_CALIBRATE_TRACEPOINT
;
2481 ret
= ust_app_calibrate_glb(&ucalibrate
);
2483 ret
= LTTNG_ERR_UST_CALIBRATE_FAIL
;
2489 ret
= LTTNG_ERR_UND
;
2500 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2502 int cmd_register_consumer(struct ltt_session
*session
, int domain
,
2503 const char *sock_path
, struct consumer_data
*cdata
)
2506 struct consumer_socket
*socket
= NULL
;
2513 case LTTNG_DOMAIN_KERNEL
:
2515 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2519 /* Can't register a consumer if there is already one */
2520 if (ksess
->consumer_fds_sent
!= 0) {
2521 ret
= LTTNG_ERR_KERN_CONSUMER_FAIL
;
2525 sock
= lttcomm_connect_unix_sock(sock_path
);
2527 ret
= LTTNG_ERR_CONNECT_FAIL
;
2530 cdata
->cmd_sock
= sock
;
2532 socket
= consumer_allocate_socket(&cdata
->cmd_sock
);
2533 if (socket
== NULL
) {
2536 PERROR("close register consumer");
2538 cdata
->cmd_sock
= -1;
2539 ret
= LTTNG_ERR_FATAL
;
2543 socket
->lock
= zmalloc(sizeof(pthread_mutex_t
));
2544 if (socket
->lock
== NULL
) {
2545 PERROR("zmalloc pthread mutex");
2546 ret
= LTTNG_ERR_FATAL
;
2549 pthread_mutex_init(socket
->lock
, NULL
);
2550 socket
->registered
= 1;
2553 consumer_add_socket(socket
, ksess
->consumer
);
2556 pthread_mutex_lock(&cdata
->pid_mutex
);
2558 pthread_mutex_unlock(&cdata
->pid_mutex
);
2563 /* TODO: Userspace tracing */
2564 ret
= LTTNG_ERR_UND
;
2572 consumer_destroy_socket(socket
);
2578 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2580 ssize_t
cmd_list_domains(struct ltt_session
*session
,
2581 struct lttng_domain
**domains
)
2586 struct lttng_ht_iter iter
;
2588 if (session
->kernel_session
!= NULL
) {
2589 DBG3("Listing domains found kernel domain");
2593 if (session
->ust_session
!= NULL
) {
2594 DBG3("Listing domains found UST global domain");
2598 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2600 if (agt
->being_used
) {
2611 *domains
= zmalloc(nb_dom
* sizeof(struct lttng_domain
));
2612 if (*domains
== NULL
) {
2613 ret
= LTTNG_ERR_FATAL
;
2617 if (session
->kernel_session
!= NULL
) {
2618 (*domains
)[index
].type
= LTTNG_DOMAIN_KERNEL
;
2620 /* Kernel session buffer type is always GLOBAL */
2621 (*domains
)[index
].buf_type
= LTTNG_BUFFER_GLOBAL
;
2626 if (session
->ust_session
!= NULL
) {
2627 (*domains
)[index
].type
= LTTNG_DOMAIN_UST
;
2628 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2632 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
, &iter
.iter
,
2634 if (agt
->being_used
) {
2635 (*domains
)[index
].type
= agt
->domain
;
2636 (*domains
)[index
].buf_type
= session
->ust_session
->buffer_type
;
2646 /* Return negative value to differentiate return code */
2652 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2654 ssize_t
cmd_list_channels(int domain
, struct ltt_session
*session
,
2655 struct lttng_channel
**channels
)
2658 ssize_t nb_chan
= 0;
2661 case LTTNG_DOMAIN_KERNEL
:
2662 if (session
->kernel_session
!= NULL
) {
2663 nb_chan
= session
->kernel_session
->channel_count
;
2665 DBG3("Number of kernel channels %zd", nb_chan
);
2667 ret
= LTTNG_ERR_KERN_CHAN_NOT_FOUND
;
2670 case LTTNG_DOMAIN_UST
:
2671 if (session
->ust_session
!= NULL
) {
2673 nb_chan
= lttng_ht_get_count(
2674 session
->ust_session
->domain_global
.channels
);
2677 DBG3("Number of UST global channels %zd", nb_chan
);
2679 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
2684 ret
= LTTNG_ERR_UND
;
2689 *channels
= zmalloc(nb_chan
* sizeof(struct lttng_channel
));
2690 if (*channels
== NULL
) {
2691 ret
= LTTNG_ERR_FATAL
;
2695 list_lttng_channels(domain
, session
, *channels
);
2701 /* Return negative value to differentiate return code */
2706 * Command LTTNG_LIST_EVENTS processed by the client thread.
2708 ssize_t
cmd_list_events(int domain
, struct ltt_session
*session
,
2709 char *channel_name
, struct lttng_event
**events
)
2712 ssize_t nb_event
= 0;
2715 case LTTNG_DOMAIN_KERNEL
:
2716 if (session
->kernel_session
!= NULL
) {
2717 nb_event
= list_lttng_kernel_events(channel_name
,
2718 session
->kernel_session
, events
);
2721 case LTTNG_DOMAIN_UST
:
2723 if (session
->ust_session
!= NULL
) {
2724 nb_event
= list_lttng_ust_global_events(channel_name
,
2725 &session
->ust_session
->domain_global
, events
);
2729 case LTTNG_DOMAIN_LOG4J
:
2730 case LTTNG_DOMAIN_JUL
:
2731 case LTTNG_DOMAIN_PYTHON
:
2732 if (session
->ust_session
) {
2733 struct lttng_ht_iter iter
;
2737 cds_lfht_for_each_entry(session
->ust_session
->agents
->ht
,
2738 &iter
.iter
, agt
, node
.node
) {
2739 if (agt
->domain
== domain
) {
2740 nb_event
= list_lttng_agent_events(
2749 ret
= LTTNG_ERR_UND
;
2756 /* Return negative value to differentiate return code */
2761 * Using the session list, filled a lttng_session array to send back to the
2762 * client for session listing.
2764 * The session list lock MUST be acquired before calling this function. Use
2765 * session_lock_list() and session_unlock_list().
2767 void cmd_list_lttng_sessions(struct lttng_session
*sessions
, uid_t uid
,
2772 struct ltt_session
*session
;
2773 struct ltt_session_list
*list
= session_get_list();
2775 DBG("Getting all available session for UID %d GID %d",
2778 * Iterate over session list and append data after the control struct in
2781 cds_list_for_each_entry(session
, &list
->head
, list
) {
2783 * Only list the sessions the user can control.
2785 if (!session_access_ok(session
, uid
, gid
)) {
2789 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2790 struct ltt_ust_session
*usess
= session
->ust_session
;
2792 if (session
->consumer
->type
== CONSUMER_DST_NET
||
2793 (ksess
&& ksess
->consumer
->type
== CONSUMER_DST_NET
) ||
2794 (usess
&& usess
->consumer
->type
== CONSUMER_DST_NET
)) {
2795 ret
= build_network_session_path(sessions
[i
].path
,
2796 sizeof(sessions
[i
].path
), session
);
2798 ret
= snprintf(sessions
[i
].path
, sizeof(sessions
[i
].path
), "%s",
2799 session
->consumer
->dst
.trace_path
);
2802 PERROR("snprintf session path");
2806 strncpy(sessions
[i
].name
, session
->name
, NAME_MAX
);
2807 sessions
[i
].name
[NAME_MAX
- 1] = '\0';
2808 sessions
[i
].enabled
= session
->active
;
2809 sessions
[i
].snapshot_mode
= session
->snapshot_mode
;
2810 sessions
[i
].live_timer_interval
= session
->live_timer
;
2816 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2817 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2819 int cmd_data_pending(struct ltt_session
*session
)
2822 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
2823 struct ltt_ust_session
*usess
= session
->ust_session
;
2827 /* Session MUST be stopped to ask for data availability. */
2828 if (session
->active
) {
2829 ret
= LTTNG_ERR_SESSION_STARTED
;
2833 * If stopped, just make sure we've started before else the above call
2834 * will always send that there is data pending.
2836 * The consumer assumes that when the data pending command is received,
2837 * the trace has been started before or else no output data is written
2838 * by the streams which is a condition for data pending. So, this is
2839 * *VERY* important that we don't ask the consumer before a start
2842 if (!session
->has_been_started
) {
2848 if (ksess
&& ksess
->consumer
) {
2849 ret
= consumer_is_data_pending(ksess
->id
, ksess
->consumer
);
2851 /* Data is still being extracted for the kernel. */
2856 if (usess
&& usess
->consumer
) {
2857 ret
= consumer_is_data_pending(usess
->id
, usess
->consumer
);
2859 /* Data is still being extracted for the kernel. */
2864 /* Data is ready to be read by a viewer */
2872 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2874 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2876 int cmd_snapshot_add_output(struct ltt_session
*session
,
2877 struct lttng_snapshot_output
*output
, uint32_t *id
)
2880 struct snapshot_output
*new_output
;
2885 DBG("Cmd snapshot add output for session %s", session
->name
);
2888 * Permission denied to create an output if the session is not
2889 * set in no output mode.
2891 if (session
->output_traces
) {
2892 ret
= LTTNG_ERR_EPERM
;
2896 /* Only one output is allowed until we have the "tee" feature. */
2897 if (session
->snapshot
.nb_output
== 1) {
2898 ret
= LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST
;
2902 new_output
= snapshot_output_alloc();
2904 ret
= LTTNG_ERR_NOMEM
;
2908 ret
= snapshot_output_init(output
->max_size
, output
->name
,
2909 output
->ctrl_url
, output
->data_url
, session
->consumer
, new_output
,
2910 &session
->snapshot
);
2912 if (ret
== -ENOMEM
) {
2913 ret
= LTTNG_ERR_NOMEM
;
2915 ret
= LTTNG_ERR_INVALID
;
2921 snapshot_add_output(&session
->snapshot
, new_output
);
2923 *id
= new_output
->id
;
2930 snapshot_output_destroy(new_output
);
2936 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2938 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2940 int cmd_snapshot_del_output(struct ltt_session
*session
,
2941 struct lttng_snapshot_output
*output
)
2944 struct snapshot_output
*sout
= NULL
;
2952 * Permission denied to create an output if the session is not
2953 * set in no output mode.
2955 if (session
->output_traces
) {
2956 ret
= LTTNG_ERR_EPERM
;
2961 DBG("Cmd snapshot del output id %" PRIu32
" for session %s", output
->id
,
2963 sout
= snapshot_find_output_by_id(output
->id
, &session
->snapshot
);
2964 } else if (*output
->name
!= '\0') {
2965 DBG("Cmd snapshot del output name %s for session %s", output
->name
,
2967 sout
= snapshot_find_output_by_name(output
->name
, &session
->snapshot
);
2970 ret
= LTTNG_ERR_INVALID
;
2974 snapshot_delete_output(&session
->snapshot
, sout
);
2975 snapshot_output_destroy(sout
);
2984 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
2986 * If no output is available, outputs is untouched and 0 is returned.
2988 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
2990 ssize_t
cmd_snapshot_list_outputs(struct ltt_session
*session
,
2991 struct lttng_snapshot_output
**outputs
)
2994 struct lttng_snapshot_output
*list
= NULL
;
2995 struct lttng_ht_iter iter
;
2996 struct snapshot_output
*output
;
3001 DBG("Cmd snapshot list outputs for session %s", session
->name
);
3004 * Permission denied to create an output if the session is not
3005 * set in no output mode.
3007 if (session
->output_traces
) {
3008 ret
= -LTTNG_ERR_EPERM
;
3012 if (session
->snapshot
.nb_output
== 0) {
3017 list
= zmalloc(session
->snapshot
.nb_output
* sizeof(*list
));
3019 ret
= -LTTNG_ERR_NOMEM
;
3023 /* Copy list from session to the new list object. */
3025 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
, &iter
.iter
,
3026 output
, node
.node
) {
3027 assert(output
->consumer
);
3028 list
[idx
].id
= output
->id
;
3029 list
[idx
].max_size
= output
->max_size
;
3030 strncpy(list
[idx
].name
, output
->name
, sizeof(list
[idx
].name
));
3031 if (output
->consumer
->type
== CONSUMER_DST_LOCAL
) {
3032 strncpy(list
[idx
].ctrl_url
, output
->consumer
->dst
.trace_path
,
3033 sizeof(list
[idx
].ctrl_url
));
3036 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.control
,
3037 list
[idx
].ctrl_url
, sizeof(list
[idx
].ctrl_url
));
3039 ret
= -LTTNG_ERR_NOMEM
;
3044 ret
= uri_to_str_url(&output
->consumer
->dst
.net
.data
,
3045 list
[idx
].data_url
, sizeof(list
[idx
].data_url
));
3047 ret
= -LTTNG_ERR_NOMEM
;
3056 ret
= session
->snapshot
.nb_output
;
3064 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3065 * snapshot output is *not* set with a remote destination.
3067 * Return 0 on success or a LTTNG_ERR code.
3069 static int set_relayd_for_snapshot(struct consumer_output
*consumer
,
3070 struct snapshot_output
*snap_output
, struct ltt_session
*session
)
3073 struct lttng_ht_iter iter
;
3074 struct consumer_socket
*socket
;
3077 assert(snap_output
);
3080 DBG2("Set relayd object from snapshot output");
3082 /* Ignore if snapshot consumer output is not network. */
3083 if (snap_output
->consumer
->type
!= CONSUMER_DST_NET
) {
3088 * For each consumer socket, create and send the relayd object of the
3092 cds_lfht_for_each_entry(snap_output
->consumer
->socks
->ht
, &iter
.iter
,
3093 socket
, node
.node
) {
3094 ret
= send_consumer_relayd_sockets(0, session
->id
,
3095 snap_output
->consumer
, socket
,
3096 session
->name
, session
->hostname
,
3097 session
->live_timer
);
3098 if (ret
!= LTTNG_OK
) {
3110 * Record a kernel snapshot.
3112 * Return LTTNG_OK on success or a LTTNG_ERR code.
3114 static int record_kernel_snapshot(struct ltt_kernel_session
*ksess
,
3115 struct snapshot_output
*output
, struct ltt_session
*session
,
3116 int wait
, uint64_t nb_packets_per_stream
)
3126 * Copy kernel session sockets so we can communicate with the right
3127 * consumer for the snapshot record command.
3129 ret
= consumer_copy_sockets(output
->consumer
, ksess
->consumer
);
3131 ret
= LTTNG_ERR_NOMEM
;
3135 ret
= set_relayd_for_snapshot(ksess
->consumer
, output
, session
);
3136 if (ret
!= LTTNG_OK
) {
3137 goto error_snapshot
;
3140 ret
= kernel_snapshot_record(ksess
, output
, wait
, nb_packets_per_stream
);
3141 if (ret
!= LTTNG_OK
) {
3142 goto error_snapshot
;
3149 /* Clean up copied sockets so this output can use some other later on. */
3150 consumer_destroy_output_sockets(output
->consumer
);
3157 * Record a UST snapshot.
3159 * Return 0 on success or a LTTNG_ERR error code.
3161 static int record_ust_snapshot(struct ltt_ust_session
*usess
,
3162 struct snapshot_output
*output
, struct ltt_session
*session
,
3163 int wait
, uint64_t nb_packets_per_stream
)
3172 * Copy UST session sockets so we can communicate with the right
3173 * consumer for the snapshot record command.
3175 ret
= consumer_copy_sockets(output
->consumer
, usess
->consumer
);
3177 ret
= LTTNG_ERR_NOMEM
;
3181 ret
= set_relayd_for_snapshot(usess
->consumer
, output
, session
);
3182 if (ret
!= LTTNG_OK
) {
3183 goto error_snapshot
;
3186 ret
= ust_app_snapshot_record(usess
, output
, wait
, nb_packets_per_stream
);
3190 ret
= LTTNG_ERR_INVALID
;
3193 ret
= LTTNG_ERR_SNAPSHOT_NODATA
;
3196 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3199 goto error_snapshot
;
3205 /* Clean up copied sockets so this output can use some other later on. */
3206 consumer_destroy_output_sockets(output
->consumer
);
3212 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session
*session
,
3213 uint64_t cur_nr_packets
)
3215 uint64_t tot_size
= 0;
3217 if (session
->kernel_session
) {
3218 struct ltt_kernel_channel
*chan
;
3219 struct ltt_kernel_session
*ksess
= session
->kernel_session
;
3221 cds_list_for_each_entry(chan
, &ksess
->channel_list
.head
, list
) {
3222 if (cur_nr_packets
>= chan
->channel
->attr
.num_subbuf
) {
3224 * Don't take channel into account if we
3225 * already grab all its packets.
3229 tot_size
+= chan
->channel
->attr
.subbuf_size
3230 * chan
->stream_count
;
3234 if (session
->ust_session
) {
3235 struct ltt_ust_session
*usess
= session
->ust_session
;
3237 tot_size
+= ust_app_get_size_one_more_packet_per_stream(usess
,
3245 * Calculate the number of packets we can grab from each stream that
3246 * fits within the overall snapshot max size.
3248 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3249 * the number of packets per stream.
3251 * TODO: this approach is not perfect: we consider the worse case
3252 * (packet filling the sub-buffers) as an upper bound, but we could do
3253 * better if we do this calculation while we actually grab the packet
3254 * content: we would know how much padding we don't actually store into
3257 * This algorithm is currently bounded by the number of packets per
3260 * Since we call this algorithm before actually grabbing the data, it's
3261 * an approximation: for instance, applications could appear/disappear
3262 * in between this call and actually grabbing data.
3265 int64_t get_session_nb_packets_per_stream(struct ltt_session
*session
, uint64_t max_size
)
3268 uint64_t cur_nb_packets
= 0;
3271 return 0; /* Infinite */
3274 size_left
= max_size
;
3276 uint64_t one_more_packet_tot_size
;
3278 one_more_packet_tot_size
= get_session_size_one_more_packet_per_stream(session
,
3280 if (!one_more_packet_tot_size
) {
3281 /* We are already grabbing all packets. */
3284 size_left
-= one_more_packet_tot_size
;
3285 if (size_left
< 0) {
3290 if (!cur_nb_packets
) {
3291 /* Not enough room to grab one packet of each stream, error. */
3294 return cur_nb_packets
;
3298 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3300 * The wait parameter is ignored so this call always wait for the snapshot to
3301 * complete before returning.
3303 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3305 int cmd_snapshot_record(struct ltt_session
*session
,
3306 struct lttng_snapshot_output
*output
, int wait
)
3309 unsigned int use_tmp_output
= 0;
3310 struct snapshot_output tmp_output
;
3311 unsigned int snapshot_success
= 0;
3317 DBG("Cmd snapshot record for session %s", session
->name
);
3319 /* Get the datetime for the snapshot output directory. */
3320 ret
= utils_get_current_time_str("%Y%m%d-%H%M%S", datetime
,
3323 ret
= LTTNG_ERR_INVALID
;
3328 * Permission denied to create an output if the session is not
3329 * set in no output mode.
3331 if (session
->output_traces
) {
3332 ret
= LTTNG_ERR_EPERM
;
3336 /* The session needs to be started at least once. */
3337 if (!session
->has_been_started
) {
3338 ret
= LTTNG_ERR_START_SESSION_ONCE
;
3342 /* Use temporary output for the session. */
3343 if (*output
->ctrl_url
!= '\0') {
3344 ret
= snapshot_output_init(output
->max_size
, output
->name
,
3345 output
->ctrl_url
, output
->data_url
, session
->consumer
,
3348 if (ret
== -ENOMEM
) {
3349 ret
= LTTNG_ERR_NOMEM
;
3351 ret
= LTTNG_ERR_INVALID
;
3355 /* Use the global session count for the temporary snapshot. */
3356 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3358 /* Use the global datetime */
3359 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3363 if (use_tmp_output
) {
3364 int64_t nb_packets_per_stream
;
3366 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3367 tmp_output
.max_size
);
3368 if (nb_packets_per_stream
< 0) {
3369 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3373 if (session
->kernel_session
) {
3374 ret
= record_kernel_snapshot(session
->kernel_session
,
3375 &tmp_output
, session
,
3376 wait
, nb_packets_per_stream
);
3377 if (ret
!= LTTNG_OK
) {
3382 if (session
->ust_session
) {
3383 ret
= record_ust_snapshot(session
->ust_session
,
3384 &tmp_output
, session
,
3385 wait
, nb_packets_per_stream
);
3386 if (ret
!= LTTNG_OK
) {
3391 snapshot_success
= 1;
3393 struct snapshot_output
*sout
;
3394 struct lttng_ht_iter iter
;
3397 cds_lfht_for_each_entry(session
->snapshot
.output_ht
->ht
,
3398 &iter
.iter
, sout
, node
.node
) {
3399 int64_t nb_packets_per_stream
;
3402 * Make a local copy of the output and assign the possible
3403 * temporary value given by the caller.
3405 memset(&tmp_output
, 0, sizeof(tmp_output
));
3406 memcpy(&tmp_output
, sout
, sizeof(tmp_output
));
3408 if (output
->max_size
!= (uint64_t) -1ULL) {
3409 tmp_output
.max_size
= output
->max_size
;
3412 nb_packets_per_stream
= get_session_nb_packets_per_stream(session
,
3413 tmp_output
.max_size
);
3414 if (nb_packets_per_stream
< 0) {
3415 ret
= LTTNG_ERR_MAX_SIZE_INVALID
;
3420 /* Use temporary name. */
3421 if (*output
->name
!= '\0') {
3422 strncpy(tmp_output
.name
, output
->name
,
3423 sizeof(tmp_output
.name
));
3426 tmp_output
.nb_snapshot
= session
->snapshot
.nb_snapshot
;
3427 memcpy(tmp_output
.datetime
, datetime
, sizeof(datetime
));
3429 if (session
->kernel_session
) {
3430 ret
= record_kernel_snapshot(session
->kernel_session
,
3431 &tmp_output
, session
,
3432 wait
, nb_packets_per_stream
);
3433 if (ret
!= LTTNG_OK
) {
3439 if (session
->ust_session
) {
3440 ret
= record_ust_snapshot(session
->ust_session
,
3441 &tmp_output
, session
,
3442 wait
, nb_packets_per_stream
);
3443 if (ret
!= LTTNG_OK
) {
3448 snapshot_success
= 1;
3453 if (snapshot_success
) {
3454 session
->snapshot
.nb_snapshot
++;
3456 ret
= LTTNG_ERR_SNAPSHOT_FAIL
;
3464 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3466 int cmd_set_session_shm_path(struct ltt_session
*session
,
3467 const char *shm_path
)
3473 * Can only set shm path before session is started.
3475 if (session
->has_been_started
) {
3476 return LTTNG_ERR_SESSION_STARTED
;
3479 strncpy(session
->shm_path
, shm_path
,
3480 sizeof(session
->shm_path
));
3481 session
->shm_path
[sizeof(session
->shm_path
) - 1] = '\0';
3487 * Init command subsystem.
3492 * Set network sequence index to 1 for streams to match a relayd
3493 * socket on the consumer side.
3495 pthread_mutex_lock(&relayd_net_seq_idx_lock
);
3496 relayd_net_seq_idx
= 1;
3497 pthread_mutex_unlock(&relayd_net_seq_idx_lock
);
3499 DBG("Command subsystem initialized");