4 * Linux Trace Toolkit Control Library
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
7 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * This library is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License, version 2.1 only,
11 * as published by the Free Software Foundation.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this library; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
32 #include <common/common.h>
33 #include <common/compat/string.h>
34 #include <common/defaults.h>
35 #include <common/sessiond-comm/sessiond-comm.h>
36 #include <common/uri.h>
37 #include <common/utils.h>
38 #include <common/dynamic-buffer.h>
39 #include <lttng/lttng.h>
40 #include <lttng/health-internal.h>
41 #include <lttng/trigger/trigger-internal.h>
42 #include <lttng/endpoint.h>
43 #include <lttng/channel-internal.h>
44 #include <lttng/event-internal.h>
45 #include <lttng/userspace-probe-internal.h>
46 #include <lttng/session-internal.h>
47 #include <lttng/session-descriptor-internal.h>
48 #include <lttng/destruction-handle.h>
50 #include "filter/filter-ast.h"
51 #include "filter/filter-parser.h"
52 #include "filter/filter-bytecode.h"
53 #include "filter/memstream.h"
54 #include "lttng-ctl-helper.h"
57 static const int print_xml
= 1;
58 #define dbg_printf(fmt, args...) \
59 printf("[debug liblttng-ctl] " fmt, ## args)
61 static const int print_xml
= 0;
62 #define dbg_printf(fmt, args...) \
64 /* do nothing but check printf format */ \
66 printf("[debug liblttnctl] " fmt, ## args); \
70 #define COPY_DOMAIN_PACKED(dst, src) \
72 struct lttng_domain _tmp_domain; \
74 lttng_ctl_copy_lttng_domain(&_tmp_domain, &src); \
78 /* Socket to session daemon for communication */
79 static int sessiond_socket
= -1;
80 static char sessiond_sock_path
[PATH_MAX
];
83 static char *tracing_group
;
89 * Those two variables are used by error.h to silent or control the verbosity of
90 * error message. They are global to the library so application linking with it
91 * are able to compile correctly and also control verbosity of the library.
94 int lttng_opt_verbose
;
98 * Copy string from src to dst and enforce null terminated byte.
101 void lttng_ctl_copy_string(char *dst
, const char *src
, size_t len
)
104 strncpy(dst
, src
, len
);
105 /* Enforce the NULL terminated byte */
113 * Copy domain to lttcomm_session_msg domain.
115 * If domain is unknown, default domain will be the kernel.
118 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
119 struct lttng_domain
*src
)
123 case LTTNG_DOMAIN_KERNEL
:
124 case LTTNG_DOMAIN_UST
:
125 case LTTNG_DOMAIN_JUL
:
126 case LTTNG_DOMAIN_LOG4J
:
127 case LTTNG_DOMAIN_PYTHON
:
128 memcpy(dst
, src
, sizeof(struct lttng_domain
));
131 memset(dst
, 0, sizeof(struct lttng_domain
));
138 * Send lttcomm_session_msg to the session daemon.
140 * On success, returns the number of bytes sent (>=0)
141 * On error, returns -1
143 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
148 ret
= -LTTNG_ERR_NO_SESSIOND
;
152 DBG("LSM cmd type : %d", lsm
->cmd_type
);
154 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
155 sizeof(struct lttcomm_session_msg
));
157 ret
= -LTTNG_ERR_FATAL
;
165 * Send var len data to the session daemon.
167 * On success, returns the number of bytes sent (>=0)
168 * On error, returns -1
170 static int send_session_varlen(const void *data
, size_t len
)
175 ret
= -LTTNG_ERR_NO_SESSIOND
;
184 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
186 ret
= -LTTNG_ERR_FATAL
;
194 * Send file descriptors to the session daemon.
196 * On success, returns the number of bytes sent (>=0)
197 * On error, returns -1
199 static int send_session_fds(const int *fds
, size_t nb_fd
)
204 ret
= -LTTNG_ERR_NO_SESSIOND
;
208 if (!fds
|| !nb_fd
) {
213 ret
= lttcomm_send_fds_unix_sock(sessiond_socket
, fds
, nb_fd
);
215 ret
= -LTTNG_ERR_FATAL
;
223 * Receive data from the sessiond socket.
225 * On success, returns the number of bytes received (>=0)
226 * On error, returns -1 (recvmsg() error) or -ENOTCONN
228 static int recv_data_sessiond(void *buf
, size_t len
)
233 ret
= -LTTNG_ERR_NO_SESSIOND
;
237 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
239 ret
= -LTTNG_ERR_FATAL
;
247 * Check if we are in the specified group.
249 * If yes return 1, else return -1.
252 int lttng_check_tracing_group(void)
254 gid_t
*grp_list
, tracing_gid
;
255 int grp_list_size
, grp_id
, i
;
257 const char *grp_name
= tracing_group
;
259 /* Get GID of group 'tracing' */
260 if (utils_get_group_id(grp_name
, false, &tracing_gid
)) {
261 /* If grp_tracing is NULL, the group does not exist. */
265 /* Get number of supplementary group IDs */
266 grp_list_size
= getgroups(0, NULL
);
267 if (grp_list_size
< 0) {
272 /* Alloc group list of the right size */
273 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
278 grp_id
= getgroups(grp_list_size
, grp_list
);
284 for (i
= 0; i
< grp_list_size
; i
++) {
285 if (grp_list
[i
] == tracing_gid
) {
298 static int check_enough_available_memory(size_t num_bytes_requested_per_cpu
)
302 size_t best_mem_info
;
303 size_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
);
314 num_bytes_requested_total
= num_bytes_requested_per_cpu
* num_cpu
;
317 * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
318 * reliable estimate we can get but it is only exposed by the kernel
319 * since 3.14. (See Linux kernel commit:
320 * 34e431b0ae398fc54ea69ff85ec700722c9da773)
322 ret
= utils_get_memory_available(&best_mem_info
);
328 * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This
329 * is a sanity check for obvious user error.
331 ret
= utils_get_memory_total(&best_mem_info
);
339 return best_mem_info
>= num_bytes_requested_total
;
343 * Try connect to session daemon with sock_path.
345 * Return 0 on success, else -1
347 static int try_connect_sessiond(const char *sock_path
)
351 /* If socket exist, we check if the daemon listens for connect. */
352 ret
= access(sock_path
, F_OK
);
358 ret
= lttcomm_connect_unix_sock(sock_path
);
364 ret
= lttcomm_close_unix_sock(ret
);
366 PERROR("lttcomm_close_unix_sock");
376 * Set sessiond socket path by putting it in the global sessiond_sock_path
379 * Returns 0 on success, negative value on failure (the sessiond socket path
380 * is somehow too long or ENOMEM).
382 static int set_session_daemon_path(void)
384 int in_tgroup
= 0; /* In tracing group. */
390 /* Are we in the tracing group ? */
391 in_tgroup
= lttng_check_tracing_group();
394 if ((uid
== 0) || in_tgroup
) {
395 lttng_ctl_copy_string(sessiond_sock_path
,
396 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
, sizeof(sessiond_sock_path
));
404 ret
= try_connect_sessiond(sessiond_sock_path
);
408 /* Global session daemon not available... */
410 /* ...or not in tracing group (and not root), default */
413 * With GNU C < 2.1, snprintf returns -1 if the target buffer
415 * With GNU C >= 2.1, snprintf returns the required size
416 * (excluding closing null)
418 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
419 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
420 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
432 * Connect to the LTTng session daemon.
434 * On success, return the socket's file descriptor. On error, return -1.
436 LTTNG_HIDDEN
int connect_sessiond(void)
440 ret
= set_session_daemon_path();
445 /* Connect to the sesssion daemon. */
446 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
457 static void reset_global_sessiond_connection_state(void)
459 sessiond_socket
= -1;
464 * Clean disconnect from the session daemon.
466 * On success, return 0. On error, return -1.
468 static int disconnect_sessiond(void)
473 ret
= lttcomm_close_unix_sock(sessiond_socket
);
474 reset_global_sessiond_connection_state();
480 static int recv_sessiond_optional_data(size_t len
, void **user_buf
,
488 ret
= -LTTNG_ERR_INVALID
;
498 ret
= recv_data_sessiond(buf
, len
);
504 ret
= -LTTNG_ERR_INVALID
;
508 /* Move ownership of command header buffer to user. */
513 /* No command header. */
529 * Ask the session daemon a specific command and put the data into buf.
530 * Takes extra var. len. data and file descriptors as input to send to the
533 * Return size of data (only payload, not header) or a negative error code.
536 int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg
*lsm
,
537 const int *fds
, size_t nb_fd
, const void *vardata
,
538 size_t vardata_len
, void **user_payload_buf
,
539 void **user_cmd_header_buf
, size_t *user_cmd_header_len
)
543 struct lttcomm_lttng_msg llm
;
545 ret
= connect_sessiond();
547 ret
= -LTTNG_ERR_NO_SESSIOND
;
550 sessiond_socket
= ret
;
554 /* Send command to session daemon */
555 ret
= send_session_msg(lsm
);
557 /* Ret value is a valid lttng error code. */
560 /* Send var len data */
561 ret
= send_session_varlen(vardata
, vardata_len
);
563 /* Ret value is a valid lttng error code. */
568 ret
= send_session_fds(fds
, nb_fd
);
570 /* Ret value is a valid lttng error code. */
574 /* Get header from data transmission */
575 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
577 /* Ret value is a valid lttng error code. */
581 /* Check error code if OK */
582 if (llm
.ret_code
!= LTTNG_OK
) {
587 /* Get command header from data transmission */
588 ret
= recv_sessiond_optional_data(llm
.cmd_header_size
,
589 user_cmd_header_buf
, user_cmd_header_len
);
594 /* Get payload from data transmission */
595 ret
= recv_sessiond_optional_data(llm
.data_size
, user_payload_buf
,
604 disconnect_sessiond();
609 * Create lttng handle and return pointer.
611 * The returned pointer will be NULL in case of malloc() error.
613 struct lttng_handle
*lttng_create_handle(const char *session_name
,
614 struct lttng_domain
*domain
)
616 struct lttng_handle
*handle
= NULL
;
618 handle
= zmalloc(sizeof(struct lttng_handle
));
619 if (handle
== NULL
) {
620 PERROR("malloc handle");
624 /* Copy session name */
625 lttng_ctl_copy_string(handle
->session_name
, session_name
,
626 sizeof(handle
->session_name
));
628 /* Copy lttng domain or leave initialized to 0. */
630 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
638 * Destroy handle by free(3) the pointer.
640 void lttng_destroy_handle(struct lttng_handle
*handle
)
646 * Register an outside consumer.
648 * Returns size of returned session payload data or a negative error code.
650 int lttng_register_consumer(struct lttng_handle
*handle
,
651 const char *socket_path
)
653 struct lttcomm_session_msg lsm
;
655 if (handle
== NULL
|| socket_path
== NULL
) {
656 return -LTTNG_ERR_INVALID
;
659 memset(&lsm
, 0, sizeof(lsm
));
660 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
661 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
662 sizeof(lsm
.session
.name
));
663 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
665 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
,
666 sizeof(lsm
.u
.reg
.path
));
668 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
672 * Start tracing for all traces of the session.
674 * Returns size of returned session payload data or a negative error code.
676 int lttng_start_tracing(const char *session_name
)
678 struct lttcomm_session_msg lsm
;
680 if (session_name
== NULL
) {
681 return -LTTNG_ERR_INVALID
;
684 memset(&lsm
, 0, sizeof(lsm
));
685 lsm
.cmd_type
= LTTNG_START_TRACE
;
687 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
688 sizeof(lsm
.session
.name
));
690 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
694 * Stop tracing for all traces of the session.
696 static int _lttng_stop_tracing(const char *session_name
, int wait
)
699 struct lttcomm_session_msg lsm
;
701 if (session_name
== NULL
) {
702 return -LTTNG_ERR_INVALID
;
705 memset(&lsm
, 0, sizeof(lsm
));
706 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
708 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
709 sizeof(lsm
.session
.name
));
711 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
712 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
720 /* Check for data availability */
722 data_ret
= lttng_data_pending(session_name
);
724 /* Return the data available call error. */
730 * Data sleep time before retrying (in usec). Don't sleep if the
731 * call returned value indicates availability.
734 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US
);
736 } while (data_ret
!= 0);
744 * Stop tracing and wait for data availability.
746 int lttng_stop_tracing(const char *session_name
)
748 return _lttng_stop_tracing(session_name
, 1);
752 * Stop tracing but _don't_ wait for data availability.
754 int lttng_stop_tracing_no_wait(const char *session_name
)
756 return _lttng_stop_tracing(session_name
, 0);
760 * Add context to a channel.
762 * If the given channel is NULL, add the contexts to all channels.
763 * The event_name param is ignored.
765 * Returns the size of the returned payload data or a negative error code.
767 int lttng_add_context(struct lttng_handle
*handle
,
768 struct lttng_event_context
*ctx
, const char *event_name
,
769 const char *channel_name
)
774 struct lttcomm_session_msg lsm
;
776 /* Safety check. Both are mandatory. */
777 if (handle
== NULL
|| ctx
== NULL
) {
778 ret
= -LTTNG_ERR_INVALID
;
782 memset(&lsm
, 0, sizeof(lsm
));
783 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
785 /* If no channel name, send empty string. */
786 if (channel_name
== NULL
) {
787 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
788 sizeof(lsm
.u
.context
.channel_name
));
790 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
791 sizeof(lsm
.u
.context
.channel_name
));
794 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
795 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
796 sizeof(lsm
.session
.name
));
798 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
799 size_t provider_len
, ctx_len
;
800 const char *provider_name
= ctx
->u
.app_ctx
.provider_name
;
801 const char *ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
803 if (!provider_name
|| !ctx_name
) {
804 ret
= -LTTNG_ERR_INVALID
;
808 provider_len
= strlen(provider_name
);
809 if (provider_len
== 0) {
810 ret
= -LTTNG_ERR_INVALID
;
813 lsm
.u
.context
.provider_name_len
= provider_len
;
815 ctx_len
= strlen(ctx_name
);
817 ret
= -LTTNG_ERR_INVALID
;
820 lsm
.u
.context
.context_name_len
= ctx_len
;
822 len
= provider_len
+ ctx_len
;
825 ret
= -LTTNG_ERR_NOMEM
;
829 memcpy(buf
, provider_name
, provider_len
);
830 memcpy(buf
+ provider_len
, ctx_name
, ctx_len
);
832 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
834 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
836 * Don't leak application addresses to the sessiond.
837 * This is only necessary when ctx is for an app ctx otherwise
838 * the values inside the union (type & config) are overwritten.
840 lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
841 lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
844 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buf
, len
, NULL
);
851 * Enable event(s) for a channel.
853 * If no event name is specified, all events are enabled.
854 * If no channel name is specified, the default 'channel0' is used.
856 * Returns size of returned session payload data or a negative error code.
858 int lttng_enable_event(struct lttng_handle
*handle
,
859 struct lttng_event
*ev
, const char *channel_name
)
861 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
866 * Create or enable an event with a filter expression.
868 * Return negative error value on error.
869 * Return size of returned session payload data if OK.
871 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
872 struct lttng_event
*event
, const char *channel_name
,
873 const char *filter_expression
)
875 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
876 filter_expression
, 0, NULL
);
880 * Depending on the event, return a newly allocated agent filter expression or
881 * NULL if not applicable.
883 * An event with NO loglevel and the name is * will return NULL.
885 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
888 char *agent_filter
= NULL
;
892 /* Don't add filter for the '*' event. */
893 if (strcmp(ev
->name
, "*") != 0) {
895 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
898 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
906 /* Add loglevel filtering if any for the JUL domain. */
907 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
910 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
916 if (filter
|| agent_filter
) {
919 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
920 agent_filter
? agent_filter
: filter
, op
,
925 agent_filter
= new_filter
;
927 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
943 * Generate the filter bytecode from a given filter expression string. Put the
944 * newly allocated parser context in ctxp and populate the lsm object with the
947 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
949 static int generate_filter(char *filter_expression
,
950 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
953 struct filter_parser_ctx
*ctx
= NULL
;
956 assert(filter_expression
);
961 * Casting const to non-const, as the underlying function will use it in
964 fmem
= lttng_fmemopen((void *) filter_expression
,
965 strlen(filter_expression
), "r");
967 fprintf(stderr
, "Error opening memory as stream\n");
968 ret
= -LTTNG_ERR_FILTER_NOMEM
;
971 ctx
= filter_parser_ctx_alloc(fmem
);
973 fprintf(stderr
, "Error allocating parser\n");
974 ret
= -LTTNG_ERR_FILTER_NOMEM
;
975 goto filter_alloc_error
;
977 ret
= filter_parser_ctx_append_ast(ctx
);
979 fprintf(stderr
, "Parse error\n");
980 ret
= -LTTNG_ERR_FILTER_INVAL
;
984 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
987 fprintf(stderr
, "XML print error\n");
988 ret
= -LTTNG_ERR_FILTER_INVAL
;
993 dbg_printf("Generating IR... ");
995 ret
= filter_visitor_ir_generate(ctx
);
997 fprintf(stderr
, "Generate IR error\n");
998 ret
= -LTTNG_ERR_FILTER_INVAL
;
1001 dbg_printf("done\n");
1003 dbg_printf("Validating IR... ");
1005 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
1007 ret
= -LTTNG_ERR_FILTER_INVAL
;
1011 /* Normalize globbing patterns in the expression. */
1012 ret
= filter_visitor_ir_normalize_glob_patterns(ctx
);
1014 ret
= -LTTNG_ERR_FILTER_INVAL
;
1018 /* Validate strings used as literals in the expression. */
1019 ret
= filter_visitor_ir_validate_string(ctx
);
1021 ret
= -LTTNG_ERR_FILTER_INVAL
;
1025 /* Validate globbing patterns in the expression. */
1026 ret
= filter_visitor_ir_validate_globbing(ctx
);
1028 ret
= -LTTNG_ERR_FILTER_INVAL
;
1032 dbg_printf("done\n");
1034 dbg_printf("Generating bytecode... ");
1036 ret
= filter_visitor_bytecode_generate(ctx
);
1038 fprintf(stderr
, "Generate bytecode error\n");
1039 ret
= -LTTNG_ERR_FILTER_INVAL
;
1042 dbg_printf("done\n");
1043 dbg_printf("Size of bytecode generated: %u bytes.\n",
1044 bytecode_get_len(&ctx
->bytecode
->b
));
1046 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
1047 + bytecode_get_len(&ctx
->bytecode
->b
);
1048 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
1050 /* No need to keep the memory stream. */
1051 if (fclose(fmem
) != 0) {
1059 filter_ir_free(ctx
);
1060 filter_parser_ctx_free(ctx
);
1062 if (fclose(fmem
) != 0) {
1070 * Enable event(s) for a channel, possibly with exclusions and a filter.
1071 * If no event name is specified, all events are enabled.
1072 * If no channel name is specified, the default name is used.
1073 * If filter expression is not NULL, the filter is set for the event.
1074 * If exclusion count is not zero, the exclusions are set for the event.
1075 * Returns size of returned session payload data or a negative error code.
1077 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
1078 struct lttng_event
*ev
, const char *channel_name
,
1079 const char *original_filter_expression
,
1080 int exclusion_count
, char **exclusion_list
)
1082 struct lttcomm_session_msg lsm
;
1083 struct lttng_dynamic_buffer send_buffer
;
1084 int ret
= 0, i
, fd_to_send
= -1;
1085 bool send_fd
= false;
1086 unsigned int free_filter_expression
= 0;
1087 struct filter_parser_ctx
*ctx
= NULL
;
1090 * We have either a filter or some exclusions, so we need to set up
1091 * a variable-length memory block from where to send the data.
1093 lttng_dynamic_buffer_init(&send_buffer
);
1096 * Cast as non-const since we may replace the filter expression
1097 * by a dynamically allocated string. Otherwise, the original
1098 * string is not modified.
1100 char *filter_expression
= (char *) original_filter_expression
;
1102 if (handle
== NULL
|| ev
== NULL
) {
1103 ret
= -LTTNG_ERR_INVALID
;
1108 * Empty filter string will always be rejected by the parser
1109 * anyway, so treat this corner-case early to eliminate
1110 * lttng_fmemopen error for 0-byte allocation.
1112 if (filter_expression
&& filter_expression
[0] == '\0') {
1113 ret
= -LTTNG_ERR_INVALID
;
1117 memset(&lsm
, 0, sizeof(lsm
));
1119 /* If no channel name, send empty string. */
1120 if (channel_name
== NULL
) {
1121 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
1122 sizeof(lsm
.u
.enable
.channel_name
));
1124 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
1125 sizeof(lsm
.u
.enable
.channel_name
));
1128 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1129 if (ev
->name
[0] == '\0') {
1130 /* Enable all events */
1131 lttng_ctl_copy_string(ev
->name
, "*", sizeof(ev
->name
));
1134 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1135 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1137 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1138 sizeof(lsm
.session
.name
));
1139 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1140 lsm
.u
.enable
.bytecode_len
= 0;
1142 /* Parse filter expression. */
1143 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1144 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1145 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1146 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1147 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1148 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1151 /* Setup JUL filter if needed. */
1152 agent_filter
= set_agent_filter(filter_expression
, ev
);
1153 if (!agent_filter
) {
1154 if (!filter_expression
) {
1156 * No JUL and no filter, just skip
1163 * With an agent filter, the original filter has
1164 * been added to it thus replace the filter
1167 filter_expression
= agent_filter
;
1168 free_filter_expression
= 1;
1172 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1178 ret
= lttng_dynamic_buffer_set_capacity(&send_buffer
,
1179 lsm
.u
.enable
.bytecode_len
1180 + lsm
.u
.enable
.expression_len
1181 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
1183 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1187 /* Put exclusion names first in the data. */
1188 for (i
= 0; i
< exclusion_count
; i
++) {
1189 size_t exclusion_len
;
1191 exclusion_len
= lttng_strnlen(*(exclusion_list
+ i
),
1192 LTTNG_SYMBOL_NAME_LEN
);
1193 if (exclusion_len
== LTTNG_SYMBOL_NAME_LEN
) {
1194 /* Exclusion is not NULL-terminated. */
1195 ret
= -LTTNG_ERR_INVALID
;
1199 ret
= lttng_dynamic_buffer_append(&send_buffer
,
1200 *(exclusion_list
+ i
),
1201 LTTNG_SYMBOL_NAME_LEN
);
1207 /* Add filter expression next. */
1208 if (filter_expression
) {
1209 ret
= lttng_dynamic_buffer_append(&send_buffer
,
1210 filter_expression
, lsm
.u
.enable
.expression_len
);
1215 /* Add filter bytecode next. */
1216 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1217 ret
= lttng_dynamic_buffer_append(&send_buffer
,
1218 &ctx
->bytecode
->b
, lsm
.u
.enable
.bytecode_len
);
1223 if (ev
->extended
.ptr
) {
1224 struct lttng_event_extended
*ev_ext
=
1225 (struct lttng_event_extended
*) ev
->extended
.ptr
;
1227 if (ev_ext
->probe_location
) {
1229 * lttng_userspace_probe_location_serialize returns the
1230 * number of bytes that was appended to the buffer.
1232 ret
= lttng_userspace_probe_location_serialize(
1233 ev_ext
->probe_location
, &send_buffer
,
1239 send_fd
= fd_to_send
>= 0;
1241 * Set the size of the userspace probe location element
1242 * of the buffer so that the receiving side knows where
1245 lsm
.u
.enable
.userspace_probe_location_len
= ret
;
1249 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
,
1250 send_fd
? &fd_to_send
: NULL
,
1252 send_buffer
.size
? send_buffer
.data
: NULL
,
1253 send_buffer
.size
, NULL
, NULL
, 0);
1256 if (filter_expression
&& ctx
) {
1257 filter_bytecode_free(ctx
);
1258 filter_ir_free(ctx
);
1259 filter_parser_ctx_free(ctx
);
1262 if (free_filter_expression
) {
1264 * The filter expression has been replaced and must be freed as
1265 * it is not the original filter expression received as a
1268 free(filter_expression
);
1272 * Return directly to the caller and don't ask the sessiond since
1273 * something went wrong in the parsing of data above.
1275 lttng_dynamic_buffer_reset(&send_buffer
);
1279 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1283 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1284 struct lttng_event
*ev
, const char *channel_name
,
1285 const char *original_filter_expression
)
1287 struct lttcomm_session_msg lsm
;
1290 unsigned int free_filter_expression
= 0;
1291 struct filter_parser_ctx
*ctx
= NULL
;
1293 * Cast as non-const since we may replace the filter expression
1294 * by a dynamically allocated string. Otherwise, the original
1295 * string is not modified.
1297 char *filter_expression
= (char *) original_filter_expression
;
1299 if (handle
== NULL
|| ev
== NULL
) {
1300 ret
= -LTTNG_ERR_INVALID
;
1305 * Empty filter string will always be rejected by the parser
1306 * anyway, so treat this corner-case early to eliminate
1307 * lttng_fmemopen error for 0-byte allocation.
1309 if (filter_expression
&& filter_expression
[0] == '\0') {
1310 ret
= -LTTNG_ERR_INVALID
;
1314 memset(&lsm
, 0, sizeof(lsm
));
1316 /* If no channel name, send empty string. */
1317 if (channel_name
== NULL
) {
1318 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1319 sizeof(lsm
.u
.disable
.channel_name
));
1321 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1322 sizeof(lsm
.u
.disable
.channel_name
));
1325 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1327 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1328 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1330 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1331 sizeof(lsm
.session
.name
));
1332 lsm
.u
.disable
.bytecode_len
= 0;
1335 * For the JUL domain, a filter is enforced except for the
1336 * disable all event. This is done to avoid having the event in
1337 * all sessions thus filtering by logger name.
1339 if (filter_expression
== NULL
&&
1340 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1341 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1342 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1347 * We have a filter, so we need to set up a variable-length
1348 * memory block from where to send the data.
1351 /* Parse filter expression */
1352 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1353 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1354 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1355 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1356 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1357 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1360 /* Setup JUL filter if needed. */
1361 agent_filter
= set_agent_filter(filter_expression
, ev
);
1362 if (!agent_filter
) {
1363 if (!filter_expression
) {
1365 * No JUL and no filter, just skip
1372 * With a JUL filter, the original filter has
1373 * been added to it thus replace the filter
1376 filter_expression
= agent_filter
;
1377 free_filter_expression
= 1;
1381 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1387 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1388 + lsm
.u
.disable
.expression_len
);
1390 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1394 /* Add filter expression. */
1395 if (lsm
.u
.disable
.expression_len
!= 0) {
1398 lsm
.u
.disable
.expression_len
);
1400 /* Add filter bytecode next. */
1401 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1403 + lsm
.u
.disable
.expression_len
,
1405 lsm
.u
.disable
.bytecode_len
);
1408 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1409 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1413 if (filter_expression
&& ctx
) {
1414 filter_bytecode_free(ctx
);
1415 filter_ir_free(ctx
);
1416 filter_parser_ctx_free(ctx
);
1419 if (free_filter_expression
) {
1421 * The filter expression has been replaced and must be freed as
1422 * it is not the original filter expression received as a
1425 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.
1435 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1440 * Disable event(s) of a channel and domain.
1441 * If no event name is specified, all events are disabled.
1442 * If no channel name is specified, the default 'channel0' is used.
1443 * Returns size of returned session payload data or a negative error code.
1445 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1446 const char *channel_name
)
1448 struct lttng_event ev
;
1450 memset(&ev
, 0, sizeof(ev
));
1452 ev
.type
= LTTNG_EVENT_ALL
;
1453 lttng_ctl_copy_string(ev
.name
, name
, sizeof(ev
.name
));
1454 return lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1457 struct lttng_channel
*lttng_channel_create(struct lttng_domain
*domain
)
1459 struct lttng_channel
*channel
= NULL
;
1460 struct lttng_channel_extended
*extended
= NULL
;
1466 /* Validate domain. */
1467 switch (domain
->type
) {
1468 case LTTNG_DOMAIN_UST
:
1469 switch (domain
->buf_type
) {
1470 case LTTNG_BUFFER_PER_UID
:
1471 case LTTNG_BUFFER_PER_PID
:
1477 case LTTNG_DOMAIN_KERNEL
:
1478 if (domain
->buf_type
!= LTTNG_BUFFER_GLOBAL
) {
1486 channel
= zmalloc(sizeof(*channel
));
1491 extended
= zmalloc(sizeof(*extended
));
1496 channel
->attr
.extended
.ptr
= extended
;
1498 lttng_channel_set_default_attr(domain
, &channel
->attr
);
1506 void lttng_channel_destroy(struct lttng_channel
*channel
)
1512 if (channel
->attr
.extended
.ptr
) {
1513 free(channel
->attr
.extended
.ptr
);
1519 * Enable channel per domain
1520 * Returns size of returned session payload data or a negative error code.
1522 int lttng_enable_channel(struct lttng_handle
*handle
,
1523 struct lttng_channel
*in_chan
)
1525 struct lttcomm_session_msg lsm
;
1526 size_t total_buffer_size_needed_per_cpu
= 0;
1528 /* NULL arguments are forbidden. No default values. */
1529 if (handle
== NULL
|| in_chan
== NULL
) {
1530 return -LTTNG_ERR_INVALID
;
1533 memset(&lsm
, 0, sizeof(lsm
));
1534 memcpy(&lsm
.u
.channel
.chan
, in_chan
, sizeof(lsm
.u
.channel
.chan
));
1535 lsm
.u
.channel
.chan
.attr
.extended
.ptr
= NULL
;
1537 if (!in_chan
->attr
.extended
.ptr
) {
1538 struct lttng_channel
*channel
;
1539 struct lttng_channel_extended
*extended
;
1541 channel
= lttng_channel_create(&handle
->domain
);
1543 return -LTTNG_ERR_NOMEM
;
1547 * Create a new channel in order to use default extended
1550 extended
= (struct lttng_channel_extended
*)
1551 channel
->attr
.extended
.ptr
;
1552 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1553 lttng_channel_destroy(channel
);
1555 struct lttng_channel_extended
*extended
;
1557 extended
= (struct lttng_channel_extended
*)
1558 in_chan
->attr
.extended
.ptr
;
1559 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1563 * Verify that the amount of memory required to create the requested
1564 * buffer is available on the system at the moment.
1566 total_buffer_size_needed_per_cpu
= lsm
.u
.channel
.chan
.attr
.num_subbuf
*
1567 lsm
.u
.channel
.chan
.attr
.subbuf_size
;
1568 if (!check_enough_available_memory(total_buffer_size_needed_per_cpu
)) {
1569 return -LTTNG_ERR_NOMEM
;
1572 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1573 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1575 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1576 sizeof(lsm
.session
.name
));
1578 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1582 * All tracing will be stopped for registered events of the channel.
1583 * Returns size of returned session payload data or a negative error code.
1585 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1587 struct lttcomm_session_msg lsm
;
1589 /* Safety check. Both are mandatory. */
1590 if (handle
== NULL
|| name
== NULL
) {
1591 return -LTTNG_ERR_INVALID
;
1594 memset(&lsm
, 0, sizeof(lsm
));
1596 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1598 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1599 sizeof(lsm
.u
.disable
.channel_name
));
1601 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1603 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1604 sizeof(lsm
.session
.name
));
1606 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1609 static int lttng_track_untrack_id(struct lttng_handle
*handle
,
1610 enum lttng_tracker_type tracker_type
,
1611 const struct lttng_tracker_id
*id
,
1612 enum lttcomm_sessiond_command cmd
)
1614 struct lttcomm_session_msg lsm
;
1615 char *var_data
= NULL
;
1616 size_t var_data_len
= 0;
1618 /* NULL arguments are forbidden. No default values. */
1619 if (handle
== NULL
) {
1620 return -LTTNG_ERR_INVALID
;
1623 memset(&lsm
, 0, sizeof(lsm
));
1626 lsm
.u
.id_tracker
.tracker_type
= tracker_type
;
1627 lsm
.u
.id_tracker
.id_type
= id
->type
;
1631 case LTTNG_ID_VALUE
:
1632 lsm
.u
.id_tracker
.u
.value
= id
->value
;
1634 case LTTNG_ID_STRING
:
1635 var_data
= id
->string
;
1636 var_data_len
= strlen(var_data
) + 1; /* Includes \0. */
1637 lsm
.u
.id_tracker
.u
.var_len
= var_data_len
;
1640 return -LTTNG_ERR_INVALID
;
1643 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1645 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1646 sizeof(lsm
.session
.name
));
1648 return lttng_ctl_ask_sessiond_varlen_no_cmd_header(
1649 &lsm
, var_data
, var_data_len
, NULL
);
1653 * Add ID to session tracker.
1654 * Return 0 on success else a negative LTTng error code.
1656 int lttng_track_id(struct lttng_handle
*handle
,
1657 enum lttng_tracker_type tracker_type
,
1658 const struct lttng_tracker_id
*id
)
1660 return lttng_track_untrack_id(handle
, tracker_type
, id
, LTTNG_TRACK_ID
);
1664 * Remove ID from session tracker.
1665 * Return 0 on success else a negative LTTng error code.
1667 int lttng_untrack_id(struct lttng_handle
*handle
,
1668 enum lttng_tracker_type tracker_type
,
1669 const struct lttng_tracker_id
*id
)
1671 return lttng_track_untrack_id(
1672 handle
, tracker_type
, id
, LTTNG_UNTRACK_ID
);
1676 * Add PID to session tracker.
1677 * Return 0 on success else a negative LTTng error code.
1679 int lttng_track_pid(struct lttng_handle
*handle
, int pid
)
1681 struct lttng_tracker_id id
;
1683 id
.type
= LTTNG_TRACKER_PID
;
1685 return lttng_track_id(handle
, LTTNG_TRACKER_PID
, &id
);
1689 * Remove PID from session tracker.
1690 * Return 0 on success else a negative LTTng error code.
1692 int lttng_untrack_pid(struct lttng_handle
*handle
, int pid
)
1694 struct lttng_tracker_id id
;
1696 id
.type
= LTTNG_TRACKER_PID
;
1698 return lttng_untrack_id(handle
, LTTNG_TRACKER_PID
, &id
);
1702 * Lists all available tracepoints of domain.
1703 * Sets the contents of the events array.
1704 * Returns the number of lttng_event entries in events;
1705 * on error, returns a negative value.
1707 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1708 struct lttng_event
**events
)
1711 struct lttcomm_session_msg lsm
;
1713 if (handle
== NULL
) {
1714 return -LTTNG_ERR_INVALID
;
1717 memset(&lsm
, 0, sizeof(lsm
));
1718 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1719 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1721 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1726 return ret
/ sizeof(struct lttng_event
);
1730 * Lists all available tracepoint fields of domain.
1731 * Sets the contents of the event field array.
1732 * Returns the number of lttng_event_field entries in events;
1733 * on error, returns a negative value.
1735 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1736 struct lttng_event_field
**fields
)
1739 struct lttcomm_session_msg lsm
;
1741 if (handle
== NULL
) {
1742 return -LTTNG_ERR_INVALID
;
1745 memset(&lsm
, 0, sizeof(lsm
));
1746 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1747 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
1749 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1754 return ret
/ sizeof(struct lttng_event_field
);
1758 * Lists all available kernel system calls. Allocates and sets the contents of
1761 * Returns the number of lttng_event entries in events; on error, returns a
1764 int lttng_list_syscalls(struct lttng_event
**events
)
1767 struct lttcomm_session_msg lsm
;
1770 return -LTTNG_ERR_INVALID
;
1773 memset(&lsm
, 0, sizeof(lsm
));
1774 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1775 /* Force kernel domain for system calls. */
1776 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1778 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1783 return ret
/ sizeof(struct lttng_event
);
1787 * Returns a human readable string describing
1788 * the error code (a negative value).
1790 const char *lttng_strerror(int code
)
1792 return error_get_str(code
);
1795 enum lttng_error_code
lttng_create_session_ext(
1796 struct lttng_session_descriptor
*session_descriptor
)
1798 enum lttng_error_code ret_code
;
1799 struct lttcomm_session_msg lsm
= {
1800 .cmd_type
= LTTNG_CREATE_SESSION_EXT
,
1803 struct lttng_buffer_view reply_view
;
1805 bool sessiond_must_generate_ouput
;
1806 struct lttng_dynamic_buffer payload
;
1808 size_t descriptor_size
;
1809 struct lttng_session_descriptor
*descriptor_reply
= NULL
;
1811 lttng_dynamic_buffer_init(&payload
);
1812 if (!session_descriptor
) {
1813 ret_code
= LTTNG_ERR_INVALID
;
1817 sessiond_must_generate_ouput
=
1818 !lttng_session_descriptor_is_output_destination_initialized(
1819 session_descriptor
);
1820 if (sessiond_must_generate_ouput
) {
1821 const char *home_dir
= utils_get_home_dir();
1822 size_t home_dir_len
= home_dir
? strlen(home_dir
) + 1 : 0;
1824 if (!home_dir
|| home_dir_len
> LTTNG_PATH_MAX
) {
1825 ret_code
= LTTNG_ERR_FATAL
;
1829 lsm
.u
.create_session
.home_dir_size
= (uint16_t) home_dir_len
;
1830 ret
= lttng_dynamic_buffer_append(&payload
, home_dir
,
1833 ret_code
= LTTNG_ERR_NOMEM
;
1838 descriptor_size
= payload
.size
;
1839 ret
= lttng_session_descriptor_serialize(session_descriptor
,
1842 ret_code
= LTTNG_ERR_INVALID
;
1845 descriptor_size
= payload
.size
- descriptor_size
;
1846 lsm
.u
.create_session
.session_descriptor_size
= descriptor_size
;
1848 /* Command returns a session descriptor on success. */
1849 reply_ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, payload
.data
,
1850 payload
.size
, &reply
);
1851 if (reply_ret
< 0) {
1852 ret_code
= -reply_ret
;
1854 } else if (reply_ret
== 0) {
1855 /* Socket unexpectedly closed by the session daemon. */
1856 ret_code
= LTTNG_ERR_FATAL
;
1860 reply_view
= lttng_buffer_view_init(reply
, 0, reply_ret
);
1861 ret
= lttng_session_descriptor_create_from_buffer(&reply_view
,
1864 ret_code
= LTTNG_ERR_FATAL
;
1867 ret_code
= LTTNG_OK
;
1868 lttng_session_descriptor_assign(session_descriptor
, descriptor_reply
);
1871 lttng_dynamic_buffer_reset(&payload
);
1872 lttng_session_descriptor_destroy(descriptor_reply
);
1877 * Create a new session using name and url for destination.
1879 * Return 0 on success else a negative LTTng error code.
1881 int lttng_create_session(const char *name
, const char *url
)
1885 struct lttng_uri
*uris
= NULL
;
1886 struct lttng_session_descriptor
*descriptor
= NULL
;
1887 enum lttng_error_code ret_code
;
1890 ret
= -LTTNG_ERR_INVALID
;
1894 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1896 ret
= -LTTNG_ERR_INVALID
;
1901 descriptor
= lttng_session_descriptor_create(name
);
1904 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1905 ret
= -LTTNG_ERR_INVALID
;
1908 descriptor
= lttng_session_descriptor_local_create(name
,
1912 descriptor
= lttng_session_descriptor_network_create(name
, url
,
1916 ret
= -LTTNG_ERR_INVALID
;
1920 ret
= -LTTNG_ERR_INVALID
;
1923 ret_code
= lttng_create_session_ext(descriptor
);
1924 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1926 lttng_session_descriptor_destroy(descriptor
);
1932 * Create a session exclusively used for snapshot.
1934 * Return 0 on success else a negative LTTng error code.
1936 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1939 enum lttng_error_code ret_code
;
1941 struct lttng_uri
*uris
= NULL
;
1942 struct lttng_session_descriptor
*descriptor
= NULL
;
1945 ret
= -LTTNG_ERR_INVALID
;
1949 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1951 ret
= -LTTNG_ERR_INVALID
;
1955 * If the user does not specify a custom subdir, use the session name.
1957 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&&
1958 strlen(uris
[0].subdir
) == 0) {
1959 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s",
1962 PERROR("Failed to set session name as network destination sub-directory");
1963 ret
= -LTTNG_ERR_FATAL
;
1965 } else if (ret
>= sizeof(uris
[0].subdir
)) {
1966 /* Truncated output. */
1967 ret
= -LTTNG_ERR_INVALID
;
1974 descriptor
= lttng_session_descriptor_snapshot_create(name
);
1977 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1978 ret
= -LTTNG_ERR_INVALID
;
1981 descriptor
= lttng_session_descriptor_snapshot_local_create(
1986 descriptor
= lttng_session_descriptor_snapshot_network_create(
1992 ret
= -LTTNG_ERR_INVALID
;
1996 ret
= -LTTNG_ERR_INVALID
;
1999 ret_code
= lttng_create_session_ext(descriptor
);
2000 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2002 lttng_session_descriptor_destroy(descriptor
);
2008 * Create a session exclusively used for live.
2010 * Return 0 on success else a negative LTTng error code.
2012 int lttng_create_session_live(const char *name
, const char *url
,
2013 unsigned int timer_interval
)
2016 enum lttng_error_code ret_code
;
2017 struct lttng_session_descriptor
*descriptor
= NULL
;
2020 ret
= -LTTNG_ERR_INVALID
;
2025 descriptor
= lttng_session_descriptor_live_network_create(
2026 name
, url
, NULL
, timer_interval
);
2028 descriptor
= lttng_session_descriptor_live_create(
2029 name
, timer_interval
);
2032 ret
= -LTTNG_ERR_INVALID
;
2035 ret_code
= lttng_create_session_ext(descriptor
);
2036 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2038 lttng_session_descriptor_destroy(descriptor
);
2043 * Stop the session and wait for the data before destroying it
2045 * Return 0 on success else a negative LTTng error code.
2047 int lttng_destroy_session(const char *session_name
)
2050 enum lttng_error_code ret_code
;
2051 enum lttng_destruction_handle_status status
;
2052 struct lttng_destruction_handle
*handle
= NULL
;
2055 * Stop the tracing and wait for the data to be
2058 ret
= _lttng_stop_tracing(session_name
, 1);
2059 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
2063 ret_code
= lttng_destroy_session_ext(session_name
, &handle
);
2064 if (ret_code
!= LTTNG_OK
) {
2065 ret
= (int) -ret_code
;
2070 /* Block until the completion of the destruction of the session. */
2071 status
= lttng_destruction_handle_wait_for_completion(handle
, -1);
2072 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED
) {
2073 ret
= -LTTNG_ERR_UNK
;
2077 status
= lttng_destruction_handle_get_result(handle
, &ret_code
);
2078 if (status
!= LTTNG_DESTRUCTION_HANDLE_STATUS_OK
) {
2079 ret
= -LTTNG_ERR_UNK
;
2082 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
2084 lttng_destruction_handle_destroy(handle
);
2089 * Destroy the session without waiting for the data.
2091 int lttng_destroy_session_no_wait(const char *session_name
)
2093 enum lttng_error_code ret_code
;
2095 ret_code
= lttng_destroy_session_ext(session_name
, NULL
);
2096 return ret_code
== LTTNG_OK
? ret_code
: -ret_code
;
2100 * Ask the session daemon for all available sessions.
2101 * Sets the contents of the sessions array.
2102 * Returns the number of lttng_session entries in sessions;
2103 * on error, returns a negative value.
2105 int lttng_list_sessions(struct lttng_session
**out_sessions
)
2108 struct lttcomm_session_msg lsm
;
2109 const size_t session_size
= sizeof(struct lttng_session
) +
2110 sizeof(struct lttng_session_extended
);
2111 size_t session_count
, i
;
2112 struct lttng_session_extended
*sessions_extended_begin
;
2113 struct lttng_session
*sessions
= NULL
;
2115 memset(&lsm
, 0, sizeof(lsm
));
2116 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
2117 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) &sessions
);
2122 ret
= -LTTNG_ERR_FATAL
;
2126 if (ret
% session_size
) {
2127 ret
= -LTTNG_ERR_UNK
;
2129 *out_sessions
= NULL
;
2132 session_count
= (size_t) ret
/ session_size
;
2133 sessions_extended_begin
= (struct lttng_session_extended
*)
2134 (&sessions
[session_count
]);
2136 /* Set extended session info pointers. */
2137 for (i
= 0; i
< session_count
; i
++) {
2138 struct lttng_session
*session
= &sessions
[i
];
2139 struct lttng_session_extended
*extended
=
2140 &(sessions_extended_begin
[i
]);
2142 session
->extended
.ptr
= extended
;
2145 ret
= (int) session_count
;
2146 *out_sessions
= sessions
;
2151 enum lttng_error_code
lttng_session_get_creation_time(
2152 const struct lttng_session
*session
, uint64_t *creation_time
)
2154 enum lttng_error_code ret
= LTTNG_OK
;
2155 struct lttng_session_extended
*extended
;
2157 if (!session
|| !creation_time
|| !session
->extended
.ptr
) {
2158 ret
= LTTNG_ERR_INVALID
;
2162 extended
= session
->extended
.ptr
;
2163 if (!extended
->creation_time
.is_set
) {
2164 /* Not created on the session daemon yet. */
2165 ret
= LTTNG_ERR_SESSION_NOT_EXIST
;
2168 *creation_time
= extended
->creation_time
.value
;
2173 int lttng_set_session_shm_path(const char *session_name
,
2174 const char *shm_path
)
2176 struct lttcomm_session_msg lsm
;
2178 if (session_name
== NULL
) {
2179 return -LTTNG_ERR_INVALID
;
2182 memset(&lsm
, 0, sizeof(lsm
));
2183 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
2185 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2186 sizeof(lsm
.session
.name
));
2187 lttng_ctl_copy_string(lsm
.u
.set_shm_path
.shm_path
, shm_path
,
2188 sizeof(lsm
.u
.set_shm_path
.shm_path
));
2190 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
2194 * Ask the session daemon for all available domains of a session.
2195 * Sets the contents of the domains array.
2196 * Returns the number of lttng_domain entries in domains;
2197 * on error, returns a negative value.
2199 int lttng_list_domains(const char *session_name
,
2200 struct lttng_domain
**domains
)
2203 struct lttcomm_session_msg lsm
;
2205 if (session_name
== NULL
) {
2206 return -LTTNG_ERR_INVALID
;
2209 memset(&lsm
, 0, sizeof(lsm
));
2210 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
2212 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2213 sizeof(lsm
.session
.name
));
2215 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
2220 return ret
/ sizeof(struct lttng_domain
);
2224 * Ask the session daemon for all available channels of a session.
2225 * Sets the contents of the channels array.
2226 * Returns the number of lttng_channel entries in channels;
2227 * on error, returns a negative value.
2229 int lttng_list_channels(struct lttng_handle
*handle
,
2230 struct lttng_channel
**channels
)
2233 size_t channel_count
, i
;
2234 const size_t channel_size
= sizeof(struct lttng_channel
) +
2235 sizeof(struct lttng_channel_extended
);
2236 struct lttcomm_session_msg lsm
;
2239 if (handle
== NULL
) {
2240 ret
= -LTTNG_ERR_INVALID
;
2244 memset(&lsm
, 0, sizeof(lsm
));
2245 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
2246 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2247 sizeof(lsm
.session
.name
));
2249 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2251 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
2256 if (ret
% channel_size
) {
2257 ret
= -LTTNG_ERR_UNK
;
2262 channel_count
= (size_t) ret
/ channel_size
;
2264 /* Set extended info pointers */
2265 extended_at
= ((void *) *channels
) +
2266 channel_count
* sizeof(struct lttng_channel
);
2267 for (i
= 0; i
< channel_count
; i
++) {
2268 struct lttng_channel
*chan
= &(*channels
)[i
];
2270 chan
->attr
.extended
.ptr
= extended_at
;
2271 extended_at
+= sizeof(struct lttng_channel_extended
);
2274 ret
= (int) channel_count
;
2280 * Ask the session daemon for all available events of a session channel.
2281 * Sets the contents of the events array.
2282 * Returns the number of lttng_event entries in events;
2283 * on error, returns a negative value.
2285 int lttng_list_events(struct lttng_handle
*handle
,
2286 const char *channel_name
, struct lttng_event
**events
)
2289 struct lttcomm_session_msg lsm
;
2290 struct lttcomm_event_command_header
*cmd_header
= NULL
;
2291 size_t cmd_header_len
;
2292 uint32_t nb_events
, i
;
2294 char *reception_buffer
= NULL
;
2295 struct lttng_dynamic_buffer listing
;
2298 /* Safety check. An handle and channel name are mandatory */
2299 if (handle
== NULL
|| channel_name
== NULL
) {
2300 return -LTTNG_ERR_INVALID
;
2303 memset(&lsm
, 0, sizeof(lsm
));
2304 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
2305 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2306 sizeof(lsm
.session
.name
));
2307 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
2308 sizeof(lsm
.u
.list
.channel_name
));
2309 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2311 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
2312 (void **) &reception_buffer
, (void **) &cmd_header
,
2319 ret
= -LTTNG_ERR_UNK
;
2323 /* Set number of events and free command header */
2324 nb_events
= cmd_header
->nb_events
;
2325 if (nb_events
> INT_MAX
) {
2326 ret
= -LTTNG_ERR_OVERFLOW
;
2333 * The buffer that is returned must contain a "flat" version of
2334 * the events that are returned. In other words, all pointers
2335 * within an lttng_event must point to a location within the returned
2336 * buffer so that the user may free everything by simply calling free()
2337 * on the returned buffer. This is needed in order to maintain API
2340 * A first pass is performed to compute the size of the buffer that
2341 * must be allocated. A second pass is then performed to setup
2342 * the returned events so that their members always point within the
2345 * The layout of the returned buffer is as follows:
2346 * - struct lttng_event[nb_events],
2347 * - nb_events times the following:
2348 * - struct lttng_event_extended,
2349 * - flattened version of userspace_probe_location
2350 * - filter_expression
2352 * - padding to align to 64-bits
2354 comm_ext_at
= reception_buffer
+
2355 (nb_events
* sizeof(struct lttng_event
));
2356 storage_req
= nb_events
* sizeof(struct lttng_event
);
2358 for (i
= 0; i
< nb_events
; i
++) {
2359 struct lttcomm_event_extended_header
*ext_comm
=
2360 (struct lttcomm_event_extended_header
*) comm_ext_at
;
2361 int probe_storage_req
= 0;
2363 comm_ext_at
+= sizeof(*ext_comm
);
2364 comm_ext_at
+= ext_comm
->filter_len
;
2366 ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
2368 if (ext_comm
->userspace_probe_location_len
) {
2369 struct lttng_userspace_probe_location
*probe_location
= NULL
;
2370 struct lttng_buffer_view probe_location_view
;
2372 probe_location_view
= lttng_buffer_view_init(
2374 ext_comm
->userspace_probe_location_len
);
2377 * Create a temporary userspace probe location to
2378 * determine the size needed by a "flattened" version
2379 * of that same probe location.
2381 ret
= lttng_userspace_probe_location_create_from_buffer(
2382 &probe_location_view
, &probe_location
);
2384 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2388 ret
= lttng_userspace_probe_location_flatten(
2389 probe_location
, NULL
);
2390 lttng_userspace_probe_location_destroy(probe_location
);
2392 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2396 probe_storage_req
= ret
;
2397 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2400 storage_req
+= sizeof(struct lttng_event_extended
);
2401 storage_req
+= ext_comm
->filter_len
;
2402 storage_req
+= ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
2403 /* Padding to ensure the flat probe is aligned. */
2404 storage_req
= ALIGN_TO(storage_req
, sizeof(uint64_t));
2405 storage_req
+= probe_storage_req
;
2408 lttng_dynamic_buffer_init(&listing
);
2410 * We must ensure that "listing" is never resized so as to preserve
2411 * the validity of the flattened objects.
2413 ret
= lttng_dynamic_buffer_set_capacity(&listing
, storage_req
);
2415 ret
= -LTTNG_ERR_NOMEM
;
2419 ret
= lttng_dynamic_buffer_append(&listing
, reception_buffer
,
2420 nb_events
* sizeof(struct lttng_event
));
2422 ret
= -LTTNG_ERR_NOMEM
;
2423 goto free_dynamic_buffer
;
2426 comm_ext_at
= reception_buffer
+
2427 (nb_events
* sizeof(struct lttng_event
));
2428 for (i
= 0; i
< nb_events
; i
++) {
2429 struct lttng_event
*event
= (struct lttng_event
*)
2430 (listing
.data
+ (sizeof(struct lttng_event
) * i
));
2431 struct lttcomm_event_extended_header
*ext_comm
=
2432 (struct lttcomm_event_extended_header
*) comm_ext_at
;
2433 struct lttng_event_extended
*event_extended
=
2434 (struct lttng_event_extended
*)
2435 (listing
.data
+ listing
.size
);
2437 /* Insert struct lttng_event_extended. */
2438 ret
= lttng_dynamic_buffer_set_size(&listing
,
2439 listing
.size
+ sizeof(*event_extended
));
2441 ret
= -LTTNG_ERR_NOMEM
;
2442 goto free_dynamic_buffer
;
2444 event
->extended
.ptr
= event_extended
;
2446 comm_ext_at
+= sizeof(*ext_comm
);
2448 /* Insert filter expression. */
2449 if (ext_comm
->filter_len
) {
2450 event_extended
->filter_expression
= listing
.data
+
2452 ret
= lttng_dynamic_buffer_append(&listing
, comm_ext_at
,
2453 ext_comm
->filter_len
);
2455 ret
= -LTTNG_ERR_NOMEM
;
2456 goto free_dynamic_buffer
;
2458 comm_ext_at
+= ext_comm
->filter_len
;
2461 /* Insert exclusions. */
2462 if (ext_comm
->nb_exclusions
) {
2463 event_extended
->exclusions
.count
=
2464 ext_comm
->nb_exclusions
;
2465 event_extended
->exclusions
.strings
=
2466 listing
.data
+ listing
.size
;
2468 ret
= lttng_dynamic_buffer_append(&listing
,
2470 ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
);
2472 ret
= -LTTNG_ERR_NOMEM
;
2473 goto free_dynamic_buffer
;
2475 comm_ext_at
+= ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
2478 /* Insert padding to align to 64-bits. */
2479 ret
= lttng_dynamic_buffer_set_size(&listing
,
2480 ALIGN_TO(listing
.size
, sizeof(uint64_t)));
2482 ret
= -LTTNG_ERR_NOMEM
;
2483 goto free_dynamic_buffer
;
2486 /* Insert flattened userspace probe location. */
2487 if (ext_comm
->userspace_probe_location_len
) {
2488 struct lttng_userspace_probe_location
*probe_location
= NULL
;
2489 struct lttng_buffer_view probe_location_view
;
2491 probe_location_view
= lttng_buffer_view_init(
2493 ext_comm
->userspace_probe_location_len
);
2495 ret
= lttng_userspace_probe_location_create_from_buffer(
2496 &probe_location_view
, &probe_location
);
2498 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2499 goto free_dynamic_buffer
;
2502 event_extended
->probe_location
= (struct lttng_userspace_probe_location
*)
2503 (listing
.data
+ listing
.size
);
2504 ret
= lttng_userspace_probe_location_flatten(
2505 probe_location
, &listing
);
2506 lttng_userspace_probe_location_destroy(probe_location
);
2508 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2509 goto free_dynamic_buffer
;
2512 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2516 /* Don't reset listing buffer as we return its content. */
2517 *events
= (struct lttng_event
*) listing
.data
;
2518 lttng_dynamic_buffer_init(&listing
);
2519 ret
= (int) nb_events
;
2520 free_dynamic_buffer
:
2521 lttng_dynamic_buffer_reset(&listing
);
2524 free(reception_buffer
);
2529 * Sets the tracing_group variable with name.
2530 * This function allocates memory pointed to by tracing_group.
2531 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2533 int lttng_set_tracing_group(const char *name
)
2536 return -LTTNG_ERR_INVALID
;
2539 if (asprintf(&tracing_group
, "%s", name
) < 0) {
2540 return -LTTNG_ERR_FATAL
;
2546 int lttng_calibrate(struct lttng_handle
*handle
,
2547 struct lttng_calibrate
*calibrate
)
2550 * This command was removed in LTTng 2.9.
2552 return -LTTNG_ERR_UND
;
2556 * Set default channel attributes.
2557 * If either or both of the arguments are null, attr content is zeroe'd.
2559 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
2560 struct lttng_channel_attr
*attr
)
2562 struct lttng_channel_extended
*extended
;
2565 if (attr
== NULL
|| domain
== NULL
) {
2569 extended
= (struct lttng_channel_extended
*) attr
->extended
.ptr
;
2570 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
2572 /* Same for all domains. */
2573 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2574 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
2575 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
2577 switch (domain
->type
) {
2578 case LTTNG_DOMAIN_KERNEL
:
2579 attr
->switch_timer_interval
=
2580 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
2581 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
2582 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
2583 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
2584 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
2586 extended
->monitor_timer_interval
=
2587 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
;
2588 extended
->blocking_timeout
=
2589 DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT
;
2592 case LTTNG_DOMAIN_UST
:
2593 switch (domain
->buf_type
) {
2594 case LTTNG_BUFFER_PER_UID
:
2595 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
2596 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
2597 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
2598 attr
->switch_timer_interval
=
2599 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
2600 attr
->read_timer_interval
=
2601 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
2603 extended
->monitor_timer_interval
=
2604 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER
;
2605 extended
->blocking_timeout
=
2606 DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT
;
2609 case LTTNG_BUFFER_PER_PID
:
2611 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
2612 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
2613 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
2614 attr
->switch_timer_interval
=
2615 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2616 attr
->read_timer_interval
=
2617 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2619 extended
->monitor_timer_interval
=
2620 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
;
2621 extended
->blocking_timeout
=
2622 DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT
;
2627 /* Default behavior: leave set to 0. */
2631 attr
->extended
.ptr
= extended
;
2634 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2635 uint64_t *discarded_events
)
2638 struct lttng_channel_extended
*chan_ext
;
2640 if (!channel
|| !discarded_events
) {
2641 ret
= -LTTNG_ERR_INVALID
;
2645 chan_ext
= channel
->attr
.extended
.ptr
;
2648 * This can happen since the lttng_channel structure is
2649 * used for other tasks where this pointer is never set.
2651 *discarded_events
= 0;
2655 *discarded_events
= chan_ext
->discarded_events
;
2660 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2661 uint64_t *lost_packets
)
2664 struct lttng_channel_extended
*chan_ext
;
2666 if (!channel
|| !lost_packets
) {
2667 ret
= -LTTNG_ERR_INVALID
;
2671 chan_ext
= channel
->attr
.extended
.ptr
;
2674 * This can happen since the lttng_channel structure is
2675 * used for other tasks where this pointer is never set.
2681 *lost_packets
= chan_ext
->lost_packets
;
2686 int lttng_channel_get_monitor_timer_interval(struct lttng_channel
*chan
,
2687 uint64_t *monitor_timer_interval
)
2691 if (!chan
|| !monitor_timer_interval
) {
2692 ret
= -LTTNG_ERR_INVALID
;
2696 if (!chan
->attr
.extended
.ptr
) {
2697 ret
= -LTTNG_ERR_INVALID
;
2701 *monitor_timer_interval
= ((struct lttng_channel_extended
*)
2702 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
2707 int lttng_channel_set_monitor_timer_interval(struct lttng_channel
*chan
,
2708 uint64_t monitor_timer_interval
)
2712 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2713 ret
= -LTTNG_ERR_INVALID
;
2717 ((struct lttng_channel_extended
*)
2718 chan
->attr
.extended
.ptr
)->monitor_timer_interval
=
2719 monitor_timer_interval
;
2724 int lttng_channel_get_blocking_timeout(struct lttng_channel
*chan
,
2725 int64_t *blocking_timeout
)
2729 if (!chan
|| !blocking_timeout
) {
2730 ret
= -LTTNG_ERR_INVALID
;
2734 if (!chan
->attr
.extended
.ptr
) {
2735 ret
= -LTTNG_ERR_INVALID
;
2739 *blocking_timeout
= ((struct lttng_channel_extended
*)
2740 chan
->attr
.extended
.ptr
)->blocking_timeout
;
2745 int lttng_channel_set_blocking_timeout(struct lttng_channel
*chan
,
2746 int64_t blocking_timeout
)
2749 int64_t msec_timeout
;
2751 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2752 ret
= -LTTNG_ERR_INVALID
;
2756 if (blocking_timeout
< 0 && blocking_timeout
!= -1) {
2757 ret
= -LTTNG_ERR_INVALID
;
2762 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2763 * us to accept a narrower range of values (msecs expressed as a signed
2766 msec_timeout
= blocking_timeout
/ 1000;
2767 if (msec_timeout
!= (int32_t) msec_timeout
) {
2768 ret
= -LTTNG_ERR_INVALID
;
2772 ((struct lttng_channel_extended
*)
2773 chan
->attr
.extended
.ptr
)->blocking_timeout
=
2780 * Check if session daemon is alive.
2782 * Return 1 if alive or 0 if not.
2783 * On error returns a negative value.
2785 int lttng_session_daemon_alive(void)
2789 ret
= set_session_daemon_path();
2795 if (*sessiond_sock_path
== '\0') {
2797 * No socket path set. Weird error which means the constructor
2803 ret
= try_connect_sessiond(sessiond_sock_path
);
2814 * Set URL for a consumer for a session and domain.
2816 * Return 0 on success, else a negative value.
2818 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2819 const char *control_url
, const char *data_url
)
2823 struct lttcomm_session_msg lsm
;
2824 struct lttng_uri
*uris
= NULL
;
2826 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2827 return -LTTNG_ERR_INVALID
;
2830 memset(&lsm
, 0, sizeof(lsm
));
2832 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2834 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2835 sizeof(lsm
.session
.name
));
2836 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2838 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2840 return -LTTNG_ERR_INVALID
;
2843 lsm
.u
.uri
.size
= size
;
2845 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2846 sizeof(struct lttng_uri
) * size
, NULL
);
2855 int lttng_enable_consumer(struct lttng_handle
*handle
);
2856 int lttng_enable_consumer(struct lttng_handle
*handle
)
2864 int lttng_disable_consumer(struct lttng_handle
*handle
);
2865 int lttng_disable_consumer(struct lttng_handle
*handle
)
2873 int _lttng_create_session_ext(const char *name
, const char *url
,
2874 const char *datetime
);
2875 int _lttng_create_session_ext(const char *name
, const char *url
,
2876 const char *datetime
)
2882 * For a given session name, this call checks if the data is ready to be read
2883 * or is still being extracted by the consumer(s) hence not ready to be used by
2886 int lttng_data_pending(const char *session_name
)
2889 struct lttcomm_session_msg lsm
;
2890 uint8_t *pending
= NULL
;
2892 if (session_name
== NULL
) {
2893 return -LTTNG_ERR_INVALID
;
2896 memset(&lsm
, 0, sizeof(lsm
));
2897 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
2899 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2900 sizeof(lsm
.session
.name
));
2902 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
2905 } else if (ret
!= 1) {
2906 /* Unexpected payload size */
2907 ret
= -LTTNG_ERR_INVALID
;
2909 } else if (!pending
) {
2910 /* Internal error. */
2911 ret
= -LTTNG_ERR_UNK
;
2915 ret
= (int) *pending
;
2922 * List IDs in the tracker.
2924 * tracker_type is the type of tracker.
2925 * ids is set to an allocated array of IDs currently tracked. On
2926 * success, ids and all the strings it contains must be freed by the caller.
2927 * nr_ids is set to the number of entries contained by the ids array.
2929 * Returns 0 on success, else a negative LTTng error code.
2931 int lttng_list_tracker_ids(struct lttng_handle
*handle
,
2932 enum lttng_tracker_type tracker_type
,
2933 struct lttng_tracker_id
**_ids
,
2937 struct lttcomm_session_msg lsm
;
2938 struct lttcomm_tracker_command_header
*cmd_header
= NULL
;
2939 char *cmd_payload
= NULL
, *p
;
2940 size_t cmd_header_len
;
2942 struct lttng_tracker_id
*ids
= NULL
;
2944 if (handle
== NULL
) {
2945 return -LTTNG_ERR_INVALID
;
2948 memset(&lsm
, 0, sizeof(lsm
));
2949 lsm
.cmd_type
= LTTNG_LIST_TRACKER_IDS
;
2950 lsm
.u
.id_tracker_list
.tracker_type
= tracker_type
;
2951 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2952 sizeof(lsm
.session
.name
));
2953 COPY_DOMAIN_PACKED(lsm
.domain
, handle
->domain
);
2955 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
2956 (void **) &cmd_payload
, (void **) &cmd_header
,
2962 /* Set number of tracker_id and free command header */
2963 nr_ids
= cmd_header
->nb_tracker_id
;
2964 if (nr_ids
> INT_MAX
) {
2965 ret
= -LTTNG_ERR_OVERFLOW
;
2971 ids
= zmalloc(sizeof(*ids
) * nr_ids
);
2973 ret
= -LTTNG_ERR_NOMEM
;
2978 for (i
= 0; i
< nr_ids
; i
++) {
2979 struct lttcomm_tracker_id_header
*tracker_id
;
2980 struct lttng_tracker_id
*id
;
2982 tracker_id
= (struct lttcomm_tracker_id_header
*) p
;
2983 p
+= sizeof(struct lttcomm_tracker_id_header
);
2986 id
->type
= tracker_id
->type
;
2987 switch (tracker_id
->type
) {
2990 case LTTNG_ID_VALUE
:
2991 id
->value
= tracker_id
->u
.value
;
2993 case LTTNG_ID_STRING
:
2994 id
->string
= strdup(p
);
2996 ret
= -LTTNG_ERR_NOMEM
;
2999 p
+= tracker_id
->u
.var_data_len
;
3012 for (i
= 0; i
< nr_ids
; i
++) {
3013 free(ids
[i
].string
);
3023 * List PIDs in the tracker.
3025 * enabled is set to whether the PID tracker is enabled.
3026 * pids is set to an allocated array of PIDs currently tracked. On
3027 * success, pids must be freed by the caller.
3028 * nr_pids is set to the number of entries contained by the pids array.
3030 * Returns 0 on success, else a negative LTTng error code.
3032 int lttng_list_tracker_pids(struct lttng_handle
*handle
,
3033 int *_enabled
, int32_t **_pids
, size_t *_nr_pids
)
3035 struct lttng_tracker_id
*ids
= NULL
;
3040 ret
= lttng_list_tracker_ids(handle
, LTTNG_TRACKER_PID
, &ids
, &nr_ids
);
3044 if (nr_ids
== 1 && ids
[0].type
== LTTNG_ID_ALL
) {
3050 pids
= zmalloc(nr_ids
* sizeof(*pids
));
3052 ret
= -LTTNG_ERR_NOMEM
;
3055 for (i
= 0; i
< nr_ids
; i
++) {
3056 struct lttng_tracker_id
*id
= &ids
[i
];
3058 if (id
->type
!= LTTNG_ID_VALUE
) {
3059 ret
= -LTTNG_ERR_UNK
;
3062 pids
[i
] = id
->value
;
3067 for (i
= 0; i
< nr_ids
; i
++) {
3068 free(ids
[i
].string
);
3078 * Regenerate the metadata for a session.
3079 * Return 0 on success, a negative error code on error.
3081 int lttng_regenerate_metadata(const char *session_name
)
3084 struct lttcomm_session_msg lsm
;
3086 if (!session_name
) {
3087 ret
= -LTTNG_ERR_INVALID
;
3091 memset(&lsm
, 0, sizeof(lsm
));
3092 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
3094 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
3095 sizeof(lsm
.session
.name
));
3097 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
3108 * Deprecated, replaced by lttng_regenerate_metadata.
3110 int lttng_metadata_regenerate(const char *session_name
)
3112 return lttng_regenerate_metadata(session_name
);
3116 * Regenerate the statedump of a session.
3117 * Return 0 on success, a negative error code on error.
3119 int lttng_regenerate_statedump(const char *session_name
)
3122 struct lttcomm_session_msg lsm
;
3124 if (!session_name
) {
3125 ret
= -LTTNG_ERR_INVALID
;
3129 memset(&lsm
, 0, sizeof(lsm
));
3130 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
3132 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
3133 sizeof(lsm
.session
.name
));
3135 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
3145 int lttng_register_trigger(struct lttng_trigger
*trigger
)
3148 struct lttcomm_session_msg lsm
;
3149 struct lttng_dynamic_buffer buffer
;
3151 lttng_dynamic_buffer_init(&buffer
);
3153 ret
= -LTTNG_ERR_INVALID
;
3157 if (!lttng_trigger_validate(trigger
)) {
3158 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3162 ret
= lttng_trigger_serialize(trigger
, &buffer
);
3164 ret
= -LTTNG_ERR_UNK
;
3168 memset(&lsm
, 0, sizeof(lsm
));
3169 lsm
.cmd_type
= LTTNG_REGISTER_TRIGGER
;
3170 lsm
.u
.trigger
.length
= (uint32_t) buffer
.size
;
3171 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buffer
.data
,
3174 lttng_dynamic_buffer_reset(&buffer
);
3178 int lttng_unregister_trigger(struct lttng_trigger
*trigger
)
3181 struct lttcomm_session_msg lsm
;
3182 struct lttng_dynamic_buffer buffer
;
3184 lttng_dynamic_buffer_init(&buffer
);
3186 ret
= -LTTNG_ERR_INVALID
;
3190 if (!lttng_trigger_validate(trigger
)) {
3191 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3195 ret
= lttng_trigger_serialize(trigger
, &buffer
);
3197 ret
= -LTTNG_ERR_UNK
;
3201 memset(&lsm
, 0, sizeof(lsm
));
3202 lsm
.cmd_type
= LTTNG_UNREGISTER_TRIGGER
;
3203 lsm
.u
.trigger
.length
= (uint32_t) buffer
.size
;
3204 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buffer
.data
,
3207 lttng_dynamic_buffer_reset(&buffer
);
3214 static void __attribute__((constructor
)) init(void)
3216 /* Set default session group */
3217 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
3223 static void __attribute__((destructor
)) lttng_ctl_exit(void)
3225 free(tracing_group
);