4 * Linux Trace Toolkit Control Library
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
7 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * SPDX-License-Identifier: LGPL-2.1-only
20 #include <common/bytecode/bytecode.h>
21 #include <common/align.h>
22 #include <common/common.h>
23 #include <common/compat/errno.h>
24 #include <common/compat/string.h>
25 #include <common/defaults.h>
26 #include <common/dynamic-array.h>
27 #include <common/dynamic-buffer.h>
28 #include <common/payload-view.h>
29 #include <common/payload.h>
30 #include <common/sessiond-comm/sessiond-comm.h>
31 #include <common/tracker.h>
32 #include <common/unix.h>
33 #include <common/uri.h>
34 #include <common/utils.h>
35 #include <lttng/channel-internal.h>
36 #include <lttng/destruction-handle.h>
37 #include <lttng/endpoint.h>
38 #include <lttng/error-query-internal.h>
39 #include <lttng/event-internal.h>
40 #include <lttng/health-internal.h>
41 #include <lttng/lttng-error.h>
42 #include <lttng/lttng.h>
43 #include <lttng/session-descriptor-internal.h>
44 #include <lttng/session-internal.h>
45 #include <lttng/trigger/trigger-internal.h>
46 #include <lttng/userspace-probe-internal.h>
48 #include "lttng-ctl-helper.h"
49 #include <common/filter/filter-ast.h>
50 #include <common/filter/filter-parser.h>
51 #include <common/filter/memstream.h>
53 #define COPY_DOMAIN_PACKED(dst, src) \
55 struct lttng_domain _tmp_domain; \
57 lttng_ctl_copy_lttng_domain(&_tmp_domain, &src); \
61 /* Socket to session daemon for communication */
62 static int sessiond_socket
= -1;
63 static char sessiond_sock_path
[PATH_MAX
];
66 static char *tracing_group
;
72 * Those two variables are used by error.h to silent or control the verbosity of
73 * error message. They are global to the library so application linking with it
74 * are able to compile correctly and also control verbosity of the library.
76 LTTNG_EXPORT
int lttng_opt_quiet
;
77 LTTNG_EXPORT
int lttng_opt_verbose
;
78 LTTNG_EXPORT
int lttng_opt_mi
;
81 * Copy domain to lttcomm_session_msg domain.
83 * If domain is unknown, default domain will be the kernel.
85 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
86 struct lttng_domain
*src
)
90 case LTTNG_DOMAIN_KERNEL
:
91 case LTTNG_DOMAIN_UST
:
92 case LTTNG_DOMAIN_JUL
:
93 case LTTNG_DOMAIN_LOG4J
:
94 case LTTNG_DOMAIN_PYTHON
:
95 memcpy(dst
, src
, sizeof(struct lttng_domain
));
98 memset(dst
, 0, sizeof(struct lttng_domain
));
105 * Send lttcomm_session_msg to the session daemon.
107 * On success, returns the number of bytes sent (>=0)
108 * On error, returns -1
110 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
115 ret
= -LTTNG_ERR_NO_SESSIOND
;
119 DBG("LSM cmd type: '%s' (%d)", lttcomm_sessiond_command_str((lttcomm_sessiond_command
) lsm
->cmd_type
),
122 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
123 sizeof(struct lttcomm_session_msg
));
125 ret
= -LTTNG_ERR_FATAL
;
133 * Send var len data to the session daemon.
135 * On success, returns the number of bytes sent (>=0)
136 * On error, returns -1
138 static int send_session_varlen(const void *data
, size_t len
)
143 ret
= -LTTNG_ERR_NO_SESSIOND
;
152 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
154 ret
= -LTTNG_ERR_FATAL
;
162 * Send file descriptors to the session daemon.
164 * On success, returns the number of bytes sent (>=0)
165 * On error, returns -1
167 static int send_session_fds(const int *fds
, size_t nb_fd
)
172 ret
= -LTTNG_ERR_NO_SESSIOND
;
176 if (!fds
|| !nb_fd
) {
181 ret
= lttcomm_send_fds_unix_sock(sessiond_socket
, fds
, nb_fd
);
183 ret
= -LTTNG_ERR_FATAL
;
191 * Receive data from the sessiond socket.
193 * On success, returns the number of bytes received (>=0)
194 * On error, returns a negative lttng_error_code.
196 static int recv_data_sessiond(void *buf
, size_t len
)
200 LTTNG_ASSERT(len
> 0);
203 ret
= -LTTNG_ERR_NO_SESSIOND
;
207 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
209 ret
= -LTTNG_ERR_FATAL
;
210 } else if (ret
== 0) {
211 ret
= -LTTNG_ERR_NO_SESSIOND
;
219 * Receive a payload from the session daemon by appending to an existing
221 * On success, returns the number of bytes received (>=0)
222 * On error, returns a negative lttng_error_code.
224 static int recv_payload_sessiond(struct lttng_payload
*payload
, size_t len
)
227 const size_t original_payload_size
= payload
->buffer
.size
;
229 ret
= lttng_dynamic_buffer_set_size(
230 &payload
->buffer
, payload
->buffer
.size
+ len
);
232 ret
= -LTTNG_ERR_NOMEM
;
236 ret
= recv_data_sessiond(
237 payload
->buffer
.data
+ original_payload_size
, len
);
243 * Check if we are in the specified group.
245 * If yes return 1, else return -1.
247 int lttng_check_tracing_group(void)
249 gid_t
*grp_list
, tracing_gid
;
250 int grp_list_size
, grp_id
, i
;
252 const char *grp_name
= tracing_group
;
254 /* Get GID of group 'tracing' */
255 if (utils_get_group_id(grp_name
, false, &tracing_gid
)) {
256 /* If grp_tracing is NULL, the group does not exist. */
260 /* Get number of supplementary group IDs */
261 grp_list_size
= getgroups(0, NULL
);
262 if (grp_list_size
< 0) {
267 /* Alloc group list of the right size */
268 grp_list
= (gid_t
*) zmalloc(grp_list_size
* sizeof(gid_t
));
273 grp_id
= getgroups(grp_list_size
, grp_list
);
279 for (i
= 0; i
< grp_list_size
; i
++) {
280 if (grp_list
[i
] == tracing_gid
) {
293 static int check_enough_available_memory(size_t num_bytes_requested_per_cpu
)
297 size_t best_mem_info
;
298 size_t num_bytes_requested_total
;
301 * Get the number of CPU currently online to compute the amount of
302 * memory needed to create a buffer for every CPU.
304 num_cpu
= sysconf(_SC_NPROCESSORS_ONLN
);
309 num_bytes_requested_total
= num_bytes_requested_per_cpu
* num_cpu
;
312 * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
313 * reliable estimate we can get but it is only exposed by the kernel
314 * since 3.14. (See Linux kernel commit:
315 * 34e431b0ae398fc54ea69ff85ec700722c9da773)
317 ret
= utils_get_memory_available(&best_mem_info
);
323 * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This
324 * is a sanity check for obvious user error.
326 ret
= utils_get_memory_total(&best_mem_info
);
334 return best_mem_info
>= num_bytes_requested_total
;
338 * Try connect to session daemon with sock_path.
340 * Return 0 on success, else -1
342 static int try_connect_sessiond(const char *sock_path
)
346 /* If socket exist, we check if the daemon listens for connect. */
347 ret
= access(sock_path
, F_OK
);
353 ret
= lttcomm_connect_unix_sock(sock_path
);
359 ret
= lttcomm_close_unix_sock(ret
);
361 PERROR("lttcomm_close_unix_sock");
371 * Set sessiond socket path by putting it in the global sessiond_sock_path
374 * Returns 0 on success, negative value on failure (the sessiond socket path
375 * is somehow too long or ENOMEM).
377 static int set_session_daemon_path(void)
379 int in_tgroup
= 0; /* In tracing group. */
385 /* Are we in the tracing group ? */
386 in_tgroup
= lttng_check_tracing_group();
389 if ((uid
== 0) || in_tgroup
== 1) {
390 const int ret
= lttng_strncpy(sessiond_sock_path
,
391 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
,
392 sizeof(sessiond_sock_path
));
404 ret
= try_connect_sessiond(sessiond_sock_path
);
408 /* Global session daemon not available... */
410 /* ...or not in tracing group (and not root), default */
413 * With GNU C < 2.1, snprintf returns -1 if the target buffer
415 * With GNU C >= 2.1, snprintf returns the required size
416 * (excluding closing null)
418 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
419 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
420 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
432 * Connect to the LTTng session daemon.
434 * On success, return the socket's file descriptor. On error, return -1.
436 int connect_sessiond(void)
440 ret
= set_session_daemon_path();
445 /* Connect to the sesssion daemon. */
446 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
457 static void reset_global_sessiond_connection_state(void)
459 sessiond_socket
= -1;
464 * Clean disconnect from the session daemon.
466 * On success, return 0. On error, return -1.
468 static int disconnect_sessiond(void)
473 ret
= lttcomm_close_unix_sock(sessiond_socket
);
474 reset_global_sessiond_connection_state();
480 static int recv_sessiond_optional_data(size_t len
, void **user_buf
,
488 ret
= -LTTNG_ERR_INVALID
;
498 ret
= recv_data_sessiond(buf
, len
);
504 ret
= -LTTNG_ERR_INVALID
;
508 /* Move ownership of command header buffer to user. */
513 /* No command header. */
529 * Ask the session daemon a specific command and put the data into buf.
530 * Takes extra var. len. data and file descriptors as input to send to the
533 * Return size of data (only payload, not header) or a negative error code.
535 int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg
*lsm
,
536 const int *fds
, size_t nb_fd
, const void *vardata
,
537 size_t vardata_len
, void **user_payload_buf
,
538 void **user_cmd_header_buf
, size_t *user_cmd_header_len
)
542 struct lttcomm_lttng_msg llm
;
544 ret
= connect_sessiond();
546 ret
= -LTTNG_ERR_NO_SESSIOND
;
549 sessiond_socket
= ret
;
553 ret
= send_session_msg(lsm
);
555 /* Ret value is a valid lttng error code. */
558 /* Send var len data */
559 ret
= send_session_varlen(vardata
, vardata_len
);
561 /* Ret value is a valid lttng error code. */
566 ret
= send_session_fds(fds
, nb_fd
);
568 /* Ret value is a valid lttng error code. */
572 /* Get header from data transmission */
573 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
575 /* Ret value is a valid lttng error code. */
579 /* Check error code if OK */
580 if (llm
.ret_code
!= LTTNG_OK
) {
585 /* Get command header from data transmission */
586 ret
= recv_sessiond_optional_data(llm
.cmd_header_size
,
587 user_cmd_header_buf
, user_cmd_header_len
);
592 /* Get payload from data transmission */
593 ret
= recv_sessiond_optional_data(llm
.data_size
, user_payload_buf
,
602 disconnect_sessiond();
606 int lttng_ctl_ask_sessiond_payload(struct lttng_payload_view
*message
,
607 struct lttng_payload
*reply
)
610 struct lttcomm_lttng_msg llm
;
611 const int fd_count
= lttng_payload_view_get_fd_handle_count(message
);
613 LTTNG_ASSERT(reply
->buffer
.size
== 0);
614 LTTNG_ASSERT(lttng_dynamic_pointer_array_get_count(&reply
->_fd_handles
) == 0);
616 ret
= connect_sessiond();
618 ret
= -LTTNG_ERR_NO_SESSIOND
;
621 sessiond_socket
= ret
;
625 /* Send command to session daemon */
626 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, message
->buffer
.data
,
627 message
->buffer
.size
);
629 ret
= -LTTNG_ERR_FATAL
;
634 ret
= lttcomm_send_payload_view_fds_unix_sock(sessiond_socket
,
637 ret
= -LTTNG_ERR_FATAL
;
642 /* Get header from data transmission */
643 ret
= recv_payload_sessiond(reply
, sizeof(llm
));
645 /* Ret value is a valid lttng error code. */
649 llm
= *((typeof(llm
) *) reply
->buffer
.data
);
651 /* Check error code if OK */
652 if (llm
.ret_code
!= LTTNG_OK
) {
653 if (llm
.ret_code
< LTTNG_OK
|| llm
.ret_code
>= LTTNG_ERR_NR
) {
654 /* Invalid error code received. */
655 ret
= -LTTNG_ERR_UNK
;
662 if (llm
.cmd_header_size
> 0) {
663 ret
= recv_payload_sessiond(reply
, llm
.cmd_header_size
);
669 /* Get command header from data transmission */
670 if (llm
.data_size
> 0) {
671 ret
= recv_payload_sessiond(reply
, llm
.data_size
);
677 if (llm
.fd_count
> 0) {
678 ret
= lttcomm_recv_payload_fds_unix_sock(
679 sessiond_socket
, llm
.fd_count
, reply
);
685 /* Don't return the llm header to the caller. */
686 memmove(reply
->buffer
.data
, reply
->buffer
.data
+ sizeof(llm
),
687 reply
->buffer
.size
- sizeof(llm
));
688 ret
= lttng_dynamic_buffer_set_size(
689 &reply
->buffer
, reply
->buffer
.size
- sizeof(llm
));
691 /* Can't happen as size is reduced. */
695 ret
= reply
->buffer
.size
;
698 disconnect_sessiond();
703 * Create lttng handle and return pointer.
705 * The returned pointer will be NULL in case of malloc() error.
707 struct lttng_handle
*lttng_create_handle(const char *session_name
,
708 struct lttng_domain
*domain
)
711 struct lttng_handle
*handle
= NULL
;
713 handle
= (lttng_handle
*) zmalloc(sizeof(struct lttng_handle
));
714 if (handle
== NULL
) {
715 PERROR("malloc handle");
719 /* Copy session name */
720 ret
= lttng_strncpy(handle
->session_name
, session_name
? : "",
721 sizeof(handle
->session_name
));
726 /* Copy lttng domain or leave initialized to 0. */
728 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
739 * Destroy handle by free(3) the pointer.
741 void lttng_destroy_handle(struct lttng_handle
*handle
)
747 * Register an outside consumer.
749 * Returns size of returned session payload data or a negative error code.
751 int lttng_register_consumer(struct lttng_handle
*handle
,
752 const char *socket_path
)
755 struct lttcomm_session_msg lsm
;
757 if (handle
== NULL
|| socket_path
== NULL
) {
758 ret
= -LTTNG_ERR_INVALID
;
762 memset(&lsm
, 0, sizeof(lsm
));
763 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
764 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
765 sizeof(lsm
.session
.name
));
767 ret
= -LTTNG_ERR_INVALID
;
771 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
773 ret
= lttng_strncpy(lsm
.u
.reg
.path
, socket_path
,
774 sizeof(lsm
.u
.reg
.path
));
776 ret
= -LTTNG_ERR_INVALID
;
780 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
786 * Start tracing for all traces of the session.
788 * Returns size of returned session payload data or a negative error code.
790 int lttng_start_tracing(const char *session_name
)
793 struct lttcomm_session_msg lsm
;
795 if (session_name
== NULL
) {
796 ret
= -LTTNG_ERR_INVALID
;
800 memset(&lsm
, 0, sizeof(lsm
));
801 lsm
.cmd_type
= LTTNG_START_TRACE
;
803 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
804 sizeof(lsm
.session
.name
));
806 ret
= -LTTNG_ERR_INVALID
;
810 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
816 * Stop tracing for all traces of the session.
818 static int _lttng_stop_tracing(const char *session_name
, int wait
)
821 struct lttcomm_session_msg lsm
;
823 if (session_name
== NULL
) {
824 ret
= -LTTNG_ERR_INVALID
;
828 memset(&lsm
, 0, sizeof(lsm
));
829 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
831 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
832 sizeof(lsm
.session
.name
));
834 ret
= -LTTNG_ERR_INVALID
;
838 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
839 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
847 /* Check for data availability */
849 data_ret
= lttng_data_pending(session_name
);
851 /* Return the data available call error. */
857 * Data sleep time before retrying (in usec). Don't sleep if the
858 * call returned value indicates availability.
861 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US
);
863 } while (data_ret
!= 0);
871 * Stop tracing and wait for data availability.
873 int lttng_stop_tracing(const char *session_name
)
875 return _lttng_stop_tracing(session_name
, 1);
879 * Stop tracing but _don't_ wait for data availability.
881 int lttng_stop_tracing_no_wait(const char *session_name
)
883 return _lttng_stop_tracing(session_name
, 0);
887 * Add context to a channel.
889 * If the given channel is NULL, add the contexts to all channels.
890 * The event_name param is ignored.
892 * Returns the size of the returned payload data or a negative error code.
894 int lttng_add_context(struct lttng_handle
*handle
,
895 struct lttng_event_context
*ctx
, const char *event_name
,
896 const char *channel_name
)
901 struct lttcomm_session_msg lsm
;
903 /* Safety check. Both are mandatory. */
904 if (handle
== NULL
|| ctx
== NULL
) {
905 ret
= -LTTNG_ERR_INVALID
;
909 memset(&lsm
, 0, sizeof(lsm
));
910 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
912 /* If no channel name, send empty string. */
913 ret
= lttng_strncpy(lsm
.u
.context
.channel_name
, channel_name
?: "",
914 sizeof(lsm
.u
.context
.channel_name
));
916 ret
= -LTTNG_ERR_INVALID
;
920 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
921 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
922 sizeof(lsm
.session
.name
));
924 ret
= -LTTNG_ERR_INVALID
;
928 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
929 size_t provider_len
, ctx_len
;
930 const char *provider_name
= ctx
->u
.app_ctx
.provider_name
;
931 const char *ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
933 if (!provider_name
|| !ctx_name
) {
934 ret
= -LTTNG_ERR_INVALID
;
938 provider_len
= strlen(provider_name
);
939 if (provider_len
== 0) {
940 ret
= -LTTNG_ERR_INVALID
;
943 lsm
.u
.context
.provider_name_len
= provider_len
;
945 ctx_len
= strlen(ctx_name
);
947 ret
= -LTTNG_ERR_INVALID
;
950 lsm
.u
.context
.context_name_len
= ctx_len
;
952 len
= provider_len
+ ctx_len
;
953 buf
= (char *) zmalloc(len
);
955 ret
= -LTTNG_ERR_NOMEM
;
959 memcpy(buf
, provider_name
, provider_len
);
960 memcpy(buf
+ provider_len
, ctx_name
, ctx_len
);
962 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
964 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
966 * Don't leak application addresses to the sessiond.
967 * This is only necessary when ctx is for an app ctx otherwise
968 * the values inside the union (type & config) are overwritten.
970 lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
971 lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
974 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buf
, len
, NULL
);
981 * Enable event(s) for a channel.
983 * If no event name is specified, all events are enabled.
984 * If no channel name is specified, the default 'channel0' is used.
986 * Returns size of returned session payload data or a negative error code.
988 int lttng_enable_event(struct lttng_handle
*handle
,
989 struct lttng_event
*ev
, const char *channel_name
)
991 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
996 * Create or enable an event with a filter expression.
998 * Return negative error value on error.
999 * Return size of returned session payload data if OK.
1001 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
1002 struct lttng_event
*event
, const char *channel_name
,
1003 const char *filter_expression
)
1005 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
1006 filter_expression
, 0, NULL
);
1010 * Depending on the event, return a newly allocated agent filter expression or
1011 * NULL if not applicable.
1013 * An event with NO loglevel and the name is * will return NULL.
1015 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
1018 char *agent_filter
= NULL
;
1022 /* Don't add filter for the '*' event. */
1023 if (strcmp(ev
->name
, "*") != 0) {
1025 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
1028 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
1036 /* Add loglevel filtering if any for the JUL domain. */
1037 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1040 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
1046 if (filter
|| agent_filter
) {
1049 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
1050 agent_filter
? agent_filter
: filter
, op
,
1055 agent_filter
= new_filter
;
1057 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
1066 return agent_filter
;
1073 * Enable event(s) for a channel, possibly with exclusions and a filter.
1074 * If no event name is specified, all events are enabled.
1075 * If no channel name is specified, the default name is used.
1076 * If filter expression is not NULL, the filter is set for the event.
1077 * If exclusion count is not zero, the exclusions are set for the event.
1078 * Returns size of returned session payload data or a negative error code.
1080 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
1081 struct lttng_event
*ev
, const char *channel_name
,
1082 const char *original_filter_expression
,
1083 int exclusion_count
, char **exclusion_list
)
1085 struct lttcomm_session_msg lsm
;
1086 struct lttng_payload payload
;
1088 unsigned int free_filter_expression
= 0;
1089 struct filter_parser_ctx
*ctx
= NULL
;
1092 * We have either a filter or some exclusions, so we need to set up
1093 * a variable-length payload from where to send the data.
1095 lttng_payload_init(&payload
);
1098 * Cast as non-const since we may replace the filter expression
1099 * by a dynamically allocated string. Otherwise, the original
1100 * string is not modified.
1102 char *filter_expression
= (char *) original_filter_expression
;
1104 if (handle
== NULL
|| ev
== NULL
) {
1105 ret
= -LTTNG_ERR_INVALID
;
1110 * Empty filter string will always be rejected by the parser
1111 * anyway, so treat this corner-case early to eliminate
1112 * lttng_fmemopen error for 0-byte allocation.
1114 if (filter_expression
&& filter_expression
[0] == '\0') {
1115 ret
= -LTTNG_ERR_INVALID
;
1119 memset(&lsm
, 0, sizeof(lsm
));
1121 /* If no channel name, send empty string. */
1122 ret
= lttng_strncpy(lsm
.u
.enable
.channel_name
, channel_name
?: "",
1123 sizeof(lsm
.u
.enable
.channel_name
));
1125 ret
= -LTTNG_ERR_INVALID
;
1129 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1130 if (ev
->name
[0] == '\0') {
1131 /* Enable all events. */
1132 ret
= lttng_strncpy(ev
->name
, "*", sizeof(ev
->name
));
1133 LTTNG_ASSERT(ret
== 0);
1136 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1137 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1139 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1140 sizeof(lsm
.session
.name
));
1142 ret
= -LTTNG_ERR_INVALID
;
1146 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1147 lsm
.u
.enable
.bytecode_len
= 0;
1149 /* Parse filter expression. */
1150 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1151 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1152 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1153 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1154 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1155 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1158 /* Setup JUL filter if needed. */
1159 agent_filter
= set_agent_filter(filter_expression
, ev
);
1160 if (!agent_filter
) {
1161 if (!filter_expression
) {
1163 * No JUL and no filter, just skip
1170 * With an agent filter, the original filter has
1171 * been added to it thus replace the filter
1174 filter_expression
= agent_filter
;
1175 free_filter_expression
= 1;
1179 ret
= filter_parser_ctx_create_from_filter_expression(filter_expression
, &ctx
);
1184 lsm
.u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
1185 + bytecode_get_len(&ctx
->bytecode
->b
);
1186 lsm
.u
.enable
.expression_len
= strlen(filter_expression
) + 1;
1189 ret
= lttng_dynamic_buffer_set_capacity(&payload
.buffer
,
1190 lsm
.u
.enable
.bytecode_len
+
1191 lsm
.u
.enable
.expression_len
+
1192 LTTNG_SYMBOL_NAME_LEN
*
1195 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1199 /* Put exclusion names first in the data. */
1200 for (i
= 0; i
< exclusion_count
; i
++) {
1201 size_t exclusion_len
;
1203 exclusion_len
= lttng_strnlen(exclusion_list
[i
],
1204 LTTNG_SYMBOL_NAME_LEN
);
1205 if (exclusion_len
== LTTNG_SYMBOL_NAME_LEN
) {
1206 /* Exclusion is not NULL-terminated. */
1207 ret
= -LTTNG_ERR_INVALID
;
1211 ret
= lttng_dynamic_buffer_append(&payload
.buffer
,
1212 exclusion_list
[i
], exclusion_len
);
1218 * Padding the rest of the entry with zeros. Every exclusion
1219 * entries take LTTNG_SYMBOL_NAME_LEN bytes in the buffer.
1221 ret
= lttng_dynamic_buffer_set_size(&payload
.buffer
,
1222 LTTNG_SYMBOL_NAME_LEN
* (i
+ 1));
1228 /* Add filter expression next. */
1229 if (filter_expression
) {
1230 ret
= lttng_dynamic_buffer_append(&payload
.buffer
,
1231 filter_expression
, lsm
.u
.enable
.expression_len
);
1236 /* Add filter bytecode next. */
1237 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1238 ret
= lttng_dynamic_buffer_append(&payload
.buffer
,
1239 &ctx
->bytecode
->b
, lsm
.u
.enable
.bytecode_len
);
1244 if (ev
->extended
.ptr
) {
1245 struct lttng_event_extended
*ev_ext
=
1246 (struct lttng_event_extended
*) ev
->extended
.ptr
;
1248 if (ev_ext
->probe_location
) {
1250 * lttng_userspace_probe_location_serialize returns the
1251 * number of bytes that was appended to the buffer.
1253 ret
= lttng_userspace_probe_location_serialize(
1254 ev_ext
->probe_location
, &payload
);
1260 * Set the size of the userspace probe location element
1261 * of the buffer so that the receiving side knows where
1264 lsm
.u
.enable
.userspace_probe_location_len
= ret
;
1269 struct lttng_payload_view view
= lttng_payload_view_from_payload(
1271 int fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
1278 LTTNG_ASSERT(fd_count
== 0 || fd_count
== 1);
1279 if (fd_count
== 1) {
1280 struct fd_handle
*h
=
1281 lttng_payload_view_pop_fd_handle(&view
);
1287 fd_to_send
= fd_handle_get_fd(h
);
1291 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
,
1292 fd_count
? &fd_to_send
: NULL
, fd_count
,
1293 view
.buffer
.size
? view
.buffer
.data
: NULL
,
1294 view
.buffer
.size
, NULL
, NULL
, 0);
1298 if (filter_expression
&& ctx
) {
1299 filter_bytecode_free(ctx
);
1300 filter_ir_free(ctx
);
1301 filter_parser_ctx_free(ctx
);
1304 if (free_filter_expression
) {
1306 * The filter expression has been replaced and must be freed as
1307 * it is not the original filter expression received as a
1310 free(filter_expression
);
1314 * Return directly to the caller and don't ask the sessiond since
1315 * something went wrong in the parsing of data above.
1317 lttng_payload_reset(&payload
);
1321 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1325 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1326 struct lttng_event
*ev
, const char *channel_name
,
1327 const char *original_filter_expression
)
1329 struct lttcomm_session_msg lsm
;
1332 unsigned int free_filter_expression
= 0;
1333 struct filter_parser_ctx
*ctx
= NULL
;
1335 * Cast as non-const since we may replace the filter expression
1336 * by a dynamically allocated string. Otherwise, the original
1337 * string is not modified.
1339 char *filter_expression
= (char *) original_filter_expression
;
1341 if (handle
== NULL
|| ev
== NULL
) {
1342 ret
= -LTTNG_ERR_INVALID
;
1347 * Empty filter string will always be rejected by the parser
1348 * anyway, so treat this corner-case early to eliminate
1349 * lttng_fmemopen error for 0-byte allocation.
1351 if (filter_expression
&& filter_expression
[0] == '\0') {
1352 ret
= -LTTNG_ERR_INVALID
;
1356 memset(&lsm
, 0, sizeof(lsm
));
1358 /* If no channel name, send empty string. */
1359 ret
= lttng_strncpy(lsm
.u
.disable
.channel_name
, channel_name
?: "",
1360 sizeof(lsm
.u
.disable
.channel_name
));
1362 ret
= -LTTNG_ERR_INVALID
;
1366 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1368 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1369 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1371 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1372 sizeof(lsm
.session
.name
));
1374 ret
= -LTTNG_ERR_INVALID
;
1378 lsm
.u
.disable
.bytecode_len
= 0;
1381 * For the JUL domain, a filter is enforced except for the
1382 * disable all event. This is done to avoid having the event in
1383 * all sessions thus filtering by logger name.
1385 if (filter_expression
== NULL
&&
1386 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1387 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1388 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1393 * We have a filter, so we need to set up a variable-length
1394 * memory block from where to send the data.
1397 /* Parse filter expression */
1398 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1399 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1400 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1401 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1402 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1403 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1406 /* Setup JUL filter if needed. */
1407 agent_filter
= set_agent_filter(filter_expression
, ev
);
1408 if (!agent_filter
) {
1409 if (!filter_expression
) {
1411 * No JUL and no filter, just skip
1418 * With a JUL filter, the original filter has
1419 * been added to it thus replace the filter
1422 filter_expression
= agent_filter
;
1423 free_filter_expression
= 1;
1427 ret
= filter_parser_ctx_create_from_filter_expression(filter_expression
, &ctx
);
1432 lsm
.u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
1433 + bytecode_get_len(&ctx
->bytecode
->b
);
1434 lsm
.u
.enable
.expression_len
= strlen(filter_expression
) + 1;
1437 varlen_data
= (char *) zmalloc(lsm
.u
.disable
.bytecode_len
1438 + lsm
.u
.disable
.expression_len
);
1440 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1444 /* Add filter expression. */
1445 if (lsm
.u
.disable
.expression_len
!= 0) {
1448 lsm
.u
.disable
.expression_len
);
1450 /* Add filter bytecode next. */
1451 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1453 + lsm
.u
.disable
.expression_len
,
1455 lsm
.u
.disable
.bytecode_len
);
1458 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1459 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1463 if (filter_expression
&& ctx
) {
1464 filter_bytecode_free(ctx
);
1465 filter_ir_free(ctx
);
1466 filter_parser_ctx_free(ctx
);
1469 if (free_filter_expression
) {
1471 * The filter expression has been replaced and must be freed as
1472 * it is not the original filter expression received as a
1475 free(filter_expression
);
1479 * Return directly to the caller and don't ask the sessiond since
1480 * something went wrong in the parsing of data above.
1485 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1490 * Disable event(s) of a channel and domain.
1491 * If no event name is specified, all events are disabled.
1492 * If no channel name is specified, the default 'channel0' is used.
1493 * Returns size of returned session payload data or a negative error code.
1495 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1496 const char *channel_name
)
1499 struct lttng_event ev
;
1501 memset(&ev
, 0, sizeof(ev
));
1503 ev
.type
= LTTNG_EVENT_ALL
;
1504 ret
= lttng_strncpy(ev
.name
, name
?: "", sizeof(ev
.name
));
1506 ret
= -LTTNG_ERR_INVALID
;
1510 ret
= lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1515 struct lttng_channel
*lttng_channel_create(struct lttng_domain
*domain
)
1517 struct lttng_channel
*channel
= NULL
;
1518 struct lttng_channel_extended
*extended
= NULL
;
1524 /* Validate domain. */
1525 switch (domain
->type
) {
1526 case LTTNG_DOMAIN_UST
:
1527 switch (domain
->buf_type
) {
1528 case LTTNG_BUFFER_PER_UID
:
1529 case LTTNG_BUFFER_PER_PID
:
1535 case LTTNG_DOMAIN_KERNEL
:
1536 if (domain
->buf_type
!= LTTNG_BUFFER_GLOBAL
) {
1544 channel
= (lttng_channel
*) zmalloc(sizeof(*channel
));
1549 extended
= (lttng_channel_extended
*) zmalloc(sizeof(*extended
));
1554 channel
->attr
.extended
.ptr
= extended
;
1556 lttng_channel_set_default_attr(domain
, &channel
->attr
);
1564 void lttng_channel_destroy(struct lttng_channel
*channel
)
1570 if (channel
->attr
.extended
.ptr
) {
1571 free(channel
->attr
.extended
.ptr
);
1577 * Enable channel per domain
1578 * Returns size of returned session payload data or a negative error code.
1580 int lttng_enable_channel(struct lttng_handle
*handle
,
1581 struct lttng_channel
*in_chan
)
1584 struct lttcomm_session_msg lsm
;
1585 size_t total_buffer_size_needed_per_cpu
= 0;
1587 /* NULL arguments are forbidden. No default values. */
1588 if (handle
== NULL
|| in_chan
== NULL
) {
1589 return -LTTNG_ERR_INVALID
;
1592 memset(&lsm
, 0, sizeof(lsm
));
1593 memcpy(&lsm
.u
.channel
.chan
, in_chan
, sizeof(lsm
.u
.channel
.chan
));
1594 lsm
.u
.channel
.chan
.attr
.extended
.ptr
= NULL
;
1596 if (!in_chan
->attr
.extended
.ptr
) {
1597 struct lttng_channel
*channel
;
1598 struct lttng_channel_extended
*extended
;
1600 channel
= lttng_channel_create(&handle
->domain
);
1602 return -LTTNG_ERR_NOMEM
;
1606 * Create a new channel in order to use default extended
1609 extended
= (struct lttng_channel_extended
*)
1610 channel
->attr
.extended
.ptr
;
1611 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1612 lttng_channel_destroy(channel
);
1614 struct lttng_channel_extended
*extended
;
1616 extended
= (struct lttng_channel_extended
*)
1617 in_chan
->attr
.extended
.ptr
;
1618 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1622 * Verify that the amount of memory required to create the requested
1623 * buffer is available on the system at the moment.
1625 total_buffer_size_needed_per_cpu
= lsm
.u
.channel
.chan
.attr
.num_subbuf
*
1626 lsm
.u
.channel
.chan
.attr
.subbuf_size
;
1627 if (!check_enough_available_memory(total_buffer_size_needed_per_cpu
)) {
1628 return -LTTNG_ERR_NOMEM
;
1631 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1632 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1634 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1635 sizeof(lsm
.session
.name
));
1637 ret
= -LTTNG_ERR_INVALID
;
1641 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1647 * All tracing will be stopped for registered events of the channel.
1648 * Returns size of returned session payload data or a negative error code.
1650 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1653 struct lttcomm_session_msg lsm
;
1655 /* Safety check. Both are mandatory. */
1656 if (handle
== NULL
|| name
== NULL
) {
1657 return -LTTNG_ERR_INVALID
;
1660 memset(&lsm
, 0, sizeof(lsm
));
1662 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1664 ret
= lttng_strncpy(lsm
.u
.disable
.channel_name
, name
,
1665 sizeof(lsm
.u
.disable
.channel_name
));
1667 ret
= -LTTNG_ERR_INVALID
;
1671 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1673 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1674 sizeof(lsm
.session
.name
));
1676 ret
= -LTTNG_ERR_INVALID
;
1680 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1686 * Lists all available tracepoints of domain.
1687 * Sets the contents of the events array.
1688 * Returns the number of lttng_event entries in events;
1689 * on error, returns a negative value.
1691 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1692 struct lttng_event
**events
)
1695 struct lttcomm_session_msg lsm
;
1697 if (handle
== NULL
) {
1698 return -LTTNG_ERR_INVALID
;
1701 memset(&lsm
, 0, sizeof(lsm
));
1702 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1703 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1705 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1710 return ret
/ sizeof(struct lttng_event
);
1714 * Lists all available tracepoint fields of domain.
1715 * Sets the contents of the event field array.
1716 * Returns the number of lttng_event_field entries in events;
1717 * on error, returns a negative value.
1719 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1720 struct lttng_event_field
**fields
)
1723 struct lttcomm_session_msg lsm
;
1725 if (handle
== NULL
) {
1726 return -LTTNG_ERR_INVALID
;
1729 memset(&lsm
, 0, sizeof(lsm
));
1730 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1731 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1733 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1738 return ret
/ sizeof(struct lttng_event_field
);
1742 * Lists all available kernel system calls. Allocates and sets the contents of
1745 * Returns the number of lttng_event entries in events; on error, returns a
1748 int lttng_list_syscalls(struct lttng_event
**events
)
1751 struct lttcomm_session_msg lsm
;
1754 return -LTTNG_ERR_INVALID
;
1757 memset(&lsm
, 0, sizeof(lsm
));
1758 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1759 /* Force kernel domain for system calls. */
1760 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1762 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1767 return ret
/ sizeof(struct lttng_event
);
1771 * Returns a human readable string describing
1772 * the error code (a negative value).
1774 const char *lttng_strerror(int code
)
1776 return error_get_str(code
);
1779 enum lttng_error_code
lttng_create_session_ext(
1780 struct lttng_session_descriptor
*session_descriptor
)
1782 enum lttng_error_code ret_code
;
1783 struct lttcomm_session_msg lsm
= {
1784 .cmd_type
= LTTNG_CREATE_SESSION_EXT
,
1787 struct lttng_buffer_view reply_view
;
1789 bool sessiond_must_generate_ouput
;
1790 struct lttng_dynamic_buffer payload
;
1792 size_t descriptor_size
;
1793 struct lttng_session_descriptor
*descriptor_reply
= NULL
;
1795 lttng_dynamic_buffer_init(&payload
);
1796 if (!session_descriptor
) {
1797 ret_code
= LTTNG_ERR_INVALID
;
1801 sessiond_must_generate_ouput
=
1802 !lttng_session_descriptor_is_output_destination_initialized(
1803 session_descriptor
);
1804 if (sessiond_must_generate_ouput
) {
1805 const char *home_dir
= utils_get_home_dir();
1806 size_t home_dir_len
= home_dir
? strlen(home_dir
) + 1 : 0;
1808 if (!home_dir
|| home_dir_len
> LTTNG_PATH_MAX
) {
1809 ret_code
= LTTNG_ERR_FATAL
;
1813 lsm
.u
.create_session
.home_dir_size
= (uint16_t) home_dir_len
;
1814 ret
= lttng_dynamic_buffer_append(&payload
, home_dir
,
1817 ret_code
= LTTNG_ERR_NOMEM
;
1822 descriptor_size
= payload
.size
;
1823 ret
= lttng_session_descriptor_serialize(session_descriptor
,
1826 ret_code
= LTTNG_ERR_INVALID
;
1829 descriptor_size
= payload
.size
- descriptor_size
;
1830 lsm
.u
.create_session
.session_descriptor_size
= descriptor_size
;
1832 /* Command returns a session descriptor on success. */
1833 reply_ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, payload
.data
,
1834 payload
.size
, &reply
);
1835 if (reply_ret
< 0) {
1836 ret_code
= (lttng_error_code
) -reply_ret
;
1838 } else if (reply_ret
== 0) {
1839 /* Socket unexpectedly closed by the session daemon. */
1840 ret_code
= LTTNG_ERR_FATAL
;
1844 reply_view
= lttng_buffer_view_init((const char *) reply
, 0, reply_ret
);
1845 ret
= lttng_session_descriptor_create_from_buffer(&reply_view
,
1848 ret_code
= LTTNG_ERR_FATAL
;
1851 ret_code
= LTTNG_OK
;
1852 lttng_session_descriptor_assign(session_descriptor
, descriptor_reply
);
1855 lttng_dynamic_buffer_reset(&payload
);
1856 lttng_session_descriptor_destroy(descriptor_reply
);
1861 * Create a new session using name and url for destination.
1863 * Return 0 on success else a negative LTTng error code.
1865 int lttng_create_session(const char *name
, const char *url
)
1869 struct lttng_uri
*uris
= NULL
;
1870 struct lttng_session_descriptor
*descriptor
= NULL
;
1871 enum lttng_error_code ret_code
;
1874 ret
= -LTTNG_ERR_INVALID
;
1878 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1880 ret
= -LTTNG_ERR_INVALID
;
1885 descriptor
= lttng_session_descriptor_create(name
);
1888 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1889 ret
= -LTTNG_ERR_INVALID
;
1892 descriptor
= lttng_session_descriptor_local_create(name
,
1896 descriptor
= lttng_session_descriptor_network_create(name
, url
,
1900 ret
= -LTTNG_ERR_INVALID
;
1904 ret
= -LTTNG_ERR_INVALID
;
1907 ret_code
= lttng_create_session_ext(descriptor
);
1908 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1910 lttng_session_descriptor_destroy(descriptor
);
1916 * Create a session exclusively used for snapshot.
1918 * Return 0 on success else a negative LTTng error code.
1920 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1923 enum lttng_error_code ret_code
;
1925 struct lttng_uri
*uris
= NULL
;
1926 struct lttng_session_descriptor
*descriptor
= NULL
;
1929 ret
= -LTTNG_ERR_INVALID
;
1933 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1935 ret
= -LTTNG_ERR_INVALID
;
1939 * If the user does not specify a custom subdir, use the session name.
1941 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&&
1942 strlen(uris
[0].subdir
) == 0) {
1943 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s",
1946 PERROR("Failed to set session name as network destination sub-directory");
1947 ret
= -LTTNG_ERR_FATAL
;
1949 } else if (ret
>= sizeof(uris
[0].subdir
)) {
1950 /* Truncated output. */
1951 ret
= -LTTNG_ERR_INVALID
;
1958 descriptor
= lttng_session_descriptor_snapshot_create(name
);
1961 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1962 ret
= -LTTNG_ERR_INVALID
;
1965 descriptor
= lttng_session_descriptor_snapshot_local_create(
1970 descriptor
= lttng_session_descriptor_snapshot_network_create(
1976 ret
= -LTTNG_ERR_INVALID
;
1980 ret
= -LTTNG_ERR_INVALID
;
1983 ret_code
= lttng_create_session_ext(descriptor
);
1984 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1986 lttng_session_descriptor_destroy(descriptor
);
1992 * Create a session exclusively used for live.
1994 * Return 0 on success else a negative LTTng error code.
1996 int lttng_create_session_live(const char *name
, const char *url
,
1997 unsigned int timer_interval
)
2000 enum lttng_error_code ret_code
;
2001 struct lttng_session_descriptor
*descriptor
= NULL
;
2004 ret
= -LTTNG_ERR_INVALID
;
2009 descriptor
= lttng_session_descriptor_live_network_create(
2010 name
, url
, NULL
, timer_interval
);
2012 descriptor
= lttng_session_descriptor_live_create(
2013 name
, timer_interval
);
2016 ret
= -LTTNG_ERR_INVALID
;
2019 ret_code
= lttng_create_session_ext(descriptor
);
2020 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2022 lttng_session_descriptor_destroy(descriptor
);
2027 * Stop the session and wait for the data before destroying it
2029 * Return 0 on success else a negative LTTng error code.
2031 int lttng_destroy_session(const char *session_name
)
2034 enum lttng_error_code ret_code
;
2035 enum lttng_destruction_handle_status status
;
2036 struct lttng_destruction_handle
*handle
= NULL
;
2039 * Stop the tracing and wait for the data to be
2042 ret
= _lttng_stop_tracing(session_name
, 1);
2043 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
2047 ret_code
= lttng_destroy_session_ext(session_name
, &handle
);
2048 if (ret_code
!= LTTNG_OK
) {
2049 ret
= (int) -ret_code
;
2052 LTTNG_ASSERT(handle
);
2054 /* Block until the completion of the destruction of the session. */
2055 status
= lttng_destruction_handle_wait_for_completion(handle
, -1);
2056 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED
) {
2057 ret
= -LTTNG_ERR_UNK
;
2061 status
= lttng_destruction_handle_get_result(handle
, &ret_code
);
2062 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
2063 ret
= -LTTNG_ERR_UNK
;
2066 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2068 lttng_destruction_handle_destroy(handle
);
2073 * Destroy the session without waiting for the data.
2075 int lttng_destroy_session_no_wait(const char *session_name
)
2077 enum lttng_error_code ret_code
;
2079 ret_code
= lttng_destroy_session_ext(session_name
, NULL
);
2080 return ret_code
== LTTNG_OK
? 0 : -ret_code
;
2084 * Ask the session daemon for all available sessions.
2085 * Sets the contents of the sessions array.
2086 * Returns the number of lttng_session entries in sessions;
2087 * on error, returns a negative value.
2089 int lttng_list_sessions(struct lttng_session
**out_sessions
)
2092 struct lttcomm_session_msg lsm
;
2093 const size_t session_size
= sizeof(struct lttng_session
) +
2094 sizeof(struct lttng_session_extended
);
2095 size_t session_count
, i
;
2096 struct lttng_session_extended
*sessions_extended_begin
;
2097 struct lttng_session
*sessions
= NULL
;
2099 memset(&lsm
, 0, sizeof(lsm
));
2100 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
2101 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) &sessions
);
2106 ret
= -LTTNG_ERR_FATAL
;
2110 if (ret
% session_size
) {
2111 ret
= -LTTNG_ERR_UNK
;
2113 *out_sessions
= NULL
;
2116 session_count
= (size_t) ret
/ session_size
;
2117 sessions_extended_begin
= (struct lttng_session_extended
*)
2118 (&sessions
[session_count
]);
2120 /* Set extended session info pointers. */
2121 for (i
= 0; i
< session_count
; i
++) {
2122 struct lttng_session
*session
= &sessions
[i
];
2123 struct lttng_session_extended
*extended
=
2124 &(sessions_extended_begin
[i
]);
2126 session
->extended
.ptr
= extended
;
2129 ret
= (int) session_count
;
2130 *out_sessions
= sessions
;
2135 enum lttng_error_code
lttng_session_get_creation_time(
2136 const struct lttng_session
*session
, uint64_t *creation_time
)
2138 enum lttng_error_code ret
= LTTNG_OK
;
2139 struct lttng_session_extended
*extended
;
2141 if (!session
|| !creation_time
|| !session
->extended
.ptr
) {
2142 ret
= LTTNG_ERR_INVALID
;
2146 extended
= (lttng_session_extended
*) session
->extended
.ptr
;
2147 if (!extended
->creation_time
.is_set
) {
2148 /* Not created on the session daemon yet. */
2149 ret
= LTTNG_ERR_SESSION_NOT_EXIST
;
2152 *creation_time
= extended
->creation_time
.value
;
2157 int lttng_set_session_shm_path(const char *session_name
,
2158 const char *shm_path
)
2161 struct lttcomm_session_msg lsm
;
2163 if (session_name
== NULL
) {
2164 return -LTTNG_ERR_INVALID
;
2167 memset(&lsm
, 0, sizeof(lsm
));
2168 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
2170 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2171 sizeof(lsm
.session
.name
));
2173 ret
= -LTTNG_ERR_INVALID
;
2177 ret
= lttng_strncpy(lsm
.u
.set_shm_path
.shm_path
, shm_path
?: "",
2178 sizeof(lsm
.u
.set_shm_path
.shm_path
));
2180 ret
= -LTTNG_ERR_INVALID
;
2184 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2190 * Ask the session daemon for all available domains of a session.
2191 * Sets the contents of the domains array.
2192 * Returns the number of lttng_domain entries in domains;
2193 * on error, returns a negative value.
2195 int lttng_list_domains(const char *session_name
,
2196 struct lttng_domain
**domains
)
2199 struct lttcomm_session_msg lsm
;
2201 if (session_name
== NULL
) {
2202 ret
= -LTTNG_ERR_INVALID
;
2206 memset(&lsm
, 0, sizeof(lsm
));
2207 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
2209 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2210 sizeof(lsm
.session
.name
));
2212 ret
= -LTTNG_ERR_INVALID
;
2216 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
2221 return ret
/ sizeof(struct lttng_domain
);
2227 * Ask the session daemon for all available channels of a session.
2228 * Sets the contents of the channels array.
2229 * Returns the number of lttng_channel entries in channels;
2230 * on error, returns a negative value.
2232 int lttng_list_channels(struct lttng_handle
*handle
,
2233 struct lttng_channel
**channels
)
2236 size_t channel_count
, i
;
2237 const size_t channel_size
= sizeof(struct lttng_channel
) +
2238 sizeof(struct lttng_channel_extended
);
2239 struct lttcomm_session_msg lsm
;
2242 if (handle
== NULL
) {
2243 ret
= -LTTNG_ERR_INVALID
;
2247 memset(&lsm
, 0, sizeof(lsm
));
2248 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
2249 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2250 sizeof(lsm
.session
.name
));
2252 ret
= -LTTNG_ERR_INVALID
;
2256 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2258 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
2263 if (ret
% channel_size
) {
2264 ret
= -LTTNG_ERR_UNK
;
2269 channel_count
= (size_t) ret
/ channel_size
;
2271 /* Set extended info pointers */
2272 extended_at
= ((char *) *channels
) +
2273 channel_count
* sizeof(struct lttng_channel
);
2274 for (i
= 0; i
< channel_count
; i
++) {
2275 struct lttng_channel
*chan
= &(*channels
)[i
];
2277 chan
->attr
.extended
.ptr
= extended_at
;
2278 extended_at
+= sizeof(struct lttng_channel_extended
);
2281 ret
= (int) channel_count
;
2287 * Ask the session daemon for all available events of a session channel.
2288 * Sets the contents of the events array.
2289 * Returns the number of lttng_event entries in events;
2290 * on error, returns a negative value.
2292 int lttng_list_events(struct lttng_handle
*handle
,
2293 const char *channel_name
, struct lttng_event
**events
)
2296 struct lttcomm_session_msg lsm
= {};
2297 const struct lttcomm_event_command_header
*cmd_header
= NULL
;
2298 uint32_t nb_events
, i
;
2299 const char *comm_ext_at
;
2300 struct lttng_dynamic_buffer listing
;
2302 struct lttng_payload payload
;
2303 struct lttng_payload payload_copy
;
2304 struct lttng_payload_view lsm_view
=
2305 lttng_payload_view_init_from_buffer(
2306 (const char *) &lsm
, 0, sizeof(lsm
));
2307 struct lttng_buffer_view cmd_header_view
;
2308 struct lttng_buffer_view cmd_payload_view
;
2309 struct lttng_buffer_view flat_events_view
;
2310 struct lttng_buffer_view ext_view
;
2312 /* Safety check. An handle and channel name are mandatory */
2313 if (handle
== NULL
|| channel_name
== NULL
) {
2314 ret
= -LTTNG_ERR_INVALID
;
2318 lttng_payload_init(&payload
);
2319 lttng_payload_init(&payload_copy
);
2321 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
2322 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2323 sizeof(lsm
.session
.name
));
2325 ret
= -LTTNG_ERR_INVALID
;
2329 ret
= lttng_strncpy(lsm
.u
.list
.channel_name
, channel_name
,
2330 sizeof(lsm
.u
.list
.channel_name
));
2332 ret
= -LTTNG_ERR_INVALID
;
2336 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2338 ret
= lttng_ctl_ask_sessiond_payload(&lsm_view
, &payload
);
2344 * A copy of the payload is performed since it will be
2345 * consumed twice. Consuming the same payload twice is invalid since
2346 * it will cause any received file descriptor to become "shared"
2347 * between different instances of the resulting objects.
2349 ret
= lttng_payload_copy(&payload
, &payload_copy
);
2351 ret
= -LTTNG_ERR_NOMEM
;
2355 cmd_header_view
= lttng_buffer_view_from_dynamic_buffer(
2356 &payload
.buffer
, 0, sizeof(*cmd_header
));
2357 if (!lttng_buffer_view_is_valid(&cmd_header_view
)) {
2358 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2362 cmd_header
= (typeof(cmd_header
)) cmd_header_view
.data
;
2364 /* Set number of events and free command header */
2365 nb_events
= cmd_header
->nb_events
;
2366 if (nb_events
> INT_MAX
) {
2367 ret
= -LTTNG_ERR_OVERFLOW
;
2371 cmd_payload_view
= lttng_buffer_view_from_dynamic_buffer(
2372 &payload
.buffer
, sizeof(*cmd_header
), -1);
2375 * The buffer that is returned must contain a "flat" version of
2376 * the events that are returned. In other words, all pointers
2377 * within an lttng_event must point to a location within the returned
2378 * buffer so that the user may free everything by simply calling free()
2379 * on the returned buffer. This is needed in order to maintain API
2382 * A first pass is performed to compute the size of the buffer that
2383 * must be allocated. A second pass is then performed to setup
2384 * the returned events so that their members always point within the
2387 * The layout of the returned buffer is as follows:
2388 * - struct lttng_event[nb_events],
2389 * - nb_events times the following:
2390 * - struct lttng_event_extended,
2391 * - flattened version of userspace_probe_location
2392 * - filter_expression
2394 * - padding to align to 64-bits
2396 ext_view
= lttng_buffer_view_from_view(&cmd_payload_view
,
2397 nb_events
* sizeof(struct lttng_event
), -1);
2398 comm_ext_at
= ext_view
.data
;
2399 storage_req
= nb_events
* sizeof(struct lttng_event
);
2401 struct lttng_payload_view payload_view
=
2402 lttng_payload_view_from_payload(&payload
, 0, -1);
2404 for (i
= 0; i
< nb_events
; i
++) {
2405 const struct lttcomm_event_extended_header
*ext_comm
=
2406 (struct lttcomm_event_extended_header
*)
2408 int probe_storage_req
= 0;
2410 comm_ext_at
+= sizeof(*ext_comm
);
2411 comm_ext_at
+= ext_comm
->filter_len
;
2412 comm_ext_at
+= ext_comm
->nb_exclusions
*
2413 LTTNG_SYMBOL_NAME_LEN
;
2415 if (ext_comm
->userspace_probe_location_len
) {
2416 struct lttng_userspace_probe_location
2417 *probe_location
= NULL
;
2418 struct lttng_payload_view probe_location_view
= lttng_payload_view_from_view(
2420 (const char *) comm_ext_at
-
2421 payload_view
.buffer
.data
,
2422 ext_comm
->userspace_probe_location_len
);
2424 if (!lttng_payload_view_is_valid(&probe_location_view
)) {
2425 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2430 * Create a temporary userspace probe location
2431 * to determine the size needed by a "flattened"
2432 * version of that same probe location.
2434 ret
= lttng_userspace_probe_location_create_from_payload(
2435 &probe_location_view
,
2438 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2442 ret
= lttng_userspace_probe_location_flatten(
2443 probe_location
, NULL
);
2444 lttng_userspace_probe_location_destroy(
2447 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2451 probe_storage_req
= ret
;
2452 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2455 storage_req
+= sizeof(struct lttng_event_extended
);
2456 storage_req
+= ext_comm
->filter_len
;
2457 storage_req
+= ext_comm
->nb_exclusions
*
2458 LTTNG_SYMBOL_NAME_LEN
;
2459 /* Padding to ensure the flat probe is aligned. */
2460 storage_req
= lttng_align_ceil(storage_req
, sizeof(uint64_t));
2461 storage_req
+= probe_storage_req
;
2465 lttng_dynamic_buffer_init(&listing
);
2467 * We must ensure that "listing" is never resized so as to preserve
2468 * the validity of the flattened objects.
2470 ret
= lttng_dynamic_buffer_set_capacity(&listing
, storage_req
);
2472 ret
= -LTTNG_ERR_NOMEM
;
2476 cmd_payload_view
= lttng_buffer_view_from_dynamic_buffer(
2477 &payload_copy
.buffer
, sizeof(*cmd_header
), -1);
2478 flat_events_view
= lttng_buffer_view_from_view(&cmd_payload_view
, 0,
2479 nb_events
* sizeof(struct lttng_event
));
2480 ret
= lttng_dynamic_buffer_append_view(&listing
, &flat_events_view
);
2482 ret
= -LTTNG_ERR_NOMEM
;
2483 goto free_dynamic_buffer
;
2486 ext_view
= lttng_buffer_view_from_view(&cmd_payload_view
,
2487 nb_events
* sizeof(struct lttng_event
), -1);
2488 comm_ext_at
= ext_view
.data
;
2491 struct lttng_payload_view payload_copy_view
=
2492 lttng_payload_view_from_payload(
2493 &payload_copy
, 0, -1);
2495 for (i
= 0; i
< nb_events
; i
++) {
2496 struct lttng_event
*event
= (typeof(event
))(
2498 (sizeof(struct lttng_event
) * i
));
2499 const struct lttcomm_event_extended_header
*ext_comm
=
2500 (typeof(ext_comm
)) comm_ext_at
;
2501 struct lttng_event_extended
*event_extended
=
2502 (typeof(event_extended
))(listing
.data
+
2505 /* Insert struct lttng_event_extended. */
2506 ret
= lttng_dynamic_buffer_set_size(&listing
,
2507 listing
.size
+ sizeof(*event_extended
));
2509 ret
= -LTTNG_ERR_NOMEM
;
2510 goto free_dynamic_buffer
;
2512 event
->extended
.ptr
= event_extended
;
2514 comm_ext_at
+= sizeof(*ext_comm
);
2516 /* Insert filter expression. */
2517 if (ext_comm
->filter_len
) {
2518 event_extended
->filter_expression
=
2519 listing
.data
+ listing
.size
;
2520 ret
= lttng_dynamic_buffer_append(&listing
,
2522 ext_comm
->filter_len
);
2524 ret
= -LTTNG_ERR_NOMEM
;
2525 goto free_dynamic_buffer
;
2527 comm_ext_at
+= ext_comm
->filter_len
;
2530 /* Insert exclusions. */
2531 if (ext_comm
->nb_exclusions
) {
2532 event_extended
->exclusions
.count
=
2533 ext_comm
->nb_exclusions
;
2534 event_extended
->exclusions
.strings
=
2535 listing
.data
+ listing
.size
;
2537 ret
= lttng_dynamic_buffer_append(&listing
,
2539 ext_comm
->nb_exclusions
*
2540 LTTNG_SYMBOL_NAME_LEN
);
2542 ret
= -LTTNG_ERR_NOMEM
;
2543 goto free_dynamic_buffer
;
2545 comm_ext_at
+= ext_comm
->nb_exclusions
*
2546 LTTNG_SYMBOL_NAME_LEN
;
2549 /* Insert padding to align to 64-bits. */
2550 ret
= lttng_dynamic_buffer_set_size(&listing
,
2551 lttng_align_ceil(listing
.size
,
2554 ret
= -LTTNG_ERR_NOMEM
;
2555 goto free_dynamic_buffer
;
2558 /* Insert flattened userspace probe location. */
2559 if (ext_comm
->userspace_probe_location_len
) {
2560 struct lttng_userspace_probe_location
2561 *probe_location
= NULL
;
2562 struct lttng_payload_view probe_location_view
= lttng_payload_view_from_view(
2564 (const char *) comm_ext_at
-
2565 payload_copy_view
.buffer
.data
,
2566 ext_comm
->userspace_probe_location_len
);
2568 if (!lttng_payload_view_is_valid(&probe_location_view
)) {
2569 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2570 goto free_dynamic_buffer
;
2573 ret
= lttng_userspace_probe_location_create_from_payload(
2574 &probe_location_view
,
2577 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2578 goto free_dynamic_buffer
;
2581 event_extended
->probe_location
= (struct lttng_userspace_probe_location
2584 ret
= lttng_userspace_probe_location_flatten(
2585 probe_location
, &listing
);
2586 lttng_userspace_probe_location_destroy(
2589 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2590 goto free_dynamic_buffer
;
2593 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2598 /* Don't reset listing buffer as we return its content. */
2599 *events
= (struct lttng_event
*) listing
.data
;
2600 lttng_dynamic_buffer_init(&listing
);
2601 ret
= (int) nb_events
;
2602 free_dynamic_buffer
:
2603 lttng_dynamic_buffer_reset(&listing
);
2605 lttng_payload_reset(&payload
);
2606 lttng_payload_reset(&payload_copy
);
2611 * Sets the tracing_group variable with name.
2612 * This function allocates memory pointed to by tracing_group.
2613 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2615 int lttng_set_tracing_group(const char *name
)
2621 ret
= -LTTNG_ERR_INVALID
;
2625 new_group
= strdup(name
);
2627 ret
= -LTTNG_ERR_FATAL
;
2631 free(tracing_group
);
2632 tracing_group
= new_group
;
2639 int lttng_calibrate(struct lttng_handle
*handle
,
2640 struct lttng_calibrate
*calibrate
)
2643 * This command was removed in LTTng 2.9.
2645 return -LTTNG_ERR_UND
;
2649 * Set default channel attributes.
2650 * If either or both of the arguments are null, attr content is zeroe'd.
2652 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
2653 struct lttng_channel_attr
*attr
)
2655 struct lttng_channel_extended
*extended
;
2658 if (attr
== NULL
|| domain
== NULL
) {
2662 extended
= (struct lttng_channel_extended
*) attr
->extended
.ptr
;
2663 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
2665 /* Same for all domains. */
2666 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2667 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
2668 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
2670 switch (domain
->type
) {
2671 case LTTNG_DOMAIN_KERNEL
:
2672 attr
->switch_timer_interval
=
2673 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
2674 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
2675 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
2676 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
2677 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
2679 extended
->monitor_timer_interval
=
2680 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
;
2681 extended
->blocking_timeout
=
2682 DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT
;
2685 case LTTNG_DOMAIN_UST
:
2686 switch (domain
->buf_type
) {
2687 case LTTNG_BUFFER_PER_UID
:
2688 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
2689 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
2690 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
2691 attr
->switch_timer_interval
=
2692 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
2693 attr
->read_timer_interval
=
2694 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
2696 extended
->monitor_timer_interval
=
2697 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER
;
2698 extended
->blocking_timeout
=
2699 DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT
;
2702 case LTTNG_BUFFER_PER_PID
:
2704 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
2705 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
2706 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
2707 attr
->switch_timer_interval
=
2708 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2709 attr
->read_timer_interval
=
2710 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2712 extended
->monitor_timer_interval
=
2713 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
;
2714 extended
->blocking_timeout
=
2715 DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT
;
2720 /* Default behavior: leave set to 0. */
2724 attr
->extended
.ptr
= extended
;
2727 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2728 uint64_t *discarded_events
)
2731 struct lttng_channel_extended
*chan_ext
;
2733 if (!channel
|| !discarded_events
) {
2734 ret
= -LTTNG_ERR_INVALID
;
2738 chan_ext
= (lttng_channel_extended
*) channel
->attr
.extended
.ptr
;
2741 * This can happen since the lttng_channel structure is
2742 * used for other tasks where this pointer is never set.
2744 *discarded_events
= 0;
2748 *discarded_events
= chan_ext
->discarded_events
;
2753 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2754 uint64_t *lost_packets
)
2757 struct lttng_channel_extended
*chan_ext
;
2759 if (!channel
|| !lost_packets
) {
2760 ret
= -LTTNG_ERR_INVALID
;
2764 chan_ext
= (lttng_channel_extended
*) channel
->attr
.extended
.ptr
;
2767 * This can happen since the lttng_channel structure is
2768 * used for other tasks where this pointer is never set.
2774 *lost_packets
= chan_ext
->lost_packets
;
2779 int lttng_channel_get_monitor_timer_interval(struct lttng_channel
*chan
,
2780 uint64_t *monitor_timer_interval
)
2784 if (!chan
|| !monitor_timer_interval
) {
2785 ret
= -LTTNG_ERR_INVALID
;
2789 if (!chan
->attr
.extended
.ptr
) {
2790 ret
= -LTTNG_ERR_INVALID
;
2794 *monitor_timer_interval
= ((struct lttng_channel_extended
*)
2795 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
2800 int lttng_channel_set_monitor_timer_interval(struct lttng_channel
*chan
,
2801 uint64_t monitor_timer_interval
)
2805 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2806 ret
= -LTTNG_ERR_INVALID
;
2810 ((struct lttng_channel_extended
*)
2811 chan
->attr
.extended
.ptr
)->monitor_timer_interval
=
2812 monitor_timer_interval
;
2817 int lttng_channel_get_blocking_timeout(struct lttng_channel
*chan
,
2818 int64_t *blocking_timeout
)
2822 if (!chan
|| !blocking_timeout
) {
2823 ret
= -LTTNG_ERR_INVALID
;
2827 if (!chan
->attr
.extended
.ptr
) {
2828 ret
= -LTTNG_ERR_INVALID
;
2832 *blocking_timeout
= ((struct lttng_channel_extended
*)
2833 chan
->attr
.extended
.ptr
)->blocking_timeout
;
2838 int lttng_channel_set_blocking_timeout(struct lttng_channel
*chan
,
2839 int64_t blocking_timeout
)
2842 int64_t msec_timeout
;
2844 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2845 ret
= -LTTNG_ERR_INVALID
;
2849 if (blocking_timeout
< 0 && blocking_timeout
!= -1) {
2850 ret
= -LTTNG_ERR_INVALID
;
2855 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2856 * us to accept a narrower range of values (msecs expressed as a signed
2859 msec_timeout
= blocking_timeout
/ 1000;
2860 if (msec_timeout
!= (int32_t) msec_timeout
) {
2861 ret
= -LTTNG_ERR_INVALID
;
2865 ((struct lttng_channel_extended
*)
2866 chan
->attr
.extended
.ptr
)->blocking_timeout
=
2873 * Check if session daemon is alive.
2875 * Return 1 if alive or 0 if not.
2876 * On error returns a negative value.
2878 int lttng_session_daemon_alive(void)
2882 ret
= set_session_daemon_path();
2888 if (*sessiond_sock_path
== '\0') {
2890 * No socket path set. Weird error which means the constructor
2896 ret
= try_connect_sessiond(sessiond_sock_path
);
2907 * Set URL for a consumer for a session and domain.
2909 * Return 0 on success, else a negative value.
2911 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2912 const char *control_url
, const char *data_url
)
2916 struct lttcomm_session_msg lsm
;
2917 struct lttng_uri
*uris
= NULL
;
2919 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2920 ret
= -LTTNG_ERR_INVALID
;
2924 memset(&lsm
, 0, sizeof(lsm
));
2926 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2928 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2929 sizeof(lsm
.session
.name
));
2931 ret
= -LTTNG_ERR_INVALID
;
2935 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2937 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2939 ret
= -LTTNG_ERR_INVALID
;
2943 lsm
.u
.uri
.size
= size
;
2945 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2946 sizeof(struct lttng_uri
) * size
, NULL
);
2957 LTTNG_EXPORT
int lttng_enable_consumer(struct lttng_handle
*handle
);
2958 int lttng_enable_consumer(struct lttng_handle
*handle
)
2967 LTTNG_EXPORT
int lttng_disable_consumer(struct lttng_handle
*handle
);
2968 int lttng_disable_consumer(struct lttng_handle
*handle
)
2977 LTTNG_EXPORT
int _lttng_create_session_ext(const char *name
, const char *url
,
2978 const char *datetime
);
2979 int _lttng_create_session_ext(const char *name
, const char *url
,
2980 const char *datetime
)
2986 * For a given session name, this call checks if the data is ready to be read
2987 * or is still being extracted by the consumer(s) hence not ready to be used by
2990 int lttng_data_pending(const char *session_name
)
2993 struct lttcomm_session_msg lsm
;
2994 uint8_t *pending
= NULL
;
2996 if (session_name
== NULL
) {
2997 return -LTTNG_ERR_INVALID
;
3000 memset(&lsm
, 0, sizeof(lsm
));
3001 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
3003 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
3004 sizeof(lsm
.session
.name
));
3006 ret
= -LTTNG_ERR_INVALID
;
3010 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
3013 } else if (ret
!= 1) {
3014 /* Unexpected payload size */
3015 ret
= -LTTNG_ERR_INVALID
;
3017 } else if (!pending
) {
3018 /* Internal error. */
3019 ret
= -LTTNG_ERR_UNK
;
3023 ret
= (int) *pending
;
3030 * Regenerate the metadata for a session.
3031 * Return 0 on success, a negative error code on error.
3033 int lttng_regenerate_metadata(const char *session_name
)
3036 struct lttcomm_session_msg lsm
;
3038 if (!session_name
) {
3039 ret
= -LTTNG_ERR_INVALID
;
3043 memset(&lsm
, 0, sizeof(lsm
));
3044 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
3046 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
3047 sizeof(lsm
.session
.name
));
3049 ret
= -LTTNG_ERR_INVALID
;
3053 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
3064 * Deprecated, replaced by lttng_regenerate_metadata.
3066 int lttng_metadata_regenerate(const char *session_name
)
3068 return lttng_regenerate_metadata(session_name
);
3072 * Regenerate the statedump of a session.
3073 * Return 0 on success, a negative error code on error.
3075 int lttng_regenerate_statedump(const char *session_name
)
3078 struct lttcomm_session_msg lsm
;
3080 if (!session_name
) {
3081 ret
= -LTTNG_ERR_INVALID
;
3085 memset(&lsm
, 0, sizeof(lsm
));
3086 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
3088 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
3089 sizeof(lsm
.session
.name
));
3091 ret
= -LTTNG_ERR_INVALID
;
3095 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
3106 int _lttng_register_trigger(struct lttng_trigger
*trigger
, const char *name
,
3110 struct lttcomm_session_msg lsm
= {
3111 .cmd_type
= LTTNG_REGISTER_TRIGGER
,
3113 lsm
.u
.trigger
.is_trigger_anonymous
= !name
&& !generate_name
;
3114 struct lttcomm_session_msg
*message_lsm
;
3115 struct lttng_payload message
;
3116 struct lttng_payload reply
;
3117 struct lttng_trigger
*reply_trigger
= NULL
;
3118 enum lttng_domain_type domain_type
;
3119 const struct lttng_credentials user_creds
= {
3120 .uid
= LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3121 .gid
= LTTNG_OPTIONAL_INIT_UNSET
,
3123 const char *unused_trigger_name
= NULL
;
3124 enum lttng_trigger_status trigger_status
;
3126 lttng_payload_init(&message
);
3127 lttng_payload_init(&reply
);
3130 ret
= -LTTNG_ERR_INVALID
;
3134 trigger_status
= lttng_trigger_get_name(trigger
, &unused_trigger_name
);
3135 if (trigger_status
!= LTTNG_TRIGGER_STATUS_UNSET
) {
3136 /* Re-using already registered trigger. */
3137 ret
= -LTTNG_ERR_INVALID
;
3142 trigger_status
= lttng_trigger_set_name(trigger
, name
);
3143 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
3144 ret
= -LTTNG_ERR_NOMEM
;
3149 if (!trigger
->creds
.uid
.is_set
) {
3150 /* Use the client's credentials as the trigger credentials. */
3151 lttng_trigger_set_credentials(trigger
, &user_creds
);
3154 * Validate that either the current trigger credentials and the
3155 * client credentials are identical or that the current user is
3156 * root. The root user can register, unregister triggers for
3157 * himself and other users.
3159 * This check is also present on the sessiond side, using the
3160 * credentials passed on the socket. These check are all
3163 const struct lttng_credentials
*trigger_creds
=
3164 lttng_trigger_get_credentials(trigger
);
3166 if (!lttng_credentials_is_equal_uid(trigger_creds
, &user_creds
)) {
3167 if (lttng_credentials_get_uid(&user_creds
) != 0) {
3168 ret
= -LTTNG_ERR_EPERM
;
3169 goto end_unset_name
;
3174 if (!lttng_trigger_validate(trigger
)) {
3175 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3176 goto end_unset_name
;
3179 domain_type
= lttng_trigger_get_underlying_domain_type_restriction(
3182 lsm
.domain
.type
= domain_type
;
3184 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3186 ret
= -LTTNG_ERR_NOMEM
;
3187 goto end_unset_name
;
3190 ret
= lttng_trigger_serialize(trigger
, &message
);
3192 ret
= -LTTNG_ERR_UNK
;
3193 goto end_unset_name
;
3197 * This is needed to populate the trigger object size for the command
3200 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3202 message_lsm
->u
.trigger
.length
= (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3205 struct lttng_payload_view message_view
=
3206 lttng_payload_view_from_payload(
3209 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3211 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3213 goto end_unset_name
;
3218 struct lttng_payload_view reply_view
=
3219 lttng_payload_view_from_payload(
3220 &reply
, 0, reply
.buffer
.size
);
3222 ret
= lttng_trigger_create_from_payload(
3223 &reply_view
, &reply_trigger
);
3225 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
3226 goto end_unset_name
;
3230 if (name
|| generate_name
) {
3231 ret
= lttng_trigger_assign_name(trigger
, reply_trigger
);
3233 ret
= -LTTNG_ERR_NOMEM
;
3242 trigger_status
= lttng_trigger_set_name(trigger
, NULL
);
3243 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
3244 ret
= -LTTNG_ERR_UNK
;
3247 lttng_payload_reset(&message
);
3248 lttng_payload_reset(&reply
);
3249 lttng_trigger_destroy(reply_trigger
);
3253 int lttng_register_trigger(struct lttng_trigger
*trigger
)
3255 /* Register an anonymous trigger. */
3256 return _lttng_register_trigger(trigger
, NULL
, false);
3259 enum lttng_error_code
lttng_register_trigger_with_name(
3260 struct lttng_trigger
*trigger
, const char *name
)
3262 const int ret
= _lttng_register_trigger(trigger
, name
, false);
3264 return ret
== 0 ? LTTNG_OK
: (enum lttng_error_code
) -ret
;
3267 enum lttng_error_code
lttng_register_trigger_with_automatic_name(
3268 struct lttng_trigger
*trigger
)
3270 const int ret
= _lttng_register_trigger(trigger
, nullptr, true);
3272 return ret
== 0 ? LTTNG_OK
: (enum lttng_error_code
) -ret
;
3275 enum lttng_error_code
lttng_error_query_execute(
3276 const struct lttng_error_query
*query
,
3277 const struct lttng_endpoint
*endpoint
,
3278 struct lttng_error_query_results
**results
)
3281 enum lttng_error_code ret_code
;
3282 struct lttcomm_session_msg lsm
= {
3283 .cmd_type
= LTTNG_EXECUTE_ERROR_QUERY
,
3285 struct lttng_payload message
;
3286 struct lttng_payload reply
;
3287 struct lttcomm_session_msg
*message_lsm
;
3289 lttng_payload_init(&message
);
3290 lttng_payload_init(&reply
);
3292 if (!query
|| !results
) {
3293 ret_code
= LTTNG_ERR_INVALID
;
3297 if (endpoint
!= lttng_session_daemon_command_endpoint
) {
3298 ret_code
= LTTNG_ERR_INVALID_ERROR_QUERY_TARGET
;
3302 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3304 ret_code
= LTTNG_ERR_NOMEM
;
3308 ret
= lttng_error_query_serialize(query
, &message
);
3310 ret_code
= LTTNG_ERR_UNK
;
3314 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3315 message_lsm
->u
.error_query
.length
=
3316 (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3319 struct lttng_payload_view message_view
=
3320 lttng_payload_view_from_payload(
3323 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3325 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3327 ret_code
=(lttng_error_code
) -ret
;
3333 ssize_t reply_create_ret
;
3334 struct lttng_payload_view reply_view
=
3335 lttng_payload_view_from_payload(
3336 &reply
, 0, reply
.buffer
.size
);
3338 reply_create_ret
= lttng_error_query_results_create_from_payload(
3339 &reply_view
, results
);
3340 if (reply_create_ret
< 0) {
3341 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3346 ret_code
= LTTNG_OK
;
3348 lttng_payload_reset(&message
);
3349 lttng_payload_reset(&reply
);
3353 int lttng_unregister_trigger(const struct lttng_trigger
*trigger
)
3356 struct lttcomm_session_msg lsm
;
3357 struct lttcomm_session_msg
*message_lsm
;
3358 struct lttng_payload message
;
3359 struct lttng_payload reply
;
3360 struct lttng_trigger
*copy
= NULL
;
3361 const struct lttng_credentials user_creds
= {
3362 .uid
= LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3363 .gid
= LTTNG_OPTIONAL_INIT_UNSET
,
3366 lttng_payload_init(&message
);
3367 lttng_payload_init(&reply
);
3370 ret
= -LTTNG_ERR_INVALID
;
3374 copy
= lttng_trigger_copy(trigger
);
3376 ret
= -LTTNG_ERR_UNK
;
3380 if (!copy
->creds
.uid
.is_set
) {
3381 /* Use the client credentials as the trigger credentials */
3382 lttng_trigger_set_credentials(copy
, &user_creds
);
3385 * Validate that either the current trigger credentials and the
3386 * client credentials are identical or that the current user is
3387 * root. The root user can register, unregister triggers for
3388 * himself and other users.
3390 * This check is also present on the sessiond side, using the
3391 * credentials passed on the socket. These check are all
3394 const struct lttng_credentials
*trigger_creds
=
3395 lttng_trigger_get_credentials(copy
);
3396 if (!lttng_credentials_is_equal_uid(trigger_creds
, &user_creds
)) {
3397 if (lttng_credentials_get_uid(&user_creds
) != 0) {
3398 ret
= -LTTNG_ERR_EPERM
;
3404 if (!lttng_trigger_validate(copy
)) {
3405 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3409 memset(&lsm
, 0, sizeof(lsm
));
3410 lsm
.cmd_type
= LTTNG_UNREGISTER_TRIGGER
;
3412 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3414 ret
= -LTTNG_ERR_NOMEM
;
3418 ret
= lttng_trigger_serialize(copy
, &message
);
3420 ret
= -LTTNG_ERR_UNK
;
3425 * This is needed to populate the trigger object size for the command
3426 * header and number of fds sent.
3428 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3430 message_lsm
->u
.trigger
.length
= (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3433 struct lttng_payload_view message_view
=
3434 lttng_payload_view_from_payload(
3438 * Update the message header with the number of fd that will be
3441 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3444 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3452 lttng_trigger_destroy(copy
);
3453 lttng_payload_reset(&message
);
3454 lttng_payload_reset(&reply
);
3459 * Ask the session daemon for all registered triggers for the current user.
3461 * Allocates and return an lttng_triggers set.
3462 * On error, returns a suitable lttng_error_code.
3464 enum lttng_error_code
lttng_list_triggers(struct lttng_triggers
**triggers
)
3467 enum lttng_error_code ret_code
= LTTNG_OK
;
3468 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_LIST_TRIGGERS
};
3469 struct lttng_triggers
*local_triggers
= NULL
;
3470 struct lttng_payload reply
;
3471 struct lttng_payload_view lsm_view
=
3472 lttng_payload_view_init_from_buffer(
3473 (const char *) &lsm
, 0, sizeof(lsm
));
3475 lttng_payload_init(&reply
);
3477 ret
= lttng_ctl_ask_sessiond_payload(&lsm_view
, &reply
);
3479 ret_code
= (enum lttng_error_code
) -ret
;
3484 struct lttng_payload_view reply_view
=
3485 lttng_payload_view_from_payload(
3486 &reply
, 0, reply
.buffer
.size
);
3488 ret
= lttng_triggers_create_from_payload(
3489 &reply_view
, &local_triggers
);
3491 ret_code
= LTTNG_ERR_FATAL
;
3496 *triggers
= local_triggers
;
3497 local_triggers
= NULL
;
3499 lttng_payload_reset(&reply
);
3500 lttng_triggers_destroy(local_triggers
);
3507 static void __attribute__((constructor
)) init(void)
3509 /* Set default session group */
3510 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
3516 static void __attribute__((destructor
)) lttng_ctl_exit(void)
3518 free(tracing_group
);