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
)
922 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_ADD_CONTEXT
};
923 struct lttng_payload payload
;
925 lttng_payload_init(&payload
);
927 /* Safety check. Both are mandatory. */
928 if (handle
== NULL
|| ctx
== NULL
) {
929 ret
= -LTTNG_ERR_INVALID
;
933 ret
= lttng_dynamic_buffer_set_size(&payload
.buffer
, sizeof(lsm
));
935 ret
= -LTTNG_ERR_NOMEM
;
939 /* If no channel name, send empty string. */
940 ret
= lttng_strncpy(lsm
.u
.context
.channel_name
, channel_name
?: "",
941 sizeof(lsm
.u
.context
.channel_name
));
943 ret
= -LTTNG_ERR_INVALID
;
947 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
948 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
949 sizeof(lsm
.session
.name
));
951 ret
= -LTTNG_ERR_INVALID
;
955 ret
= lttng_event_context_serialize(ctx
, &payload
);
957 ret
= -LTTNG_ERR_INVALID
;
961 lsm
.u
.context
.length
= payload
.buffer
.size
- sizeof(lsm
);
963 /* Update message header. */
964 memcpy(payload
.buffer
.data
, &lsm
, sizeof(lsm
));
967 struct lttng_payload reply
;
968 struct lttng_payload_view payload_view
=
969 lttng_payload_view_from_payload(&payload
, 0,
972 lttng_payload_init(&reply
);
973 ret
= lttng_ctl_ask_sessiond_payload(&payload_view
, &reply
);
974 lttng_payload_reset(&reply
);
981 lttng_payload_reset(&payload
);
986 * Enable event(s) for a channel.
988 * If no event name is specified, all events are enabled.
989 * If no channel name is specified, the default 'channel0' is used.
991 * Returns size of returned session payload data or a negative error code.
993 int lttng_enable_event(struct lttng_handle
*handle
,
994 struct lttng_event
*ev
, const char *channel_name
)
996 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
1001 * Create or enable an event with a filter expression.
1003 * Return negative error value on error.
1004 * Return size of returned session payload data if OK.
1006 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
1007 struct lttng_event
*event
, const char *channel_name
,
1008 const char *filter_expression
)
1010 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
1011 filter_expression
, 0, NULL
);
1015 * Depending on the event, return a newly allocated agent filter expression or
1016 * NULL if not applicable.
1018 * An event with NO loglevel and the name is * will return NULL.
1020 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
1023 char *agent_filter
= NULL
;
1027 /* Don't add filter for the '*' event. */
1028 if (strcmp(ev
->name
, "*") != 0) {
1030 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
1033 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
1041 /* Add loglevel filtering if any for the JUL domain. */
1042 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1045 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
1051 if (filter
|| agent_filter
) {
1054 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
1055 agent_filter
? agent_filter
: filter
, op
,
1060 agent_filter
= new_filter
;
1062 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
1071 return agent_filter
;
1078 * Enable event(s) for a channel, possibly with exclusions and a filter.
1079 * If no event name is specified, all events are enabled.
1080 * If no channel name is specified, the default name is used.
1081 * If filter expression is not NULL, the filter is set for the event.
1082 * If exclusion count is not zero, the exclusions are set for the event.
1083 * Returns size of returned session payload data or a negative error code.
1085 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
1086 struct lttng_event
*ev
, const char *channel_name
,
1087 const char *original_filter_expression
,
1088 int exclusion_count
, char **exclusion_list
)
1090 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_ENABLE_EVENT
};
1091 struct lttng_payload payload
;
1093 unsigned int free_filter_expression
= 0;
1094 struct filter_parser_ctx
*ctx
= NULL
;
1095 size_t bytecode_len
= 0;
1098 * We have either a filter or some exclusions, so we need to set up
1099 * a variable-length payload from where to send the data.
1101 lttng_payload_init(&payload
);
1104 * Cast as non-const since we may replace the filter expression
1105 * by a dynamically allocated string. Otherwise, the original
1106 * string is not modified.
1108 char *filter_expression
= (char *) original_filter_expression
;
1110 if (handle
== NULL
|| ev
== NULL
) {
1111 ret
= -LTTNG_ERR_INVALID
;
1116 * Empty filter string will always be rejected by the parser
1117 * anyway, so treat this corner-case early to eliminate
1118 * lttng_fmemopen error for 0-byte allocation.
1120 if (filter_expression
&& filter_expression
[0] == '\0') {
1121 ret
= -LTTNG_ERR_INVALID
;
1125 if (ev
->name
[0] == '\0') {
1126 /* Enable all events. */
1127 ret
= lttng_strncpy(ev
->name
, "*", sizeof(ev
->name
));
1131 /* Parse filter expression. */
1132 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1133 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1134 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1135 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1136 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1137 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1140 /* Setup agent filter if needed. */
1141 agent_filter
= set_agent_filter(filter_expression
, ev
);
1142 if (!agent_filter
) {
1143 if (!filter_expression
) {
1145 * No JUL and no filter, just skip
1152 * With an agent filter, the original filter has
1153 * been added to it thus replace the filter
1156 filter_expression
= agent_filter
;
1157 free_filter_expression
= 1;
1161 if (strnlen(filter_expression
, LTTNG_FILTER_MAX_LEN
) ==
1162 LTTNG_FILTER_MAX_LEN
) {
1163 ret
= -LTTNG_ERR_FILTER_INVAL
;
1167 ret
= filter_parser_ctx_create_from_filter_expression(filter_expression
, &ctx
);
1172 bytecode_len
= bytecode_get_len(&ctx
->bytecode
->b
) +
1173 sizeof(ctx
->bytecode
->b
);
1174 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
1175 ret
= -LTTNG_ERR_FILTER_INVAL
;
1181 ret
= lttng_event_serialize(ev
, exclusion_count
, exclusion_list
,
1182 filter_expression
, bytecode_len
,
1183 (ctx
&& bytecode_len
) ? &ctx
->bytecode
->b
: NULL
,
1186 ret
= -LTTNG_ERR_INVALID
;
1190 /* If no channel name, send empty string. */
1191 ret
= lttng_strncpy(lsm
.u
.enable
.channel_name
, channel_name
?: "",
1192 sizeof(lsm
.u
.enable
.channel_name
));
1194 ret
= -LTTNG_ERR_INVALID
;
1199 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1202 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1203 sizeof(lsm
.session
.name
));
1205 ret
= -LTTNG_ERR_INVALID
;
1209 /* Length of the serialized event. */
1210 lsm
.u
.enable
.length
= (uint32_t) payload
.buffer
.size
;
1213 struct lttng_payload_view view
= lttng_payload_view_from_payload(
1215 int fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
1222 assert(fd_count
== 0 || fd_count
== 1);
1223 if (fd_count
== 1) {
1224 struct fd_handle
*h
=
1225 lttng_payload_view_pop_fd_handle(&view
);
1231 fd_to_send
= fd_handle_get_fd(h
);
1235 lsm
.fd_count
= fd_count
;
1237 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
,
1238 fd_count
? &fd_to_send
: NULL
, fd_count
,
1239 view
.buffer
.size
? view
.buffer
.data
: NULL
,
1240 view
.buffer
.size
, NULL
, NULL
, 0);
1244 if (filter_expression
&& ctx
) {
1245 filter_bytecode_free(ctx
);
1246 filter_ir_free(ctx
);
1247 filter_parser_ctx_free(ctx
);
1249 if (free_filter_expression
) {
1251 * The filter expression has been replaced and must be freed as
1252 * it is not the original filter expression received as a
1255 free(filter_expression
);
1258 * Return directly to the caller and don't ask the sessiond since
1259 * something went wrong in the parsing of data above.
1261 lttng_payload_reset(&payload
);
1265 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1266 struct lttng_event
*ev
, const char *channel_name
,
1267 const char *original_filter_expression
)
1269 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_DISABLE_EVENT
};
1270 struct lttng_payload payload
;
1272 unsigned int free_filter_expression
= 0;
1273 struct filter_parser_ctx
*ctx
= NULL
;
1274 size_t bytecode_len
= 0;
1277 * We have either a filter or some exclusions, so we need to set up
1278 * a variable-length payload from where to send the data.
1280 lttng_payload_init(&payload
);
1283 * Cast as non-const since we may replace the filter expression
1284 * by a dynamically allocated string. Otherwise, the original
1285 * string is not modified.
1287 char *filter_expression
= (char *) original_filter_expression
;
1289 if (handle
== NULL
|| ev
== NULL
) {
1290 ret
= -LTTNG_ERR_INVALID
;
1295 * Empty filter string will always be rejected by the parser
1296 * anyway, so treat this corner-case early to eliminate
1297 * lttng_fmemopen error for 0-byte allocation.
1299 if (filter_expression
&& filter_expression
[0] == '\0') {
1300 ret
= -LTTNG_ERR_INVALID
;
1304 /* Parse filter expression. */
1305 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1306 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1307 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1308 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1309 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1310 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1313 /* Setup agent filter if needed. */
1314 agent_filter
= set_agent_filter(filter_expression
, ev
);
1315 if (!agent_filter
) {
1316 if (!filter_expression
) {
1318 * No JUL and no filter, just skip
1325 * With an agent filter, the original filter has
1326 * been added to it thus replace the filter
1329 filter_expression
= agent_filter
;
1330 free_filter_expression
= 1;
1334 if (strnlen(filter_expression
, LTTNG_FILTER_MAX_LEN
) ==
1335 LTTNG_FILTER_MAX_LEN
) {
1336 ret
= -LTTNG_ERR_FILTER_INVAL
;
1340 ret
= filter_parser_ctx_create_from_filter_expression(filter_expression
, &ctx
);
1345 bytecode_len
= bytecode_get_len(&ctx
->bytecode
->b
) +
1346 sizeof(ctx
->bytecode
->b
);
1347 if (bytecode_len
> LTTNG_FILTER_MAX_LEN
) {
1348 ret
= -LTTNG_ERR_FILTER_INVAL
;
1354 ret
= lttng_event_serialize(ev
, 0, NULL
,
1355 filter_expression
, bytecode_len
,
1356 (ctx
&& bytecode_len
) ? &ctx
->bytecode
->b
: NULL
,
1359 ret
= -LTTNG_ERR_INVALID
;
1363 /* If no channel name, send empty string. */
1364 ret
= lttng_strncpy(lsm
.u
.disable
.channel_name
, channel_name
?: "",
1365 sizeof(lsm
.u
.disable
.channel_name
));
1367 ret
= -LTTNG_ERR_INVALID
;
1372 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1375 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1376 sizeof(lsm
.session
.name
));
1378 ret
= -LTTNG_ERR_INVALID
;
1382 /* Length of the serialized event. */
1383 lsm
.u
.disable
.length
= (uint32_t) payload
.buffer
.size
;
1386 struct lttng_payload_view view
= lttng_payload_view_from_payload(
1388 int fd_count
= lttng_payload_view_get_fd_handle_count(&view
);
1395 assert(fd_count
== 0 || fd_count
== 1);
1396 if (fd_count
== 1) {
1397 struct fd_handle
*h
=
1398 lttng_payload_view_pop_fd_handle(&view
);
1404 fd_to_send
= fd_handle_get_fd(h
);
1408 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
,
1409 fd_count
? &fd_to_send
: NULL
, fd_count
,
1410 view
.buffer
.size
? view
.buffer
.data
: NULL
,
1411 view
.buffer
.size
, NULL
, NULL
, 0);
1415 if (filter_expression
&& ctx
) {
1416 filter_bytecode_free(ctx
);
1417 filter_ir_free(ctx
);
1418 filter_parser_ctx_free(ctx
);
1420 if (free_filter_expression
) {
1422 * The filter expression has been replaced and must be freed as
1423 * it is not the original filter expression received as a
1426 free(filter_expression
);
1429 * Return directly to the caller and don't ask the sessiond since
1430 * something went wrong in the parsing of data above.
1432 lttng_payload_reset(&payload
);
1437 * Disable event(s) of a channel and domain.
1438 * If no event name is specified, all events are disabled.
1439 * If no channel name is specified, the default 'channel0' is used.
1440 * Returns size of returned session payload data or a negative error code.
1442 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1443 const char *channel_name
)
1446 struct lttng_event ev
;
1448 memset(&ev
, 0, sizeof(ev
));
1450 ev
.type
= LTTNG_EVENT_ALL
;
1451 ret
= lttng_strncpy(ev
.name
, name
?: "", sizeof(ev
.name
));
1453 ret
= -LTTNG_ERR_INVALID
;
1457 ret
= lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1462 struct lttng_channel
*lttng_channel_create(struct lttng_domain
*domain
)
1464 struct lttng_channel
*channel
= NULL
;
1470 /* Validate domain. */
1471 switch (domain
->type
) {
1472 case LTTNG_DOMAIN_UST
:
1473 switch (domain
->buf_type
) {
1474 case LTTNG_BUFFER_PER_UID
:
1475 case LTTNG_BUFFER_PER_PID
:
1481 case LTTNG_DOMAIN_KERNEL
:
1482 if (domain
->buf_type
!= LTTNG_BUFFER_GLOBAL
) {
1490 channel
= lttng_channel_create_internal();
1495 lttng_channel_set_default_attr(domain
, &channel
->attr
);
1500 void lttng_channel_destroy(struct lttng_channel
*channel
)
1506 if (channel
->attr
.extended
.ptr
) {
1507 free(channel
->attr
.extended
.ptr
);
1513 * Enable channel per domain
1514 * Returns size of returned session payload data or a negative error code.
1516 int lttng_enable_channel(struct lttng_handle
*handle
,
1517 struct lttng_channel
*in_chan
)
1519 enum lttng_error_code ret_code
;
1521 struct lttng_dynamic_buffer buffer
;
1522 struct lttcomm_session_msg lsm
;
1523 uint64_t total_buffer_size_needed_per_cpu
= 0;
1524 struct lttng_channel
*channel
= NULL
;
1526 lttng_dynamic_buffer_init(&buffer
);
1528 /* NULL arguments are forbidden. No default values. */
1529 if (handle
== NULL
|| in_chan
== NULL
) {
1530 ret
= -LTTNG_ERR_INVALID
;
1535 * Verify that the amount of memory required to create the requested
1536 * buffer is available on the system at the moment.
1538 if (in_chan
->attr
.num_subbuf
>
1539 UINT64_MAX
/ in_chan
->attr
.subbuf_size
) {
1541 ret
= -LTTNG_ERR_OVERFLOW
;
1545 total_buffer_size_needed_per_cpu
=
1546 in_chan
->attr
.num_subbuf
* in_chan
->attr
.subbuf_size
;
1547 ret_code
= check_enough_available_memory(
1548 total_buffer_size_needed_per_cpu
);
1549 if (ret_code
!= LTTNG_OK
) {
1554 /* Copy the channel for easier manipulation. */
1555 channel
= lttng_channel_copy(in_chan
);
1557 ret
= -LTTNG_ERR_NOMEM
;
1561 /* Populate the channel extended attribute if necessary. */
1562 if (!channel
->attr
.extended
.ptr
) {
1563 struct lttng_channel_extended
*extended
=
1564 (struct lttng_channel_extended
*) zmalloc(
1568 ret
= -LTTNG_ERR_NOMEM
;
1571 lttng_channel_set_default_extended_attr(
1572 &handle
->domain
, extended
);
1573 channel
->attr
.extended
.ptr
= extended
;
1576 /* Prepare the payload */
1577 memset(&lsm
, 0, sizeof(lsm
));
1579 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1580 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1582 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1583 sizeof(lsm
.session
.name
));
1585 ret
= -LTTNG_ERR_INVALID
;
1589 ret
= lttng_channel_serialize(channel
, &buffer
);
1591 ret
= -LTTNG_ERR_FATAL
;
1595 lsm
.u
.channel
.length
= buffer
.size
;
1597 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(
1598 &lsm
, buffer
.data
, buffer
.size
, NULL
);
1600 lttng_channel_destroy(channel
);
1601 lttng_dynamic_buffer_reset(&buffer
);
1606 * All tracing will be stopped for registered events of the channel.
1607 * Returns size of returned session payload data or a negative error code.
1609 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1612 struct lttcomm_session_msg lsm
;
1614 /* Safety check. Both are mandatory. */
1615 if (handle
== NULL
|| name
== NULL
) {
1616 return -LTTNG_ERR_INVALID
;
1619 memset(&lsm
, 0, sizeof(lsm
));
1621 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1623 ret
= lttng_strncpy(lsm
.u
.disable
.channel_name
, name
,
1624 sizeof(lsm
.u
.disable
.channel_name
));
1626 ret
= -LTTNG_ERR_INVALID
;
1630 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1632 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
1633 sizeof(lsm
.session
.name
));
1635 ret
= -LTTNG_ERR_INVALID
;
1639 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1645 * Lists all available tracepoints of domain.
1646 * Sets the contents of the events array.
1647 * Returns the number of lttng_event entries in events;
1648 * on error, returns a negative value.
1650 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1651 struct lttng_event
**events
)
1653 enum lttng_error_code ret_code
;
1654 int ret
, total_payload_received
;
1655 char *reception_buffer
= NULL
;
1656 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_LIST_TRACEPOINTS
};
1657 struct lttcomm_list_command_header
*cmd_header
= NULL
;
1658 size_t cmd_header_len
;
1659 unsigned int nb_events
= 0;
1661 if (handle
== NULL
) {
1662 ret
= -LTTNG_ERR_INVALID
;
1666 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1668 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
1669 (void **) &reception_buffer
, (void **) &cmd_header
,
1675 total_payload_received
= ret
;
1678 ret
= -LTTNG_ERR_UNK
;
1682 if (cmd_header
->count
> INT_MAX
) {
1683 ret
= -LTTNG_ERR_OVERFLOW
;
1687 nb_events
= (unsigned int) cmd_header
->count
;
1690 struct lttng_buffer_view events_view
=
1691 lttng_buffer_view_init(reception_buffer
, 0,
1692 total_payload_received
);
1693 struct lttng_payload_view events_payload_view
=
1694 lttng_payload_view_from_buffer_view(
1695 &events_view
, 0, -1);
1697 ret_code
= lttng_events_create_and_flatten_from_payload(
1698 &events_payload_view
, nb_events
, events
);
1699 if (ret_code
!= LTTNG_OK
) {
1705 ret
= (int) nb_events
;
1709 free(reception_buffer
);
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
)
1750 enum lttng_error_code ret_code
;
1751 int ret
, total_payload_received
;
1752 char *reception_buffer
= NULL
;
1753 struct lttcomm_session_msg lsm
= {};
1754 struct lttcomm_list_command_header
*cmd_header
= NULL
;
1755 size_t cmd_header_len
;
1756 uint32_t nb_events
= 0;
1759 ret
= -LTTNG_ERR_INVALID
;
1763 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1764 /* Force kernel domain for system calls. */
1765 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1767 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
1768 (void **) &reception_buffer
, (void **) &cmd_header
,
1773 total_payload_received
= ret
;
1776 ret
= -LTTNG_ERR_UNK
;
1780 if (cmd_header
->count
> INT_MAX
) {
1781 ret
= -LTTNG_ERR_OVERFLOW
;
1785 nb_events
= (unsigned int) cmd_header
->count
;
1788 const struct lttng_buffer_view events_view
=
1789 lttng_buffer_view_init(reception_buffer
, 0,
1790 total_payload_received
);
1791 struct lttng_payload_view events_payload_view
=
1792 lttng_payload_view_from_buffer_view(
1793 &events_view
, 0, -1);
1795 ret_code
= lttng_events_create_and_flatten_from_payload(
1796 &events_payload_view
, nb_events
, events
);
1797 if (ret_code
!= LTTNG_OK
) {
1803 ret
= (int) nb_events
;
1806 free(reception_buffer
);
1812 * Returns a human readable string describing
1813 * the error code (a negative value).
1815 const char *lttng_strerror(int code
)
1817 return error_get_str(code
);
1820 enum lttng_error_code
lttng_create_session_ext(
1821 struct lttng_session_descriptor
*session_descriptor
)
1823 enum lttng_error_code ret_code
;
1824 struct lttcomm_session_msg lsm
= {
1825 .cmd_type
= LTTNG_CREATE_SESSION_EXT
,
1828 struct lttng_buffer_view reply_view
;
1830 bool sessiond_must_generate_ouput
;
1831 struct lttng_dynamic_buffer payload
;
1833 size_t descriptor_size
;
1834 struct lttng_session_descriptor
*descriptor_reply
= NULL
;
1836 lttng_dynamic_buffer_init(&payload
);
1837 if (!session_descriptor
) {
1838 ret_code
= LTTNG_ERR_INVALID
;
1842 sessiond_must_generate_ouput
=
1843 !lttng_session_descriptor_is_output_destination_initialized(
1844 session_descriptor
);
1845 if (sessiond_must_generate_ouput
) {
1846 const char *home_dir
= utils_get_home_dir();
1847 size_t home_dir_len
= home_dir
? strlen(home_dir
) + 1 : 0;
1849 if (!home_dir
|| home_dir_len
> LTTNG_PATH_MAX
) {
1850 ret_code
= LTTNG_ERR_FATAL
;
1854 lsm
.u
.create_session
.home_dir_size
= (uint16_t) home_dir_len
;
1855 ret
= lttng_dynamic_buffer_append(&payload
, home_dir
,
1858 ret_code
= LTTNG_ERR_NOMEM
;
1863 descriptor_size
= payload
.size
;
1864 ret
= lttng_session_descriptor_serialize(session_descriptor
,
1867 ret_code
= LTTNG_ERR_INVALID
;
1870 descriptor_size
= payload
.size
- descriptor_size
;
1871 lsm
.u
.create_session
.session_descriptor_size
= descriptor_size
;
1873 /* Command returns a session descriptor on success. */
1874 reply_ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, payload
.data
,
1875 payload
.size
, &reply
);
1876 if (reply_ret
< 0) {
1877 ret_code
= -reply_ret
;
1879 } else if (reply_ret
== 0) {
1880 /* Socket unexpectedly closed by the session daemon. */
1881 ret_code
= LTTNG_ERR_FATAL
;
1885 reply_view
= lttng_buffer_view_init(reply
, 0, reply_ret
);
1886 ret
= lttng_session_descriptor_create_from_buffer(&reply_view
,
1889 ret_code
= LTTNG_ERR_FATAL
;
1892 ret_code
= LTTNG_OK
;
1893 lttng_session_descriptor_assign(session_descriptor
, descriptor_reply
);
1896 lttng_dynamic_buffer_reset(&payload
);
1897 lttng_session_descriptor_destroy(descriptor_reply
);
1902 * Create a new session using name and url for destination.
1904 * Return 0 on success else a negative LTTng error code.
1906 int lttng_create_session(const char *name
, const char *url
)
1910 struct lttng_uri
*uris
= NULL
;
1911 struct lttng_session_descriptor
*descriptor
= NULL
;
1912 enum lttng_error_code ret_code
;
1915 ret
= -LTTNG_ERR_INVALID
;
1919 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1921 ret
= -LTTNG_ERR_INVALID
;
1926 descriptor
= lttng_session_descriptor_create(name
);
1929 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1930 ret
= -LTTNG_ERR_INVALID
;
1933 descriptor
= lttng_session_descriptor_local_create(name
,
1937 descriptor
= lttng_session_descriptor_network_create(name
, url
,
1941 ret
= -LTTNG_ERR_INVALID
;
1945 ret
= -LTTNG_ERR_INVALID
;
1948 ret_code
= lttng_create_session_ext(descriptor
);
1949 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1951 lttng_session_descriptor_destroy(descriptor
);
1957 * Create a session exclusively used for snapshot.
1959 * Return 0 on success else a negative LTTng error code.
1961 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1964 enum lttng_error_code ret_code
;
1966 struct lttng_uri
*uris
= NULL
;
1967 struct lttng_session_descriptor
*descriptor
= NULL
;
1970 ret
= -LTTNG_ERR_INVALID
;
1974 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1976 ret
= -LTTNG_ERR_INVALID
;
1980 * If the user does not specify a custom subdir, use the session name.
1982 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&&
1983 strlen(uris
[0].subdir
) == 0) {
1984 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s",
1987 PERROR("Failed to set session name as network destination sub-directory");
1988 ret
= -LTTNG_ERR_FATAL
;
1990 } else if (ret
>= sizeof(uris
[0].subdir
)) {
1991 /* Truncated output. */
1992 ret
= -LTTNG_ERR_INVALID
;
1999 descriptor
= lttng_session_descriptor_snapshot_create(name
);
2002 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
2003 ret
= -LTTNG_ERR_INVALID
;
2006 descriptor
= lttng_session_descriptor_snapshot_local_create(
2011 descriptor
= lttng_session_descriptor_snapshot_network_create(
2017 ret
= -LTTNG_ERR_INVALID
;
2021 ret
= -LTTNG_ERR_INVALID
;
2024 ret_code
= lttng_create_session_ext(descriptor
);
2025 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2027 lttng_session_descriptor_destroy(descriptor
);
2033 * Create a session exclusively used for live.
2035 * Return 0 on success else a negative LTTng error code.
2037 int lttng_create_session_live(const char *name
, const char *url
,
2038 unsigned int timer_interval
)
2041 enum lttng_error_code ret_code
;
2042 struct lttng_session_descriptor
*descriptor
= NULL
;
2045 ret
= -LTTNG_ERR_INVALID
;
2050 descriptor
= lttng_session_descriptor_live_network_create(
2051 name
, url
, NULL
, timer_interval
);
2053 descriptor
= lttng_session_descriptor_live_create(
2054 name
, timer_interval
);
2057 ret
= -LTTNG_ERR_INVALID
;
2060 ret_code
= lttng_create_session_ext(descriptor
);
2061 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2063 lttng_session_descriptor_destroy(descriptor
);
2068 * Stop the session and wait for the data before destroying it
2070 * Return 0 on success else a negative LTTng error code.
2072 int lttng_destroy_session(const char *session_name
)
2075 enum lttng_error_code ret_code
;
2076 enum lttng_destruction_handle_status status
;
2077 struct lttng_destruction_handle
*handle
= NULL
;
2080 * Stop the tracing and wait for the data to be
2083 ret
= _lttng_stop_tracing(session_name
, 1);
2084 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
2088 ret_code
= lttng_destroy_session_ext(session_name
, &handle
);
2089 if (ret_code
!= LTTNG_OK
) {
2090 ret
= (int) -ret_code
;
2095 /* Block until the completion of the destruction of the session. */
2096 status
= lttng_destruction_handle_wait_for_completion(handle
, -1);
2097 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED
) {
2098 ret
= -LTTNG_ERR_UNK
;
2102 status
= lttng_destruction_handle_get_result(handle
, &ret_code
);
2103 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
2104 ret
= -LTTNG_ERR_UNK
;
2107 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2109 lttng_destruction_handle_destroy(handle
);
2114 * Destroy the session without waiting for the data.
2116 int lttng_destroy_session_no_wait(const char *session_name
)
2118 enum lttng_error_code ret_code
;
2120 ret_code
= lttng_destroy_session_ext(session_name
, NULL
);
2121 return ret_code
== LTTNG_OK
? 0 : -ret_code
;
2125 * Ask the session daemon for all available sessions.
2126 * Sets the contents of the sessions array.
2127 * Returns the number of lttng_session entries in sessions;
2128 * on error, returns a negative value.
2130 int lttng_list_sessions(struct lttng_session
**out_sessions
)
2133 struct lttcomm_session_msg lsm
;
2134 const size_t session_size
= sizeof(struct lttng_session
) +
2135 sizeof(struct lttng_session_extended
);
2136 size_t session_count
, i
;
2137 struct lttng_session_extended
*sessions_extended_begin
;
2138 struct lttng_session
*sessions
= NULL
;
2140 memset(&lsm
, 0, sizeof(lsm
));
2141 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
2143 * Initialize out_sessions to NULL so it is initialized when
2144 * lttng_list_sessions returns 0, thus allowing *out_sessions to
2145 * be subsequently freed.
2147 *out_sessions
= NULL
;
2148 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) &sessions
);
2153 ret
= -LTTNG_ERR_FATAL
;
2157 if (ret
% session_size
) {
2158 ret
= -LTTNG_ERR_UNK
;
2162 session_count
= (size_t) ret
/ session_size
;
2163 sessions_extended_begin
= (struct lttng_session_extended
*)
2164 (&sessions
[session_count
]);
2166 /* Set extended session info pointers. */
2167 for (i
= 0; i
< session_count
; i
++) {
2168 struct lttng_session
*session
= &sessions
[i
];
2169 struct lttng_session_extended
*extended
=
2170 &(sessions_extended_begin
[i
]);
2172 session
->extended
.ptr
= extended
;
2175 ret
= (int) session_count
;
2176 *out_sessions
= sessions
;
2181 enum lttng_error_code
lttng_session_get_creation_time(
2182 const struct lttng_session
*session
, uint64_t *creation_time
)
2184 enum lttng_error_code ret
= LTTNG_OK
;
2185 struct lttng_session_extended
*extended
;
2187 if (!session
|| !creation_time
|| !session
->extended
.ptr
) {
2188 ret
= LTTNG_ERR_INVALID
;
2192 extended
= session
->extended
.ptr
;
2193 if (!extended
->creation_time
.is_set
) {
2194 /* Not created on the session daemon yet. */
2195 ret
= LTTNG_ERR_SESSION_NOT_EXIST
;
2198 *creation_time
= extended
->creation_time
.value
;
2203 int lttng_set_session_shm_path(const char *session_name
,
2204 const char *shm_path
)
2207 struct lttcomm_session_msg lsm
;
2209 if (session_name
== NULL
) {
2210 return -LTTNG_ERR_INVALID
;
2213 memset(&lsm
, 0, sizeof(lsm
));
2214 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
2216 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2217 sizeof(lsm
.session
.name
));
2219 ret
= -LTTNG_ERR_INVALID
;
2223 ret
= lttng_strncpy(lsm
.u
.set_shm_path
.shm_path
, shm_path
?: "",
2224 sizeof(lsm
.u
.set_shm_path
.shm_path
));
2226 ret
= -LTTNG_ERR_INVALID
;
2230 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2236 * Ask the session daemon for all available domains of a session.
2237 * Sets the contents of the domains array.
2238 * Returns the number of lttng_domain entries in domains;
2239 * on error, returns a negative value.
2241 int lttng_list_domains(const char *session_name
,
2242 struct lttng_domain
**domains
)
2245 struct lttcomm_session_msg lsm
;
2247 if (session_name
== NULL
) {
2248 ret
= -LTTNG_ERR_INVALID
;
2252 memset(&lsm
, 0, sizeof(lsm
));
2253 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
2255 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2256 sizeof(lsm
.session
.name
));
2258 ret
= -LTTNG_ERR_INVALID
;
2262 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
2267 return ret
/ sizeof(struct lttng_domain
);
2273 * Ask the session daemon for all available channels of a session.
2274 * Sets the contents of the channels array.
2275 * Returns the number of lttng_channel entries in channels;
2276 * on error, returns a negative value.
2278 int lttng_list_channels(struct lttng_handle
*handle
,
2279 struct lttng_channel
**channels
)
2281 int ret
, total_payload_received
;
2282 struct lttcomm_session_msg lsm
;
2283 char *reception_buffer
= NULL
;
2284 size_t cmd_header_len
= 0;
2285 struct lttcomm_list_command_header
*cmd_header
= NULL
;
2286 struct lttng_dynamic_buffer tmp_buffer
;
2288 lttng_dynamic_buffer_init(&tmp_buffer
);
2290 if (handle
== NULL
) {
2291 ret
= -LTTNG_ERR_INVALID
;
2295 memset(&lsm
, 0, sizeof(lsm
));
2296 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
2297 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2298 sizeof(lsm
.session
.name
));
2300 ret
= -LTTNG_ERR_INVALID
;
2304 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2306 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
2307 (void **) &reception_buffer
, (void **) &cmd_header
,
2313 total_payload_received
= ret
;
2315 if (cmd_header_len
!= sizeof(*cmd_header
)) {
2316 ret
= -LTTNG_ERR_FATAL
;
2321 ret
= LTTNG_ERR_UNK
;
2325 if (cmd_header
->count
> INT_MAX
) {
2326 ret
= -LTTNG_ERR_OVERFLOW
;
2331 enum lttng_error_code ret_code
;
2332 const struct lttng_buffer_view events_view
=
2333 lttng_buffer_view_init(reception_buffer
, 0,
2334 total_payload_received
);
2336 ret_code
= lttng_channels_create_and_flatten_from_buffer(
2337 &events_view
, cmd_header
->count
, channels
);
2338 if (ret_code
!= LTTNG_OK
) {
2344 ret
= (int) cmd_header
->count
;
2347 free(reception_buffer
);
2352 * Ask the session daemon for all available events of a session channel.
2353 * Sets the contents of the events array.
2354 * Returns the number of lttng_event entries in events;
2355 * on error, returns a negative value.
2357 int lttng_list_events(struct lttng_handle
*handle
,
2358 const char *channel_name
, struct lttng_event
**events
)
2361 struct lttcomm_session_msg lsm
= {};
2362 struct lttng_payload reply
;
2363 struct lttng_payload_view lsm_view
=
2364 lttng_payload_view_init_from_buffer(
2365 (const char *) &lsm
, 0, sizeof(lsm
));
2366 unsigned int nb_events
= 0;
2368 /* Safety check. An handle and channel name are mandatory. */
2369 if (handle
== NULL
|| channel_name
== NULL
) {
2370 ret
= -LTTNG_ERR_INVALID
;
2374 lttng_payload_init(&reply
);
2376 /* Initialize command parameters. */
2377 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
2378 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2379 sizeof(lsm
.session
.name
));
2381 ret
= -LTTNG_ERR_INVALID
;
2385 ret
= lttng_strncpy(lsm
.u
.list
.channel_name
, channel_name
,
2386 sizeof(lsm
.u
.list
.channel_name
));
2388 ret
= -LTTNG_ERR_INVALID
;
2392 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2394 /* Execute command against the session daemon. */
2395 ret
= lttng_ctl_ask_sessiond_payload(&lsm_view
, &reply
);
2401 const struct lttcomm_list_command_header
*cmd_reply_header
=
2403 const struct lttng_payload_view cmd_reply_header_view
=
2404 lttng_payload_view_from_payload(&reply
, 0,
2405 sizeof(*cmd_reply_header
));
2407 if (!lttng_payload_view_is_valid(&cmd_reply_header_view
)) {
2408 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
2412 cmd_reply_header
= (const struct lttcomm_list_command_header
*)
2413 cmd_reply_header_view
.buffer
2415 if (cmd_reply_header
->count
> INT_MAX
) {
2416 ret
= -LTTNG_ERR_OVERFLOW
;
2420 nb_events
= (unsigned int) cmd_reply_header
->count
;
2424 enum lttng_error_code ret_code
;
2425 struct lttng_payload_view cmd_reply_payload
= lttng_payload_view_from_payload(
2427 sizeof(struct lttcomm_list_command_header
), -1);
2429 ret_code
= lttng_events_create_and_flatten_from_payload(
2430 &cmd_reply_payload
, nb_events
, events
);
2431 if (ret_code
!= LTTNG_OK
) {
2432 ret
= -((int) ret_code
);
2437 ret
= (int) nb_events
;
2439 lttng_payload_reset(&reply
);
2444 * Sets the tracing_group variable with name.
2445 * This function allocates memory pointed to by tracing_group.
2446 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2448 int lttng_set_tracing_group(const char *name
)
2452 return -LTTNG_ERR_INVALID
;
2455 if (asprintf(&new_group
, "%s", name
) < 0) {
2456 return -LTTNG_ERR_FATAL
;
2459 free(tracing_group
);
2460 tracing_group
= new_group
;
2466 int lttng_calibrate(struct lttng_handle
*handle
,
2467 struct lttng_calibrate
*calibrate
)
2470 * This command was removed in LTTng 2.9.
2472 return -LTTNG_ERR_UND
;
2476 * Set default channel attributes.
2477 * If either or both of the arguments are null, attr content is zeroe'd.
2479 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
2480 struct lttng_channel_attr
*attr
)
2482 struct lttng_channel_extended
*extended
;
2485 if (attr
== NULL
|| domain
== NULL
) {
2489 /* Save the pointer for later use */
2490 extended
= (struct lttng_channel_extended
*) attr
->extended
.ptr
;
2491 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
2493 /* Same for all domains. */
2494 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2495 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
2496 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
2498 switch (domain
->type
) {
2499 case LTTNG_DOMAIN_KERNEL
:
2500 attr
->switch_timer_interval
=
2501 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
2502 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
2503 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
2504 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
2505 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
2507 case LTTNG_DOMAIN_UST
:
2508 switch (domain
->buf_type
) {
2509 case LTTNG_BUFFER_PER_UID
:
2510 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
2511 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
2512 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
2513 attr
->switch_timer_interval
=
2514 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
2515 attr
->read_timer_interval
=
2516 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
2518 case LTTNG_BUFFER_PER_PID
:
2520 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
2521 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
2522 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
2523 attr
->switch_timer_interval
=
2524 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2525 attr
->read_timer_interval
=
2526 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2530 /* Default behavior: leave set to 0. */
2535 lttng_channel_set_default_extended_attr(domain
, extended
);
2538 /* Reassign the extended pointer. */
2539 attr
->extended
.ptr
= extended
;
2542 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2543 uint64_t *discarded_events
)
2546 struct lttng_channel_extended
*chan_ext
;
2548 if (!channel
|| !discarded_events
) {
2549 ret
= -LTTNG_ERR_INVALID
;
2553 chan_ext
= channel
->attr
.extended
.ptr
;
2556 * This can happen since the lttng_channel structure is
2557 * used for other tasks where this pointer is never set.
2559 *discarded_events
= 0;
2563 *discarded_events
= chan_ext
->discarded_events
;
2568 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2569 uint64_t *lost_packets
)
2572 struct lttng_channel_extended
*chan_ext
;
2574 if (!channel
|| !lost_packets
) {
2575 ret
= -LTTNG_ERR_INVALID
;
2579 chan_ext
= channel
->attr
.extended
.ptr
;
2582 * This can happen since the lttng_channel structure is
2583 * used for other tasks where this pointer is never set.
2589 *lost_packets
= chan_ext
->lost_packets
;
2594 int lttng_channel_get_monitor_timer_interval(struct lttng_channel
*chan
,
2595 uint64_t *monitor_timer_interval
)
2599 if (!chan
|| !monitor_timer_interval
) {
2600 ret
= -LTTNG_ERR_INVALID
;
2604 if (!chan
->attr
.extended
.ptr
) {
2605 ret
= -LTTNG_ERR_INVALID
;
2609 *monitor_timer_interval
= ((struct lttng_channel_extended
*)
2610 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
2615 int lttng_channel_set_monitor_timer_interval(struct lttng_channel
*chan
,
2616 uint64_t monitor_timer_interval
)
2620 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2621 ret
= -LTTNG_ERR_INVALID
;
2625 ((struct lttng_channel_extended
*)
2626 chan
->attr
.extended
.ptr
)->monitor_timer_interval
=
2627 monitor_timer_interval
;
2632 int lttng_channel_get_blocking_timeout(struct lttng_channel
*chan
,
2633 int64_t *blocking_timeout
)
2637 if (!chan
|| !blocking_timeout
) {
2638 ret
= -LTTNG_ERR_INVALID
;
2642 if (!chan
->attr
.extended
.ptr
) {
2643 ret
= -LTTNG_ERR_INVALID
;
2647 *blocking_timeout
= ((struct lttng_channel_extended
*)
2648 chan
->attr
.extended
.ptr
)->blocking_timeout
;
2653 int lttng_channel_set_blocking_timeout(struct lttng_channel
*chan
,
2654 int64_t blocking_timeout
)
2657 int64_t msec_timeout
;
2659 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2660 ret
= -LTTNG_ERR_INVALID
;
2664 if (blocking_timeout
< 0 && blocking_timeout
!= -1) {
2665 ret
= -LTTNG_ERR_INVALID
;
2670 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2671 * us to accept a narrower range of values (msecs expressed as a signed
2674 msec_timeout
= blocking_timeout
/ 1000;
2675 if (msec_timeout
!= (int32_t) msec_timeout
) {
2676 ret
= -LTTNG_ERR_INVALID
;
2680 ((struct lttng_channel_extended
*)
2681 chan
->attr
.extended
.ptr
)->blocking_timeout
=
2688 * Check if session daemon is alive.
2690 * Return 1 if alive or 0 if not.
2691 * On error returns a negative value.
2693 int lttng_session_daemon_alive(void)
2697 ret
= set_session_daemon_path();
2703 if (*sessiond_sock_path
== '\0') {
2705 * No socket path set. Weird error which means the constructor
2711 ret
= try_connect_sessiond(sessiond_sock_path
);
2722 * Set URL for a consumer for a session and domain.
2724 * Return 0 on success, else a negative value.
2726 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2727 const char *control_url
, const char *data_url
)
2731 struct lttcomm_session_msg lsm
;
2732 struct lttng_uri
*uris
= NULL
;
2734 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2735 ret
= -LTTNG_ERR_INVALID
;
2739 memset(&lsm
, 0, sizeof(lsm
));
2741 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2743 ret
= lttng_strncpy(lsm
.session
.name
, handle
->session_name
,
2744 sizeof(lsm
.session
.name
));
2746 ret
= -LTTNG_ERR_INVALID
;
2750 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2752 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2754 ret
= -LTTNG_ERR_INVALID
;
2758 lsm
.u
.uri
.size
= size
;
2760 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2761 sizeof(struct lttng_uri
) * size
, NULL
);
2771 int lttng_enable_consumer(struct lttng_handle
*handle
);
2772 int lttng_enable_consumer(struct lttng_handle
*handle
)
2780 int lttng_disable_consumer(struct lttng_handle
*handle
);
2781 int lttng_disable_consumer(struct lttng_handle
*handle
)
2789 int _lttng_create_session_ext(const char *name
, const char *url
,
2790 const char *datetime
);
2791 int _lttng_create_session_ext(const char *name
, const char *url
,
2792 const char *datetime
)
2798 * For a given session name, this call checks if the data is ready to be read
2799 * or is still being extracted by the consumer(s) hence not ready to be used by
2802 int lttng_data_pending(const char *session_name
)
2805 struct lttcomm_session_msg lsm
;
2806 uint8_t *pending
= NULL
;
2808 if (session_name
== NULL
) {
2809 return -LTTNG_ERR_INVALID
;
2812 memset(&lsm
, 0, sizeof(lsm
));
2813 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
2815 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2816 sizeof(lsm
.session
.name
));
2818 ret
= -LTTNG_ERR_INVALID
;
2822 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
2825 } else if (ret
!= 1) {
2826 /* Unexpected payload size */
2827 ret
= -LTTNG_ERR_INVALID
;
2829 } else if (!pending
) {
2830 /* Internal error. */
2831 ret
= -LTTNG_ERR_UNK
;
2835 ret
= (int) *pending
;
2842 * Regenerate the metadata for a session.
2843 * Return 0 on success, a negative error code on error.
2845 int lttng_regenerate_metadata(const char *session_name
)
2848 struct lttcomm_session_msg lsm
;
2850 if (!session_name
) {
2851 ret
= -LTTNG_ERR_INVALID
;
2855 memset(&lsm
, 0, sizeof(lsm
));
2856 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
2858 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2859 sizeof(lsm
.session
.name
));
2861 ret
= -LTTNG_ERR_INVALID
;
2865 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2876 * Deprecated, replaced by lttng_regenerate_metadata.
2878 int lttng_metadata_regenerate(const char *session_name
)
2880 return lttng_regenerate_metadata(session_name
);
2884 * Regenerate the statedump of a session.
2885 * Return 0 on success, a negative error code on error.
2887 int lttng_regenerate_statedump(const char *session_name
)
2890 struct lttcomm_session_msg lsm
;
2892 if (!session_name
) {
2893 ret
= -LTTNG_ERR_INVALID
;
2897 memset(&lsm
, 0, sizeof(lsm
));
2898 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
2900 ret
= lttng_strncpy(lsm
.session
.name
, session_name
,
2901 sizeof(lsm
.session
.name
));
2903 ret
= -LTTNG_ERR_INVALID
;
2907 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2918 int _lttng_register_trigger(struct lttng_trigger
*trigger
, const char *name
,
2922 struct lttcomm_session_msg lsm
= {
2923 .cmd_type
= LTTNG_REGISTER_TRIGGER
,
2924 .u
.trigger
.is_trigger_anonymous
= !name
&& !generate_name
,
2926 struct lttcomm_session_msg
*message_lsm
;
2927 struct lttng_payload message
;
2928 struct lttng_payload reply
;
2929 struct lttng_trigger
*reply_trigger
= NULL
;
2930 enum lttng_domain_type domain_type
;
2931 const struct lttng_credentials user_creds
= {
2932 .uid
= LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
2933 .gid
= LTTNG_OPTIONAL_INIT_UNSET
,
2935 const char *unused_trigger_name
= NULL
;
2936 enum lttng_trigger_status trigger_status
;
2938 lttng_payload_init(&message
);
2939 lttng_payload_init(&reply
);
2942 ret
= -LTTNG_ERR_INVALID
;
2946 trigger_status
= lttng_trigger_get_name(trigger
, &unused_trigger_name
);
2947 if (trigger_status
!= LTTNG_TRIGGER_STATUS_UNSET
) {
2948 /* Re-using already registered trigger. */
2949 ret
= -LTTNG_ERR_INVALID
;
2954 trigger_status
= lttng_trigger_set_name(trigger
, name
);
2955 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
2956 ret
= -LTTNG_ERR_NOMEM
;
2961 if (!trigger
->creds
.uid
.is_set
) {
2962 /* Use the client's credentials as the trigger credentials. */
2963 lttng_trigger_set_credentials(trigger
, &user_creds
);
2966 * Validate that either the current trigger credentials and the
2967 * client credentials are identical or that the current user is
2968 * root. The root user can register, unregister triggers for
2969 * himself and other users.
2971 * This check is also present on the sessiond side, using the
2972 * credentials passed on the socket. These check are all
2975 const struct lttng_credentials
*trigger_creds
=
2976 lttng_trigger_get_credentials(trigger
);
2978 if (!lttng_credentials_is_equal_uid(trigger_creds
, &user_creds
)) {
2979 if (lttng_credentials_get_uid(&user_creds
) != 0) {
2980 ret
= -LTTNG_ERR_EPERM
;
2981 goto end_unset_name
;
2986 if (!lttng_trigger_validate(trigger
)) {
2987 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
2988 goto end_unset_name
;
2991 domain_type
= lttng_trigger_get_underlying_domain_type_restriction(
2994 lsm
.domain
.type
= domain_type
;
2996 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
2998 ret
= -LTTNG_ERR_NOMEM
;
2999 goto end_unset_name
;
3002 ret
= lttng_trigger_serialize(trigger
, &message
);
3004 ret
= -LTTNG_ERR_UNK
;
3005 goto end_unset_name
;
3009 * This is needed to populate the trigger object size for the command
3012 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3014 message_lsm
->u
.trigger
.length
= (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3017 struct lttng_payload_view message_view
=
3018 lttng_payload_view_from_payload(
3021 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3023 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3025 goto end_unset_name
;
3030 struct lttng_payload_view reply_view
=
3031 lttng_payload_view_from_payload(
3032 &reply
, 0, reply
.buffer
.size
);
3034 ret
= lttng_trigger_create_from_payload(
3035 &reply_view
, &reply_trigger
);
3037 ret
= -LTTNG_ERR_INVALID_PROTOCOL
;
3038 goto end_unset_name
;
3042 if (name
|| generate_name
) {
3043 ret
= lttng_trigger_assign_name(trigger
, reply_trigger
);
3045 ret
= -LTTNG_ERR_NOMEM
;
3054 trigger_status
= lttng_trigger_set_name(trigger
, NULL
);
3055 if (trigger_status
!= LTTNG_TRIGGER_STATUS_OK
) {
3056 ret
= -LTTNG_ERR_UNK
;
3059 lttng_payload_reset(&message
);
3060 lttng_payload_reset(&reply
);
3061 lttng_trigger_destroy(reply_trigger
);
3065 int lttng_register_trigger(struct lttng_trigger
*trigger
)
3067 /* Register an anonymous trigger. */
3068 return _lttng_register_trigger(trigger
, NULL
, false);
3071 enum lttng_error_code
lttng_register_trigger_with_name(
3072 struct lttng_trigger
*trigger
, const char *name
)
3074 const int ret
= _lttng_register_trigger(trigger
, name
, false);
3076 return ret
== 0 ? LTTNG_OK
: (enum lttng_error_code
) -ret
;
3079 enum lttng_error_code
lttng_register_trigger_with_automatic_name(
3080 struct lttng_trigger
*trigger
)
3082 const int ret
= _lttng_register_trigger(trigger
, false, true);
3084 return ret
== 0 ? LTTNG_OK
: (enum lttng_error_code
) -ret
;
3087 enum lttng_error_code
lttng_error_query_execute(
3088 const struct lttng_error_query
*query
,
3089 const struct lttng_endpoint
*endpoint
,
3090 struct lttng_error_query_results
**results
)
3093 enum lttng_error_code ret_code
;
3094 struct lttcomm_session_msg lsm
= {
3095 .cmd_type
= LTTNG_EXECUTE_ERROR_QUERY
,
3097 struct lttng_payload message
;
3098 struct lttng_payload reply
;
3099 struct lttcomm_session_msg
*message_lsm
;
3101 lttng_payload_init(&message
);
3102 lttng_payload_init(&reply
);
3104 if (!query
|| !results
) {
3105 ret_code
= LTTNG_ERR_INVALID
;
3109 if (endpoint
!= lttng_session_daemon_command_endpoint
) {
3110 ret_code
= LTTNG_ERR_INVALID_ERROR_QUERY_TARGET
;
3114 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3116 ret_code
= LTTNG_ERR_NOMEM
;
3120 ret
= lttng_error_query_serialize(query
, &message
);
3122 ret_code
= LTTNG_ERR_UNK
;
3126 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3127 message_lsm
->u
.error_query
.length
=
3128 (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3131 struct lttng_payload_view message_view
=
3132 lttng_payload_view_from_payload(
3135 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3137 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3145 ssize_t reply_create_ret
;
3146 struct lttng_payload_view reply_view
=
3147 lttng_payload_view_from_payload(
3148 &reply
, 0, reply
.buffer
.size
);
3150 reply_create_ret
= lttng_error_query_results_create_from_payload(
3151 &reply_view
, results
);
3152 if (reply_create_ret
< 0) {
3153 ret_code
= LTTNG_ERR_INVALID_PROTOCOL
;
3158 ret_code
= LTTNG_OK
;
3160 lttng_payload_reset(&message
);
3161 lttng_payload_reset(&reply
);
3165 int lttng_unregister_trigger(const struct lttng_trigger
*trigger
)
3168 struct lttcomm_session_msg lsm
;
3169 struct lttcomm_session_msg
*message_lsm
;
3170 struct lttng_payload message
;
3171 struct lttng_payload reply
;
3172 struct lttng_trigger
*copy
= NULL
;
3173 const struct lttng_credentials user_creds
= {
3174 .uid
= LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3175 .gid
= LTTNG_OPTIONAL_INIT_UNSET
,
3178 lttng_payload_init(&message
);
3179 lttng_payload_init(&reply
);
3182 ret
= -LTTNG_ERR_INVALID
;
3186 copy
= lttng_trigger_copy(trigger
);
3188 ret
= -LTTNG_ERR_UNK
;
3192 if (!copy
->creds
.uid
.is_set
) {
3193 /* Use the client credentials as the trigger credentials */
3194 lttng_trigger_set_credentials(copy
, &user_creds
);
3197 * Validate that either the current trigger credentials and the
3198 * client credentials are identical or that the current user is
3199 * root. The root user can register, unregister triggers for
3200 * himself and other users.
3202 * This check is also present on the sessiond side, using the
3203 * credentials passed on the socket. These check are all
3206 const struct lttng_credentials
*trigger_creds
=
3207 lttng_trigger_get_credentials(copy
);
3208 if (!lttng_credentials_is_equal_uid(trigger_creds
, &user_creds
)) {
3209 if (lttng_credentials_get_uid(&user_creds
) != 0) {
3210 ret
= -LTTNG_ERR_EPERM
;
3216 if (!lttng_trigger_validate(copy
)) {
3217 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3221 memset(&lsm
, 0, sizeof(lsm
));
3222 lsm
.cmd_type
= LTTNG_UNREGISTER_TRIGGER
;
3224 ret
= lttng_dynamic_buffer_append(&message
.buffer
, &lsm
, sizeof(lsm
));
3226 ret
= -LTTNG_ERR_NOMEM
;
3230 ret
= lttng_trigger_serialize(copy
, &message
);
3232 ret
= -LTTNG_ERR_UNK
;
3237 * This is needed to populate the trigger object size for the command
3238 * header and number of fds sent.
3240 message_lsm
= (struct lttcomm_session_msg
*) message
.buffer
.data
;
3242 message_lsm
->u
.trigger
.length
= (uint32_t) message
.buffer
.size
- sizeof(lsm
);
3245 struct lttng_payload_view message_view
=
3246 lttng_payload_view_from_payload(
3250 * Update the message header with the number of fd that will be
3253 message_lsm
->fd_count
= lttng_payload_view_get_fd_handle_count(
3256 ret
= lttng_ctl_ask_sessiond_payload(&message_view
, &reply
);
3264 lttng_trigger_destroy(copy
);
3265 lttng_payload_reset(&message
);
3266 lttng_payload_reset(&reply
);
3271 * Ask the session daemon for all registered triggers for the current user.
3273 * Allocates and return an lttng_triggers set.
3274 * On error, returns a suitable lttng_error_code.
3276 enum lttng_error_code
lttng_list_triggers(struct lttng_triggers
**triggers
)
3279 enum lttng_error_code ret_code
= LTTNG_OK
;
3280 struct lttcomm_session_msg lsm
= { .cmd_type
= LTTNG_LIST_TRIGGERS
};
3281 struct lttng_triggers
*local_triggers
= NULL
;
3282 struct lttng_payload reply
;
3283 struct lttng_payload_view lsm_view
=
3284 lttng_payload_view_init_from_buffer(
3285 (const char *) &lsm
, 0, sizeof(lsm
));
3287 lttng_payload_init(&reply
);
3289 ret
= lttng_ctl_ask_sessiond_payload(&lsm_view
, &reply
);
3291 ret_code
= (enum lttng_error_code
) -ret
;
3296 struct lttng_payload_view reply_view
=
3297 lttng_payload_view_from_payload(
3298 &reply
, 0, reply
.buffer
.size
);
3300 ret
= lttng_triggers_create_from_payload(
3301 &reply_view
, &local_triggers
);
3303 ret_code
= LTTNG_ERR_FATAL
;
3308 *triggers
= local_triggers
;
3309 local_triggers
= NULL
;
3311 lttng_payload_reset(&reply
);
3312 lttng_triggers_destroy(local_triggers
);
3319 static void __attribute__((constructor
)) init(void)
3321 /* Set default session group */
3322 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
3328 static void __attribute__((destructor
)) lttng_ctl_exit(void)
3330 free(tracing_group
);