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/defaults.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35 #include <common/uri.h>
36 #include <common/utils.h>
37 #include <lttng/lttng.h>
38 #include <lttng/health-internal.h>
40 #include "filter/filter-ast.h"
41 #include "filter/filter-parser.h"
42 #include "filter/filter-bytecode.h"
43 #include "filter/memstream.h"
44 #include "lttng-ctl-helper.h"
47 static const int print_xml
= 1;
48 #define dbg_printf(fmt, args...) \
49 printf("[debug liblttng-ctl] " fmt, ## args)
51 static const int print_xml
= 0;
52 #define dbg_printf(fmt, args...) \
54 /* do nothing but check printf format */ \
56 printf("[debug liblttnctl] " fmt, ## args); \
61 /* Socket to session daemon for communication */
62 static int sessiond_socket
;
63 static char sessiond_sock_path
[PATH_MAX
];
66 static char *tracing_group
;
72 * Those two variables are used by error.h to silent or control the verbosity of
73 * error message. They are global to the library so application linking with it
74 * are able to compile correctly and also control verbosity of the library.
77 int lttng_opt_verbose
;
81 * Copy string from src to dst and enforce null terminated byte.
84 void lttng_ctl_copy_string(char *dst
, const char *src
, size_t len
)
87 strncpy(dst
, src
, len
);
88 /* Enforce the NULL terminated byte */
96 * Copy domain to lttcomm_session_msg domain.
98 * If domain is unknown, default domain will be the kernel.
101 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
102 struct lttng_domain
*src
)
106 case LTTNG_DOMAIN_KERNEL
:
107 case LTTNG_DOMAIN_UST
:
108 case LTTNG_DOMAIN_JUL
:
109 case LTTNG_DOMAIN_LOG4J
:
110 case LTTNG_DOMAIN_PYTHON
:
111 memcpy(dst
, src
, sizeof(struct lttng_domain
));
114 memset(dst
, 0, sizeof(struct lttng_domain
));
121 * Send lttcomm_session_msg to the session daemon.
123 * On success, returns the number of bytes sent (>=0)
124 * On error, returns -1
126 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
131 ret
= -LTTNG_ERR_NO_SESSIOND
;
135 DBG("LSM cmd type : %d", lsm
->cmd_type
);
137 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
138 sizeof(struct lttcomm_session_msg
));
140 ret
= -LTTNG_ERR_FATAL
;
148 * Send var len data to the session daemon.
150 * On success, returns the number of bytes sent (>=0)
151 * On error, returns -1
153 static int send_session_varlen(const void *data
, size_t len
)
158 ret
= -LTTNG_ERR_NO_SESSIOND
;
167 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
169 ret
= -LTTNG_ERR_FATAL
;
177 * Receive data from the sessiond socket.
179 * On success, returns the number of bytes received (>=0)
180 * On error, returns -1 (recvmsg() error) or -ENOTCONN
182 static int recv_data_sessiond(void *buf
, size_t len
)
187 ret
= -LTTNG_ERR_NO_SESSIOND
;
191 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
193 ret
= -LTTNG_ERR_FATAL
;
201 * Check if we are in the specified group.
203 * If yes return 1, else return -1.
206 int lttng_check_tracing_group(void)
208 struct group
*grp_tracing
; /* no free(). See getgrnam(3) */
210 int grp_list_size
, grp_id
, i
;
212 const char *grp_name
= tracing_group
;
214 /* Get GID of group 'tracing' */
215 grp_tracing
= getgrnam(grp_name
);
217 /* If grp_tracing is NULL, the group does not exist. */
221 /* Get number of supplementary group IDs */
222 grp_list_size
= getgroups(0, NULL
);
223 if (grp_list_size
< 0) {
228 /* Alloc group list of the right size */
229 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
234 grp_id
= getgroups(grp_list_size
, grp_list
);
240 for (i
= 0; i
< grp_list_size
; i
++) {
241 if (grp_list
[i
] == grp_tracing
->gr_gid
) {
255 * Try connect to session daemon with sock_path.
257 * Return 0 on success, else -1
259 static int try_connect_sessiond(const char *sock_path
)
263 /* If socket exist, we check if the daemon listens for connect. */
264 ret
= access(sock_path
, F_OK
);
270 ret
= lttcomm_connect_unix_sock(sock_path
);
276 ret
= lttcomm_close_unix_sock(ret
);
278 PERROR("lttcomm_close_unix_sock");
288 * Set sessiond socket path by putting it in the global sessiond_sock_path
291 * Returns 0 on success, negative value on failure (the sessiond socket path
292 * is somehow too long or ENOMEM).
294 static int set_session_daemon_path(void)
296 int in_tgroup
= 0; /* In tracing group. */
302 /* Are we in the tracing group ? */
303 in_tgroup
= lttng_check_tracing_group();
306 if ((uid
== 0) || in_tgroup
) {
307 lttng_ctl_copy_string(sessiond_sock_path
,
308 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
, sizeof(sessiond_sock_path
));
316 ret
= try_connect_sessiond(sessiond_sock_path
);
320 /* Global session daemon not available... */
322 /* ...or not in tracing group (and not root), default */
325 * With GNU C < 2.1, snprintf returns -1 if the target buffer
327 * With GNU C >= 2.1, snprintf returns the required size
328 * (excluding closing null)
330 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
331 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
332 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
344 * Connect to the LTTng session daemon.
346 * On success, return 0. On error, return -1.
348 static int connect_sessiond(void)
352 /* Don't try to connect if already connected. */
357 ret
= set_session_daemon_path();
362 /* Connect to the sesssion daemon. */
363 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
368 sessiond_socket
= ret
;
378 * Clean disconnect from the session daemon.
380 * On success, return 0. On error, return -1.
382 static int disconnect_sessiond(void)
387 ret
= lttcomm_close_unix_sock(sessiond_socket
);
395 static int recv_sessiond_optional_data(size_t len
, void **user_buf
,
403 ret
= -LTTNG_ERR_INVALID
;
413 ret
= recv_data_sessiond(buf
, len
);
419 ret
= -LTTNG_ERR_INVALID
;
423 /* Move ownership of command header buffer to user. */
428 /* No command header. */
444 * Ask the session daemon a specific command and put the data into buf.
445 * Takes extra var. len. data as input to send to the session daemon.
447 * Return size of data (only payload, not header) or a negative error code.
450 int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg
*lsm
,
451 const void *vardata
, size_t vardata_len
,
452 void **user_payload_buf
, void **user_cmd_header_buf
,
453 size_t *user_cmd_header_len
)
457 struct lttcomm_lttng_msg llm
;
459 ret
= connect_sessiond();
461 ret
= -LTTNG_ERR_NO_SESSIOND
;
465 /* Send command to session daemon */
466 ret
= send_session_msg(lsm
);
468 /* Ret value is a valid lttng error code. */
471 /* Send var len data */
472 ret
= send_session_varlen(vardata
, vardata_len
);
474 /* Ret value is a valid lttng error code. */
478 /* Get header from data transmission */
479 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
481 /* Ret value is a valid lttng error code. */
485 /* Check error code if OK */
486 if (llm
.ret_code
!= LTTNG_OK
) {
491 /* Get command header from data transmission */
492 ret
= recv_sessiond_optional_data(llm
.cmd_header_size
,
493 user_cmd_header_buf
, user_cmd_header_len
);
498 /* Get payload from data transmission */
499 ret
= recv_sessiond_optional_data(llm
.data_size
, user_payload_buf
,
508 disconnect_sessiond();
513 * Create lttng handle and return pointer.
515 * The returned pointer will be NULL in case of malloc() error.
517 struct lttng_handle
*lttng_create_handle(const char *session_name
,
518 struct lttng_domain
*domain
)
520 struct lttng_handle
*handle
= NULL
;
522 handle
= zmalloc(sizeof(struct lttng_handle
));
523 if (handle
== NULL
) {
524 PERROR("malloc handle");
528 /* Copy session name */
529 lttng_ctl_copy_string(handle
->session_name
, session_name
,
530 sizeof(handle
->session_name
));
532 /* Copy lttng domain or leave initialized to 0. */
534 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
542 * Destroy handle by free(3) the pointer.
544 void lttng_destroy_handle(struct lttng_handle
*handle
)
550 * Register an outside consumer.
552 * Returns size of returned session payload data or a negative error code.
554 int lttng_register_consumer(struct lttng_handle
*handle
,
555 const char *socket_path
)
557 struct lttcomm_session_msg lsm
;
559 if (handle
== NULL
|| socket_path
== NULL
) {
560 return -LTTNG_ERR_INVALID
;
563 memset(&lsm
, 0, sizeof(lsm
));
564 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
565 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
566 sizeof(lsm
.session
.name
));
567 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
569 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
,
570 sizeof(lsm
.u
.reg
.path
));
572 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
576 * Start tracing for all traces of the session.
578 * Returns size of returned session payload data or a negative error code.
580 int lttng_start_tracing(const char *session_name
)
582 struct lttcomm_session_msg lsm
;
584 if (session_name
== NULL
) {
585 return -LTTNG_ERR_INVALID
;
588 memset(&lsm
, 0, sizeof(lsm
));
589 lsm
.cmd_type
= LTTNG_START_TRACE
;
591 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
592 sizeof(lsm
.session
.name
));
594 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
598 * Stop tracing for all traces of the session.
600 static int _lttng_stop_tracing(const char *session_name
, int wait
)
603 struct lttcomm_session_msg lsm
;
605 if (session_name
== NULL
) {
606 return -LTTNG_ERR_INVALID
;
609 memset(&lsm
, 0, sizeof(lsm
));
610 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
612 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
613 sizeof(lsm
.session
.name
));
615 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
616 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
624 /* Check for data availability */
626 data_ret
= lttng_data_pending(session_name
);
628 /* Return the data available call error. */
634 * Data sleep time before retrying (in usec). Don't sleep if the
635 * call returned value indicates availability.
638 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME
);
640 } while (data_ret
!= 0);
648 * Stop tracing and wait for data availability.
650 int lttng_stop_tracing(const char *session_name
)
652 return _lttng_stop_tracing(session_name
, 1);
656 * Stop tracing but _don't_ wait for data availability.
658 int lttng_stop_tracing_no_wait(const char *session_name
)
660 return _lttng_stop_tracing(session_name
, 0);
664 * Add context to a channel.
666 * If the given channel is NULL, add the contexts to all channels.
667 * The event_name param is ignored.
669 * Returns the size of the returned payload data or a negative error code.
671 int lttng_add_context(struct lttng_handle
*handle
,
672 struct lttng_event_context
*ctx
, const char *event_name
,
673 const char *channel_name
)
678 struct lttcomm_session_msg lsm
;
680 /* Safety check. Both are mandatory. */
681 if (handle
== NULL
|| ctx
== NULL
) {
682 ret
= -LTTNG_ERR_INVALID
;
686 memset(&lsm
, 0, sizeof(lsm
));
687 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
689 /* If no channel name, send empty string. */
690 if (channel_name
== NULL
) {
691 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
692 sizeof(lsm
.u
.context
.channel_name
));
694 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
695 sizeof(lsm
.u
.context
.channel_name
));
698 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
699 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
700 sizeof(lsm
.session
.name
));
702 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
703 size_t provider_len
, ctx_len
;
704 const char *provider_name
= ctx
->u
.app_ctx
.provider_name
;
705 const char *ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
707 if (!provider_name
|| !ctx_name
) {
708 ret
= -LTTNG_ERR_INVALID
;
712 provider_len
= strlen(provider_name
);
713 if (provider_len
== 0) {
714 ret
= -LTTNG_ERR_INVALID
;
717 lsm
.u
.context
.provider_name_len
= provider_len
;
719 ctx_len
= strlen(ctx_name
);
721 ret
= -LTTNG_ERR_INVALID
;
724 lsm
.u
.context
.context_name_len
= ctx_len
;
726 len
= provider_len
+ ctx_len
;
729 ret
= -LTTNG_ERR_NOMEM
;
733 memcpy(buf
, provider_name
, provider_len
);
734 memcpy(buf
+ provider_len
, ctx_name
, ctx_len
);
736 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
738 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
740 * Don't leak application addresses to the sessiond.
741 * This is only necessary when ctx is for an app ctx otherwise
742 * the values inside the union (type & config) are overwritten.
744 lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
745 lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
748 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buf
, len
, NULL
);
755 * Enable event(s) for a channel.
757 * If no event name is specified, all events are enabled.
758 * If no channel name is specified, the default 'channel0' is used.
760 * Returns size of returned session payload data or a negative error code.
762 int lttng_enable_event(struct lttng_handle
*handle
,
763 struct lttng_event
*ev
, const char *channel_name
)
765 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
770 * Create or enable an event with a filter expression.
772 * Return negative error value on error.
773 * Return size of returned session payload data if OK.
775 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
776 struct lttng_event
*event
, const char *channel_name
,
777 const char *filter_expression
)
779 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
780 filter_expression
, 0, NULL
);
784 * Depending on the event, return a newly allocated agent filter expression or
785 * NULL if not applicable.
787 * An event with NO loglevel and the name is * will return NULL.
789 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
792 char *agent_filter
= NULL
;
796 /* Don't add filter for the '*' event. */
797 if (strcmp(ev
->name
, "*") != 0) {
799 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
802 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
810 /* Add loglevel filtering if any for the JUL domain. */
811 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
814 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
820 if (filter
|| agent_filter
) {
823 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
824 agent_filter
? agent_filter
: filter
, op
,
829 agent_filter
= new_filter
;
831 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
847 * Generate the filter bytecode from a given filter expression string. Put the
848 * newly allocated parser context in ctxp and populate the lsm object with the
851 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
853 static int generate_filter(char *filter_expression
,
854 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
857 struct filter_parser_ctx
*ctx
= NULL
;
860 assert(filter_expression
);
865 * Casting const to non-const, as the underlying function will use it in
868 fmem
= lttng_fmemopen((void *) filter_expression
,
869 strlen(filter_expression
), "r");
871 fprintf(stderr
, "Error opening memory as stream\n");
872 ret
= -LTTNG_ERR_FILTER_NOMEM
;
875 ctx
= filter_parser_ctx_alloc(fmem
);
877 fprintf(stderr
, "Error allocating parser\n");
878 ret
= -LTTNG_ERR_FILTER_NOMEM
;
879 goto filter_alloc_error
;
881 ret
= filter_parser_ctx_append_ast(ctx
);
883 fprintf(stderr
, "Parse error\n");
884 ret
= -LTTNG_ERR_FILTER_INVAL
;
887 ret
= filter_visitor_set_parent(ctx
);
889 fprintf(stderr
, "Set parent error\n");
890 ret
= -LTTNG_ERR_FILTER_INVAL
;
894 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
897 fprintf(stderr
, "XML print error\n");
898 ret
= -LTTNG_ERR_FILTER_INVAL
;
903 dbg_printf("Generating IR... ");
905 ret
= filter_visitor_ir_generate(ctx
);
907 fprintf(stderr
, "Generate IR error\n");
908 ret
= -LTTNG_ERR_FILTER_INVAL
;
911 dbg_printf("done\n");
913 dbg_printf("Validating IR... ");
915 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
917 ret
= -LTTNG_ERR_FILTER_INVAL
;
921 /* Normalize globbing patterns in the expression. */
922 ret
= filter_visitor_ir_normalize_glob_patterns(ctx
);
924 ret
= -LTTNG_ERR_FILTER_INVAL
;
928 /* Validate strings used as literals in the expression. */
929 ret
= filter_visitor_ir_validate_string(ctx
);
931 ret
= -LTTNG_ERR_FILTER_INVAL
;
935 /* Validate globbing patterns in the expression. */
936 ret
= filter_visitor_ir_validate_globbing(ctx
);
938 ret
= -LTTNG_ERR_FILTER_INVAL
;
942 dbg_printf("done\n");
944 dbg_printf("Generating bytecode... ");
946 ret
= filter_visitor_bytecode_generate(ctx
);
948 fprintf(stderr
, "Generate bytecode error\n");
949 ret
= -LTTNG_ERR_FILTER_INVAL
;
952 dbg_printf("done\n");
953 dbg_printf("Size of bytecode generated: %u bytes.\n",
954 bytecode_get_len(&ctx
->bytecode
->b
));
956 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
957 + bytecode_get_len(&ctx
->bytecode
->b
);
958 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
960 /* No need to keep the memory stream. */
961 if (fclose(fmem
) != 0) {
970 filter_parser_ctx_free(ctx
);
972 if (fclose(fmem
) != 0) {
980 * Enable event(s) for a channel, possibly with exclusions and a filter.
981 * If no event name is specified, all events are enabled.
982 * If no channel name is specified, the default name is used.
983 * If filter expression is not NULL, the filter is set for the event.
984 * If exclusion count is not zero, the exclusions are set for the event.
985 * Returns size of returned session payload data or a negative error code.
987 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
988 struct lttng_event
*ev
, const char *channel_name
,
989 const char *original_filter_expression
,
990 int exclusion_count
, char **exclusion_list
)
992 struct lttcomm_session_msg lsm
;
995 unsigned int free_filter_expression
= 0;
996 struct filter_parser_ctx
*ctx
= NULL
;
998 * Cast as non-const since we may replace the filter expression
999 * by a dynamically allocated string. Otherwise, the original
1000 * string is not modified.
1002 char *filter_expression
= (char *) original_filter_expression
;
1004 if (handle
== NULL
|| ev
== NULL
) {
1005 ret
= -LTTNG_ERR_INVALID
;
1010 * Empty filter string will always be rejected by the parser
1011 * anyway, so treat this corner-case early to eliminate
1012 * lttng_fmemopen error for 0-byte allocation.
1014 if (filter_expression
&& filter_expression
[0] == '\0') {
1015 ret
= -LTTNG_ERR_INVALID
;
1019 memset(&lsm
, 0, sizeof(lsm
));
1021 /* If no channel name, send empty string. */
1022 if (channel_name
== NULL
) {
1023 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
1024 sizeof(lsm
.u
.enable
.channel_name
));
1026 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
1027 sizeof(lsm
.u
.enable
.channel_name
));
1030 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1031 if (ev
->name
[0] == '\0') {
1032 /* Enable all events */
1033 lttng_ctl_copy_string(ev
->name
, "*", sizeof(ev
->name
));
1036 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1037 /* FIXME: copying non-packed struct to packed struct. */
1038 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1040 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1041 sizeof(lsm
.session
.name
));
1042 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1043 lsm
.u
.enable
.bytecode_len
= 0;
1046 * For the JUL domain, a filter is enforced except for the enable all
1047 * event. This is done to avoid having the event in all sessions thus
1048 * filtering by logger name.
1050 if (exclusion_count
== 0 && filter_expression
== NULL
&&
1051 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1052 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1053 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1058 * We have either a filter or some exclusions, so we need to set up
1059 * a variable-length memory block from where to send the data.
1062 /* Parse filter expression. */
1063 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1064 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1065 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1066 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1067 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1068 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1071 /* Setup JUL filter if needed. */
1072 agent_filter
= set_agent_filter(filter_expression
, ev
);
1073 if (!agent_filter
) {
1074 if (!filter_expression
) {
1076 * No JUL and no filter, just skip
1083 * With an agent filter, the original filter has
1084 * been added to it thus replace the filter
1087 filter_expression
= agent_filter
;
1088 free_filter_expression
= 1;
1092 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1098 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
1099 + lsm
.u
.enable
.expression_len
1100 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
1102 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1106 /* Put exclusion names first in the data. */
1107 while (exclusion_count
--) {
1108 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
1109 *(exclusion_list
+ exclusion_count
),
1110 LTTNG_SYMBOL_NAME_LEN
- 1);
1112 /* Add filter expression next. */
1113 if (lsm
.u
.enable
.expression_len
!= 0) {
1115 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
1117 lsm
.u
.enable
.expression_len
);
1119 /* Add filter bytecode next. */
1120 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1122 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
1123 + lsm
.u
.enable
.expression_len
,
1125 lsm
.u
.enable
.bytecode_len
);
1128 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1129 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
1130 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
,
1135 if (filter_expression
&& ctx
) {
1136 filter_bytecode_free(ctx
);
1137 filter_ir_free(ctx
);
1138 filter_parser_ctx_free(ctx
);
1141 if (free_filter_expression
) {
1143 * The filter expression has been replaced and must be freed as
1144 * it is not the original filter expression received as a
1147 free(filter_expression
);
1151 * Return directly to the caller and don't ask the sessiond since
1152 * something went wrong in the parsing of data above.
1157 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1161 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1162 struct lttng_event
*ev
, const char *channel_name
,
1163 const char *original_filter_expression
)
1165 struct lttcomm_session_msg lsm
;
1168 unsigned int free_filter_expression
= 0;
1169 struct filter_parser_ctx
*ctx
= NULL
;
1171 * Cast as non-const since we may replace the filter expression
1172 * by a dynamically allocated string. Otherwise, the original
1173 * string is not modified.
1175 char *filter_expression
= (char *) original_filter_expression
;
1177 if (handle
== NULL
|| ev
== NULL
) {
1178 ret
= -LTTNG_ERR_INVALID
;
1183 * Empty filter string will always be rejected by the parser
1184 * anyway, so treat this corner-case early to eliminate
1185 * lttng_fmemopen error for 0-byte allocation.
1187 if (filter_expression
&& filter_expression
[0] == '\0') {
1188 ret
= -LTTNG_ERR_INVALID
;
1192 memset(&lsm
, 0, sizeof(lsm
));
1194 /* If no channel name, send empty string. */
1195 if (channel_name
== NULL
) {
1196 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1197 sizeof(lsm
.u
.disable
.channel_name
));
1199 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1200 sizeof(lsm
.u
.disable
.channel_name
));
1203 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1205 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1206 /* FIXME: copying non-packed struct to packed struct. */
1207 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1209 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1210 sizeof(lsm
.session
.name
));
1211 lsm
.u
.disable
.bytecode_len
= 0;
1214 * For the JUL domain, a filter is enforced except for the
1215 * disable all event. This is done to avoid having the event in
1216 * all sessions thus filtering by logger name.
1218 if (filter_expression
== NULL
&&
1219 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1220 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1221 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1226 * We have a filter, so we need to set up a variable-length
1227 * memory block from where to send the data.
1230 /* Parse filter expression */
1231 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1232 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1233 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1234 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1235 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1236 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1239 /* Setup JUL filter if needed. */
1240 agent_filter
= set_agent_filter(filter_expression
, ev
);
1241 if (!agent_filter
) {
1242 if (!filter_expression
) {
1244 * No JUL and no filter, just skip
1251 * With a JUL filter, the original filter has
1252 * been added to it thus replace the filter
1255 filter_expression
= agent_filter
;
1256 free_filter_expression
= 1;
1260 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1266 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1267 + lsm
.u
.disable
.expression_len
);
1269 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1273 /* Add filter expression. */
1274 if (lsm
.u
.disable
.expression_len
!= 0) {
1277 lsm
.u
.disable
.expression_len
);
1279 /* Add filter bytecode next. */
1280 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1282 + lsm
.u
.disable
.expression_len
,
1284 lsm
.u
.disable
.bytecode_len
);
1287 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1288 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1292 if (filter_expression
&& ctx
) {
1293 filter_bytecode_free(ctx
);
1294 filter_ir_free(ctx
);
1295 filter_parser_ctx_free(ctx
);
1298 if (free_filter_expression
) {
1300 * The filter expression has been replaced and must be freed as
1301 * it is not the original filter expression received as a
1304 free(filter_expression
);
1308 * Return directly to the caller and don't ask the sessiond since
1309 * something went wrong in the parsing of data above.
1314 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1319 * Disable event(s) of a channel and domain.
1320 * If no event name is specified, all events are disabled.
1321 * If no channel name is specified, the default 'channel0' is used.
1322 * Returns size of returned session payload data or a negative error code.
1324 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1325 const char *channel_name
)
1327 struct lttng_event ev
;
1329 memset(&ev
, 0, sizeof(ev
));
1331 ev
.type
= LTTNG_EVENT_ALL
;
1332 lttng_ctl_copy_string(ev
.name
, name
, sizeof(ev
.name
));
1333 return lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1337 * Enable channel per domain
1338 * Returns size of returned session payload data or a negative error code.
1340 int lttng_enable_channel(struct lttng_handle
*handle
,
1341 struct lttng_channel
*chan
)
1343 struct lttcomm_session_msg lsm
;
1345 /* NULL arguments are forbidden. No default values. */
1346 if (handle
== NULL
|| chan
== NULL
) {
1347 return -LTTNG_ERR_INVALID
;
1350 memset(&lsm
, 0, sizeof(lsm
));
1352 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(lsm
.u
.channel
.chan
));
1354 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1356 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1358 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1359 sizeof(lsm
.session
.name
));
1361 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1365 * All tracing will be stopped for registered events of the channel.
1366 * Returns size of returned session payload data or a negative error code.
1368 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1370 struct lttcomm_session_msg lsm
;
1372 /* Safety check. Both are mandatory. */
1373 if (handle
== NULL
|| name
== NULL
) {
1374 return -LTTNG_ERR_INVALID
;
1377 memset(&lsm
, 0, sizeof(lsm
));
1379 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1381 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1382 sizeof(lsm
.u
.disable
.channel_name
));
1384 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1386 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1387 sizeof(lsm
.session
.name
));
1389 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1393 * Add PID to session tracker.
1394 * Return 0 on success else a negative LTTng error code.
1396 int lttng_track_pid(struct lttng_handle
*handle
, int pid
)
1398 struct lttcomm_session_msg lsm
;
1400 /* NULL arguments are forbidden. No default values. */
1401 if (handle
== NULL
) {
1402 return -LTTNG_ERR_INVALID
;
1405 memset(&lsm
, 0, sizeof(lsm
));
1407 lsm
.cmd_type
= LTTNG_TRACK_PID
;
1408 lsm
.u
.pid_tracker
.pid
= pid
;
1410 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1412 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1413 sizeof(lsm
.session
.name
));
1415 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1419 * Remove PID from session tracker.
1420 * Return 0 on success else a negative LTTng error code.
1422 int lttng_untrack_pid(struct lttng_handle
*handle
, int pid
)
1424 struct lttcomm_session_msg lsm
;
1426 /* NULL arguments are forbidden. No default values. */
1427 if (handle
== NULL
) {
1428 return -LTTNG_ERR_INVALID
;
1431 memset(&lsm
, 0, sizeof(lsm
));
1433 lsm
.cmd_type
= LTTNG_UNTRACK_PID
;
1434 lsm
.u
.pid_tracker
.pid
= pid
;
1436 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1438 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1439 sizeof(lsm
.session
.name
));
1441 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1445 * Lists all available tracepoints of domain.
1446 * Sets the contents of the events array.
1447 * Returns the number of lttng_event entries in events;
1448 * on error, returns a negative value.
1450 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1451 struct lttng_event
**events
)
1454 struct lttcomm_session_msg lsm
;
1456 if (handle
== NULL
) {
1457 return -LTTNG_ERR_INVALID
;
1460 memset(&lsm
, 0, sizeof(lsm
));
1461 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1462 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1464 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1469 return ret
/ sizeof(struct lttng_event
);
1473 * Lists all available tracepoint fields of domain.
1474 * Sets the contents of the event field array.
1475 * Returns the number of lttng_event_field entries in events;
1476 * on error, returns a negative value.
1478 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1479 struct lttng_event_field
**fields
)
1482 struct lttcomm_session_msg lsm
;
1484 if (handle
== NULL
) {
1485 return -LTTNG_ERR_INVALID
;
1488 memset(&lsm
, 0, sizeof(lsm
));
1489 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1490 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1492 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1497 return ret
/ sizeof(struct lttng_event_field
);
1501 * Lists all available kernel system calls. Allocates and sets the contents of
1504 * Returns the number of lttng_event entries in events; on error, returns a
1507 int lttng_list_syscalls(struct lttng_event
**events
)
1510 struct lttcomm_session_msg lsm
;
1513 return -LTTNG_ERR_INVALID
;
1516 memset(&lsm
, 0, sizeof(lsm
));
1517 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1518 /* Force kernel domain for system calls. */
1519 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1521 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1526 return ret
/ sizeof(struct lttng_event
);
1530 * Returns a human readable string describing
1531 * the error code (a negative value).
1533 const char *lttng_strerror(int code
)
1535 return error_get_str(code
);
1539 * Create a brand new session using name and url for destination.
1541 * Returns LTTNG_OK on success or a negative error code.
1543 int lttng_create_session(const char *name
, const char *url
)
1547 struct lttcomm_session_msg lsm
;
1548 struct lttng_uri
*uris
= NULL
;
1551 return -LTTNG_ERR_INVALID
;
1554 memset(&lsm
, 0, sizeof(lsm
));
1556 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1557 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1559 /* There should never be a data URL */
1560 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1562 return -LTTNG_ERR_INVALID
;
1565 lsm
.u
.uri
.size
= size
;
1567 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
1568 sizeof(struct lttng_uri
) * size
, NULL
);
1575 * Destroy session using name.
1576 * Returns size of returned session payload data or a negative error code.
1579 int _lttng_destroy_session(const char *session_name
)
1581 struct lttcomm_session_msg lsm
;
1583 if (session_name
== NULL
) {
1584 return -LTTNG_ERR_INVALID
;
1587 memset(&lsm
, 0, sizeof(lsm
));
1588 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1590 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1591 sizeof(lsm
.session
.name
));
1593 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1597 * Stop the session and wait for the data before destroying it
1599 int lttng_destroy_session(const char *session_name
)
1604 * Stop the tracing and wait for the data.
1606 ret
= _lttng_stop_tracing(session_name
, 1);
1607 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
1611 ret
= _lttng_destroy_session(session_name
);
1617 * Destroy the session without waiting for the data.
1619 int lttng_destroy_session_no_wait(const char *session_name
)
1624 * Stop the tracing without waiting for the data.
1625 * The session might already have been stopped, so just
1628 ret
= _lttng_stop_tracing(session_name
, 0);
1629 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
1633 ret
= _lttng_destroy_session(session_name
);
1639 * Ask the session daemon for all available sessions.
1640 * Sets the contents of the sessions array.
1641 * Returns the number of lttng_session entries in sessions;
1642 * on error, returns a negative value.
1644 int lttng_list_sessions(struct lttng_session
**sessions
)
1647 struct lttcomm_session_msg lsm
;
1649 memset(&lsm
, 0, sizeof(lsm
));
1650 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1651 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1656 return ret
/ sizeof(struct lttng_session
);
1659 int lttng_set_session_shm_path(const char *session_name
,
1660 const char *shm_path
)
1662 struct lttcomm_session_msg lsm
;
1664 if (session_name
== NULL
) {
1665 return -LTTNG_ERR_INVALID
;
1668 memset(&lsm
, 0, sizeof(lsm
));
1669 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
1671 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1672 sizeof(lsm
.session
.name
));
1673 lttng_ctl_copy_string(lsm
.u
.set_shm_path
.shm_path
, shm_path
,
1674 sizeof(lsm
.u
.set_shm_path
.shm_path
));
1676 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1680 * Ask the session daemon for all available domains of a session.
1681 * Sets the contents of the domains array.
1682 * Returns the number of lttng_domain entries in domains;
1683 * on error, returns a negative value.
1685 int lttng_list_domains(const char *session_name
,
1686 struct lttng_domain
**domains
)
1689 struct lttcomm_session_msg lsm
;
1691 if (session_name
== NULL
) {
1692 return -LTTNG_ERR_INVALID
;
1695 memset(&lsm
, 0, sizeof(lsm
));
1696 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1698 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1699 sizeof(lsm
.session
.name
));
1701 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1706 return ret
/ sizeof(struct lttng_domain
);
1710 * Ask the session daemon for all available channels of a session.
1711 * Sets the contents of the channels array.
1712 * Returns the number of lttng_channel entries in channels;
1713 * on error, returns a negative value.
1715 int lttng_list_channels(struct lttng_handle
*handle
,
1716 struct lttng_channel
**channels
)
1719 size_t channel_count
, i
;
1720 const size_t channel_size
= sizeof(struct lttng_channel
) +
1721 sizeof(struct lttcomm_channel_extended
);
1722 struct lttcomm_session_msg lsm
;
1725 if (handle
== NULL
) {
1726 ret
= -LTTNG_ERR_INVALID
;
1730 memset(&lsm
, 0, sizeof(lsm
));
1731 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1732 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1733 sizeof(lsm
.session
.name
));
1735 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1737 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1742 if (ret
% channel_size
) {
1743 ret
= -LTTNG_ERR_UNK
;
1748 channel_count
= (size_t) ret
/ channel_size
;
1750 /* Set extended info pointers */
1751 extended_at
= ((void *) *channels
) +
1752 channel_count
* sizeof(struct lttng_channel
);
1753 for (i
= 0; i
< channel_count
; i
++) {
1754 struct lttng_channel
*chan
= &(*channels
)[i
];
1756 chan
->attr
.extended
.ptr
= extended_at
;
1757 extended_at
+= sizeof(struct lttcomm_channel_extended
);
1760 ret
= (int) channel_count
;
1766 * Ask the session daemon for all available events of a session channel.
1767 * Sets the contents of the events array.
1768 * Returns the number of lttng_event entries in events;
1769 * on error, returns a negative value.
1771 int lttng_list_events(struct lttng_handle
*handle
,
1772 const char *channel_name
, struct lttng_event
**events
)
1775 struct lttcomm_session_msg lsm
;
1776 struct lttcomm_event_command_header
*cmd_header
= NULL
;
1777 size_t cmd_header_len
;
1778 uint32_t nb_events
, i
;
1781 /* Safety check. An handle and channel name are mandatory */
1782 if (handle
== NULL
|| channel_name
== NULL
) {
1783 return -LTTNG_ERR_INVALID
;
1786 memset(&lsm
, 0, sizeof(lsm
));
1787 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1788 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1789 sizeof(lsm
.session
.name
));
1790 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1791 sizeof(lsm
.u
.list
.channel_name
));
1792 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1794 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, NULL
, 0, (void **) events
,
1795 (void **) &cmd_header
, &cmd_header_len
);
1800 /* Set number of events and free command header */
1801 nb_events
= cmd_header
->nb_events
;
1802 if (nb_events
> INT_MAX
) {
1806 ret
= (int) nb_events
;
1810 /* Set extended info pointers */
1811 extended_at
= ((void*) (*events
)) +
1812 nb_events
* sizeof(struct lttng_event
);
1814 for (i
= 0; i
< nb_events
; i
++) {
1815 struct lttcomm_event_extended_header
*ext_header
;
1816 struct lttng_event
*event
= &(*events
)[i
];
1818 event
->extended
.ptr
= extended_at
;
1820 (struct lttcomm_event_extended_header
*) extended_at
;
1821 extended_at
+= sizeof(*ext_header
);
1822 extended_at
+= ext_header
->filter_len
;
1824 ext_header
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
1834 int lttng_event_get_filter_expression(struct lttng_event
*event
,
1835 const char **filter_expression
)
1838 struct lttcomm_event_extended_header
*ext_header
;
1840 if (!event
|| !filter_expression
) {
1841 ret
= -LTTNG_ERR_INVALID
;
1845 ext_header
= event
->extended
.ptr
;
1849 * This can happen since the lttng_event structure is
1850 * used for other tasks where this pointer is never set.
1852 *filter_expression
= NULL
;
1856 if (ext_header
->filter_len
) {
1857 *filter_expression
= ((const char *) (ext_header
)) +
1858 sizeof(*ext_header
);
1860 *filter_expression
= NULL
;
1867 int lttng_event_get_exclusion_name_count(struct lttng_event
*event
)
1870 struct lttcomm_event_extended_header
*ext_header
;
1873 ret
= -LTTNG_ERR_INVALID
;
1877 ext_header
= event
->extended
.ptr
;
1880 * This can happen since the lttng_event structure is
1881 * used for other tasks where this pointer is never set.
1887 if (ext_header
->nb_exclusions
> INT_MAX
) {
1888 ret
= -LTTNG_ERR_OVERFLOW
;
1891 ret
= (int) ext_header
->nb_exclusions
;
1896 int lttng_event_get_exclusion_name(struct lttng_event
*event
,
1897 size_t index
, const char **exclusion_name
)
1900 struct lttcomm_event_extended_header
*ext_header
;
1903 if (!event
|| !exclusion_name
) {
1904 ret
= -LTTNG_ERR_INVALID
;
1908 ext_header
= event
->extended
.ptr
;
1910 ret
= -LTTNG_ERR_INVALID
;
1914 if (index
>= ext_header
->nb_exclusions
) {
1915 ret
= -LTTNG_ERR_INVALID
;
1919 at
= (void *) ext_header
+ sizeof(*ext_header
);
1920 at
+= ext_header
->filter_len
;
1921 at
+= index
* LTTNG_SYMBOL_NAME_LEN
;
1922 *exclusion_name
= at
;
1929 * Sets the tracing_group variable with name.
1930 * This function allocates memory pointed to by tracing_group.
1931 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1933 int lttng_set_tracing_group(const char *name
)
1936 return -LTTNG_ERR_INVALID
;
1939 if (asprintf(&tracing_group
, "%s", name
) < 0) {
1940 return -LTTNG_ERR_FATAL
;
1946 int lttng_calibrate(struct lttng_handle
*handle
,
1947 struct lttng_calibrate
*calibrate
)
1950 * This command was removed in LTTng 2.9.
1952 return -LTTNG_ERR_UND
;
1956 * Set default channel attributes.
1957 * If either or both of the arguments are null, attr content is zeroe'd.
1959 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
1960 struct lttng_channel_attr
*attr
)
1963 if (attr
== NULL
|| domain
== NULL
) {
1967 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
1969 /* Same for all domains. */
1970 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1971 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
1972 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
1974 switch (domain
->type
) {
1975 case LTTNG_DOMAIN_KERNEL
:
1976 attr
->switch_timer_interval
=
1977 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
1978 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
1979 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
1980 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1981 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1983 case LTTNG_DOMAIN_UST
:
1984 switch (domain
->buf_type
) {
1985 case LTTNG_BUFFER_PER_UID
:
1986 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
1987 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
1988 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
1989 attr
->switch_timer_interval
=
1990 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
1991 attr
->read_timer_interval
=
1992 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
1994 case LTTNG_BUFFER_PER_PID
:
1996 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
1997 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
1998 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
1999 attr
->switch_timer_interval
=
2000 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2001 attr
->read_timer_interval
=
2002 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2006 /* Default behavior: leave set to 0. */
2011 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2012 uint64_t *discarded_events
)
2015 struct lttcomm_channel_extended
*chan_ext
;
2017 if (!channel
|| !discarded_events
) {
2018 ret
= -LTTNG_ERR_INVALID
;
2022 chan_ext
= channel
->attr
.extended
.ptr
;
2025 * This can happen since the lttng_channel structure is
2026 * used for other tasks where this pointer is never set.
2028 *discarded_events
= 0;
2032 *discarded_events
= chan_ext
->discarded_events
;
2037 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2038 uint64_t *lost_packets
)
2041 struct lttcomm_channel_extended
*chan_ext
;
2043 if (!channel
|| !lost_packets
) {
2044 ret
= -LTTNG_ERR_INVALID
;
2048 chan_ext
= channel
->attr
.extended
.ptr
;
2051 * This can happen since the lttng_channel structure is
2052 * used for other tasks where this pointer is never set.
2058 *lost_packets
= chan_ext
->lost_packets
;
2064 * Check if session daemon is alive.
2066 * Return 1 if alive or 0 if not.
2067 * On error returns a negative value.
2069 int lttng_session_daemon_alive(void)
2073 ret
= set_session_daemon_path();
2079 if (*sessiond_sock_path
== '\0') {
2081 * No socket path set. Weird error which means the constructor
2087 ret
= try_connect_sessiond(sessiond_sock_path
);
2098 * Set URL for a consumer for a session and domain.
2100 * Return 0 on success, else a negative value.
2102 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2103 const char *control_url
, const char *data_url
)
2107 struct lttcomm_session_msg lsm
;
2108 struct lttng_uri
*uris
= NULL
;
2110 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2111 return -LTTNG_ERR_INVALID
;
2114 memset(&lsm
, 0, sizeof(lsm
));
2116 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2118 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2119 sizeof(lsm
.session
.name
));
2120 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2122 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2124 return -LTTNG_ERR_INVALID
;
2127 lsm
.u
.uri
.size
= size
;
2129 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2130 sizeof(struct lttng_uri
) * size
, NULL
);
2139 int lttng_enable_consumer(struct lttng_handle
*handle
)
2147 int lttng_disable_consumer(struct lttng_handle
*handle
)
2153 * This is an extension of create session that is ONLY and SHOULD only be used
2154 * by the lttng command line program. It exists to avoid using URI parsing in
2157 * We need the date and time for the trace path subdirectory for the case where
2158 * the user does NOT define one using either -o or -U. Using the normal
2159 * lttng_create_session API call, we have no clue on the session daemon side if
2160 * the URL was generated automatically by the client or define by the user.
2162 * So this function "wrapper" is hidden from the public API, takes the datetime
2163 * string and appends it if necessary to the URI subdirectory before sending it
2164 * to the session daemon.
2166 * With this extra function, the lttng_create_session call behavior is not
2167 * changed and the timestamp is appended to the URI on the session daemon side
2170 int _lttng_create_session_ext(const char *name
, const char *url
,
2171 const char *datetime
)
2175 struct lttcomm_session_msg lsm
;
2176 struct lttng_uri
*uris
= NULL
;
2178 if (name
== NULL
|| datetime
== NULL
) {
2179 return -LTTNG_ERR_INVALID
;
2182 memset(&lsm
, 0, sizeof(lsm
));
2184 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
2185 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2187 /* There should never be a data URL. */
2188 size
= uri_parse_str_urls(url
, NULL
, &uris
);
2190 ret
= -LTTNG_ERR_INVALID
;
2194 lsm
.u
.uri
.size
= size
;
2196 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
2197 /* Don't append datetime if the name was automatically created. */
2198 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
2199 strlen(DEFAULT_SESSION_NAME
) + 1)) {
2200 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
2203 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
2206 PERROR("snprintf uri subdir");
2207 ret
= -LTTNG_ERR_FATAL
;
2212 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2213 sizeof(struct lttng_uri
) * size
, NULL
);
2221 * For a given session name, this call checks if the data is ready to be read
2222 * or is still being extracted by the consumer(s) hence not ready to be used by
2225 int lttng_data_pending(const char *session_name
)
2228 struct lttcomm_session_msg lsm
;
2229 uint8_t *pending
= NULL
;
2231 if (session_name
== NULL
) {
2232 return -LTTNG_ERR_INVALID
;
2235 memset(&lsm
, 0, sizeof(lsm
));
2236 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
2238 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2239 sizeof(lsm
.session
.name
));
2241 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
2244 } else if (ret
!= 1) {
2245 /* Unexpected payload size */
2246 ret
= -LTTNG_ERR_INVALID
;
2250 ret
= (int) *pending
;
2257 * Create a session exclusively used for snapshot.
2259 * Returns LTTNG_OK on success or a negative error code.
2261 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
2265 struct lttcomm_session_msg lsm
;
2266 struct lttng_uri
*uris
= NULL
;
2269 return -LTTNG_ERR_INVALID
;
2272 memset(&lsm
, 0, sizeof(lsm
));
2274 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
2275 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2277 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
2279 return -LTTNG_ERR_INVALID
;
2282 lsm
.u
.uri
.size
= size
;
2284 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2285 sizeof(struct lttng_uri
) * size
, NULL
);
2292 * Create a session exclusively used for live.
2294 * Returns LTTNG_OK on success or a negative error code.
2296 int lttng_create_session_live(const char *name
, const char *url
,
2297 unsigned int timer_interval
)
2301 struct lttcomm_session_msg lsm
;
2302 struct lttng_uri
*uris
= NULL
;
2304 if (name
== NULL
|| timer_interval
== 0) {
2305 return -LTTNG_ERR_INVALID
;
2308 memset(&lsm
, 0, sizeof(lsm
));
2310 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
2311 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2314 size
= uri_parse_str_urls(url
, NULL
, &uris
);
2316 ret
= -LTTNG_ERR_INVALID
;
2320 /* file:// is not accepted for live session. */
2321 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
2322 ret
= -LTTNG_ERR_INVALID
;
2329 lsm
.u
.session_live
.nb_uri
= size
;
2330 lsm
.u
.session_live
.timer_interval
= timer_interval
;
2332 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2333 sizeof(struct lttng_uri
) * size
, NULL
);
2341 * List PIDs in the tracker.
2343 * enabled is set to whether the PID tracker is enabled.
2344 * pids is set to an allocated array of PIDs currently tracked. On
2345 * success, pids must be freed by the caller.
2346 * nr_pids is set to the number of entries contained by the pids array.
2348 * Returns 0 on success, else a negative LTTng error code.
2350 int lttng_list_tracker_pids(struct lttng_handle
*handle
,
2351 int *_enabled
, int32_t **_pids
, size_t *_nr_pids
)
2355 struct lttcomm_session_msg lsm
;
2359 if (handle
== NULL
) {
2360 return -LTTNG_ERR_INVALID
;
2363 memset(&lsm
, 0, sizeof(lsm
));
2364 lsm
.cmd_type
= LTTNG_LIST_TRACKER_PIDS
;
2365 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2366 sizeof(lsm
.session
.name
));
2367 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2369 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pids
);
2373 nr_pids
= ret
/ sizeof(int32_t);
2374 if (nr_pids
== 1 && pids
[0] == -1) {
2380 *_enabled
= enabled
;
2382 *_nr_pids
= nr_pids
;
2387 * Regenerate the metadata for a session.
2388 * Return 0 on success, a negative error code on error.
2390 int lttng_regenerate_metadata(const char *session_name
)
2393 struct lttcomm_session_msg lsm
;
2395 if (!session_name
) {
2396 ret
= -LTTNG_ERR_INVALID
;
2400 memset(&lsm
, 0, sizeof(lsm
));
2401 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
2403 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2404 sizeof(lsm
.session
.name
));
2406 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2417 * Deprecated, replaced by lttng_regenerate_metadata.
2419 int lttng_metadata_regenerate(const char *session_name
)
2421 return lttng_regenerate_metadata(session_name
);
2425 * Regenerate the statedump of a session.
2426 * Return 0 on success, a negative error code on error.
2428 int lttng_regenerate_statedump(const char *session_name
)
2431 struct lttcomm_session_msg lsm
;
2433 if (!session_name
) {
2434 ret
= -LTTNG_ERR_INVALID
;
2438 memset(&lsm
, 0, sizeof(lsm
));
2439 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
2441 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2442 sizeof(lsm
.session
.name
));
2444 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2457 static void __attribute__((constructor
)) init(void)
2459 /* Set default session group */
2460 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
2466 static void __attribute__((destructor
)) lttng_ctl_exit(void)
2468 free(tracing_group
);