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>
49 #include "filter/filter-ast.h"
50 #include "filter/filter-parser.h"
51 #include "filter/filter-bytecode.h"
52 #include "filter/memstream.h"
53 #include "lttng-ctl-helper.h"
56 static const int print_xml
= 1;
57 #define dbg_printf(fmt, args...) \
58 printf("[debug liblttng-ctl] " fmt, ## args)
60 static const int print_xml
= 0;
61 #define dbg_printf(fmt, args...) \
63 /* do nothing but check printf format */ \
65 printf("[debug liblttnctl] " fmt, ## args); \
70 /* Socket to session daemon for communication */
71 static int sessiond_socket
;
72 static char sessiond_sock_path
[PATH_MAX
];
75 static char *tracing_group
;
81 * Those two variables are used by error.h to silent or control the verbosity of
82 * error message. They are global to the library so application linking with it
83 * are able to compile correctly and also control verbosity of the library.
86 int lttng_opt_verbose
;
90 * Copy string from src to dst and enforce null terminated byte.
93 void lttng_ctl_copy_string(char *dst
, const char *src
, size_t len
)
96 strncpy(dst
, src
, len
);
97 /* Enforce the NULL terminated byte */
105 * Copy domain to lttcomm_session_msg domain.
107 * If domain is unknown, default domain will be the kernel.
110 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
111 struct lttng_domain
*src
)
115 case LTTNG_DOMAIN_KERNEL
:
116 case LTTNG_DOMAIN_UST
:
117 case LTTNG_DOMAIN_JUL
:
118 case LTTNG_DOMAIN_LOG4J
:
119 case LTTNG_DOMAIN_PYTHON
:
120 memcpy(dst
, src
, sizeof(struct lttng_domain
));
123 memset(dst
, 0, sizeof(struct lttng_domain
));
130 * Send lttcomm_session_msg to the session daemon.
132 * On success, returns the number of bytes sent (>=0)
133 * On error, returns -1
135 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
140 ret
= -LTTNG_ERR_NO_SESSIOND
;
144 DBG("LSM cmd type : %d", lsm
->cmd_type
);
146 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
147 sizeof(struct lttcomm_session_msg
));
149 ret
= -LTTNG_ERR_FATAL
;
157 * Send var len data to the session daemon.
159 * On success, returns the number of bytes sent (>=0)
160 * On error, returns -1
162 static int send_session_varlen(const void *data
, size_t len
)
167 ret
= -LTTNG_ERR_NO_SESSIOND
;
176 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
178 ret
= -LTTNG_ERR_FATAL
;
186 * Send file descriptors to the session daemon.
188 * On success, returns the number of bytes sent (>=0)
189 * On error, returns -1
191 static int send_session_fds(const int *fds
, size_t nb_fd
)
196 ret
= -LTTNG_ERR_NO_SESSIOND
;
200 if (!fds
|| !nb_fd
) {
205 ret
= lttcomm_send_fds_unix_sock(sessiond_socket
, fds
, nb_fd
);
207 ret
= -LTTNG_ERR_FATAL
;
215 * Receive data from the sessiond socket.
217 * On success, returns the number of bytes received (>=0)
218 * On error, returns -1 (recvmsg() error) or -ENOTCONN
220 static int recv_data_sessiond(void *buf
, size_t len
)
225 ret
= -LTTNG_ERR_NO_SESSIOND
;
229 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
231 ret
= -LTTNG_ERR_FATAL
;
239 * Check if we are in the specified group.
241 * If yes return 1, else return -1.
244 int lttng_check_tracing_group(void)
246 gid_t
*grp_list
, tracing_gid
;
247 int grp_list_size
, grp_id
, i
;
249 const char *grp_name
= tracing_group
;
251 /* Get GID of group 'tracing' */
252 if (utils_get_group_id(grp_name
, false, &tracing_gid
)) {
253 /* If grp_tracing is NULL, the group does not exist. */
257 /* Get number of supplementary group IDs */
258 grp_list_size
= getgroups(0, NULL
);
259 if (grp_list_size
< 0) {
264 /* Alloc group list of the right size */
265 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
270 grp_id
= getgroups(grp_list_size
, grp_list
);
276 for (i
= 0; i
< grp_list_size
; i
++) {
277 if (grp_list
[i
] == tracing_gid
) {
290 static int check_enough_available_memory(size_t num_bytes_requested_per_cpu
)
294 size_t best_mem_info
;
295 size_t num_bytes_requested_total
;
298 * Get the number of CPU currently online to compute the amount of
299 * memory needed to create a buffer for every CPU.
301 num_cpu
= sysconf(_SC_NPROCESSORS_ONLN
);
306 num_bytes_requested_total
= num_bytes_requested_per_cpu
* num_cpu
;
309 * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
310 * reliable estimate we can get but it is only exposed by the kernel
311 * since 3.14. (See Linux kernel commit:
312 * 34e431b0ae398fc54ea69ff85ec700722c9da773)
314 ret
= utils_get_memory_available(&best_mem_info
);
320 * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This
321 * is a sanity check for obvious user error.
323 ret
= utils_get_memory_total(&best_mem_info
);
331 return best_mem_info
>= num_bytes_requested_total
;
335 * Try connect to session daemon with sock_path.
337 * Return 0 on success, else -1
339 static int try_connect_sessiond(const char *sock_path
)
343 /* If socket exist, we check if the daemon listens for connect. */
344 ret
= access(sock_path
, F_OK
);
350 ret
= lttcomm_connect_unix_sock(sock_path
);
356 ret
= lttcomm_close_unix_sock(ret
);
358 PERROR("lttcomm_close_unix_sock");
368 * Set sessiond socket path by putting it in the global sessiond_sock_path
371 * Returns 0 on success, negative value on failure (the sessiond socket path
372 * is somehow too long or ENOMEM).
374 static int set_session_daemon_path(void)
376 int in_tgroup
= 0; /* In tracing group. */
382 /* Are we in the tracing group ? */
383 in_tgroup
= lttng_check_tracing_group();
386 if ((uid
== 0) || in_tgroup
) {
387 lttng_ctl_copy_string(sessiond_sock_path
,
388 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
, sizeof(sessiond_sock_path
));
396 ret
= try_connect_sessiond(sessiond_sock_path
);
400 /* Global session daemon not available... */
402 /* ...or not in tracing group (and not root), default */
405 * With GNU C < 2.1, snprintf returns -1 if the target buffer
407 * With GNU C >= 2.1, snprintf returns the required size
408 * (excluding closing null)
410 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
411 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
412 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
424 * Connect to the LTTng session daemon.
426 * On success, return 0. On error, return -1.
428 static int connect_sessiond(void)
432 /* Don't try to connect if already connected. */
437 ret
= set_session_daemon_path();
442 /* Connect to the sesssion daemon. */
443 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
448 sessiond_socket
= ret
;
458 * Clean disconnect from the session daemon.
460 * On success, return 0. On error, return -1.
462 static int disconnect_sessiond(void)
467 ret
= lttcomm_close_unix_sock(sessiond_socket
);
475 static int recv_sessiond_optional_data(size_t len
, void **user_buf
,
483 ret
= -LTTNG_ERR_INVALID
;
493 ret
= recv_data_sessiond(buf
, len
);
499 ret
= -LTTNG_ERR_INVALID
;
503 /* Move ownership of command header buffer to user. */
508 /* No command header. */
524 * Ask the session daemon a specific command and put the data into buf.
525 * Takes extra var. len. data and file descriptors as input to send to the
528 * Return size of data (only payload, not header) or a negative error code.
531 int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg
*lsm
,
532 const int *fds
, size_t nb_fd
, const void *vardata
,
533 size_t vardata_len
, void **user_payload_buf
,
534 void **user_cmd_header_buf
, size_t *user_cmd_header_len
)
538 struct lttcomm_lttng_msg llm
;
540 ret
= connect_sessiond();
542 ret
= -LTTNG_ERR_NO_SESSIOND
;
546 /* Send command to session daemon */
547 ret
= send_session_msg(lsm
);
549 /* Ret value is a valid lttng error code. */
552 /* Send var len data */
553 ret
= send_session_varlen(vardata
, vardata_len
);
555 /* Ret value is a valid lttng error code. */
560 ret
= send_session_fds(fds
, nb_fd
);
562 /* Ret value is a valid lttng error code. */
566 /* Get header from data transmission */
567 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
569 /* Ret value is a valid lttng error code. */
573 /* Check error code if OK */
574 if (llm
.ret_code
!= LTTNG_OK
) {
579 /* Get command header from data transmission */
580 ret
= recv_sessiond_optional_data(llm
.cmd_header_size
,
581 user_cmd_header_buf
, user_cmd_header_len
);
586 /* Get payload from data transmission */
587 ret
= recv_sessiond_optional_data(llm
.data_size
, user_payload_buf
,
596 disconnect_sessiond();
601 * Create lttng handle and return pointer.
603 * The returned pointer will be NULL in case of malloc() error.
605 struct lttng_handle
*lttng_create_handle(const char *session_name
,
606 struct lttng_domain
*domain
)
608 struct lttng_handle
*handle
= NULL
;
610 handle
= zmalloc(sizeof(struct lttng_handle
));
611 if (handle
== NULL
) {
612 PERROR("malloc handle");
616 /* Copy session name */
617 lttng_ctl_copy_string(handle
->session_name
, session_name
,
618 sizeof(handle
->session_name
));
620 /* Copy lttng domain or leave initialized to 0. */
622 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
630 * Destroy handle by free(3) the pointer.
632 void lttng_destroy_handle(struct lttng_handle
*handle
)
638 * Register an outside consumer.
640 * Returns size of returned session payload data or a negative error code.
642 int lttng_register_consumer(struct lttng_handle
*handle
,
643 const char *socket_path
)
645 struct lttcomm_session_msg lsm
;
647 if (handle
== NULL
|| socket_path
== NULL
) {
648 return -LTTNG_ERR_INVALID
;
651 memset(&lsm
, 0, sizeof(lsm
));
652 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
653 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
654 sizeof(lsm
.session
.name
));
655 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
657 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
,
658 sizeof(lsm
.u
.reg
.path
));
660 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
664 * Start tracing for all traces of the session.
666 * Returns size of returned session payload data or a negative error code.
668 int lttng_start_tracing(const char *session_name
)
670 struct lttcomm_session_msg lsm
;
672 if (session_name
== NULL
) {
673 return -LTTNG_ERR_INVALID
;
676 memset(&lsm
, 0, sizeof(lsm
));
677 lsm
.cmd_type
= LTTNG_START_TRACE
;
679 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
680 sizeof(lsm
.session
.name
));
682 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
686 * Stop tracing for all traces of the session.
688 static int _lttng_stop_tracing(const char *session_name
, int wait
)
691 struct lttcomm_session_msg lsm
;
693 if (session_name
== NULL
) {
694 return -LTTNG_ERR_INVALID
;
697 memset(&lsm
, 0, sizeof(lsm
));
698 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
700 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
701 sizeof(lsm
.session
.name
));
703 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
704 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
712 /* Check for data availability */
714 data_ret
= lttng_data_pending(session_name
);
716 /* Return the data available call error. */
722 * Data sleep time before retrying (in usec). Don't sleep if the
723 * call returned value indicates availability.
726 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME
);
728 } while (data_ret
!= 0);
736 * Stop tracing and wait for data availability.
738 int lttng_stop_tracing(const char *session_name
)
740 return _lttng_stop_tracing(session_name
, 1);
744 * Stop tracing but _don't_ wait for data availability.
746 int lttng_stop_tracing_no_wait(const char *session_name
)
748 return _lttng_stop_tracing(session_name
, 0);
752 * Add context to a channel.
754 * If the given channel is NULL, add the contexts to all channels.
755 * The event_name param is ignored.
757 * Returns the size of the returned payload data or a negative error code.
759 int lttng_add_context(struct lttng_handle
*handle
,
760 struct lttng_event_context
*ctx
, const char *event_name
,
761 const char *channel_name
)
766 struct lttcomm_session_msg lsm
;
768 /* Safety check. Both are mandatory. */
769 if (handle
== NULL
|| ctx
== NULL
) {
770 ret
= -LTTNG_ERR_INVALID
;
774 memset(&lsm
, 0, sizeof(lsm
));
775 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
777 /* If no channel name, send empty string. */
778 if (channel_name
== NULL
) {
779 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
780 sizeof(lsm
.u
.context
.channel_name
));
782 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
783 sizeof(lsm
.u
.context
.channel_name
));
786 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
787 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
788 sizeof(lsm
.session
.name
));
790 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
791 size_t provider_len
, ctx_len
;
792 const char *provider_name
= ctx
->u
.app_ctx
.provider_name
;
793 const char *ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
795 if (!provider_name
|| !ctx_name
) {
796 ret
= -LTTNG_ERR_INVALID
;
800 provider_len
= strlen(provider_name
);
801 if (provider_len
== 0) {
802 ret
= -LTTNG_ERR_INVALID
;
805 lsm
.u
.context
.provider_name_len
= provider_len
;
807 ctx_len
= strlen(ctx_name
);
809 ret
= -LTTNG_ERR_INVALID
;
812 lsm
.u
.context
.context_name_len
= ctx_len
;
814 len
= provider_len
+ ctx_len
;
817 ret
= -LTTNG_ERR_NOMEM
;
821 memcpy(buf
, provider_name
, provider_len
);
822 memcpy(buf
+ provider_len
, ctx_name
, ctx_len
);
824 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
826 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
828 * Don't leak application addresses to the sessiond.
829 * This is only necessary when ctx is for an app ctx otherwise
830 * the values inside the union (type & config) are overwritten.
832 lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
833 lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
836 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buf
, len
, NULL
);
843 * Enable event(s) for a channel.
845 * If no event name is specified, all events are enabled.
846 * If no channel name is specified, the default 'channel0' is used.
848 * Returns size of returned session payload data or a negative error code.
850 int lttng_enable_event(struct lttng_handle
*handle
,
851 struct lttng_event
*ev
, const char *channel_name
)
853 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
858 * Create or enable an event with a filter expression.
860 * Return negative error value on error.
861 * Return size of returned session payload data if OK.
863 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
864 struct lttng_event
*event
, const char *channel_name
,
865 const char *filter_expression
)
867 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
868 filter_expression
, 0, NULL
);
872 * Depending on the event, return a newly allocated agent filter expression or
873 * NULL if not applicable.
875 * An event with NO loglevel and the name is * will return NULL.
877 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
880 char *agent_filter
= NULL
;
884 /* Don't add filter for the '*' event. */
885 if (strcmp(ev
->name
, "*") != 0) {
887 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
890 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
898 /* Add loglevel filtering if any for the JUL domain. */
899 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
902 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
908 if (filter
|| agent_filter
) {
911 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
912 agent_filter
? agent_filter
: filter
, op
,
917 agent_filter
= new_filter
;
919 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
935 * Generate the filter bytecode from a given filter expression string. Put the
936 * newly allocated parser context in ctxp and populate the lsm object with the
939 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
941 static int generate_filter(char *filter_expression
,
942 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
945 struct filter_parser_ctx
*ctx
= NULL
;
948 assert(filter_expression
);
953 * Casting const to non-const, as the underlying function will use it in
956 fmem
= lttng_fmemopen((void *) filter_expression
,
957 strlen(filter_expression
), "r");
959 fprintf(stderr
, "Error opening memory as stream\n");
960 ret
= -LTTNG_ERR_FILTER_NOMEM
;
963 ctx
= filter_parser_ctx_alloc(fmem
);
965 fprintf(stderr
, "Error allocating parser\n");
966 ret
= -LTTNG_ERR_FILTER_NOMEM
;
967 goto filter_alloc_error
;
969 ret
= filter_parser_ctx_append_ast(ctx
);
971 fprintf(stderr
, "Parse error\n");
972 ret
= -LTTNG_ERR_FILTER_INVAL
;
976 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
979 fprintf(stderr
, "XML print error\n");
980 ret
= -LTTNG_ERR_FILTER_INVAL
;
985 dbg_printf("Generating IR... ");
987 ret
= filter_visitor_ir_generate(ctx
);
989 fprintf(stderr
, "Generate IR error\n");
990 ret
= -LTTNG_ERR_FILTER_INVAL
;
993 dbg_printf("done\n");
995 dbg_printf("Validating IR... ");
997 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
999 ret
= -LTTNG_ERR_FILTER_INVAL
;
1003 /* Normalize globbing patterns in the expression. */
1004 ret
= filter_visitor_ir_normalize_glob_patterns(ctx
);
1006 ret
= -LTTNG_ERR_FILTER_INVAL
;
1010 /* Validate strings used as literals in the expression. */
1011 ret
= filter_visitor_ir_validate_string(ctx
);
1013 ret
= -LTTNG_ERR_FILTER_INVAL
;
1017 /* Validate globbing patterns in the expression. */
1018 ret
= filter_visitor_ir_validate_globbing(ctx
);
1020 ret
= -LTTNG_ERR_FILTER_INVAL
;
1024 dbg_printf("done\n");
1026 dbg_printf("Generating bytecode... ");
1028 ret
= filter_visitor_bytecode_generate(ctx
);
1030 fprintf(stderr
, "Generate bytecode error\n");
1031 ret
= -LTTNG_ERR_FILTER_INVAL
;
1034 dbg_printf("done\n");
1035 dbg_printf("Size of bytecode generated: %u bytes.\n",
1036 bytecode_get_len(&ctx
->bytecode
->b
));
1038 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
1039 + bytecode_get_len(&ctx
->bytecode
->b
);
1040 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
1042 /* No need to keep the memory stream. */
1043 if (fclose(fmem
) != 0) {
1051 filter_ir_free(ctx
);
1052 filter_parser_ctx_free(ctx
);
1054 if (fclose(fmem
) != 0) {
1062 * Enable event(s) for a channel, possibly with exclusions and a filter.
1063 * If no event name is specified, all events are enabled.
1064 * If no channel name is specified, the default name is used.
1065 * If filter expression is not NULL, the filter is set for the event.
1066 * If exclusion count is not zero, the exclusions are set for the event.
1067 * Returns size of returned session payload data or a negative error code.
1069 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
1070 struct lttng_event
*ev
, const char *channel_name
,
1071 const char *original_filter_expression
,
1072 int exclusion_count
, char **exclusion_list
)
1074 struct lttcomm_session_msg lsm
;
1075 struct lttng_dynamic_buffer send_buffer
;
1076 int ret
= 0, i
, fd_to_send
= -1;
1077 bool send_fd
= false;
1078 unsigned int free_filter_expression
= 0;
1079 struct filter_parser_ctx
*ctx
= NULL
;
1082 * We have either a filter or some exclusions, so we need to set up
1083 * a variable-length memory block from where to send the data.
1085 lttng_dynamic_buffer_init(&send_buffer
);
1088 * Cast as non-const since we may replace the filter expression
1089 * by a dynamically allocated string. Otherwise, the original
1090 * string is not modified.
1092 char *filter_expression
= (char *) original_filter_expression
;
1094 if (handle
== NULL
|| ev
== NULL
) {
1095 ret
= -LTTNG_ERR_INVALID
;
1100 * Empty filter string will always be rejected by the parser
1101 * anyway, so treat this corner-case early to eliminate
1102 * lttng_fmemopen error for 0-byte allocation.
1104 if (filter_expression
&& filter_expression
[0] == '\0') {
1105 ret
= -LTTNG_ERR_INVALID
;
1109 memset(&lsm
, 0, sizeof(lsm
));
1111 /* If no channel name, send empty string. */
1112 if (channel_name
== NULL
) {
1113 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
1114 sizeof(lsm
.u
.enable
.channel_name
));
1116 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
1117 sizeof(lsm
.u
.enable
.channel_name
));
1120 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1121 if (ev
->name
[0] == '\0') {
1122 /* Enable all events */
1123 lttng_ctl_copy_string(ev
->name
, "*", sizeof(ev
->name
));
1126 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1127 /* FIXME: copying non-packed struct to packed struct. */
1128 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1130 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1131 sizeof(lsm
.session
.name
));
1132 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1133 lsm
.u
.enable
.bytecode_len
= 0;
1135 /* Parse filter expression. */
1136 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1137 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1138 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1139 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1140 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1141 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1144 /* Setup JUL filter if needed. */
1145 agent_filter
= set_agent_filter(filter_expression
, ev
);
1146 if (!agent_filter
) {
1147 if (!filter_expression
) {
1149 * No JUL and no filter, just skip
1156 * With an agent filter, the original filter has
1157 * been added to it thus replace the filter
1160 filter_expression
= agent_filter
;
1161 free_filter_expression
= 1;
1165 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1171 ret
= lttng_dynamic_buffer_set_capacity(&send_buffer
,
1172 lsm
.u
.enable
.bytecode_len
1173 + lsm
.u
.enable
.expression_len
1174 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
1176 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1180 /* Put exclusion names first in the data. */
1181 for (i
= 0; i
< exclusion_count
; i
++) {
1182 size_t exclusion_len
;
1184 exclusion_len
= lttng_strnlen(*(exclusion_list
+ i
),
1185 LTTNG_SYMBOL_NAME_LEN
);
1186 if (exclusion_len
== LTTNG_SYMBOL_NAME_LEN
) {
1187 /* Exclusion is not NULL-terminated. */
1188 ret
= -LTTNG_ERR_INVALID
;
1192 ret
= lttng_dynamic_buffer_append(&send_buffer
,
1193 *(exclusion_list
+ i
),
1194 LTTNG_SYMBOL_NAME_LEN
);
1200 /* Add filter expression next. */
1201 if (filter_expression
) {
1202 ret
= lttng_dynamic_buffer_append(&send_buffer
,
1203 filter_expression
, lsm
.u
.enable
.expression_len
);
1208 /* Add filter bytecode next. */
1209 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1210 ret
= lttng_dynamic_buffer_append(&send_buffer
,
1211 &ctx
->bytecode
->b
, lsm
.u
.enable
.bytecode_len
);
1216 if (ev
->extended
.ptr
) {
1217 struct lttng_event_extended
*ev_ext
=
1218 (struct lttng_event_extended
*) ev
->extended
.ptr
;
1220 if (ev_ext
->probe_location
) {
1222 * lttng_userspace_probe_location_serialize returns the
1223 * number of bytes that was appended to the buffer.
1225 ret
= lttng_userspace_probe_location_serialize(
1226 ev_ext
->probe_location
, &send_buffer
,
1232 send_fd
= fd_to_send
>= 0;
1234 * Set the size of the userspace probe location element
1235 * of the buffer so that the receiving side knows where
1238 lsm
.u
.enable
.userspace_probe_location_len
= ret
;
1242 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
,
1243 send_fd
? &fd_to_send
: NULL
,
1245 send_buffer
.size
? send_buffer
.data
: NULL
,
1246 send_buffer
.size
, NULL
, NULL
, 0);
1249 if (filter_expression
&& ctx
) {
1250 filter_bytecode_free(ctx
);
1251 filter_ir_free(ctx
);
1252 filter_parser_ctx_free(ctx
);
1255 if (free_filter_expression
) {
1257 * The filter expression has been replaced and must be freed as
1258 * it is not the original filter expression received as a
1261 free(filter_expression
);
1265 * Return directly to the caller and don't ask the sessiond since
1266 * something went wrong in the parsing of data above.
1268 lttng_dynamic_buffer_reset(&send_buffer
);
1272 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1276 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1277 struct lttng_event
*ev
, const char *channel_name
,
1278 const char *original_filter_expression
)
1280 struct lttcomm_session_msg lsm
;
1283 unsigned int free_filter_expression
= 0;
1284 struct filter_parser_ctx
*ctx
= NULL
;
1286 * Cast as non-const since we may replace the filter expression
1287 * by a dynamically allocated string. Otherwise, the original
1288 * string is not modified.
1290 char *filter_expression
= (char *) original_filter_expression
;
1292 if (handle
== NULL
|| ev
== NULL
) {
1293 ret
= -LTTNG_ERR_INVALID
;
1298 * Empty filter string will always be rejected by the parser
1299 * anyway, so treat this corner-case early to eliminate
1300 * lttng_fmemopen error for 0-byte allocation.
1302 if (filter_expression
&& filter_expression
[0] == '\0') {
1303 ret
= -LTTNG_ERR_INVALID
;
1307 memset(&lsm
, 0, sizeof(lsm
));
1309 /* If no channel name, send empty string. */
1310 if (channel_name
== NULL
) {
1311 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1312 sizeof(lsm
.u
.disable
.channel_name
));
1314 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1315 sizeof(lsm
.u
.disable
.channel_name
));
1318 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1320 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1321 /* FIXME: copying non-packed struct to packed struct. */
1322 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1324 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1325 sizeof(lsm
.session
.name
));
1326 lsm
.u
.disable
.bytecode_len
= 0;
1329 * For the JUL domain, a filter is enforced except for the
1330 * disable all event. This is done to avoid having the event in
1331 * all sessions thus filtering by logger name.
1333 if (filter_expression
== NULL
&&
1334 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1335 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1336 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1341 * We have a filter, so we need to set up a variable-length
1342 * memory block from where to send the data.
1345 /* Parse filter expression */
1346 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1347 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1348 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1349 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1350 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1351 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1354 /* Setup JUL filter if needed. */
1355 agent_filter
= set_agent_filter(filter_expression
, ev
);
1356 if (!agent_filter
) {
1357 if (!filter_expression
) {
1359 * No JUL and no filter, just skip
1366 * With a JUL filter, the original filter has
1367 * been added to it thus replace the filter
1370 filter_expression
= agent_filter
;
1371 free_filter_expression
= 1;
1375 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1381 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1382 + lsm
.u
.disable
.expression_len
);
1384 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1388 /* Add filter expression. */
1389 if (lsm
.u
.disable
.expression_len
!= 0) {
1392 lsm
.u
.disable
.expression_len
);
1394 /* Add filter bytecode next. */
1395 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1397 + lsm
.u
.disable
.expression_len
,
1399 lsm
.u
.disable
.bytecode_len
);
1402 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1403 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1407 if (filter_expression
&& ctx
) {
1408 filter_bytecode_free(ctx
);
1409 filter_ir_free(ctx
);
1410 filter_parser_ctx_free(ctx
);
1413 if (free_filter_expression
) {
1415 * The filter expression has been replaced and must be freed as
1416 * it is not the original filter expression received as a
1419 free(filter_expression
);
1423 * Return directly to the caller and don't ask the sessiond since
1424 * something went wrong in the parsing of data above.
1429 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1434 * Disable event(s) of a channel and domain.
1435 * If no event name is specified, all events are disabled.
1436 * If no channel name is specified, the default 'channel0' is used.
1437 * Returns size of returned session payload data or a negative error code.
1439 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1440 const char *channel_name
)
1442 struct lttng_event ev
;
1444 memset(&ev
, 0, sizeof(ev
));
1446 ev
.type
= LTTNG_EVENT_ALL
;
1447 lttng_ctl_copy_string(ev
.name
, name
, sizeof(ev
.name
));
1448 return lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1451 struct lttng_channel
*lttng_channel_create(struct lttng_domain
*domain
)
1453 struct lttng_channel
*channel
= NULL
;
1454 struct lttng_channel_extended
*extended
= NULL
;
1460 /* Validate domain. */
1461 switch (domain
->type
) {
1462 case LTTNG_DOMAIN_UST
:
1463 switch (domain
->buf_type
) {
1464 case LTTNG_BUFFER_PER_UID
:
1465 case LTTNG_BUFFER_PER_PID
:
1471 case LTTNG_DOMAIN_KERNEL
:
1472 if (domain
->buf_type
!= LTTNG_BUFFER_GLOBAL
) {
1480 channel
= zmalloc(sizeof(*channel
));
1485 extended
= zmalloc(sizeof(*extended
));
1490 channel
->attr
.extended
.ptr
= extended
;
1492 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 struct lttcomm_session_msg lsm
;
1520 size_t total_buffer_size_needed_per_cpu
= 0;
1522 /* NULL arguments are forbidden. No default values. */
1523 if (handle
== NULL
|| in_chan
== NULL
) {
1524 return -LTTNG_ERR_INVALID
;
1527 memset(&lsm
, 0, sizeof(lsm
));
1528 memcpy(&lsm
.u
.channel
.chan
, in_chan
, sizeof(lsm
.u
.channel
.chan
));
1529 lsm
.u
.channel
.chan
.attr
.extended
.ptr
= NULL
;
1531 if (!in_chan
->attr
.extended
.ptr
) {
1532 struct lttng_channel
*channel
;
1533 struct lttng_channel_extended
*extended
;
1535 channel
= lttng_channel_create(&handle
->domain
);
1537 return -LTTNG_ERR_NOMEM
;
1541 * Create a new channel in order to use default extended
1544 extended
= (struct lttng_channel_extended
*)
1545 channel
->attr
.extended
.ptr
;
1546 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1547 lttng_channel_destroy(channel
);
1549 struct lttng_channel_extended
*extended
;
1551 extended
= (struct lttng_channel_extended
*)
1552 in_chan
->attr
.extended
.ptr
;
1553 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1557 * Verify that the amount of memory required to create the requested
1558 * buffer is available on the system at the moment.
1560 total_buffer_size_needed_per_cpu
= lsm
.u
.channel
.chan
.attr
.num_subbuf
*
1561 lsm
.u
.channel
.chan
.attr
.subbuf_size
;
1562 if (!check_enough_available_memory(total_buffer_size_needed_per_cpu
)) {
1563 return -LTTNG_ERR_NOMEM
;
1566 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1567 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1569 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1570 sizeof(lsm
.session
.name
));
1572 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1576 * All tracing will be stopped for registered events of the channel.
1577 * Returns size of returned session payload data or a negative error code.
1579 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1581 struct lttcomm_session_msg lsm
;
1583 /* Safety check. Both are mandatory. */
1584 if (handle
== NULL
|| name
== NULL
) {
1585 return -LTTNG_ERR_INVALID
;
1588 memset(&lsm
, 0, sizeof(lsm
));
1590 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1592 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1593 sizeof(lsm
.u
.disable
.channel_name
));
1595 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1597 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1598 sizeof(lsm
.session
.name
));
1600 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1604 * Add PID to session tracker.
1605 * Return 0 on success else a negative LTTng error code.
1607 int lttng_track_pid(struct lttng_handle
*handle
, int pid
)
1609 struct lttcomm_session_msg lsm
;
1611 /* NULL arguments are forbidden. No default values. */
1612 if (handle
== NULL
) {
1613 return -LTTNG_ERR_INVALID
;
1616 memset(&lsm
, 0, sizeof(lsm
));
1618 lsm
.cmd_type
= LTTNG_TRACK_PID
;
1619 lsm
.u
.pid_tracker
.pid
= pid
;
1621 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1623 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1624 sizeof(lsm
.session
.name
));
1626 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1630 * Remove PID from session tracker.
1631 * Return 0 on success else a negative LTTng error code.
1633 int lttng_untrack_pid(struct lttng_handle
*handle
, int pid
)
1635 struct lttcomm_session_msg lsm
;
1637 /* NULL arguments are forbidden. No default values. */
1638 if (handle
== NULL
) {
1639 return -LTTNG_ERR_INVALID
;
1642 memset(&lsm
, 0, sizeof(lsm
));
1644 lsm
.cmd_type
= LTTNG_UNTRACK_PID
;
1645 lsm
.u
.pid_tracker
.pid
= pid
;
1647 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1649 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1650 sizeof(lsm
.session
.name
));
1652 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1656 * Lists all available tracepoints of domain.
1657 * Sets the contents of the events array.
1658 * Returns the number of lttng_event entries in events;
1659 * on error, returns a negative value.
1661 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1662 struct lttng_event
**events
)
1665 struct lttcomm_session_msg lsm
;
1667 if (handle
== NULL
) {
1668 return -LTTNG_ERR_INVALID
;
1671 memset(&lsm
, 0, sizeof(lsm
));
1672 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1673 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1675 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1680 return ret
/ sizeof(struct lttng_event
);
1684 * Lists all available tracepoint fields of domain.
1685 * Sets the contents of the event field array.
1686 * Returns the number of lttng_event_field entries in events;
1687 * on error, returns a negative value.
1689 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1690 struct lttng_event_field
**fields
)
1693 struct lttcomm_session_msg lsm
;
1695 if (handle
== NULL
) {
1696 return -LTTNG_ERR_INVALID
;
1699 memset(&lsm
, 0, sizeof(lsm
));
1700 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1701 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1703 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1708 return ret
/ sizeof(struct lttng_event_field
);
1712 * Lists all available kernel system calls. Allocates and sets the contents of
1715 * Returns the number of lttng_event entries in events; on error, returns a
1718 int lttng_list_syscalls(struct lttng_event
**events
)
1721 struct lttcomm_session_msg lsm
;
1724 return -LTTNG_ERR_INVALID
;
1727 memset(&lsm
, 0, sizeof(lsm
));
1728 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1729 /* Force kernel domain for system calls. */
1730 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1732 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1737 return ret
/ sizeof(struct lttng_event
);
1741 * Returns a human readable string describing
1742 * the error code (a negative value).
1744 const char *lttng_strerror(int code
)
1746 return error_get_str(code
);
1749 enum lttng_error_code
lttng_create_session_ext(
1750 struct lttng_session_descriptor
*session_descriptor
)
1752 enum lttng_error_code ret_code
;
1753 struct lttcomm_session_msg lsm
= {
1754 .cmd_type
= LTTNG_CREATE_SESSION_EXT
,
1757 struct lttng_buffer_view reply_view
;
1759 bool sessiond_must_generate_ouput
;
1760 struct lttng_dynamic_buffer payload
;
1762 size_t descriptor_size
;
1763 struct lttng_session_descriptor
*descriptor_reply
= NULL
;
1765 lttng_dynamic_buffer_init(&payload
);
1766 if (!session_descriptor
) {
1767 ret_code
= LTTNG_ERR_INVALID
;
1771 sessiond_must_generate_ouput
=
1772 !lttng_session_descriptor_is_output_destination_initialized(
1773 session_descriptor
);
1774 if (sessiond_must_generate_ouput
) {
1775 const char *home_dir
= utils_get_home_dir();
1776 size_t home_dir_len
= home_dir
? strlen(home_dir
) + 1 : 0;
1778 if (!home_dir
|| home_dir_len
> LTTNG_PATH_MAX
) {
1779 ret_code
= LTTNG_ERR_FATAL
;
1783 lsm
.u
.create_session
.home_dir_size
= (uint16_t) home_dir_len
;
1784 ret
= lttng_dynamic_buffer_append(&payload
, home_dir
,
1787 ret_code
= LTTNG_ERR_NOMEM
;
1792 descriptor_size
= payload
.size
;
1793 ret
= lttng_session_descriptor_serialize(session_descriptor
,
1796 ret_code
= LTTNG_ERR_INVALID
;
1799 descriptor_size
= payload
.size
- descriptor_size
;
1800 lsm
.u
.create_session
.session_descriptor_size
= descriptor_size
;
1802 /* Command returns a session descriptor on success. */
1803 reply_ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, payload
.data
,
1804 payload
.size
, &reply
);
1805 if (reply_ret
< 0) {
1806 ret_code
= -reply_ret
;
1808 } else if (reply_ret
== 0) {
1809 /* Socket unexpectedly closed by the session daemon. */
1810 ret_code
= LTTNG_ERR_FATAL
;
1814 reply_view
= lttng_buffer_view_init(reply
, 0, reply_ret
);
1815 ret
= lttng_session_descriptor_create_from_buffer(&reply_view
,
1818 ret_code
= LTTNG_ERR_FATAL
;
1821 ret_code
= LTTNG_OK
;
1822 lttng_session_descriptor_assign(session_descriptor
, descriptor_reply
);
1825 lttng_dynamic_buffer_reset(&payload
);
1826 lttng_session_descriptor_destroy(descriptor_reply
);
1831 * Create a new session using name and url for destination.
1833 * Returns LTTNG_OK on success or a negative error code.
1835 int lttng_create_session(const char *name
, const char *url
)
1839 struct lttng_uri
*uris
= NULL
;
1840 struct lttng_session_descriptor
*descriptor
= NULL
;
1841 enum lttng_error_code ret_code
;
1844 ret
= -LTTNG_ERR_INVALID
;
1848 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1850 ret
= -LTTNG_ERR_INVALID
;
1855 descriptor
= lttng_session_descriptor_create(name
);
1858 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1859 ret
= -LTTNG_ERR_INVALID
;
1862 descriptor
= lttng_session_descriptor_local_create(name
,
1866 descriptor
= lttng_session_descriptor_network_create(name
, url
,
1870 ret
= -LTTNG_ERR_INVALID
;
1874 ret
= -LTTNG_ERR_INVALID
;
1877 ret_code
= lttng_create_session_ext(descriptor
);
1878 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1880 lttng_session_descriptor_destroy(descriptor
);
1886 * Create a session exclusively used for snapshot.
1888 * Returns LTTNG_OK on success or a negative error code.
1890 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1893 enum lttng_error_code ret_code
;
1895 struct lttng_uri
*uris
= NULL
;
1896 struct lttng_session_descriptor
*descriptor
= NULL
;
1899 ret
= -LTTNG_ERR_INVALID
;
1903 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1905 ret
= -LTTNG_ERR_INVALID
;
1909 * If the user does not specify a custom subdir, use the session name.
1911 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&&
1912 strlen(uris
[0].subdir
) == 0) {
1913 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s",
1916 PERROR("Failed to set session name as network destination sub-directory");
1917 ret
= -LTTNG_ERR_FATAL
;
1919 } else if (ret
>= sizeof(uris
[0].subdir
)) {
1920 /* Truncated output. */
1921 ret
= -LTTNG_ERR_INVALID
;
1928 descriptor
= lttng_session_descriptor_snapshot_create(name
);
1931 if (uris
[0].dtype
!= LTTNG_DST_PATH
) {
1932 ret
= -LTTNG_ERR_INVALID
;
1935 descriptor
= lttng_session_descriptor_snapshot_local_create(
1940 descriptor
= lttng_session_descriptor_snapshot_network_create(
1946 ret
= -LTTNG_ERR_INVALID
;
1950 ret
= -LTTNG_ERR_INVALID
;
1953 ret_code
= lttng_create_session_ext(descriptor
);
1954 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1956 lttng_session_descriptor_destroy(descriptor
);
1962 * Create a session exclusively used for live.
1964 * Returns LTTNG_OK on success or a negative error code.
1966 int lttng_create_session_live(const char *name
, const char *url
,
1967 unsigned int timer_interval
)
1970 enum lttng_error_code ret_code
;
1971 struct lttng_session_descriptor
*descriptor
= NULL
;
1974 ret
= -LTTNG_ERR_INVALID
;
1979 descriptor
= lttng_session_descriptor_live_network_create(
1980 name
, url
, NULL
, timer_interval
);
1982 descriptor
= lttng_session_descriptor_live_create(
1983 name
, timer_interval
);
1986 ret
= -LTTNG_ERR_INVALID
;
1989 ret_code
= lttng_create_session_ext(descriptor
);
1990 ret
= ret_code
== LTTNG_OK
? 0 : -ret_code
;
1992 lttng_session_descriptor_destroy(descriptor
);
1997 * Destroy session using name.
1998 * Returns size of returned session payload data or a negative error code.
2001 int _lttng_destroy_session(const char *session_name
)
2003 struct lttcomm_session_msg lsm
;
2005 if (session_name
== NULL
) {
2006 return -LTTNG_ERR_INVALID
;
2009 memset(&lsm
, 0, sizeof(lsm
));
2010 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
2012 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2013 sizeof(lsm
.session
.name
));
2015 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
2019 * Stop the session and wait for the data before destroying it
2021 int lttng_destroy_session(const char *session_name
)
2026 * Stop the tracing and wait for the data.
2028 ret
= _lttng_stop_tracing(session_name
, 1);
2029 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
2033 ret
= _lttng_destroy_session(session_name
);
2039 * Destroy the session without waiting for the data.
2041 int lttng_destroy_session_no_wait(const char *session_name
)
2046 * Stop the tracing without waiting for the data.
2047 * The session might already have been stopped, so just
2050 ret
= _lttng_stop_tracing(session_name
, 0);
2051 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
2055 ret
= _lttng_destroy_session(session_name
);
2061 * Ask the session daemon for all available sessions.
2062 * Sets the contents of the sessions array.
2063 * Returns the number of lttng_session entries in sessions;
2064 * on error, returns a negative value.
2066 int lttng_list_sessions(struct lttng_session
**out_sessions
)
2069 struct lttcomm_session_msg lsm
;
2070 const size_t session_size
= sizeof(struct lttng_session
) +
2071 sizeof(struct lttng_session_extended
);
2072 size_t session_count
, i
;
2073 struct lttng_session_extended
*sessions_extended_begin
;
2074 struct lttng_session
*sessions
= NULL
;
2076 memset(&lsm
, 0, sizeof(lsm
));
2077 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
2078 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) &sessions
);
2083 ret
= -LTTNG_ERR_FATAL
;
2087 if (ret
% session_size
) {
2088 ret
= -LTTNG_ERR_UNK
;
2090 *out_sessions
= NULL
;
2093 session_count
= (size_t) ret
/ session_size
;
2094 sessions_extended_begin
= (struct lttng_session_extended
*)
2095 (&sessions
[session_count
]);
2097 /* Set extended session info pointers. */
2098 for (i
= 0; i
< session_count
; i
++) {
2099 struct lttng_session
*session
= &sessions
[i
];
2100 struct lttng_session_extended
*extended
=
2101 &(sessions_extended_begin
[i
]);
2103 session
->extended
.ptr
= extended
;
2106 ret
= (int) session_count
;
2107 *out_sessions
= sessions
;
2112 enum lttng_error_code
lttng_session_get_creation_time(
2113 const struct lttng_session
*session
, uint64_t *creation_time
)
2115 enum lttng_error_code ret
= LTTNG_OK
;
2116 struct lttng_session_extended
*extended
;
2118 if (!session
|| !creation_time
|| !session
->extended
.ptr
) {
2119 ret
= LTTNG_ERR_INVALID
;
2123 extended
= session
->extended
.ptr
;
2124 if (!extended
->creation_time
.is_set
) {
2125 /* Not created on the session daemon yet. */
2126 ret
= LTTNG_ERR_SESSION_NOT_EXIST
;
2129 *creation_time
= extended
->creation_time
.value
;
2134 int lttng_set_session_shm_path(const char *session_name
,
2135 const char *shm_path
)
2137 struct lttcomm_session_msg lsm
;
2139 if (session_name
== NULL
) {
2140 return -LTTNG_ERR_INVALID
;
2143 memset(&lsm
, 0, sizeof(lsm
));
2144 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
2146 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2147 sizeof(lsm
.session
.name
));
2148 lttng_ctl_copy_string(lsm
.u
.set_shm_path
.shm_path
, shm_path
,
2149 sizeof(lsm
.u
.set_shm_path
.shm_path
));
2151 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
2155 * Ask the session daemon for all available domains of a session.
2156 * Sets the contents of the domains array.
2157 * Returns the number of lttng_domain entries in domains;
2158 * on error, returns a negative value.
2160 int lttng_list_domains(const char *session_name
,
2161 struct lttng_domain
**domains
)
2164 struct lttcomm_session_msg lsm
;
2166 if (session_name
== NULL
) {
2167 return -LTTNG_ERR_INVALID
;
2170 memset(&lsm
, 0, sizeof(lsm
));
2171 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
2173 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2174 sizeof(lsm
.session
.name
));
2176 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
2181 return ret
/ sizeof(struct lttng_domain
);
2185 * Ask the session daemon for all available channels of a session.
2186 * Sets the contents of the channels array.
2187 * Returns the number of lttng_channel entries in channels;
2188 * on error, returns a negative value.
2190 int lttng_list_channels(struct lttng_handle
*handle
,
2191 struct lttng_channel
**channels
)
2194 size_t channel_count
, i
;
2195 const size_t channel_size
= sizeof(struct lttng_channel
) +
2196 sizeof(struct lttng_channel_extended
);
2197 struct lttcomm_session_msg lsm
;
2200 if (handle
== NULL
) {
2201 ret
= -LTTNG_ERR_INVALID
;
2205 memset(&lsm
, 0, sizeof(lsm
));
2206 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
2207 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2208 sizeof(lsm
.session
.name
));
2210 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2212 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
2217 if (ret
% channel_size
) {
2218 ret
= -LTTNG_ERR_UNK
;
2223 channel_count
= (size_t) ret
/ channel_size
;
2225 /* Set extended info pointers */
2226 extended_at
= ((void *) *channels
) +
2227 channel_count
* sizeof(struct lttng_channel
);
2228 for (i
= 0; i
< channel_count
; i
++) {
2229 struct lttng_channel
*chan
= &(*channels
)[i
];
2231 chan
->attr
.extended
.ptr
= extended_at
;
2232 extended_at
+= sizeof(struct lttng_channel_extended
);
2235 ret
= (int) channel_count
;
2241 * Ask the session daemon for all available events of a session channel.
2242 * Sets the contents of the events array.
2243 * Returns the number of lttng_event entries in events;
2244 * on error, returns a negative value.
2246 int lttng_list_events(struct lttng_handle
*handle
,
2247 const char *channel_name
, struct lttng_event
**events
)
2250 struct lttcomm_session_msg lsm
;
2251 struct lttcomm_event_command_header
*cmd_header
= NULL
;
2252 size_t cmd_header_len
;
2253 uint32_t nb_events
, i
;
2255 char *reception_buffer
= NULL
;
2256 struct lttng_dynamic_buffer listing
;
2259 /* Safety check. An handle and channel name are mandatory */
2260 if (handle
== NULL
|| channel_name
== NULL
) {
2261 return -LTTNG_ERR_INVALID
;
2264 memset(&lsm
, 0, sizeof(lsm
));
2265 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
2266 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2267 sizeof(lsm
.session
.name
));
2268 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
2269 sizeof(lsm
.u
.list
.channel_name
));
2270 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2272 ret
= lttng_ctl_ask_sessiond_fds_varlen(&lsm
, NULL
, 0, NULL
, 0,
2273 (void **) &reception_buffer
, (void **) &cmd_header
,
2280 ret
= -LTTNG_ERR_UNK
;
2284 /* Set number of events and free command header */
2285 nb_events
= cmd_header
->nb_events
;
2286 if (nb_events
> INT_MAX
) {
2294 * The buffer that is returned must contain a "flat" version of
2295 * the events that are returned. In other words, all pointers
2296 * within an lttng_event must point to a location within the returned
2297 * buffer so that the user may free everything by simply calling free()
2298 * on the returned buffer. This is needed in order to maintain API
2301 * A first pass is performed to compute the size of the buffer that
2302 * must be allocated. A second pass is then performed to setup
2303 * the returned events so that their members always point within the
2306 * The layout of the returned buffer is as follows:
2307 * - struct lttng_event[nb_events],
2308 * - nb_events times the following:
2309 * - struct lttng_event_extended,
2310 * - flattened version of userspace_probe_location
2311 * - filter_expression
2313 * - padding to align to 64-bits
2315 comm_ext_at
= reception_buffer
+
2316 (nb_events
* sizeof(struct lttng_event
));
2317 storage_req
= nb_events
* sizeof(struct lttng_event
);
2319 for (i
= 0; i
< nb_events
; i
++) {
2320 struct lttcomm_event_extended_header
*ext_comm
=
2321 (struct lttcomm_event_extended_header
*) comm_ext_at
;
2322 int probe_storage_req
= 0;
2324 comm_ext_at
+= sizeof(*ext_comm
);
2325 comm_ext_at
+= ext_comm
->filter_len
;
2327 ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
2329 if (ext_comm
->userspace_probe_location_len
) {
2330 struct lttng_userspace_probe_location
*probe_location
= NULL
;
2331 struct lttng_buffer_view probe_location_view
;
2333 probe_location_view
= lttng_buffer_view_init(
2335 ext_comm
->userspace_probe_location_len
);
2338 * Create a temporary userspace probe location to
2339 * determine the size needed by a "flattened" version
2340 * of that same probe location.
2342 ret
= lttng_userspace_probe_location_create_from_buffer(
2343 &probe_location_view
, &probe_location
);
2345 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2349 ret
= lttng_userspace_probe_location_flatten(
2350 probe_location
, NULL
);
2351 lttng_userspace_probe_location_destroy(probe_location
);
2353 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2357 probe_storage_req
= ret
;
2358 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2361 storage_req
+= sizeof(struct lttng_event_extended
);
2362 storage_req
+= ext_comm
->filter_len
;
2363 storage_req
+= ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
2364 /* Padding to ensure the flat probe is aligned. */
2365 storage_req
= ALIGN_TO(storage_req
, sizeof(uint64_t));
2366 storage_req
+= probe_storage_req
;
2369 lttng_dynamic_buffer_init(&listing
);
2371 * We must ensure that "listing" is never resized so as to preserve
2372 * the validity of the flattened objects.
2374 ret
= lttng_dynamic_buffer_set_capacity(&listing
, storage_req
);
2376 ret
= -LTTNG_ERR_NOMEM
;
2380 ret
= lttng_dynamic_buffer_append(&listing
, reception_buffer
,
2381 nb_events
* sizeof(struct lttng_event
));
2383 ret
= -LTTNG_ERR_NOMEM
;
2384 goto free_dynamic_buffer
;
2387 comm_ext_at
= reception_buffer
+
2388 (nb_events
* sizeof(struct lttng_event
));
2389 for (i
= 0; i
< nb_events
; i
++) {
2390 struct lttng_event
*event
= (struct lttng_event
*)
2391 (listing
.data
+ (sizeof(struct lttng_event
) * i
));
2392 struct lttcomm_event_extended_header
*ext_comm
=
2393 (struct lttcomm_event_extended_header
*) comm_ext_at
;
2394 struct lttng_event_extended
*event_extended
=
2395 (struct lttng_event_extended
*)
2396 (listing
.data
+ listing
.size
);
2398 /* Insert struct lttng_event_extended. */
2399 ret
= lttng_dynamic_buffer_set_size(&listing
,
2400 listing
.size
+ sizeof(*event_extended
));
2402 ret
= -LTTNG_ERR_NOMEM
;
2403 goto free_dynamic_buffer
;
2405 event
->extended
.ptr
= event_extended
;
2407 comm_ext_at
+= sizeof(*ext_comm
);
2409 /* Insert filter expression. */
2410 if (ext_comm
->filter_len
) {
2411 event_extended
->filter_expression
= listing
.data
+
2413 ret
= lttng_dynamic_buffer_append(&listing
, comm_ext_at
,
2414 ext_comm
->filter_len
);
2416 ret
= -LTTNG_ERR_NOMEM
;
2417 goto free_dynamic_buffer
;
2419 comm_ext_at
+= ext_comm
->filter_len
;
2422 /* Insert exclusions. */
2423 if (ext_comm
->nb_exclusions
) {
2424 event_extended
->exclusions
.count
=
2425 ext_comm
->nb_exclusions
;
2426 event_extended
->exclusions
.strings
=
2427 listing
.data
+ listing
.size
;
2429 ret
= lttng_dynamic_buffer_append(&listing
,
2431 ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
);
2433 ret
= -LTTNG_ERR_NOMEM
;
2434 goto free_dynamic_buffer
;
2436 comm_ext_at
+= ext_comm
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
2439 /* Insert padding to align to 64-bits. */
2440 ret
= lttng_dynamic_buffer_set_size(&listing
,
2441 ALIGN_TO(listing
.size
, sizeof(uint64_t)));
2443 ret
= -LTTNG_ERR_NOMEM
;
2444 goto free_dynamic_buffer
;
2447 /* Insert flattened userspace probe location. */
2448 if (ext_comm
->userspace_probe_location_len
) {
2449 struct lttng_userspace_probe_location
*probe_location
= NULL
;
2450 struct lttng_buffer_view probe_location_view
;
2452 probe_location_view
= lttng_buffer_view_init(
2454 ext_comm
->userspace_probe_location_len
);
2456 ret
= lttng_userspace_probe_location_create_from_buffer(
2457 &probe_location_view
, &probe_location
);
2459 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2460 goto free_dynamic_buffer
;
2463 event_extended
->probe_location
= (struct lttng_userspace_probe_location
*)
2464 (listing
.data
+ listing
.size
);
2465 ret
= lttng_userspace_probe_location_flatten(
2466 probe_location
, &listing
);
2467 lttng_userspace_probe_location_destroy(probe_location
);
2469 ret
= -LTTNG_ERR_PROBE_LOCATION_INVAL
;
2470 goto free_dynamic_buffer
;
2473 comm_ext_at
+= ext_comm
->userspace_probe_location_len
;
2477 /* Don't reset listing buffer as we return its content. */
2478 *events
= (struct lttng_event
*) listing
.data
;
2479 lttng_dynamic_buffer_init(&listing
);
2480 ret
= (int) nb_events
;
2481 free_dynamic_buffer
:
2482 lttng_dynamic_buffer_reset(&listing
);
2485 free(reception_buffer
);
2490 * Sets the tracing_group variable with name.
2491 * This function allocates memory pointed to by tracing_group.
2492 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2494 int lttng_set_tracing_group(const char *name
)
2497 return -LTTNG_ERR_INVALID
;
2500 if (asprintf(&tracing_group
, "%s", name
) < 0) {
2501 return -LTTNG_ERR_FATAL
;
2507 int lttng_calibrate(struct lttng_handle
*handle
,
2508 struct lttng_calibrate
*calibrate
)
2511 * This command was removed in LTTng 2.9.
2513 return -LTTNG_ERR_UND
;
2517 * Set default channel attributes.
2518 * If either or both of the arguments are null, attr content is zeroe'd.
2520 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
2521 struct lttng_channel_attr
*attr
)
2523 struct lttng_channel_extended
*extended
;
2526 if (attr
== NULL
|| domain
== NULL
) {
2530 extended
= (struct lttng_channel_extended
*) attr
->extended
.ptr
;
2531 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
2533 /* Same for all domains. */
2534 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2535 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
2536 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
2538 switch (domain
->type
) {
2539 case LTTNG_DOMAIN_KERNEL
:
2540 attr
->switch_timer_interval
=
2541 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
2542 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
2543 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
2544 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
2545 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
2547 extended
->monitor_timer_interval
=
2548 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
;
2549 extended
->blocking_timeout
=
2550 DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT
;
2553 case LTTNG_DOMAIN_UST
:
2554 switch (domain
->buf_type
) {
2555 case LTTNG_BUFFER_PER_UID
:
2556 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
2557 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
2558 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
2559 attr
->switch_timer_interval
=
2560 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
2561 attr
->read_timer_interval
=
2562 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
2564 extended
->monitor_timer_interval
=
2565 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER
;
2566 extended
->blocking_timeout
=
2567 DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT
;
2570 case LTTNG_BUFFER_PER_PID
:
2572 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
2573 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
2574 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
2575 attr
->switch_timer_interval
=
2576 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2577 attr
->read_timer_interval
=
2578 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2580 extended
->monitor_timer_interval
=
2581 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
;
2582 extended
->blocking_timeout
=
2583 DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT
;
2588 /* Default behavior: leave set to 0. */
2592 attr
->extended
.ptr
= extended
;
2595 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2596 uint64_t *discarded_events
)
2599 struct lttng_channel_extended
*chan_ext
;
2601 if (!channel
|| !discarded_events
) {
2602 ret
= -LTTNG_ERR_INVALID
;
2606 chan_ext
= channel
->attr
.extended
.ptr
;
2609 * This can happen since the lttng_channel structure is
2610 * used for other tasks where this pointer is never set.
2612 *discarded_events
= 0;
2616 *discarded_events
= chan_ext
->discarded_events
;
2621 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2622 uint64_t *lost_packets
)
2625 struct lttng_channel_extended
*chan_ext
;
2627 if (!channel
|| !lost_packets
) {
2628 ret
= -LTTNG_ERR_INVALID
;
2632 chan_ext
= channel
->attr
.extended
.ptr
;
2635 * This can happen since the lttng_channel structure is
2636 * used for other tasks where this pointer is never set.
2642 *lost_packets
= chan_ext
->lost_packets
;
2647 int lttng_channel_get_monitor_timer_interval(struct lttng_channel
*chan
,
2648 uint64_t *monitor_timer_interval
)
2652 if (!chan
|| !monitor_timer_interval
) {
2653 ret
= -LTTNG_ERR_INVALID
;
2657 if (!chan
->attr
.extended
.ptr
) {
2658 ret
= -LTTNG_ERR_INVALID
;
2662 *monitor_timer_interval
= ((struct lttng_channel_extended
*)
2663 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
2668 int lttng_channel_set_monitor_timer_interval(struct lttng_channel
*chan
,
2669 uint64_t monitor_timer_interval
)
2673 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2674 ret
= -LTTNG_ERR_INVALID
;
2678 ((struct lttng_channel_extended
*)
2679 chan
->attr
.extended
.ptr
)->monitor_timer_interval
=
2680 monitor_timer_interval
;
2685 int lttng_channel_get_blocking_timeout(struct lttng_channel
*chan
,
2686 int64_t *blocking_timeout
)
2690 if (!chan
|| !blocking_timeout
) {
2691 ret
= -LTTNG_ERR_INVALID
;
2695 if (!chan
->attr
.extended
.ptr
) {
2696 ret
= -LTTNG_ERR_INVALID
;
2700 *blocking_timeout
= ((struct lttng_channel_extended
*)
2701 chan
->attr
.extended
.ptr
)->blocking_timeout
;
2706 int lttng_channel_set_blocking_timeout(struct lttng_channel
*chan
,
2707 int64_t blocking_timeout
)
2710 int64_t msec_timeout
;
2712 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2713 ret
= -LTTNG_ERR_INVALID
;
2717 if (blocking_timeout
< 0 && blocking_timeout
!= -1) {
2718 ret
= -LTTNG_ERR_INVALID
;
2723 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2724 * us to accept a narrower range of values (msecs expressed as a signed
2727 msec_timeout
= blocking_timeout
/ 1000;
2728 if (msec_timeout
!= (int32_t) msec_timeout
) {
2729 ret
= -LTTNG_ERR_INVALID
;
2733 ((struct lttng_channel_extended
*)
2734 chan
->attr
.extended
.ptr
)->blocking_timeout
=
2741 * Check if session daemon is alive.
2743 * Return 1 if alive or 0 if not.
2744 * On error returns a negative value.
2746 int lttng_session_daemon_alive(void)
2750 ret
= set_session_daemon_path();
2756 if (*sessiond_sock_path
== '\0') {
2758 * No socket path set. Weird error which means the constructor
2764 ret
= try_connect_sessiond(sessiond_sock_path
);
2775 * Set URL for a consumer for a session and domain.
2777 * Return 0 on success, else a negative value.
2779 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2780 const char *control_url
, const char *data_url
)
2784 struct lttcomm_session_msg lsm
;
2785 struct lttng_uri
*uris
= NULL
;
2787 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2788 return -LTTNG_ERR_INVALID
;
2791 memset(&lsm
, 0, sizeof(lsm
));
2793 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2795 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2796 sizeof(lsm
.session
.name
));
2797 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2799 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2801 return -LTTNG_ERR_INVALID
;
2804 lsm
.u
.uri
.size
= size
;
2806 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2807 sizeof(struct lttng_uri
) * size
, NULL
);
2816 int lttng_enable_consumer(struct lttng_handle
*handle
)
2824 int lttng_disable_consumer(struct lttng_handle
*handle
)
2832 int _lttng_create_session_ext(const char *name
, const char *url
,
2833 const char *datetime
)
2839 * For a given session name, this call checks if the data is ready to be read
2840 * or is still being extracted by the consumer(s) hence not ready to be used by
2843 int lttng_data_pending(const char *session_name
)
2846 struct lttcomm_session_msg lsm
;
2847 uint8_t *pending
= NULL
;
2849 if (session_name
== NULL
) {
2850 return -LTTNG_ERR_INVALID
;
2853 memset(&lsm
, 0, sizeof(lsm
));
2854 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
2856 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2857 sizeof(lsm
.session
.name
));
2859 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
2862 } else if (ret
!= 1) {
2863 /* Unexpected payload size */
2864 ret
= -LTTNG_ERR_INVALID
;
2868 ret
= (int) *pending
;
2875 * List PIDs in the tracker.
2877 * enabled is set to whether the PID tracker is enabled.
2878 * pids is set to an allocated array of PIDs currently tracked. On
2879 * success, pids must be freed by the caller.
2880 * nr_pids is set to the number of entries contained by the pids array.
2882 * Returns 0 on success, else a negative LTTng error code.
2884 int lttng_list_tracker_pids(struct lttng_handle
*handle
,
2885 int *_enabled
, int32_t **_pids
, size_t *_nr_pids
)
2889 struct lttcomm_session_msg lsm
;
2891 int32_t *pids
= NULL
;
2893 if (handle
== NULL
) {
2894 return -LTTNG_ERR_INVALID
;
2897 memset(&lsm
, 0, sizeof(lsm
));
2898 lsm
.cmd_type
= LTTNG_LIST_TRACKER_PIDS
;
2899 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2900 sizeof(lsm
.session
.name
));
2901 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2903 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pids
);
2907 nr_pids
= ret
/ sizeof(int32_t);
2908 if (nr_pids
> 0 && !pids
) {
2909 return -LTTNG_ERR_UNK
;
2911 if (nr_pids
== 1 && pids
[0] == -1) {
2917 *_enabled
= enabled
;
2919 *_nr_pids
= nr_pids
;
2924 * Regenerate the metadata for a session.
2925 * Return 0 on success, a negative error code on error.
2927 int lttng_regenerate_metadata(const char *session_name
)
2930 struct lttcomm_session_msg lsm
;
2932 if (!session_name
) {
2933 ret
= -LTTNG_ERR_INVALID
;
2937 memset(&lsm
, 0, sizeof(lsm
));
2938 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
2940 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2941 sizeof(lsm
.session
.name
));
2943 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2954 * Deprecated, replaced by lttng_regenerate_metadata.
2956 int lttng_metadata_regenerate(const char *session_name
)
2958 return lttng_regenerate_metadata(session_name
);
2962 * Regenerate the statedump of a session.
2963 * Return 0 on success, a negative error code on error.
2965 int lttng_regenerate_statedump(const char *session_name
)
2968 struct lttcomm_session_msg lsm
;
2970 if (!session_name
) {
2971 ret
= -LTTNG_ERR_INVALID
;
2975 memset(&lsm
, 0, sizeof(lsm
));
2976 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
2978 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2979 sizeof(lsm
.session
.name
));
2981 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2991 int lttng_register_trigger(struct lttng_trigger
*trigger
)
2994 struct lttcomm_session_msg lsm
;
2995 struct lttng_dynamic_buffer buffer
;
2997 lttng_dynamic_buffer_init(&buffer
);
2999 ret
= -LTTNG_ERR_INVALID
;
3003 if (!lttng_trigger_validate(trigger
)) {
3004 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3008 ret
= lttng_trigger_serialize(trigger
, &buffer
);
3010 ret
= -LTTNG_ERR_UNK
;
3014 memset(&lsm
, 0, sizeof(lsm
));
3015 lsm
.cmd_type
= LTTNG_REGISTER_TRIGGER
;
3016 lsm
.u
.trigger
.length
= (uint32_t) buffer
.size
;
3017 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buffer
.data
,
3020 lttng_dynamic_buffer_reset(&buffer
);
3024 int lttng_unregister_trigger(struct lttng_trigger
*trigger
)
3027 struct lttcomm_session_msg lsm
;
3028 struct lttng_dynamic_buffer buffer
;
3030 lttng_dynamic_buffer_init(&buffer
);
3032 ret
= -LTTNG_ERR_INVALID
;
3036 if (!lttng_trigger_validate(trigger
)) {
3037 ret
= -LTTNG_ERR_INVALID_TRIGGER
;
3041 ret
= lttng_trigger_serialize(trigger
, &buffer
);
3043 ret
= -LTTNG_ERR_UNK
;
3047 memset(&lsm
, 0, sizeof(lsm
));
3048 lsm
.cmd_type
= LTTNG_UNREGISTER_TRIGGER
;
3049 lsm
.u
.trigger
.length
= (uint32_t) buffer
.size
;
3050 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buffer
.data
,
3053 lttng_dynamic_buffer_reset(&buffer
);
3060 static void __attribute__((constructor
)) init(void)
3062 /* Set default session group */
3063 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
3069 static void __attribute__((destructor
)) lttng_ctl_exit(void)
3071 free(tracing_group
);