4 * Linux Trace Toolkit Control Library
6 * Copyright (C) 2011 EfficiOS Inc.
7 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * SPDX-License-Identifier: LGPL-2.1-only
22 #include <common/bytecode/bytecode.h>
23 #include <common/common.h>
24 #include <common/compat/errno.h>
25 #include <common/compat/string.h>
26 #include <common/defaults.h>
27 #include <common/dynamic-array.h>
28 #include <common/dynamic-buffer.h>
29 #include <common/payload-view.h>
30 #include <common/payload.h>
31 #include <common/sessiond-comm/sessiond-comm.h>
32 #include <common/tracker.h>
33 #include <common/unix.h>
34 #include <common/uri.h>
35 #include <common/utils.h>
36 #include <lttng/channel-internal.h>
37 #include <lttng/destruction-handle.h>
38 #include <lttng/endpoint.h>
39 #include <lttng/error-query-internal.h>
40 #include <lttng/event-internal.h>
41 #include <lttng/health-internal.h>
42 #include <lttng/lttng-error.h>
43 #include <lttng/lttng.h>
44 #include <lttng/session-descriptor-internal.h>
45 #include <lttng/session-internal.h>
46 #include <lttng/trigger/trigger-internal.h>
47 #include <lttng/userspace-probe-internal.h>
49 #include "lttng-ctl-helper.h"
50 #include <common/filter/filter-ast.h>
51 #include <common/filter/filter-parser.h>
52 #include <common/filter/memstream.h>
54 #define COPY_DOMAIN_PACKED(dst, src) \
56 struct lttng_domain _tmp_domain; \
58 lttng_ctl_copy_lttng_domain(&_tmp_domain, &src); \
62 /* Socket to session daemon for communication */
63 static int sessiond_socket
= -1;
64 static char sessiond_sock_path
[PATH_MAX
];
67 static char *tracing_group
;
73 * Those two variables are used by error.h to silent or control the verbosity of
74 * error message. They are global to the library so application linking with it
75 * are able to compile correctly and also control verbosity of the library.
78 int lttng_opt_verbose
;
82 * Copy domain to lttcomm_session_msg domain.
84 * If domain is unknown, default domain will be the kernel.
87 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
88 struct lttng_domain
*src
)
92 case LTTNG_DOMAIN_KERNEL
:
93 case LTTNG_DOMAIN_UST
:
94 case LTTNG_DOMAIN_JUL
:
95 case LTTNG_DOMAIN_LOG4J
:
96 case LTTNG_DOMAIN_PYTHON
:
97 memcpy(dst
, src
, sizeof(struct lttng_domain
));
100 memset(dst
, 0, sizeof(struct lttng_domain
));
107 * Send lttcomm_session_msg to the session daemon.
109 * On success, returns the number of bytes sent (>=0)
110 * On error, returns -1
112 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
117 ret
= -LTTNG_ERR_NO_SESSIOND
;
121 DBG("LSM cmd type: '%s' (%d)", lttcomm_sessiond_command_str(lsm
->cmd_type
),
124 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
125 sizeof(struct lttcomm_session_msg
));
127 ret
= -LTTNG_ERR_FATAL
;
135 * Send var len data to the session daemon.
137 * On success, returns the number of bytes sent (>=0)
138 * On error, returns -1
140 static int send_session_varlen(const void *data
, size_t len
)
145 ret
= -LTTNG_ERR_NO_SESSIOND
;
154 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
156 ret
= -LTTNG_ERR_FATAL
;
164 * Send file descriptors to the session daemon.
166 * On success, returns the number of bytes sent (>=0)
167 * On error, returns -1
169 static int send_session_fds(const int *fds
, size_t nb_fd
)
174 ret
= -LTTNG_ERR_NO_SESSIOND
;
178 if (!fds
|| !nb_fd
) {
183 ret
= lttcomm_send_fds_unix_sock(sessiond_socket
, fds
, nb_fd
);
185 ret
= -LTTNG_ERR_FATAL
;
193 * Receive data from the sessiond socket.
195 * On success, returns the number of bytes received (>=0)
196 * On error, returns a negative lttng_error_code.
198 static int recv_data_sessiond(void *buf
, size_t len
)
205 ret
= -LTTNG_ERR_NO_SESSIOND
;
209 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
211 ret
= -LTTNG_ERR_FATAL
;
212 } else if (ret
== 0) {
213 ret
= -LTTNG_ERR_NO_SESSIOND
;
221 * Receive a payload from the session daemon by appending to an existing
223 * On success, returns the number of bytes received (>=0)
224 * On error, returns a negative lttng_error_code.
226 static int recv_payload_sessiond(struct lttng_payload
*payload
, size_t len
)
229 const size_t original_payload_size
= payload
->buffer
.size
;
231 ret
= lttng_dynamic_buffer_set_size(
232 &payload
->buffer
, payload
->buffer
.size
+ len
);
234 ret
= -LTTNG_ERR_NOMEM
;
238 ret
= recv_data_sessiond(
239 payload
->buffer
.data
+ original_payload_size
, len
);
245 * Check if we are in the specified group.
247 * If yes return 1, else return -1.
250 int lttng_check_tracing_group(void)
252 gid_t
*grp_list
, tracing_gid
;
253 int grp_list_size
, grp_id
, i
;
255 const char *grp_name
= tracing_group
;
257 /* Get GID of group 'tracing' */
258 if (utils_get_group_id(grp_name
, false, &tracing_gid
)) {
259 /* If grp_tracing is NULL, the group does not exist. */
263 /* Get number of supplementary group IDs */
264 grp_list_size
= getgroups(0, NULL
);
265 if (grp_list_size
< 0) {
270 /* Alloc group list of the right size */
271 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
276 grp_id
= getgroups(grp_list_size
, grp_list
);
282 for (i
= 0; i
< grp_list_size
; i
++) {
283 if (grp_list
[i
] == tracing_gid
) {
296 static enum lttng_error_code
check_enough_available_memory(
297 uint64_t num_bytes_requested_per_cpu
)
300 enum lttng_error_code ret_code
;
302 uint64_t best_mem_info
;
303 uint64_t num_bytes_requested_total
;
306 * Get the number of CPU currently online to compute the amount of
307 * memory needed to create a buffer for every CPU.
309 num_cpu
= sysconf(_SC_NPROCESSORS_ONLN
);
311 ret_code
= LTTNG_ERR_FATAL
;
315 if (num_bytes_requested_per_cpu
> UINT64_MAX
/ (uint64_t) num_cpu
) {
317 ret_code
= LTTNG_ERR_OVERFLOW
;
321 num_bytes_requested_total
=
322 num_bytes_requested_per_cpu
* (uint64_t) num_cpu
;
325 * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
326 * reliable estimate we can get but it is only exposed by the kernel
327 * since 3.14. (See Linux kernel commit:
328 * 34e431b0ae398fc54ea69ff85ec700722c9da773)
330 ret
= utils_get_memory_available(&best_mem_info
);
336 * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This
337 * is a sanity check for obvious user error.
339 ret
= utils_get_memory_total(&best_mem_info
);
344 /* No valid source of information. */
345 ret_code
= LTTNG_ERR_NOMEM
;
349 if (best_mem_info
>= num_bytes_requested_total
) {
352 ret_code
= LTTNG_ERR_NOMEM
;
359 * Try connect to session daemon with sock_path.
361 * Return 0 on success, else -1
363 static int try_connect_sessiond(const char *sock_path
)
367 /* If socket exist, we check if the daemon listens for connect. */
368 ret
= access(sock_path
, F_OK
);
374 ret
= lttcomm_connect_unix_sock(sock_path
);
380 ret
= lttcomm_close_unix_sock(ret
);
382 PERROR("lttcomm_close_unix_sock");
392 * Set sessiond socket path by putting it in the global sessiond_sock_path
395 * Returns 0 on success, negative value on failure (the sessiond socket path
396 * is somehow too long or ENOMEM).
398 static int set_session_daemon_path(void)
400 int in_tgroup
= 0; /* In tracing group. */
406 /* Are we in the tracing group ? */
407 in_tgroup
= lttng_check_tracing_group();
410 if ((uid
== 0) || in_tgroup
== 1) {
411 const int ret
= lttng_strncpy(sessiond_sock_path
,
412 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
,
413 sizeof(sessiond_sock_path
));
425 ret
= try_connect_sessiond(sessiond_sock_path
);
429 /* Global session daemon not available... */
431 /* ...or not in tracing group (and not root), default */
434 * With GNU C < 2.1, snprintf returns -1 if the target buffer
436 * With GNU C >= 2.1, snprintf returns the required size
437 * (excluding closing null)
439 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
440 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
441 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
453 * Connect to the LTTng session daemon.
455 * On success, return the socket's file descriptor. On error, return -1.
457 LTTNG_HIDDEN
int connect_sessiond(void)
461 ret
= set_session_daemon_path();
466 /* Connect to the sesssion daemon. */
467 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
478 static void reset_global_sessiond_connection_state(void)
480 sessiond_socket
= -1;
485 * Clean disconnect from the session daemon.
487 * On success, return 0. On error, return -1.
489 static int disconnect_sessiond(void)
494 ret
= lttcomm_close_unix_sock(sessiond_socket
);
495 reset_global_sessiond_connection_state();
501 static int recv_sessiond_optional_data(size_t len
, void **user_buf
,
509 ret
= -LTTNG_ERR_INVALID
;
519 ret
= recv_data_sessiond(buf
, len
);
525 ret
= -LTTNG_ERR_INVALID
;
529 /* Move ownership of command header buffer to user. */
534 /* No command header. */
550 * Ask the session daemon a specific command and put the data into buf.
551 * Takes extra var. len. data and file descriptors as input to send to the
554 * Return size of data (only payload, not header) or a negative error code.
557 int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg
*lsm
,
558 const int *fds
, size_t nb_fd
, const void *vardata
,
559 size_t vardata_len
, void **user_payload_buf
,
560 void **user_cmd_header_buf
, size_t *user_cmd_header_len
)
564 struct lttcomm_lttng_msg llm
;
566 ret
= connect_sessiond();
568 ret
= -LTTNG_ERR_NO_SESSIOND
;
571 sessiond_socket
= ret
;
575 ret
= send_session_msg(lsm
);
577 /* Ret value is a valid lttng error code. */
580 /* Send var len data */
581 ret
= send_session_varlen(vardata
, vardata_len
);
583 /* Ret value is a valid lttng error code. */
588 ret
= send_session_fds(fds
, nb_fd
);
590 /* Ret value is a valid lttng error code. */
594 /* Get header from data transmission */
595 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
597 /* Ret value is a valid lttng error code. */
601 /* Check error code if OK */
602 if (llm
.ret_code
!= LTTNG_OK
) {
607 /* Get command header from data transmission */
608 ret
= recv_sessiond_optional_data(llm
.cmd_header_size
,
609 user_cmd_header_buf
, user_cmd_header_len
);
614 /* Get payload from data transmission */
615 ret
= recv_sessiond_optional_data(llm
.data_size
, user_payload_buf
,
624 disconnect_sessiond();
629 int lttng_ctl_ask_sessiond_payload(struct lttng_payload_view
*message
,
630 struct lttng_payload
*reply
)
633 struct lttcomm_lttng_msg llm
;
634 const int fd_count
= lttng_payload_view_get_fd_handle_count(message
);
636 assert(reply
->buffer
.size
== 0);
637 assert(lttng_dynamic_pointer_array_get_count(&reply
->_fd_handles
) == 0);
639 ret
= connect_sessiond();
641 ret
= -LTTNG_ERR_NO_SESSIOND
;
644 sessiond_socket
= ret
;
648 /* Send command to session daemon */
649 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, message
->buffer
.data
,
650 message
->buffer
.size
);
652 ret
= -LTTNG_ERR_FATAL
;
657 ret
= lttcomm_send_payload_view_fds_unix_sock(sessiond_socket
,
660 ret
= -LTTNG_ERR_FATAL
;
665 /* Get header from data transmission */
666 ret
= recv_payload_sessiond(reply
, sizeof(llm
));
668 /* Ret value is a valid lttng error code. */
672 llm
= *((typeof(llm
) *) reply
->buffer
.data
);
674 /* Check error code if OK */
675 if (llm
.ret_code
!= LTTNG_OK
) {
676 if (llm
.ret_code
< LTTNG_OK
|| llm
.ret_code
>= LTTNG_ERR_NR
) {
677 /* Invalid error code received. */
678 ret
= -LTTNG_ERR_UNK
;
685 if (llm
.cmd_header_size
> 0) {
686 ret
= recv_payload_sessiond(reply
, llm
.cmd_header_size
);
692 /* Get command header from data transmission */
693 if (llm
.data_size
> 0) {
694 ret
= recv_payload_sessiond(reply
, llm
.data_size
);
700 if (llm
.fd_count
> 0) {
701 ret
= lttcomm_recv_payload_fds_unix_sock(
702 sessiond_socket
, llm
.fd_count
, reply
);
708 /* Don't return the llm header to the caller. */
709 memmove(reply
->buffer
.data
, reply
->buffer
.data
+ sizeof(llm
),
710 reply
->buffer
.size
- sizeof(llm
));
711 ret
= lttng_dynamic_buffer_set_size(
712 &reply
->buffer
, reply
->buffer
.size
- sizeof(llm
));
714 /* Can't happen as size is reduced. */
718 ret
= reply
->buffer
.size
;
721 disconnect_sessiond();
726 * Create lttng handle and return pointer.
728 * The returned pointer will be NULL in case of malloc() error.
730 struct lttng_handle
*lttng_create_handle(const char *session_name
,
731 struct lttng_domain
*domain
)
734 struct lttng_handle
*handle
= NULL
;
736 handle
= zmalloc(sizeof(struct lttng_handle
));
737 if (handle
== NULL
) {
738 PERROR("malloc handle");
742 /* Copy session name */
743 ret
= lttng_strncpy(handle
->session_name
, session_name
? : "",
744 sizeof(handle
->session_name
));
749 /* Copy lttng domain or leave initialized to 0. */
751 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
762 * Destroy handle by free(3) the pointer.
764 void lttng_destroy_handle(struct lttng_handle
*handle
)
770 * Register an outside consumer.
772 * Returns size of returned session payload data or a negative error code.
774 int lttng_register_consumer(struct lttng_handle
*handle
,
775 const char *socket_path
)
778 struct lttcomm_session_msg lsm
;
780 if (handle
== NULL
|| socket_path
== NULL
) {
781 ret
= -LTTNG_ERR_INVALID
;
785 memset(&lsm
, 0, sizeof(lsm
));
786 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
787 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
788 sizeof(lsm
.session
.name
));
790 ret
= -LTTNG_ERR_INVALID
;
794 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
796 ret
= lttng_strncpy(lsm
.u
.reg
.path
, socket_path
,
797 sizeof(lsm
.u
.reg
.path
));
799 ret
= -LTTNG_ERR_INVALID
;
803 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
809 * Start tracing for all traces of the session.
811 * Returns size of returned session payload data or a negative error code.
813 int lttng_start_tracing(const char *session_name
)
816 struct lttcomm_session_msg lsm
;
818 if (session_name
== NULL
) {
819 ret
= -LTTNG_ERR_INVALID
;
823 memset(&lsm
, 0, sizeof(lsm
));
824 lsm
.cmd_type
= LTTNG_START_TRACE
;
826 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
827 sizeof(lsm
.session
.name
));
829 ret
= -LTTNG_ERR_INVALID
;
833 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
839 * Stop tracing for all traces of the session.
841 static int _lttng_stop_tracing(const char *session_name
, int wait
)
844 struct lttcomm_session_msg lsm
;
846 if (session_name
== NULL
) {
847 ret
= -LTTNG_ERR_INVALID
;
851 memset(&lsm
, 0, sizeof(lsm
));
852 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
854 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
855 sizeof(lsm
.session
.name
));
857 ret
= -LTTNG_ERR_INVALID
;
861 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
862 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
870 /* Check for data availability */
872 data_ret
= lttng_data_pending(session_name
);
874 /* Return the data available call error. */
880 * Data sleep time before retrying (in usec). Don't sleep if the
881 * call returned value indicates availability.
884 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US
);
886 } while (data_ret
!= 0);
894 * Stop tracing and wait for data availability.
896 int lttng_stop_tracing(const char *session_name
)
898 return _lttng_stop_tracing(session_name
, 1);
902 * Stop tracing but _don't_ wait for data availability.
904 int lttng_stop_tracing_no_wait(const char *session_name
)
906 return _lttng_stop_tracing(session_name
, 0);
910 * Add context to a channel.
912 * If the given channel is NULL, add the contexts to all channels.
913 * The event_name param is ignored.
915 * Returns the size of the returned payload data or a negative error code.
917 int lttng_add_context(struct lttng_handle
*handle
,
918 struct lttng_event_context
*ctx
, const char *event_name
,
919 const char *channel_name
)
924 struct lttcomm_session_msg lsm
;
926 /* Safety check. Both are mandatory. */
927 if (handle
== NULL
|| ctx
== NULL
) {
928 ret
= -LTTNG_ERR_INVALID
;
932 memset(&lsm
, 0, sizeof(lsm
));
933 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
935 /* If no channel name, send empty string. */
936 ret
= lttng_strncpy(lsm
.u
.context
.channel_name
, channel_name
?: "",
937 sizeof(lsm
.u
.context
.channel_name
));
939 ret
= -LTTNG_ERR_INVALID
;
943 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
944 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
945 sizeof(lsm
.session
.name
));
947 ret
= -LTTNG_ERR_INVALID
;
951 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
952 size_t provider_len
, ctx_len
;
953 const char *provider_name
= ctx
->u
.app_ctx
.provider_name
;
954 const char *ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
956 if (!provider_name
|| !ctx_name
) {
957 ret
= -LTTNG_ERR_INVALID
;
961 provider_len
= strlen(provider_name
);
962 if (provider_len
== 0) {
963 ret
= -LTTNG_ERR_INVALID
;
966 lsm
.u
.context
.provider_name_len
= provider_len
;
968 ctx_len
= strlen(ctx_name
);
970 ret
= -LTTNG_ERR_INVALID
;
973 lsm
.u
.context
.context_name_len
= ctx_len
;
975 len
= provider_len
+ ctx_len
;
978 ret
= -LTTNG_ERR_NOMEM
;
982 memcpy(buf
, provider_name
, provider_len
);
983 memcpy(buf
+ provider_len
, ctx_name
, ctx_len
);
985 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
987 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
989 * Don't leak application addresses to the sessiond.
990 * This is only necessary when ctx is for an app ctx otherwise
991 * the values inside the union (type & config) are overwritten.
993 lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
994 lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
997 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buf
, len
, NULL
);
1004 * Enable event(s) for a channel.
1006 * If no event name is specified, all events are enabled.
1007 * If no channel name is specified, the default 'channel0' is used.
1009 * Returns size of returned session payload data or a negative error code.
1011 int lttng_enable_event(struct lttng_handle
*handle
,
1012 struct lttng_event
*ev
, const char *channel_name
)
1014 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
1019 * Create or enable an event with a filter expression.
1021 * Return negative error value on error.
1022 * Return size of returned session payload data if OK.
1024 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
1025 struct lttng_event
*event
, const char *channel_name
,
1026 const char *filter_expression
)
1028 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
1029 filter_expression
, 0, NULL
);
1033 * Depending on the event, return a newly allocated agent filter expression or
1034 * NULL if not applicable.
1036 * An event with NO loglevel and the name is * will return NULL.
1038 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
1041 char *agent_filter
= NULL
;
1045 /* Don't add filter for the '*' event. */
1046 if (strcmp(ev
->name
, "*") != 0) {
1048 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
1051 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
1059 /* Add loglevel filtering if any for the JUL domain. */
1060 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1063 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
1069 if (filter
|| agent_filter
) {
1072 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
1073 agent_filter
? agent_filter
: filter
, op
,
1078 agent_filter
= new_filter
;
1080 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
1089 return agent_filter
;
1096 * Enable event(s) for a channel, possibly with exclusions and a filter.
1097 * If no event name is specified, all events are enabled.
1098 * If no channel name is specified, the default name is used.
1099 * If filter expression is not NULL, the filter is set for the event.
1100 * If exclusion count is not zero, the exclusions are set for the event.
1101 * Returns size of returned session payload data or a negative error code.
1103 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
1104 struct lttng_event
*ev
, const char *channel_name
,
1105 const char *original_filter_expression
,
1106 int exclusion_count
, char **exclusion_list
)
1108 struct lttcomm_session_msg lsm
;
1109 struct lttng_payload payload
;
1111 unsigned int free_filter_expression
= 0;
1112 struct filter_parser_ctx
*ctx
= NULL
;
1115 * We have either a filter or some exclusions, so we need to set up
1116 * a variable-length payload from where to send the data.
1118 lttng_payload_init(&payload
);
1121 * Cast as non-const since we may replace the filter expression
1122 * by a dynamically allocated string. Otherwise, the original
1123 * string is not modified.
1125 char *filter_expression
= (char *) original_filter_expression
;
1127 if (handle
== NULL
|| ev
== NULL
) {
1128 ret
= -LTTNG_ERR_INVALID
;
1133 * Empty filter string will always be rejected by the parser
1134 * anyway, so treat this corner-case early to eliminate
1135 * lttng_fmemopen error for 0-byte allocation.
1137 if (filter_expression
&& filter_expression
[0] == '\0') {
1138 ret
= -LTTNG_ERR_INVALID
;
1142 memset(&lsm
, 0, sizeof(lsm
));
1144 /* If no channel name, send empty string. */
1145 ret
= lttng_strncpy(lsm
.u
.enable
.channel_name
, channel_name
?: "",
1146 sizeof(lsm
.u
.enable
.channel_name
));
1148 ret
= -LTTNG_ERR_INVALID
;
1152 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1153 if (ev
->name
[0] == '\0') {
1154 /* Enable all events. */
1155 ret
= lttng_strncpy(ev
->name
, "*", sizeof(ev
->name
));
1159 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1160 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1162 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1163 sizeof(lsm
.session
.name
));
1165 ret
= -LTTNG_ERR_INVALID
;
1169 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1170 lsm
.u
.enable
.bytecode_len
= 0;
1172 /* Parse filter expression. */
1173 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1174 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1175 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1176 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1177 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1178 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1181 /* Setup JUL filter if needed. */
1182 agent_filter
= set_agent_filter(filter_expression
, ev
);
1183 if (!agent_filter
) {
1184 if (!filter_expression
) {
1186 * No JUL and no filter, just skip
1193 * With an agent filter, the original filter has
1194 * been added to it thus replace the filter
1197 filter_expression
= agent_filter
;
1198 free_filter_expression
= 1;
1202 ret
= filter_parser_ctx_create_from_filter_expression(filter_expression
, &ctx
);
1207 lsm
.u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
1208 + bytecode_get_len(&ctx
->bytecode
->b
);
1209 lsm
.u
.enable
.expression_len
= strlen(filter_expression
) + 1;
1212 ret
= lttng_dynamic_buffer_set_capacity(&payload
.buffer
,
1213 lsm
.u
.enable
.bytecode_len
+
1214 lsm
.u
.enable
.expression_len
+
1215 LTTNG_SYMBOL_NAME_LEN
*
1218 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1222 /* Put exclusion names first in the data. */
1223 for (i
= 0; i
< exclusion_count
; i
++) {
1224 size_t exclusion_len
;
1226 exclusion_len
= lttng_strnlen(exclusion_list
[i
],
1227 LTTNG_SYMBOL_NAME_LEN
);
1228 if (exclusion_len
== LTTNG_SYMBOL_NAME_LEN
) {
1229 /* Exclusion is not NULL-terminated. */
1230 ret
= -LTTNG_ERR_INVALID
;
1234 ret
= lttng_dynamic_buffer_append(&payload
.buffer
,
1235 exclusion_list
[i
], exclusion_len
);
1241 * Padding the rest of the entry with zeros. Every exclusion
1242 * entries take LTTNG_SYMBOL_NAME_LEN bytes in the buffer.
1244 ret
= lttng_dynamic_buffer_set_size(&payload
.buffer
,
1245 LTTNG_SYMBOL_NAME_LEN
* (i
+ 1));
1251 /* Add filter expression next. */
1252 if (filter_expression
) {
1253 ret
= lttng_dynamic_buffer_append(&payload
.buffer
,
1254 filter_expression
, lsm
.u
.enable
.expression_len
);
1259 /* Add filter bytecode next. */
1260 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1261 ret
= lttng_dynamic_buffer_append(&payload
.buffer
,
1262 &ctx
->bytecode
->b
, lsm
.u
.enable
.bytecode_len
);
1267 if (ev
->extended
.ptr
) {
1268 struct lttng_event_extended
*ev_ext
=
1269 (struct lttng_event_extended
*) ev
->extended
.ptr
;
1271 if (ev_ext
->probe_location
) {
1273 * lttng_userspace_probe_location_serialize returns the
1274 * number of bytes that was appended to the buffer.
1276 ret
= lttng_userspace_probe_location_serialize(
1277 ev_ext
->probe_location
, &payload
);
1283 * Set the size of the userspace probe location element
1284 * of the buffer so that the receiving side knows where
1287 lsm
.u
.enable
.userspace_probe_location_len
= ret
;
1292 struct lttng_payload_view view
= lttng_payload_view_from_payload(
1294 int fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
1301 assert(fd_count
== 0 || fd_count
== 1);
1302 if (fd_count
== 1) {
1303 struct fd_handle
*h
=
1304 lttng_payload_view_pop_fd_handle(&view
);
1310 fd_to_send
= fd_handle_get_fd(h
);
1314 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
,
1315 fd_count
? &fd_to_send
: NULL
, fd_count
,
1316 view
.buffer
.size
? view
.buffer
.data
: NULL
,
1317 view
.buffer
.size
, NULL
, NULL
, 0);
1321 if (filter_expression
&& ctx
) {
1322 filter_bytecode_free(ctx
);
1323 filter_ir_free(ctx
);
1324 filter_parser_ctx_free(ctx
);
1327 if (free_filter_expression
) {
1329 * The filter expression has been replaced and must be freed as
1330 * it is not the original filter expression received as a
1333 free(filter_expression
);
1337 * Return directly to the caller and don't ask the sessiond since
1338 * something went wrong in the parsing of data above.
1340 lttng_payload_reset(&payload
);
1344 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1348 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1349 struct lttng_event
*ev
, const char *channel_name
,
1350 const char *original_filter_expression
)
1352 struct lttcomm_session_msg lsm
;
1355 unsigned int free_filter_expression
= 0;
1356 struct filter_parser_ctx
*ctx
= NULL
;
1358 * Cast as non-const since we may replace the filter expression
1359 * by a dynamically allocated string. Otherwise, the original
1360 * string is not modified.
1362 char *filter_expression
= (char *) original_filter_expression
;
1364 if (handle
== NULL
|| ev
== NULL
) {
1365 ret
= -LTTNG_ERR_INVALID
;
1370 * Empty filter string will always be rejected by the parser
1371 * anyway, so treat this corner-case early to eliminate
1372 * lttng_fmemopen error for 0-byte allocation.
1374 if (filter_expression
&& filter_expression
[0] == '\0') {
1375 ret
= -LTTNG_ERR_INVALID
;
1379 memset(&lsm
, 0, sizeof(lsm
));
1381 /* If no channel name, send empty string. */
1382 ret
= lttng_strncpy(lsm
.u
.disable
.channel_name
, channel_name
?: "",
1383 sizeof(lsm
.u
.disable
.channel_name
));
1385 ret
= -LTTNG_ERR_INVALID
;
1389 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1391 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1392 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1394 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1395 sizeof(lsm
.session
.name
));
1397 ret
= -LTTNG_ERR_INVALID
;
1401 lsm
.u
.disable
.bytecode_len
= 0;
1404 * For the JUL domain, a filter is enforced except for the
1405 * disable all event. This is done to avoid having the event in
1406 * all sessions thus filtering by logger name.
1408 if (filter_expression
== NULL
&&
1409 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1410 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1411 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1416 * We have a filter, so we need to set up a variable-length
1417 * memory block from where to send the data.
1420 /* Parse filter expression */
1421 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1422 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1423 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1424 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1425 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1426 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1429 /* Setup JUL filter if needed. */
1430 agent_filter
= set_agent_filter(filter_expression
, ev
);
1431 if (!agent_filter
) {
1432 if (!filter_expression
) {
1434 * No JUL and no filter, just skip
1441 * With a JUL filter, the original filter has
1442 * been added to it thus replace the filter
1445 filter_expression
= agent_filter
;
1446 free_filter_expression
= 1;
1450 ret
= filter_parser_ctx_create_from_filter_expression(filter_expression
, &ctx
);
1455 lsm
.u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
1456 + bytecode_get_len(&ctx
->bytecode
->b
);
1457 lsm
.u
.enable
.expression_len
= strlen(filter_expression
) + 1;
1460 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1461 + lsm
.u
.disable
.expression_len
);
1463 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1467 /* Add filter expression. */
1468 if (lsm
.u
.disable
.expression_len
!= 0) {
1471 lsm
.u
.disable
.expression_len
);
1473 /* Add filter bytecode next. */
1474 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1476 + lsm
.u
.disable
.expression_len
,
1478 lsm
.u
.disable
.bytecode_len
);
1481 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1482 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1486 if (filter_expression
&& ctx
) {
1487 filter_bytecode_free(ctx
);
1488 filter_ir_free(ctx
);
1489 filter_parser_ctx_free(ctx
);
1492 if (free_filter_expression
) {
1494 * The filter expression has been replaced and must be freed as
1495 * it is not the original filter expression received as a
1498 free(filter_expression
);
1502 * Return directly to the caller and don't ask the sessiond since
1503 * something went wrong in the parsing of data above.
1508 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1513 * Disable event(s) of a channel and domain.
1514 * If no event name is specified, all events are disabled.
1515 * If no channel name is specified, the default 'channel0' is used.
1516 * Returns size of returned session payload data or a negative error code.
1518 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1519 const char *channel_name
)
1522 struct lttng_event ev
;
1524 memset(&ev
, 0, sizeof(ev
));
1526 ev
.type
= LTTNG_EVENT_ALL
;
1527 ret
= lttng_strncpy(ev
.name
, name
?: "", sizeof(ev
.name
));
1529 ret
= -LTTNG_ERR_INVALID
;
1533 ret
= lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1538 struct lttng_channel
*lttng_channel_create(struct lttng_domain
*domain
)
1540 struct lttng_channel
*channel
= NULL
;
1546 /* Validate domain. */
1547 switch (domain
->type
) {
1548 case LTTNG_DOMAIN_UST
:
1549 switch (domain
->buf_type
) {
1550 case LTTNG_BUFFER_PER_UID
:
1551 case LTTNG_BUFFER_PER_PID
:
1557 case LTTNG_DOMAIN_KERNEL
:
1558 if (domain
->buf_type
!= LTTNG_BUFFER_GLOBAL
) {
1566 channel
= lttng_channel_create_internal();
1571 lttng_channel_set_default_attr(domain
, &channel
->attr
);
1576 void lttng_channel_destroy(struct lttng_channel
*channel
)
1582 if (channel
->attr
.extended
.ptr
) {
1583 free(channel
->attr
.extended
.ptr
);
1589 * Enable channel per domain
1590 * Returns size of returned session payload data or a negative error code.
1592 int lttng_enable_channel(struct lttng_handle
*handle
,
1593 struct lttng_channel
*in_chan
)
1595 enum lttng_error_code ret_code
;
1597 struct lttng_dynamic_buffer buffer
;
1598 struct lttcomm_session_msg lsm
;
1599 uint64_t total_buffer_size_needed_per_cpu
= 0;
1600 struct lttng_channel
*channel
= NULL
;
1602 lttng_dynamic_buffer_init(&buffer
);
1604 /* NULL arguments are forbidden. No default values. */
1605 if (handle
== NULL
|| in_chan
== NULL
) {
1606 ret
= -LTTNG_ERR_INVALID
;
1611 * Verify that the amount of memory required to create the requested
1612 * buffer is available on the system at the moment.
1614 if (in_chan
->attr
.num_subbuf
>
1615 UINT64_MAX
/ in_chan
->attr
.subbuf_size
) {
1617 ret
= -LTTNG_ERR_OVERFLOW
;
1621 total_buffer_size_needed_per_cpu
=
1622 in_chan
->attr
.num_subbuf
* in_chan
->attr
.subbuf_size
;
1623 ret_code
= check_enough_available_memory(
1624 total_buffer_size_needed_per_cpu
);
1625 if (ret_code
!= LTTNG_OK
) {
1630 /* Copy the channel for easier manipulation. */
1631 channel
= lttng_channel_copy(in_chan
);
1633 ret
= -LTTNG_ERR_NOMEM
;
1637 /* Populate the channel extended attribute if necessary. */
1638 if (!channel
->attr
.extended
.ptr
) {
1639 struct lttng_channel_extended
*extended
=
1640 (struct lttng_channel_extended
*) zmalloc(
1644 ret
= -LTTNG_ERR_NOMEM
;
1647 lttng_channel_set_default_extended_attr(
1648 &handle
->domain
, extended
);
1649 channel
->attr
.extended
.ptr
= extended
;
1652 /* Prepare the payload */
1653 memset(&lsm
, 0, sizeof(lsm
));
1655 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1656 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1658 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1659 sizeof(lsm
.session
.name
));
1661 ret
= -LTTNG_ERR_INVALID
;
1665 ret
= lttng_channel_serialize(channel
, &buffer
);
1667 ret
= -LTTNG_ERR_FATAL
;
1671 lsm
.u
.channel
.length
= buffer
.size
;
1673 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(
1674 &lsm
, buffer
.data
, buffer
.size
, NULL
);
1676 lttng_channel_destroy(channel
);
1677 lttng_dynamic_buffer_reset(&buffer
);
1682 * All tracing will be stopped for registered events of the channel.
1683 * Returns size of returned session payload data or a negative error code.
1685 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1688 struct lttcomm_session_msg lsm
;
1690 /* Safety check. Both are mandatory. */
1691 if (handle
== NULL
|| name
== NULL
) {
1692 return -LTTNG_ERR_INVALID
;
1695 memset(&lsm
, 0, sizeof(lsm
));
1697 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1699 ret
= lttng_strncpy(lsm
.u
.disable
.channel_name
, name
,
1700 sizeof(lsm
.u
.disable
.channel_name
));
1702 ret
= -LTTNG_ERR_INVALID
;
1706 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1708 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1709 sizeof(lsm
.session
.name
));
1711 ret
= -LTTNG_ERR_INVALID
;
1715 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1721 * Lists all available tracepoints of domain.
1722 * Sets the contents of the events array.
1723 * Returns the number of lttng_event entries in events;
1724 * on error, returns a negative value.
1726 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1727 struct lttng_event
**events
)
1730 struct lttcomm_session_msg lsm
;
1732 if (handle
== NULL
) {
1733 return -LTTNG_ERR_INVALID
;
1736 memset(&lsm
, 0, sizeof(lsm
));
1737 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1738 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1740 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1745 return ret
/ sizeof(struct lttng_event
);
1749 * Lists all available tracepoint fields of domain.
1750 * Sets the contents of the event field array.
1751 * Returns the number of lttng_event_field entries in events;
1752 * on error, returns a negative value.
1754 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1755 struct lttng_event_field
**fields
)
1758 struct lttcomm_session_msg lsm
;
1760 if (handle
== NULL
) {
1761 return -LTTNG_ERR_INVALID
;
1764 memset(&lsm
, 0, sizeof(lsm
));
1765 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1766 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1768 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1773 return ret
/ sizeof(struct lttng_event_field
);
1777 * Lists all available kernel system calls. Allocates and sets the contents of
1780 * Returns the number of lttng_event entries in events; on error, returns a
1783 int lttng_list_syscalls(struct lttng_event
**events
)
1786 struct lttcomm_session_msg lsm
;
1789 return -LTTNG_ERR_INVALID
;
1792 memset(&lsm
, 0, sizeof(lsm
));
1793 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1794 /* Force kernel domain for system calls. */
1795 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1797 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1802 return ret
/ sizeof(struct lttng_event
);
1806 * Returns a human readable string describing
1807 * the error code (a negative value).
1809 const char *lttng_strerror(int code
)
1811 return error_get_str(code
);
1814 enum lttng_error_code
lttng_create_session_ext(
1815 struct lttng_session_descriptor
*session_descriptor
)
1817 enum lttng_error_code ret_code
;
1818 struct lttcomm_session_msg lsm
= {
1819 .cmd_type
= LTTNG_CREATE_SESSION_EXT
,
1822 struct lttng_buffer_view reply_view
;
1824 bool sessiond_must_generate_ouput
;
1825 struct lttng_dynamic_buffer payload
;
1827 size_t descriptor_size
;
1828 struct lttng_session_descriptor
*descriptor_reply
= NULL
;
1830 lttng_dynamic_buffer_init(&payload
);
1831 if (!session_descriptor
) {
1832 ret_code
= LTTNG_ERR_INVALID
;
1836 sessiond_must_generate_ouput
=
1837 !lttng_session_descriptor_is_output_destination_initialized(
1838 session_descriptor
);
1839 if (sessiond_must_generate_ouput
) {
1840 const char *home_dir
= utils_get_home_dir();
1841 size_t home_dir_len
= home_dir
? strlen(home_dir
) + 1 : 0;
1843 if (!home_dir
|| home_dir_len
> LTTNG_PATH_MAX
) {
1844 ret_code
= LTTNG_ERR_FATAL
;
1848 lsm
.u
.create_session
.home_dir_size
= (uint16_t) home_dir_len
;
1849 ret
= lttng_dynamic_buffer_append(&payload
, home_dir
,
1852 ret_code
= LTTNG_ERR_NOMEM
;
1857 descriptor_size
= payload
.size
;
1858 ret
= lttng_session_descriptor_serialize(session_descriptor
,
1861 ret_code
= LTTNG_ERR_INVALID
;
1864 descriptor_size
= payload
.size
- descriptor_size
;
1865 lsm
.u
.create_session
.session_descriptor_size
= descriptor_size
;
1867 /* Command returns a session descriptor on success. */
1868 reply_ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, payload
.data
,
1869 payload
.size
, &reply
);
1870 if (reply_ret
< 0) {
1871 ret_code
= -reply_ret
;
1873 } else if (reply_ret
== 0) {
1874 /* Socket unexpectedly closed by the session daemon. */
1875 ret_code
= LTTNG_ERR_FATAL
;
1879 reply_view
= lttng_buffer_view_init(reply
, 0, reply_ret
);
1880 ret
= lttng_session_descriptor_create_from_buffer(&reply_view
,
1883 ret_code
= LTTNG_ERR_FATAL
;
1886 ret_code
= LTTNG_OK
;
1887 lttng_session_descriptor_assign(session_descriptor
, descriptor_reply
);
1890 lttng_dynamic_buffer_reset(&payload
);
1891 lttng_session_descriptor_destroy(descriptor_reply
);
1896 * Create a new session using name and url for destination.
1898 * Return 0 on success else a negative LTTng error code.
1900 int lttng_create_session(const char *name
, const char *url
)
1904 struct lttng_uri
*uris
= NULL
;
1905 struct lttng_session_descriptor
*descriptor
= NULL
;
1906 enum lttng_error_code ret_code
;
1909 ret
= -LTTNG_ERR_INVALID
;
1913 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1915 ret
= -LTTNG_ERR_INVALID
;
1920 descriptor
= lttng_session_descriptor_create(name
);
1923 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1924 ret
= -LTTNG_ERR_INVALID
;
1927 descriptor
= lttng_session_descriptor_local_create(name
,
1931 descriptor
= lttng_session_descriptor_network_create(name
, url
,
1935 ret
= -LTTNG_ERR_INVALID
;
1939 ret
= -LTTNG_ERR_INVALID
;
1942 ret_code
= lttng_create_session_ext(descriptor
);
1943 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1945 lttng_session_descriptor_destroy(descriptor
);
1951 * Create a session exclusively used for snapshot.
1953 * Return 0 on success else a negative LTTng error code.
1955 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1958 enum lttng_error_code ret_code
;
1960 struct lttng_uri
*uris
= NULL
;
1961 struct lttng_session_descriptor
*descriptor
= NULL
;
1964 ret
= -LTTNG_ERR_INVALID
;
1968 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1970 ret
= -LTTNG_ERR_INVALID
;
1974 * If the user does not specify a custom subdir, use the session name.
1976 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&&
1977 strlen(uris
[0].subdir
) == 0) {
1978 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s",
1981 PERROR("Failed to set session name as network destination sub-directory");
1982 ret
= -LTTNG_ERR_FATAL
;
1984 } else if (ret
>= sizeof(uris
[0].subdir
)) {
1985 /* Truncated output. */
1986 ret
= -LTTNG_ERR_INVALID
;
1993 descriptor
= lttng_session_descriptor_snapshot_create(name
);
1996 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1997 ret
= -LTTNG_ERR_INVALID
;
2000 descriptor
= lttng_session_descriptor_snapshot_local_create(
2005 descriptor
= lttng_session_descriptor_snapshot_network_create(
2011 ret
= -LTTNG_ERR_INVALID
;
2015 ret
= -LTTNG_ERR_INVALID
;
2018 ret_code
= lttng_create_session_ext(descriptor
);
2019 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2021 lttng_session_descriptor_destroy(descriptor
);
2027 * Create a session exclusively used for live.
2029 * Return 0 on success else a negative LTTng error code.
2031 int lttng_create_session_live(const char *name
, const char *url
,
2032 unsigned int timer_interval
)
2035 enum lttng_error_code ret_code
;
2036 struct lttng_session_descriptor
*descriptor
= NULL
;
2039 ret
= -LTTNG_ERR_INVALID
;
2044 descriptor
= lttng_session_descriptor_live_network_create(
2045 name
, url
, NULL
, timer_interval
);
2047 descriptor
= lttng_session_descriptor_live_create(
2048 name
, timer_interval
);
2051 ret
= -LTTNG_ERR_INVALID
;
2054 ret_code
= lttng_create_session_ext(descriptor
);
2055 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2057 lttng_session_descriptor_destroy(descriptor
);
2062 * Stop the session and wait for the data before destroying it
2064 * Return 0 on success else a negative LTTng error code.
2066 int lttng_destroy_session(const char *session_name
)
2069 enum lttng_error_code ret_code
;
2070 enum lttng_destruction_handle_status status
;
2071 struct lttng_destruction_handle
*handle
= NULL
;
2074 * Stop the tracing and wait for the data to be
2077 ret
= _lttng_stop_tracing(session_name
, 1);
2078 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
2082 ret_code
= lttng_destroy_session_ext(session_name
, &handle
);
2083 if (ret_code
!= LTTNG_OK
) {
2084 ret
= (int) -ret_code
;
2089 /* Block until the completion of the destruction of the session. */
2090 status
= lttng_destruction_handle_wait_for_completion(handle
, -1);
2091 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED
) {
2092 ret
= -LTTNG_ERR_UNK
;
2096 status
= lttng_destruction_handle_get_result(handle
, &ret_code
);
2097 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
2098 ret
= -LTTNG_ERR_UNK
;
2101 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2103 lttng_destruction_handle_destroy(handle
);
2108 * Destroy the session without waiting for the data.
2110 int lttng_destroy_session_no_wait(const char *session_name
)
2112 enum lttng_error_code ret_code
;
2114 ret_code
= lttng_destroy_session_ext(session_name
, NULL
);
2115 return ret_code
== LTTNG_OK
? 0 : -ret_code
;
2119 * Ask the session daemon for all available sessions.
2120 * Sets the contents of the sessions array.
2121 * Returns the number of lttng_session entries in sessions;
2122 * on error, returns a negative value.
2124 int lttng_list_sessions(struct lttng_session
**out_sessions
)
2127 struct lttcomm_session_msg lsm
;
2128 const size_t session_size
= sizeof(struct lttng_session
) +
2129 sizeof(struct lttng_session_extended
);
2130 size_t session_count
, i
;
2131 struct lttng_session_extended
*sessions_extended_begin
;
2132 struct lttng_session
*sessions
= NULL
;
2134 memset(&lsm
, 0, sizeof(lsm
));
2135 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
2137 * Initialize out_sessions to NULL so it is initialized when
2138 * lttng_list_sessions returns 0, thus allowing *out_sessions to
2139 * be subsequently freed.
2141 *out_sessions
= NULL
;
2142 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) &sessions
);
2147 ret
= -LTTNG_ERR_FATAL
;
2151 if (ret
% session_size
) {
2152 ret
= -LTTNG_ERR_UNK
;
2156 session_count
= (size_t) ret
/ session_size
;
2157 sessions_extended_begin
= (struct lttng_session_extended
*)
2158 (&sessions
[session_count
]);
2160 /* Set extended session info pointers. */
2161 for (i
= 0; i
< session_count
; i
++) {
2162 struct lttng_session
*session
= &sessions
[i
];
2163 struct lttng_session_extended
*extended
=
2164 &(sessions_extended_begin
[i
]);
2166 session
->extended
.ptr
= extended
;
2169 ret
= (int) session_count
;
2170 *out_sessions
= sessions
;
2175 enum lttng_error_code
lttng_session_get_creation_time(
2176 const struct lttng_session
*session
, uint64_t *creation_time
)
2178 enum lttng_error_code ret
= LTTNG_OK
;
2179 struct lttng_session_extended
*extended
;
2181 if (!session
|| !creation_time
|| !session
->extended
.ptr
) {
2182 ret
= LTTNG_ERR_INVALID
;
2186 extended
= session
->extended
.ptr
;
2187 if (!extended
->creation_time
.is_set
) {
2188 /* Not created on the session daemon yet. */
2189 ret
= LTTNG_ERR_SESSION_NOT_EXIST
;
2192 *creation_time
= extended
->creation_time
.value
;
2197 int lttng_set_session_shm_path(const char *session_name
,
2198 const char *shm_path
)
2201 struct lttcomm_session_msg lsm
;
2203 if (session_name
== NULL
) {
2204 return -LTTNG_ERR_INVALID
;
2207 memset(&lsm
, 0, sizeof(lsm
));
2208 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
2210 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2211 sizeof(lsm
.session
.name
));
2213 ret
= -LTTNG_ERR_INVALID
;
2217 ret
= lttng_strncpy(lsm
.u
.set_shm_path
.shm_path
, shm_path
?: "",
2218 sizeof(lsm
.u
.set_shm_path
.shm_path
));
2220 ret
= -LTTNG_ERR_INVALID
;
2224 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2230 * Ask the session daemon for all available domains of a session.
2231 * Sets the contents of the domains array.
2232 * Returns the number of lttng_domain entries in domains;
2233 * on error, returns a negative value.
2235 int lttng_list_domains(const char *session_name
,
2236 struct lttng_domain
**domains
)
2239 struct lttcomm_session_msg lsm
;
2241 if (session_name
== NULL
) {
2242 ret
= -LTTNG_ERR_INVALID
;
2246 memset(&lsm
, 0, sizeof(lsm
));
2247 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
2249 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2250 sizeof(lsm
.session
.name
));
2252 ret
= -LTTNG_ERR_INVALID
;
2256 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
2261 return ret
/ sizeof(struct lttng_domain
);
2267 * Ask the session daemon for all available channels of a session.
2268 * Sets the contents of the channels array.
2269 * Returns the number of lttng_channel entries in channels;
2270 * on error, returns a negative value.
2272 int lttng_list_channels(struct lttng_handle
*handle
,
2273 struct lttng_channel
**channels
)
2275 int ret
, total_payload_received
;
2276 struct lttcomm_session_msg lsm
;
2277 char *reception_buffer
= NULL
;
2278 size_t cmd_header_len
= 0;
2279 struct lttcomm_list_command_header
*cmd_header
= NULL
;
2280 struct lttng_dynamic_buffer tmp_buffer
;
2282 lttng_dynamic_buffer_init(&tmp_buffer
);
2284 if (handle
== NULL
) {
2285 ret
= -LTTNG_ERR_INVALID
;
2289 memset(&lsm
, 0, sizeof(lsm
));
2290 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
2291 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2292 sizeof(lsm
.session
.name
));
2294 ret
= -LTTNG_ERR_INVALID
;
2298 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2300 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
2301 (void **) &reception_buffer
, (void **) &cmd_header
,
2307 total_payload_received
= ret
;
2309 if (cmd_header_len
!= sizeof(*cmd_header
)) {
2310 ret
= -LTTNG_ERR_FATAL
;
2315 ret
= LTTNG_ERR_UNK
;
2319 if (cmd_header
->count
> INT_MAX
) {
2320 ret
= -LTTNG_ERR_OVERFLOW
;
2325 enum lttng_error_code ret_code
;
2326 const struct lttng_buffer_view events_view
=
2327 lttng_buffer_view_init(reception_buffer
, 0,
2328 total_payload_received
);
2330 ret_code
= lttng_channels_create_and_flatten_from_buffer(
2331 &events_view
, cmd_header
->count
, channels
);
2332 if (ret_code
!= LTTNG_OK
) {
2338 ret
= (int) cmd_header
->count
;
2341 free(reception_buffer
);
2346 * Ask the session daemon for all available events of a session channel.
2347 * Sets the contents of the events array.
2348 * Returns the number of lttng_event entries in events;
2349 * on error, returns a negative value.
2351 int lttng_list_events(struct lttng_handle
*handle
,
2352 const char *channel_name
, struct lttng_event
**events
)
2355 struct lttcomm_session_msg lsm
= {};
2356 const struct lttcomm_event_command_header
*cmd_header
= NULL
;
2357 uint32_t nb_events
, i
;
2358 const void *comm_ext_at
;
2359 struct lttng_dynamic_buffer listing
;
2361 struct lttng_payload payload
;
2362 struct lttng_payload payload_copy
;
2363 struct lttng_payload_view lsm_view
=
2364 lttng_payload_view_init_from_buffer(
2365 (const char *) &lsm
, 0, sizeof(lsm
));
2366 struct lttng_buffer_view cmd_header_view
;
2367 struct lttng_buffer_view cmd_payload_view
;
2368 struct lttng_buffer_view flat_events_view
;
2369 struct lttng_buffer_view ext_view
;
2371 /* Safety check. An handle and channel name are mandatory */
2372 if (handle
== NULL
|| channel_name
== NULL
) {
2373 ret
= -LTTNG_ERR_INVALID
;
2377 lttng_payload_init(&payload
);
2378 lttng_payload_init(&payload_copy
);
2380 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
2381 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2382 sizeof(lsm
.session
.name
));
2384 ret
= -LTTNG_ERR_INVALID
;
2388 ret
= lttng_strncpy(lsm
.u
.list
.channel_name
, channel_name
,
2389 sizeof(lsm
.u
.list
.channel_name
));
2391 ret
= -LTTNG_ERR_INVALID
;
2395 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2397 ret
= lttng_ctl_ask_sessiond_payload(&lsm_view
, &payload
);
2403 * A copy of the payload is performed since it will be
2404 * consumed twice. Consuming the same payload twice is invalid since
2405 * it will cause any received file descriptor to become "shared"
2406 * between different instances of the resulting objects.
2408 ret
= lttng_payload_copy(&payload
, &payload_copy
);
2410 ret
= -LTTNG_ERR_NOMEM
;
2414 cmd_header_view
= lttng_buffer_view_from_dynamic_buffer(
2415 &payload
.buffer
, 0, sizeof(*cmd_header
));
2416 if (!lttng_buffer_view_is_valid(&cmd_header_view
)) {
2417 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2421 cmd_header
= (typeof(cmd_header
)) cmd_header_view
.data
;
2423 /* Set number of events and free command header */
2424 nb_events
= cmd_header
->nb_events
;
2425 if (nb_events
> INT_MAX
) {
2426 ret
= -LTTNG_ERR_OVERFLOW
;
2430 cmd_payload_view
= lttng_buffer_view_from_dynamic_buffer(
2431 &payload
.buffer
, sizeof(*cmd_header
), -1);
2434 * The buffer that is returned must contain a "flat" version of
2435 * the events that are returned. In other words, all pointers
2436 * within an lttng_event must point to a location within the returned
2437 * buffer so that the user may free everything by simply calling free()
2438 * on the returned buffer. This is needed in order to maintain API
2441 * A first pass is performed to compute the size of the buffer that
2442 * must be allocated. A second pass is then performed to setup
2443 * the returned events so that their members always point within the
2446 * The layout of the returned buffer is as follows:
2447 * - struct lttng_event[nb_events],
2448 * - nb_events times the following:
2449 * - struct lttng_event_extended,
2450 * - flattened version of userspace_probe_location
2451 * - filter_expression
2453 * - padding to align to 64-bits
2455 ext_view
= lttng_buffer_view_from_view(&cmd_payload_view
,
2456 nb_events
* sizeof(struct lttng_event
), -1);
2457 comm_ext_at
= ext_view
.data
;
2458 storage_req
= nb_events
* sizeof(struct lttng_event
);
2460 struct lttng_payload_view payload_view
=
2461 lttng_payload_view_from_payload(&payload
, 0, -1);
2463 for (i
= 0; i
< nb_events
; i
++) {
2464 const struct lttcomm_event_extended_header
*ext_comm
=
2465 (struct lttcomm_event_extended_header
*)
2467 int probe_storage_req
= 0;
2469 comm_ext_at
+= sizeof(*ext_comm
);
2470 comm_ext_at
+= ext_comm
->filter_len
;
2471 comm_ext_at
+= ext_comm
->nb_exclusions
*
2472 LTTNG_SYMBOL_NAME_LEN
;
2474 if (ext_comm
->userspace_probe_location_len
) {
2475 struct lttng_userspace_probe_location
2476 *probe_location
= NULL
;
2477 struct lttng_payload_view probe_location_view
= lttng_payload_view_from_view(
2479 (const char *) comm_ext_at
-
2480 payload_view
.buffer
.data
,
2481 ext_comm
->userspace_probe_location_len
);
2483 if (!lttng_payload_view_is_valid(&probe_location_view
)) {
2484 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2489 * Create a temporary userspace probe location
2490 * to determine the size needed by a "flattened"
2491 * version of that same probe location.
2493 ret
= lttng_userspace_probe_location_create_from_payload(
2494 &probe_location_view
,
2497 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2501 ret
= lttng_userspace_probe_location_flatten(
2502 probe_location
, NULL
);
2503 lttng_userspace_probe_location_destroy(
2506 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2510 probe_storage_req
= ret
;
2511 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2514 storage_req
+= sizeof(struct lttng_event_extended
);
2515 storage_req
+= ext_comm
->filter_len
;
2516 storage_req
+= ext_comm
->nb_exclusions
*
2517 LTTNG_SYMBOL_NAME_LEN
;
2518 /* Padding to ensure the flat probe is aligned. */
2519 storage_req
= ALIGN_TO(storage_req
, sizeof(uint64_t));
2520 storage_req
+= probe_storage_req
;
2524 lttng_dynamic_buffer_init(&listing
);
2526 * We must ensure that "listing" is never resized so as to preserve
2527 * the validity of the flattened objects.
2529 ret
= lttng_dynamic_buffer_set_capacity(&listing
, storage_req
);
2531 ret
= -LTTNG_ERR_NOMEM
;
2535 cmd_payload_view
= lttng_buffer_view_from_dynamic_buffer(
2536 &payload_copy
.buffer
, sizeof(*cmd_header
), -1);
2537 flat_events_view
= lttng_buffer_view_from_view(&cmd_payload_view
, 0,
2538 nb_events
* sizeof(struct lttng_event
));
2539 ret
= lttng_dynamic_buffer_append_view(&listing
, &flat_events_view
);
2541 ret
= -LTTNG_ERR_NOMEM
;
2542 goto free_dynamic_buffer
;
2545 ext_view
= lttng_buffer_view_from_view(&cmd_payload_view
,
2546 nb_events
* sizeof(struct lttng_event
), -1);
2547 comm_ext_at
= ext_view
.data
;
2550 struct lttng_payload_view payload_copy_view
=
2551 lttng_payload_view_from_payload(
2552 &payload_copy
, 0, -1);
2554 for (i
= 0; i
< nb_events
; i
++) {
2555 struct lttng_event
*event
= (typeof(event
))(
2557 (sizeof(struct lttng_event
) * i
));
2558 const struct lttcomm_event_extended_header
*ext_comm
=
2559 (typeof(ext_comm
)) comm_ext_at
;
2560 struct lttng_event_extended
*event_extended
=
2561 (typeof(event_extended
))(listing
.data
+
2564 /* Insert struct lttng_event_extended. */
2565 ret
= lttng_dynamic_buffer_set_size(&listing
,
2566 listing
.size
+ sizeof(*event_extended
));
2568 ret
= -LTTNG_ERR_NOMEM
;
2569 goto free_dynamic_buffer
;
2571 event
->extended
.ptr
= event_extended
;
2573 comm_ext_at
+= sizeof(*ext_comm
);
2575 /* Insert filter expression. */
2576 if (ext_comm
->filter_len
) {
2577 event_extended
->filter_expression
=
2578 listing
.data
+ listing
.size
;
2579 ret
= lttng_dynamic_buffer_append(&listing
,
2581 ext_comm
->filter_len
);
2583 ret
= -LTTNG_ERR_NOMEM
;
2584 goto free_dynamic_buffer
;
2586 comm_ext_at
+= ext_comm
->filter_len
;
2589 /* Insert exclusions. */
2590 if (ext_comm
->nb_exclusions
) {
2591 event_extended
->exclusions
.count
=
2592 ext_comm
->nb_exclusions
;
2593 event_extended
->exclusions
.strings
=
2594 listing
.data
+ listing
.size
;
2596 ret
= lttng_dynamic_buffer_append(&listing
,
2598 ext_comm
->nb_exclusions
*
2599 LTTNG_SYMBOL_NAME_LEN
);
2601 ret
= -LTTNG_ERR_NOMEM
;
2602 goto free_dynamic_buffer
;
2604 comm_ext_at
+= ext_comm
->nb_exclusions
*
2605 LTTNG_SYMBOL_NAME_LEN
;
2608 /* Insert padding to align to 64-bits. */
2609 ret
= lttng_dynamic_buffer_set_size(&listing
,
2610 ALIGN_TO(listing
.size
,
2613 ret
= -LTTNG_ERR_NOMEM
;
2614 goto free_dynamic_buffer
;
2617 /* Insert flattened userspace probe location. */
2618 if (ext_comm
->userspace_probe_location_len
) {
2619 struct lttng_userspace_probe_location
2620 *probe_location
= NULL
;
2621 struct lttng_payload_view probe_location_view
= lttng_payload_view_from_view(
2623 (const char *) comm_ext_at
-
2624 payload_copy_view
.buffer
.data
,
2625 ext_comm
->userspace_probe_location_len
);
2627 if (!lttng_payload_view_is_valid(&probe_location_view
)) {
2628 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2629 goto free_dynamic_buffer
;
2632 ret
= lttng_userspace_probe_location_create_from_payload(
2633 &probe_location_view
,
2636 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2637 goto free_dynamic_buffer
;
2640 event_extended
->probe_location
= (struct lttng_userspace_probe_location
2643 ret
= lttng_userspace_probe_location_flatten(
2644 probe_location
, &listing
);
2645 lttng_userspace_probe_location_destroy(
2648 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2649 goto free_dynamic_buffer
;
2652 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2657 /* Don't reset listing buffer as we return its content. */
2658 *events
= (struct lttng_event
*) listing
.data
;
2659 lttng_dynamic_buffer_init(&listing
);
2660 ret
= (int) nb_events
;
2661 free_dynamic_buffer
:
2662 lttng_dynamic_buffer_reset(&listing
);
2664 lttng_payload_reset(&payload
);
2665 lttng_payload_reset(&payload_copy
);
2670 * Sets the tracing_group variable with name.
2671 * This function allocates memory pointed to by tracing_group.
2672 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2674 int lttng_set_tracing_group(const char *name
)
2678 return -LTTNG_ERR_INVALID
;
2681 if (asprintf(&new_group
, "%s", name
) < 0) {
2682 return -LTTNG_ERR_FATAL
;
2685 free(tracing_group
);
2686 tracing_group
= new_group
;
2692 int lttng_calibrate(struct lttng_handle
*handle
,
2693 struct lttng_calibrate
*calibrate
)
2696 * This command was removed in LTTng 2.9.
2698 return -LTTNG_ERR_UND
;
2702 * Set default channel attributes.
2703 * If either or both of the arguments are null, attr content is zeroe'd.
2705 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
2706 struct lttng_channel_attr
*attr
)
2708 struct lttng_channel_extended
*extended
;
2711 if (attr
== NULL
|| domain
== NULL
) {
2715 /* Save the pointer for later use */
2716 extended
= (struct lttng_channel_extended
*) attr
->extended
.ptr
;
2717 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
2719 /* Same for all domains. */
2720 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2721 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
2722 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
2724 switch (domain
->type
) {
2725 case LTTNG_DOMAIN_KERNEL
:
2726 attr
->switch_timer_interval
=
2727 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
2728 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
2729 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
2730 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
2731 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
2733 case LTTNG_DOMAIN_UST
:
2734 switch (domain
->buf_type
) {
2735 case LTTNG_BUFFER_PER_UID
:
2736 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
2737 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
2738 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
2739 attr
->switch_timer_interval
=
2740 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
2741 attr
->read_timer_interval
=
2742 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
2744 case LTTNG_BUFFER_PER_PID
:
2746 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
2747 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
2748 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
2749 attr
->switch_timer_interval
=
2750 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2751 attr
->read_timer_interval
=
2752 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2756 /* Default behavior: leave set to 0. */
2761 lttng_channel_set_default_extended_attr(domain
, extended
);
2764 /* Reassign the extended pointer. */
2765 attr
->extended
.ptr
= extended
;
2768 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2769 uint64_t *discarded_events
)
2772 struct lttng_channel_extended
*chan_ext
;
2774 if (!channel
|| !discarded_events
) {
2775 ret
= -LTTNG_ERR_INVALID
;
2779 chan_ext
= channel
->attr
.extended
.ptr
;
2782 * This can happen since the lttng_channel structure is
2783 * used for other tasks where this pointer is never set.
2785 *discarded_events
= 0;
2789 *discarded_events
= chan_ext
->discarded_events
;
2794 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2795 uint64_t *lost_packets
)
2798 struct lttng_channel_extended
*chan_ext
;
2800 if (!channel
|| !lost_packets
) {
2801 ret
= -LTTNG_ERR_INVALID
;
2805 chan_ext
= channel
->attr
.extended
.ptr
;
2808 * This can happen since the lttng_channel structure is
2809 * used for other tasks where this pointer is never set.
2815 *lost_packets
= chan_ext
->lost_packets
;
2820 int lttng_channel_get_monitor_timer_interval(struct lttng_channel
*chan
,
2821 uint64_t *monitor_timer_interval
)
2825 if (!chan
|| !monitor_timer_interval
) {
2826 ret
= -LTTNG_ERR_INVALID
;
2830 if (!chan
->attr
.extended
.ptr
) {
2831 ret
= -LTTNG_ERR_INVALID
;
2835 *monitor_timer_interval
= ((struct lttng_channel_extended
*)
2836 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
2841 int lttng_channel_set_monitor_timer_interval(struct lttng_channel
*chan
,
2842 uint64_t monitor_timer_interval
)
2846 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2847 ret
= -LTTNG_ERR_INVALID
;
2851 ((struct lttng_channel_extended
*)
2852 chan
->attr
.extended
.ptr
)->monitor_timer_interval
=
2853 monitor_timer_interval
;
2858 int lttng_channel_get_blocking_timeout(struct lttng_channel
*chan
,
2859 int64_t *blocking_timeout
)
2863 if (!chan
|| !blocking_timeout
) {
2864 ret
= -LTTNG_ERR_INVALID
;
2868 if (!chan
->attr
.extended
.ptr
) {
2869 ret
= -LTTNG_ERR_INVALID
;
2873 *blocking_timeout
= ((struct lttng_channel_extended
*)
2874 chan
->attr
.extended
.ptr
)->blocking_timeout
;
2879 int lttng_channel_set_blocking_timeout(struct lttng_channel
*chan
,
2880 int64_t blocking_timeout
)
2883 int64_t msec_timeout
;
2885 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2886 ret
= -LTTNG_ERR_INVALID
;
2890 if (blocking_timeout
< 0 && blocking_timeout
!= -1) {
2891 ret
= -LTTNG_ERR_INVALID
;
2896 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2897 * us to accept a narrower range of values (msecs expressed as a signed
2900 msec_timeout
= blocking_timeout
/ 1000;
2901 if (msec_timeout
!= (int32_t) msec_timeout
) {
2902 ret
= -LTTNG_ERR_INVALID
;
2906 ((struct lttng_channel_extended
*)
2907 chan
->attr
.extended
.ptr
)->blocking_timeout
=
2914 * Check if session daemon is alive.
2916 * Return 1 if alive or 0 if not.
2917 * On error returns a negative value.
2919 int lttng_session_daemon_alive(void)
2923 ret
= set_session_daemon_path();
2929 if (*sessiond_sock_path
== '\0') {
2931 * No socket path set. Weird error which means the constructor
2937 ret
= try_connect_sessiond(sessiond_sock_path
);
2948 * Set URL for a consumer for a session and domain.
2950 * Return 0 on success, else a negative value.
2952 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2953 const char *control_url
, const char *data_url
)
2957 struct lttcomm_session_msg lsm
;
2958 struct lttng_uri
*uris
= NULL
;
2960 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2961 ret
= -LTTNG_ERR_INVALID
;
2965 memset(&lsm
, 0, sizeof(lsm
));
2967 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2969 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2970 sizeof(lsm
.session
.name
));
2972 ret
= -LTTNG_ERR_INVALID
;
2976 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2978 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2980 ret
= -LTTNG_ERR_INVALID
;
2984 lsm
.u
.uri
.size
= size
;
2986 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2987 sizeof(struct lttng_uri
) * size
, NULL
);
2997 int lttng_enable_consumer(struct lttng_handle
*handle
);
2998 int lttng_enable_consumer(struct lttng_handle
*handle
)
3006 int lttng_disable_consumer(struct lttng_handle
*handle
);
3007 int lttng_disable_consumer(struct lttng_handle
*handle
)
3015 int _lttng_create_session_ext(const char *name
, const char *url
,
3016 const char *datetime
);
3017 int _lttng_create_session_ext(const char *name
, const char *url
,
3018 const char *datetime
)
3024 * For a given session name, this call checks if the data is ready to be read
3025 * or is still being extracted by the consumer(s) hence not ready to be used by
3028 int lttng_data_pending(const char *session_name
)
3031 struct lttcomm_session_msg lsm
;
3032 uint8_t *pending
= NULL
;
3034 if (session_name
== NULL
) {
3035 return -LTTNG_ERR_INVALID
;
3038 memset(&lsm
, 0, sizeof(lsm
));
3039 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
3041 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
3042 sizeof(lsm
.session
.name
));
3044 ret
= -LTTNG_ERR_INVALID
;
3048 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
3051 } else if (ret
!= 1) {
3052 /* Unexpected payload size */
3053 ret
= -LTTNG_ERR_INVALID
;
3055 } else if (!pending
) {
3056 /* Internal error. */
3057 ret
= -LTTNG_ERR_UNK
;
3061 ret
= (int) *pending
;
3068 * Regenerate the metadata for a session.
3069 * Return 0 on success, a negative error code on error.
3071 int lttng_regenerate_metadata(const char *session_name
)
3074 struct lttcomm_session_msg lsm
;
3076 if (!session_name
) {
3077 ret
= -LTTNG_ERR_INVALID
;
3081 memset(&lsm
, 0, sizeof(lsm
));
3082 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
3084 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
3085 sizeof(lsm
.session
.name
));
3087 ret
= -LTTNG_ERR_INVALID
;
3091 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
3102 * Deprecated, replaced by lttng_regenerate_metadata.
3104 int lttng_metadata_regenerate(const char *session_name
)
3106 return lttng_regenerate_metadata(session_name
);
3110 * Regenerate the statedump of a session.
3111 * Return 0 on success, a negative error code on error.
3113 int lttng_regenerate_statedump(const char *session_name
)
3116 struct lttcomm_session_msg lsm
;
3118 if (!session_name
) {
3119 ret
= -LTTNG_ERR_INVALID
;
3123 memset(&lsm
, 0, sizeof(lsm
));
3124 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
3126 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
3127 sizeof(lsm
.session
.name
));
3129 ret
= -LTTNG_ERR_INVALID
;
3133 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
3144 int _lttng_register_trigger(struct lttng_trigger
*trigger
, const char *name
,
3148 struct lttcomm_session_msg lsm
= {
3149 .cmd_type
= LTTNG_REGISTER_TRIGGER
,
3150 .u
.trigger
.is_trigger_anonymous
= !name
&& !generate_name
,
3152 struct lttcomm_session_msg
*message_lsm
;
3153 struct lttng_payload message
;
3154 struct lttng_payload reply
;
3155 struct lttng_trigger
*reply_trigger
= NULL
;
3156 enum lttng_domain_type domain_type
;
3157 const struct lttng_credentials user_creds
= {
3158 .uid
= LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3159 .gid
= LTTNG_OPTIONAL_INIT_UNSET
,
3161 const char *unused_trigger_name
= NULL
;
3162 enum lttng_trigger_status trigger_status
;
3164 lttng_payload_init(&message
);
3165 lttng_payload_init(&reply
);
3168 ret
= -LTTNG_ERR_INVALID
;
3172 trigger_status
= lttng_trigger_get_name(trigger
, &unused_trigger_name
);
3173 if (trigger_status
!= LTTNG_TRIGGER_STATUS_UNSET
) {
3174 /* Re-using already registered trigger. */
3175 ret
= -LTTNG_ERR_INVALID
;
3180 trigger_status
= lttng_trigger_set_name(trigger
, name
);
3181 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
3182 ret
= -LTTNG_ERR_NOMEM
;
3187 if (!trigger
->creds
.uid
.is_set
) {
3188 /* Use the client's credentials as the trigger credentials. */
3189 lttng_trigger_set_credentials(trigger
, &user_creds
);
3192 * Validate that either the current trigger credentials and the
3193 * client credentials are identical or that the current user is
3194 * root. The root user can register, unregister triggers for
3195 * himself and other users.
3197 * This check is also present on the sessiond side, using the
3198 * credentials passed on the socket. These check are all
3201 const struct lttng_credentials
*trigger_creds
=
3202 lttng_trigger_get_credentials(trigger
);
3204 if (!lttng_credentials_is_equal_uid(trigger_creds
, &user_creds
)) {
3205 if (lttng_credentials_get_uid(&user_creds
) != 0) {
3206 ret
= -LTTNG_ERR_EPERM
;
3207 goto end_unset_name
;
3212 if (!lttng_trigger_validate(trigger
)) {
3213 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3214 goto end_unset_name
;
3217 domain_type
= lttng_trigger_get_underlying_domain_type_restriction(
3220 lsm
.domain
.type
= domain_type
;
3222 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3224 ret
= -LTTNG_ERR_NOMEM
;
3225 goto end_unset_name
;
3228 ret
= lttng_trigger_serialize(trigger
, &message
);
3230 ret
= -LTTNG_ERR_UNK
;
3231 goto end_unset_name
;
3235 * This is needed to populate the trigger object size for the command
3238 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3240 message_lsm
->u
.trigger
.length
= (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3243 struct lttng_payload_view message_view
=
3244 lttng_payload_view_from_payload(
3247 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3249 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3251 goto end_unset_name
;
3256 struct lttng_payload_view reply_view
=
3257 lttng_payload_view_from_payload(
3258 &reply
, 0, reply
.buffer
.size
);
3260 ret
= lttng_trigger_create_from_payload(
3261 &reply_view
, &reply_trigger
);
3263 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
3264 goto end_unset_name
;
3268 if (name
|| generate_name
) {
3269 ret
= lttng_trigger_assign_name(trigger
, reply_trigger
);
3271 ret
= -LTTNG_ERR_NOMEM
;
3280 trigger_status
= lttng_trigger_set_name(trigger
, NULL
);
3281 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
3282 ret
= -LTTNG_ERR_UNK
;
3285 lttng_payload_reset(&message
);
3286 lttng_payload_reset(&reply
);
3287 lttng_trigger_destroy(reply_trigger
);
3291 int lttng_register_trigger(struct lttng_trigger
*trigger
)
3293 /* Register an anonymous trigger. */
3294 return _lttng_register_trigger(trigger
, NULL
, false);
3297 enum lttng_error_code
lttng_register_trigger_with_name(
3298 struct lttng_trigger
*trigger
, const char *name
)
3300 const int ret
= _lttng_register_trigger(trigger
, name
, false);
3302 return ret
== 0 ? LTTNG_OK
: (enum lttng_error_code
) -ret
;
3305 enum lttng_error_code
lttng_register_trigger_with_automatic_name(
3306 struct lttng_trigger
*trigger
)
3308 const int ret
= _lttng_register_trigger(trigger
, false, true);
3310 return ret
== 0 ? LTTNG_OK
: (enum lttng_error_code
) -ret
;
3313 enum lttng_error_code
lttng_error_query_execute(
3314 const struct lttng_error_query
*query
,
3315 const struct lttng_endpoint
*endpoint
,
3316 struct lttng_error_query_results
**results
)
3319 enum lttng_error_code ret_code
;
3320 struct lttcomm_session_msg lsm
= {
3321 .cmd_type
= LTTNG_EXECUTE_ERROR_QUERY
,
3323 struct lttng_payload message
;
3324 struct lttng_payload reply
;
3325 struct lttcomm_session_msg
*message_lsm
;
3327 lttng_payload_init(&message
);
3328 lttng_payload_init(&reply
);
3330 if (!query
|| !results
) {
3331 ret_code
= LTTNG_ERR_INVALID
;
3335 if (endpoint
!= lttng_session_daemon_command_endpoint
) {
3336 ret_code
= LTTNG_ERR_INVALID_ERROR_QUERY_TARGET
;
3340 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3342 ret_code
= LTTNG_ERR_NOMEM
;
3346 ret
= lttng_error_query_serialize(query
, &message
);
3348 ret_code
= LTTNG_ERR_UNK
;
3352 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3353 message_lsm
->u
.error_query
.length
=
3354 (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3357 struct lttng_payload_view message_view
=
3358 lttng_payload_view_from_payload(
3361 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3363 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3371 ssize_t reply_create_ret
;
3372 struct lttng_payload_view reply_view
=
3373 lttng_payload_view_from_payload(
3374 &reply
, 0, reply
.buffer
.size
);
3376 reply_create_ret
= lttng_error_query_results_create_from_payload(
3377 &reply_view
, results
);
3378 if (reply_create_ret
< 0) {
3379 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3384 ret_code
= LTTNG_OK
;
3386 lttng_payload_reset(&message
);
3387 lttng_payload_reset(&reply
);
3391 int lttng_unregister_trigger(const struct lttng_trigger
*trigger
)
3394 struct lttcomm_session_msg lsm
;
3395 struct lttcomm_session_msg
*message_lsm
;
3396 struct lttng_payload message
;
3397 struct lttng_payload reply
;
3398 struct lttng_trigger
*copy
= NULL
;
3399 const struct lttng_credentials user_creds
= {
3400 .uid
= LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3401 .gid
= LTTNG_OPTIONAL_INIT_UNSET
,
3404 lttng_payload_init(&message
);
3405 lttng_payload_init(&reply
);
3408 ret
= -LTTNG_ERR_INVALID
;
3412 copy
= lttng_trigger_copy(trigger
);
3414 ret
= -LTTNG_ERR_UNK
;
3418 if (!copy
->creds
.uid
.is_set
) {
3419 /* Use the client credentials as the trigger credentials */
3420 lttng_trigger_set_credentials(copy
, &user_creds
);
3423 * Validate that either the current trigger credentials and the
3424 * client credentials are identical or that the current user is
3425 * root. The root user can register, unregister triggers for
3426 * himself and other users.
3428 * This check is also present on the sessiond side, using the
3429 * credentials passed on the socket. These check are all
3432 const struct lttng_credentials
*trigger_creds
=
3433 lttng_trigger_get_credentials(copy
);
3434 if (!lttng_credentials_is_equal_uid(trigger_creds
, &user_creds
)) {
3435 if (lttng_credentials_get_uid(&user_creds
) != 0) {
3436 ret
= -LTTNG_ERR_EPERM
;
3442 if (!lttng_trigger_validate(copy
)) {
3443 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3447 memset(&lsm
, 0, sizeof(lsm
));
3448 lsm
.cmd_type
= LTTNG_UNREGISTER_TRIGGER
;
3450 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3452 ret
= -LTTNG_ERR_NOMEM
;
3456 ret
= lttng_trigger_serialize(copy
, &message
);
3458 ret
= -LTTNG_ERR_UNK
;
3463 * This is needed to populate the trigger object size for the command
3464 * header and number of fds sent.
3466 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3468 message_lsm
->u
.trigger
.length
= (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3471 struct lttng_payload_view message_view
=
3472 lttng_payload_view_from_payload(
3476 * Update the message header with the number of fd that will be
3479 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3482 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3490 lttng_trigger_destroy(copy
);
3491 lttng_payload_reset(&message
);
3492 lttng_payload_reset(&reply
);
3497 * Ask the session daemon for all registered triggers for the current user.
3499 * Allocates and return an lttng_triggers set.
3500 * On error, returns a suitable lttng_error_code.
3502 enum lttng_error_code
lttng_list_triggers(struct lttng_triggers
**triggers
)
3505 enum lttng_error_code ret_code
= LTTNG_OK
;
3506 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_LIST_TRIGGERS
};
3507 struct lttng_triggers
*local_triggers
= NULL
;
3508 struct lttng_payload reply
;
3509 struct lttng_payload_view lsm_view
=
3510 lttng_payload_view_init_from_buffer(
3511 (const char *) &lsm
, 0, sizeof(lsm
));
3513 lttng_payload_init(&reply
);
3515 ret
= lttng_ctl_ask_sessiond_payload(&lsm_view
, &reply
);
3517 ret_code
= (enum lttng_error_code
) -ret
;
3522 struct lttng_payload_view reply_view
=
3523 lttng_payload_view_from_payload(
3524 &reply
, 0, reply
.buffer
.size
);
3526 ret
= lttng_triggers_create_from_payload(
3527 &reply_view
, &local_triggers
);
3529 ret_code
= LTTNG_ERR_FATAL
;
3534 *triggers
= local_triggers
;
3535 local_triggers
= NULL
;
3537 lttng_payload_reset(&reply
);
3538 lttng_triggers_destroy(local_triggers
);
3545 static void __attribute__((constructor
)) init(void)
3547 /* Set default session group */
3548 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
3554 static void __attribute__((destructor
)) lttng_ctl_exit(void)
3556 free(tracing_group
);