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 (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
;
920 /* Validate strings used as literals in the expression. */
921 ret
= filter_visitor_ir_validate_string(ctx
);
923 ret
= -LTTNG_ERR_FILTER_INVAL
;
926 dbg_printf("done\n");
928 dbg_printf("Generating bytecode... ");
930 ret
= filter_visitor_bytecode_generate(ctx
);
932 fprintf(stderr
, "Generate bytecode error\n");
933 ret
= -LTTNG_ERR_FILTER_INVAL
;
936 dbg_printf("done\n");
937 dbg_printf("Size of bytecode generated: %u bytes.\n",
938 bytecode_get_len(&ctx
->bytecode
->b
));
940 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
941 + bytecode_get_len(&ctx
->bytecode
->b
);
942 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
944 /* No need to keep the memory stream. */
945 if (fclose(fmem
) != 0) {
954 filter_parser_ctx_free(ctx
);
956 if (fclose(fmem
) != 0) {
964 * Enable event(s) for a channel, possibly with exclusions and a filter.
965 * If no event name is specified, all events are enabled.
966 * If no channel name is specified, the default name is used.
967 * If filter expression is not NULL, the filter is set for the event.
968 * If exclusion count is not zero, the exclusions are set for the event.
969 * Returns size of returned session payload data or a negative error code.
971 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
972 struct lttng_event
*ev
, const char *channel_name
,
973 const char *original_filter_expression
,
974 int exclusion_count
, char **exclusion_list
)
976 struct lttcomm_session_msg lsm
;
979 unsigned int free_filter_expression
= 0;
980 struct filter_parser_ctx
*ctx
= NULL
;
982 * Cast as non-const since we may replace the filter expression
983 * by a dynamically allocated string. Otherwise, the original
984 * string is not modified.
986 char *filter_expression
= (char *) original_filter_expression
;
988 if (handle
== NULL
|| ev
== NULL
) {
989 ret
= -LTTNG_ERR_INVALID
;
994 * Empty filter string will always be rejected by the parser
995 * anyway, so treat this corner-case early to eliminate
996 * lttng_fmemopen error for 0-byte allocation.
998 if (filter_expression
&& filter_expression
[0] == '\0') {
999 ret
= -LTTNG_ERR_INVALID
;
1003 memset(&lsm
, 0, sizeof(lsm
));
1005 /* If no channel name, send empty string. */
1006 if (channel_name
== NULL
) {
1007 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
1008 sizeof(lsm
.u
.enable
.channel_name
));
1010 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
1011 sizeof(lsm
.u
.enable
.channel_name
));
1014 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1015 if (ev
->name
[0] == '\0') {
1016 /* Enable all events */
1017 lttng_ctl_copy_string(ev
->name
, "*", sizeof(ev
->name
));
1020 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1021 /* FIXME: copying non-packed struct to packed struct. */
1022 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1024 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1025 sizeof(lsm
.session
.name
));
1026 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1027 lsm
.u
.enable
.bytecode_len
= 0;
1030 * For the JUL domain, a filter is enforced except for the enable all
1031 * event. This is done to avoid having the event in all sessions thus
1032 * filtering by logger name.
1034 if (exclusion_count
== 0 && filter_expression
== NULL
&&
1035 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1036 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1037 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1042 * We have either a filter or some exclusions, so we need to set up
1043 * a variable-length memory block from where to send the data.
1046 /* Parse filter expression. */
1047 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1048 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1049 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1050 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1051 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1052 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1055 /* Setup JUL filter if needed. */
1056 agent_filter
= set_agent_filter(filter_expression
, ev
);
1057 if (!agent_filter
) {
1058 if (!filter_expression
) {
1060 * No JUL and no filter, just skip
1067 * With an agent filter, the original filter has
1068 * been added to it thus replace the filter
1071 filter_expression
= agent_filter
;
1072 free_filter_expression
= 1;
1076 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1082 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
1083 + lsm
.u
.enable
.expression_len
1084 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
1086 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1090 /* Put exclusion names first in the data. */
1091 while (exclusion_count
--) {
1092 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
1093 *(exclusion_list
+ exclusion_count
),
1094 LTTNG_SYMBOL_NAME_LEN
- 1);
1096 /* Add filter expression next. */
1097 if (lsm
.u
.enable
.expression_len
!= 0) {
1099 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
1101 lsm
.u
.enable
.expression_len
);
1103 /* Add filter bytecode next. */
1104 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1106 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
1107 + lsm
.u
.enable
.expression_len
,
1109 lsm
.u
.enable
.bytecode_len
);
1112 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1113 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
1114 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
,
1119 if (filter_expression
&& ctx
) {
1120 filter_bytecode_free(ctx
);
1121 filter_ir_free(ctx
);
1122 filter_parser_ctx_free(ctx
);
1125 if (free_filter_expression
) {
1127 * The filter expression has been replaced and must be freed as
1128 * it is not the original filter expression received as a
1131 free(filter_expression
);
1135 * Return directly to the caller and don't ask the sessiond since
1136 * something went wrong in the parsing of data above.
1141 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1145 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1146 struct lttng_event
*ev
, const char *channel_name
,
1147 const char *original_filter_expression
)
1149 struct lttcomm_session_msg lsm
;
1152 unsigned int free_filter_expression
= 0;
1153 struct filter_parser_ctx
*ctx
= NULL
;
1155 * Cast as non-const since we may replace the filter expression
1156 * by a dynamically allocated string. Otherwise, the original
1157 * string is not modified.
1159 char *filter_expression
= (char *) original_filter_expression
;
1161 if (handle
== NULL
|| ev
== NULL
) {
1162 ret
= -LTTNG_ERR_INVALID
;
1167 * Empty filter string will always be rejected by the parser
1168 * anyway, so treat this corner-case early to eliminate
1169 * lttng_fmemopen error for 0-byte allocation.
1171 if (filter_expression
&& filter_expression
[0] == '\0') {
1172 ret
= -LTTNG_ERR_INVALID
;
1176 memset(&lsm
, 0, sizeof(lsm
));
1178 /* If no channel name, send empty string. */
1179 if (channel_name
== NULL
) {
1180 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1181 sizeof(lsm
.u
.disable
.channel_name
));
1183 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1184 sizeof(lsm
.u
.disable
.channel_name
));
1187 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1189 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1190 /* FIXME: copying non-packed struct to packed struct. */
1191 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1193 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1194 sizeof(lsm
.session
.name
));
1195 lsm
.u
.disable
.bytecode_len
= 0;
1198 * For the JUL domain, a filter is enforced except for the
1199 * disable all event. This is done to avoid having the event in
1200 * all sessions thus filtering by logger name.
1202 if (filter_expression
== NULL
&&
1203 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1204 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1205 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1210 * We have a filter, so we need to set up a variable-length
1211 * memory block from where to send the data.
1214 /* Parse filter expression */
1215 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1216 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1217 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1218 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1219 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1220 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1223 /* Setup JUL filter if needed. */
1224 agent_filter
= set_agent_filter(filter_expression
, ev
);
1225 if (!agent_filter
) {
1226 if (!filter_expression
) {
1228 * No JUL and no filter, just skip
1235 * With a JUL filter, the original filter has
1236 * been added to it thus replace the filter
1239 filter_expression
= agent_filter
;
1240 free_filter_expression
= 1;
1244 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1250 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1251 + lsm
.u
.disable
.expression_len
);
1253 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1257 /* Add filter expression. */
1258 if (lsm
.u
.disable
.expression_len
!= 0) {
1261 lsm
.u
.disable
.expression_len
);
1263 /* Add filter bytecode next. */
1264 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1266 + lsm
.u
.disable
.expression_len
,
1268 lsm
.u
.disable
.bytecode_len
);
1271 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1272 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1276 if (filter_expression
&& ctx
) {
1277 filter_bytecode_free(ctx
);
1278 filter_ir_free(ctx
);
1279 filter_parser_ctx_free(ctx
);
1282 if (free_filter_expression
) {
1284 * The filter expression has been replaced and must be freed as
1285 * it is not the original filter expression received as a
1288 free(filter_expression
);
1292 * Return directly to the caller and don't ask the sessiond since
1293 * something went wrong in the parsing of data above.
1298 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1303 * Disable event(s) of a channel and domain.
1304 * If no event name is specified, all events are disabled.
1305 * If no channel name is specified, the default 'channel0' is used.
1306 * Returns size of returned session payload data or a negative error code.
1308 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1309 const char *channel_name
)
1311 struct lttng_event ev
;
1313 memset(&ev
, 0, sizeof(ev
));
1315 ev
.type
= LTTNG_EVENT_ALL
;
1316 lttng_ctl_copy_string(ev
.name
, name
, sizeof(ev
.name
));
1317 return lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1321 * Enable channel per domain
1322 * Returns size of returned session payload data or a negative error code.
1324 int lttng_enable_channel(struct lttng_handle
*handle
,
1325 struct lttng_channel
*chan
)
1327 struct lttcomm_session_msg lsm
;
1329 /* NULL arguments are forbidden. No default values. */
1330 if (handle
== NULL
|| chan
== NULL
) {
1331 return -LTTNG_ERR_INVALID
;
1334 memset(&lsm
, 0, sizeof(lsm
));
1336 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(lsm
.u
.channel
.chan
));
1338 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1340 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1342 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1343 sizeof(lsm
.session
.name
));
1345 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1349 * All tracing will be stopped for registered events of the channel.
1350 * Returns size of returned session payload data or a negative error code.
1352 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1354 struct lttcomm_session_msg lsm
;
1356 /* Safety check. Both are mandatory. */
1357 if (handle
== NULL
|| name
== NULL
) {
1358 return -LTTNG_ERR_INVALID
;
1361 memset(&lsm
, 0, sizeof(lsm
));
1363 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1365 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1366 sizeof(lsm
.u
.disable
.channel_name
));
1368 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1370 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1371 sizeof(lsm
.session
.name
));
1373 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1377 * Add PID to session tracker.
1378 * Return 0 on success else a negative LTTng error code.
1380 int lttng_track_pid(struct lttng_handle
*handle
, int pid
)
1382 struct lttcomm_session_msg lsm
;
1384 /* NULL arguments are forbidden. No default values. */
1385 if (handle
== NULL
) {
1386 return -LTTNG_ERR_INVALID
;
1389 memset(&lsm
, 0, sizeof(lsm
));
1391 lsm
.cmd_type
= LTTNG_TRACK_PID
;
1392 lsm
.u
.pid_tracker
.pid
= pid
;
1394 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1396 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1397 sizeof(lsm
.session
.name
));
1399 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1403 * Remove PID from session tracker.
1404 * Return 0 on success else a negative LTTng error code.
1406 int lttng_untrack_pid(struct lttng_handle
*handle
, int pid
)
1408 struct lttcomm_session_msg lsm
;
1410 /* NULL arguments are forbidden. No default values. */
1411 if (handle
== NULL
) {
1412 return -LTTNG_ERR_INVALID
;
1415 memset(&lsm
, 0, sizeof(lsm
));
1417 lsm
.cmd_type
= LTTNG_UNTRACK_PID
;
1418 lsm
.u
.pid_tracker
.pid
= pid
;
1420 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1422 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1423 sizeof(lsm
.session
.name
));
1425 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1429 * Lists all available tracepoints of domain.
1430 * Sets the contents of the events array.
1431 * Returns the number of lttng_event entries in events;
1432 * on error, returns a negative value.
1434 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1435 struct lttng_event
**events
)
1438 struct lttcomm_session_msg lsm
;
1440 if (handle
== NULL
) {
1441 return -LTTNG_ERR_INVALID
;
1444 memset(&lsm
, 0, sizeof(lsm
));
1445 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1446 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1448 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1453 return ret
/ sizeof(struct lttng_event
);
1457 * Lists all available tracepoint fields of domain.
1458 * Sets the contents of the event field array.
1459 * Returns the number of lttng_event_field entries in events;
1460 * on error, returns a negative value.
1462 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1463 struct lttng_event_field
**fields
)
1466 struct lttcomm_session_msg lsm
;
1468 if (handle
== NULL
) {
1469 return -LTTNG_ERR_INVALID
;
1472 memset(&lsm
, 0, sizeof(lsm
));
1473 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1474 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1476 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1481 return ret
/ sizeof(struct lttng_event_field
);
1485 * Lists all available kernel system calls. Allocates and sets the contents of
1488 * Returns the number of lttng_event entries in events; on error, returns a
1491 int lttng_list_syscalls(struct lttng_event
**events
)
1494 struct lttcomm_session_msg lsm
;
1497 return -LTTNG_ERR_INVALID
;
1500 memset(&lsm
, 0, sizeof(lsm
));
1501 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1502 /* Force kernel domain for system calls. */
1503 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1505 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1510 return ret
/ sizeof(struct lttng_event
);
1514 * Returns a human readable string describing
1515 * the error code (a negative value).
1517 const char *lttng_strerror(int code
)
1519 return error_get_str(code
);
1523 * Create a brand new session using name and url for destination.
1525 * Returns LTTNG_OK on success or a negative error code.
1527 int lttng_create_session(const char *name
, const char *url
)
1531 struct lttcomm_session_msg lsm
;
1532 struct lttng_uri
*uris
= NULL
;
1535 return -LTTNG_ERR_INVALID
;
1538 memset(&lsm
, 0, sizeof(lsm
));
1540 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1541 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1543 /* There should never be a data URL */
1544 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1546 return -LTTNG_ERR_INVALID
;
1549 lsm
.u
.uri
.size
= size
;
1551 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
1552 sizeof(struct lttng_uri
) * size
, NULL
);
1559 * Destroy session using name.
1560 * Returns size of returned session payload data or a negative error code.
1563 int _lttng_destroy_session(const char *session_name
)
1565 struct lttcomm_session_msg lsm
;
1567 if (session_name
== NULL
) {
1568 return -LTTNG_ERR_INVALID
;
1571 memset(&lsm
, 0, sizeof(lsm
));
1572 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1574 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1575 sizeof(lsm
.session
.name
));
1577 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1581 * Stop the session and wait for the data before destroying it
1583 int lttng_destroy_session(const char *session_name
)
1588 * Stop the tracing and wait for the data.
1590 ret
= _lttng_stop_tracing(session_name
, 1);
1591 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
1595 ret
= _lttng_destroy_session(session_name
);
1601 * Destroy the session without waiting for the data.
1603 int lttng_destroy_session_no_wait(const char *session_name
)
1608 * Stop the tracing without waiting for the data.
1609 * The session might already have been stopped, so just
1612 ret
= _lttng_stop_tracing(session_name
, 0);
1613 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
1617 ret
= _lttng_destroy_session(session_name
);
1623 * Ask the session daemon for all available sessions.
1624 * Sets the contents of the sessions array.
1625 * Returns the number of lttng_session entries in sessions;
1626 * on error, returns a negative value.
1628 int lttng_list_sessions(struct lttng_session
**sessions
)
1631 struct lttcomm_session_msg lsm
;
1633 memset(&lsm
, 0, sizeof(lsm
));
1634 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1635 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1640 return ret
/ sizeof(struct lttng_session
);
1643 int lttng_set_session_shm_path(const char *session_name
,
1644 const char *shm_path
)
1646 struct lttcomm_session_msg lsm
;
1648 if (session_name
== NULL
) {
1649 return -LTTNG_ERR_INVALID
;
1652 memset(&lsm
, 0, sizeof(lsm
));
1653 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
1655 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1656 sizeof(lsm
.session
.name
));
1657 lttng_ctl_copy_string(lsm
.u
.set_shm_path
.shm_path
, shm_path
,
1658 sizeof(lsm
.u
.set_shm_path
.shm_path
));
1660 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1664 * Ask the session daemon for all available domains of a session.
1665 * Sets the contents of the domains array.
1666 * Returns the number of lttng_domain entries in domains;
1667 * on error, returns a negative value.
1669 int lttng_list_domains(const char *session_name
,
1670 struct lttng_domain
**domains
)
1673 struct lttcomm_session_msg lsm
;
1675 if (session_name
== NULL
) {
1676 return -LTTNG_ERR_INVALID
;
1679 memset(&lsm
, 0, sizeof(lsm
));
1680 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1682 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1683 sizeof(lsm
.session
.name
));
1685 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1690 return ret
/ sizeof(struct lttng_domain
);
1694 * Ask the session daemon for all available channels of a session.
1695 * Sets the contents of the channels array.
1696 * Returns the number of lttng_channel entries in channels;
1697 * on error, returns a negative value.
1699 int lttng_list_channels(struct lttng_handle
*handle
,
1700 struct lttng_channel
**channels
)
1703 size_t channel_count
, i
;
1704 const size_t channel_size
= sizeof(struct lttng_channel
) +
1705 sizeof(struct lttcomm_channel_extended
);
1706 struct lttcomm_session_msg lsm
;
1709 if (handle
== NULL
) {
1710 ret
= -LTTNG_ERR_INVALID
;
1714 memset(&lsm
, 0, sizeof(lsm
));
1715 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1716 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1717 sizeof(lsm
.session
.name
));
1719 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1721 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1726 if (ret
% channel_size
) {
1727 ret
= -LTTNG_ERR_UNK
;
1732 channel_count
= (size_t) ret
/ channel_size
;
1734 /* Set extended info pointers */
1735 extended_at
= ((void *) *channels
) +
1736 channel_count
* sizeof(struct lttng_channel
);
1737 for (i
= 0; i
< channel_count
; i
++) {
1738 struct lttng_channel
*chan
= &(*channels
)[i
];
1740 chan
->attr
.extended
.ptr
= extended_at
;
1741 extended_at
+= sizeof(struct lttcomm_channel_extended
);
1744 ret
= (int) channel_count
;
1750 * Ask the session daemon for all available events of a session channel.
1751 * Sets the contents of the events array.
1752 * Returns the number of lttng_event entries in events;
1753 * on error, returns a negative value.
1755 int lttng_list_events(struct lttng_handle
*handle
,
1756 const char *channel_name
, struct lttng_event
**events
)
1759 struct lttcomm_session_msg lsm
;
1760 struct lttcomm_event_command_header
*cmd_header
= NULL
;
1761 size_t cmd_header_len
;
1762 uint32_t nb_events
, i
;
1765 /* Safety check. An handle and channel name are mandatory */
1766 if (handle
== NULL
|| channel_name
== NULL
) {
1767 return -LTTNG_ERR_INVALID
;
1770 memset(&lsm
, 0, sizeof(lsm
));
1771 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1772 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1773 sizeof(lsm
.session
.name
));
1774 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1775 sizeof(lsm
.u
.list
.channel_name
));
1776 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1778 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, NULL
, 0, (void **) events
,
1779 (void **) &cmd_header
, &cmd_header_len
);
1784 /* Set number of events and free command header */
1785 nb_events
= cmd_header
->nb_events
;
1786 if (nb_events
> INT_MAX
) {
1790 ret
= (int) nb_events
;
1794 /* Set extended info pointers */
1795 extended_at
= ((void*) (*events
)) +
1796 nb_events
* sizeof(struct lttng_event
);
1798 for (i
= 0; i
< nb_events
; i
++) {
1799 struct lttcomm_event_extended_header
*ext_header
;
1800 struct lttng_event
*event
= &(*events
)[i
];
1802 event
->extended
.ptr
= extended_at
;
1804 (struct lttcomm_event_extended_header
*) extended_at
;
1805 extended_at
+= sizeof(*ext_header
);
1806 extended_at
+= ext_header
->filter_len
;
1808 ext_header
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
1818 int lttng_event_get_filter_expression(struct lttng_event
*event
,
1819 const char **filter_expression
)
1822 struct lttcomm_event_extended_header
*ext_header
;
1824 if (!event
|| !filter_expression
) {
1825 ret
= -LTTNG_ERR_INVALID
;
1829 ext_header
= event
->extended
.ptr
;
1833 * This can happen since the lttng_event structure is
1834 * used for other tasks where this pointer is never set.
1836 *filter_expression
= NULL
;
1840 if (ext_header
->filter_len
) {
1841 *filter_expression
= ((const char *) (ext_header
)) +
1842 sizeof(*ext_header
);
1844 *filter_expression
= NULL
;
1851 int lttng_event_get_exclusion_name_count(struct lttng_event
*event
)
1854 struct lttcomm_event_extended_header
*ext_header
;
1857 ret
= -LTTNG_ERR_INVALID
;
1861 ext_header
= event
->extended
.ptr
;
1864 * This can happen since the lttng_event structure is
1865 * used for other tasks where this pointer is never set.
1871 if (ext_header
->nb_exclusions
> INT_MAX
) {
1872 ret
= -LTTNG_ERR_OVERFLOW
;
1875 ret
= (int) ext_header
->nb_exclusions
;
1880 int lttng_event_get_exclusion_name(struct lttng_event
*event
,
1881 size_t index
, const char **exclusion_name
)
1884 struct lttcomm_event_extended_header
*ext_header
;
1887 if (!event
|| !exclusion_name
) {
1888 ret
= -LTTNG_ERR_INVALID
;
1892 ext_header
= event
->extended
.ptr
;
1894 ret
= -LTTNG_ERR_INVALID
;
1898 if (index
>= ext_header
->nb_exclusions
) {
1899 ret
= -LTTNG_ERR_INVALID
;
1903 at
= (void *) ext_header
+ sizeof(*ext_header
);
1904 at
+= ext_header
->filter_len
;
1905 at
+= index
* LTTNG_SYMBOL_NAME_LEN
;
1906 *exclusion_name
= at
;
1913 * Sets the tracing_group variable with name.
1914 * This function allocates memory pointed to by tracing_group.
1915 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1917 int lttng_set_tracing_group(const char *name
)
1920 return -LTTNG_ERR_INVALID
;
1923 if (asprintf(&tracing_group
, "%s", name
) < 0) {
1924 return -LTTNG_ERR_FATAL
;
1931 * Returns size of returned session payload data or a negative error code.
1933 int lttng_calibrate(struct lttng_handle
*handle
,
1934 struct lttng_calibrate
*calibrate
)
1936 struct lttcomm_session_msg lsm
;
1938 /* Safety check. NULL pointer are forbidden */
1939 if (handle
== NULL
|| calibrate
== NULL
) {
1940 return -LTTNG_ERR_INVALID
;
1943 memset(&lsm
, 0, sizeof(lsm
));
1944 lsm
.cmd_type
= LTTNG_CALIBRATE
;
1945 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1947 memcpy(&lsm
.u
.calibrate
, calibrate
, sizeof(lsm
.u
.calibrate
));
1949 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1953 * Set default channel attributes.
1954 * If either or both of the arguments are null, attr content is zeroe'd.
1956 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
1957 struct lttng_channel_attr
*attr
)
1960 if (attr
== NULL
|| domain
== NULL
) {
1964 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
1966 /* Same for all domains. */
1967 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1968 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
1969 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
1971 switch (domain
->type
) {
1972 case LTTNG_DOMAIN_KERNEL
:
1973 attr
->switch_timer_interval
=
1974 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
1975 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
1976 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
1977 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1978 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1980 case LTTNG_DOMAIN_UST
:
1981 switch (domain
->buf_type
) {
1982 case LTTNG_BUFFER_PER_UID
:
1983 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
1984 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
1985 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
1986 attr
->switch_timer_interval
=
1987 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
1988 attr
->read_timer_interval
=
1989 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
1991 case LTTNG_BUFFER_PER_PID
:
1993 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
1994 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
1995 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
1996 attr
->switch_timer_interval
=
1997 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
1998 attr
->read_timer_interval
=
1999 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2003 /* Default behavior: leave set to 0. */
2008 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2009 uint64_t *discarded_events
)
2012 struct lttcomm_channel_extended
*chan_ext
;
2014 if (!channel
|| !discarded_events
) {
2015 ret
= -LTTNG_ERR_INVALID
;
2019 chan_ext
= channel
->attr
.extended
.ptr
;
2022 * This can happen since the lttng_channel structure is
2023 * used for other tasks where this pointer is never set.
2025 *discarded_events
= 0;
2029 *discarded_events
= chan_ext
->discarded_events
;
2034 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2035 uint64_t *lost_packets
)
2038 struct lttcomm_channel_extended
*chan_ext
;
2040 if (!channel
|| !lost_packets
) {
2041 ret
= -LTTNG_ERR_INVALID
;
2045 chan_ext
= channel
->attr
.extended
.ptr
;
2048 * This can happen since the lttng_channel structure is
2049 * used for other tasks where this pointer is never set.
2055 *lost_packets
= chan_ext
->lost_packets
;
2061 * Check if session daemon is alive.
2063 * Return 1 if alive or 0 if not.
2064 * On error returns a negative value.
2066 int lttng_session_daemon_alive(void)
2070 ret
= set_session_daemon_path();
2076 if (*sessiond_sock_path
== '\0') {
2078 * No socket path set. Weird error which means the constructor
2084 ret
= try_connect_sessiond(sessiond_sock_path
);
2095 * Set URL for a consumer for a session and domain.
2097 * Return 0 on success, else a negative value.
2099 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2100 const char *control_url
, const char *data_url
)
2104 struct lttcomm_session_msg lsm
;
2105 struct lttng_uri
*uris
= NULL
;
2107 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2108 return -LTTNG_ERR_INVALID
;
2111 memset(&lsm
, 0, sizeof(lsm
));
2113 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2115 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2116 sizeof(lsm
.session
.name
));
2117 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2119 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2121 return -LTTNG_ERR_INVALID
;
2124 lsm
.u
.uri
.size
= size
;
2126 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2127 sizeof(struct lttng_uri
) * size
, NULL
);
2136 int lttng_enable_consumer(struct lttng_handle
*handle
)
2144 int lttng_disable_consumer(struct lttng_handle
*handle
)
2150 * This is an extension of create session that is ONLY and SHOULD only be used
2151 * by the lttng command line program. It exists to avoid using URI parsing in
2154 * We need the date and time for the trace path subdirectory for the case where
2155 * the user does NOT define one using either -o or -U. Using the normal
2156 * lttng_create_session API call, we have no clue on the session daemon side if
2157 * the URL was generated automatically by the client or define by the user.
2159 * So this function "wrapper" is hidden from the public API, takes the datetime
2160 * string and appends it if necessary to the URI subdirectory before sending it
2161 * to the session daemon.
2163 * With this extra function, the lttng_create_session call behavior is not
2164 * changed and the timestamp is appended to the URI on the session daemon side
2167 int _lttng_create_session_ext(const char *name
, const char *url
,
2168 const char *datetime
)
2172 struct lttcomm_session_msg lsm
;
2173 struct lttng_uri
*uris
= NULL
;
2175 if (name
== NULL
|| datetime
== NULL
) {
2176 return -LTTNG_ERR_INVALID
;
2179 memset(&lsm
, 0, sizeof(lsm
));
2181 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
2182 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2184 /* There should never be a data URL. */
2185 size
= uri_parse_str_urls(url
, NULL
, &uris
);
2187 ret
= -LTTNG_ERR_INVALID
;
2191 lsm
.u
.uri
.size
= size
;
2193 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
2194 /* Don't append datetime if the name was automatically created. */
2195 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
2196 strlen(DEFAULT_SESSION_NAME
) + 1)) {
2197 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
2200 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
2203 PERROR("snprintf uri subdir");
2204 ret
= -LTTNG_ERR_FATAL
;
2209 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2210 sizeof(struct lttng_uri
) * size
, NULL
);
2218 * For a given session name, this call checks if the data is ready to be read
2219 * or is still being extracted by the consumer(s) hence not ready to be used by
2222 int lttng_data_pending(const char *session_name
)
2225 struct lttcomm_session_msg lsm
;
2226 uint8_t *pending
= NULL
;
2228 if (session_name
== NULL
) {
2229 return -LTTNG_ERR_INVALID
;
2232 memset(&lsm
, 0, sizeof(lsm
));
2233 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
2235 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2236 sizeof(lsm
.session
.name
));
2238 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
2241 } else if (ret
!= 1) {
2242 /* Unexpected payload size */
2243 ret
= -LTTNG_ERR_INVALID
;
2247 ret
= (int) *pending
;
2254 * Create a session exclusively used for snapshot.
2256 * Returns LTTNG_OK on success or a negative error code.
2258 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
2262 struct lttcomm_session_msg lsm
;
2263 struct lttng_uri
*uris
= NULL
;
2266 return -LTTNG_ERR_INVALID
;
2269 memset(&lsm
, 0, sizeof(lsm
));
2271 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
2272 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2274 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
2276 return -LTTNG_ERR_INVALID
;
2279 lsm
.u
.uri
.size
= size
;
2281 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2282 sizeof(struct lttng_uri
) * size
, NULL
);
2289 * Create a session exclusively used for live.
2291 * Returns LTTNG_OK on success or a negative error code.
2293 int lttng_create_session_live(const char *name
, const char *url
,
2294 unsigned int timer_interval
)
2298 struct lttcomm_session_msg lsm
;
2299 struct lttng_uri
*uris
= NULL
;
2301 if (name
== NULL
|| timer_interval
== 0) {
2302 return -LTTNG_ERR_INVALID
;
2305 memset(&lsm
, 0, sizeof(lsm
));
2307 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
2308 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2311 size
= uri_parse_str_urls(url
, NULL
, &uris
);
2313 ret
= -LTTNG_ERR_INVALID
;
2317 /* file:// is not accepted for live session. */
2318 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
2319 ret
= -LTTNG_ERR_INVALID
;
2326 lsm
.u
.session_live
.nb_uri
= size
;
2327 lsm
.u
.session_live
.timer_interval
= timer_interval
;
2329 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2330 sizeof(struct lttng_uri
) * size
, NULL
);
2338 * List PIDs in the tracker.
2340 * enabled is set to whether the PID tracker is enabled.
2341 * pids is set to an allocated array of PIDs currently tracked. On
2342 * success, pids must be freed by the caller.
2343 * nr_pids is set to the number of entries contained by the pids array.
2345 * Returns 0 on success, else a negative LTTng error code.
2347 int lttng_list_tracker_pids(struct lttng_handle
*handle
,
2348 int *_enabled
, int32_t **_pids
, size_t *_nr_pids
)
2352 struct lttcomm_session_msg lsm
;
2356 if (handle
== NULL
) {
2357 return -LTTNG_ERR_INVALID
;
2360 memset(&lsm
, 0, sizeof(lsm
));
2361 lsm
.cmd_type
= LTTNG_LIST_TRACKER_PIDS
;
2362 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2363 sizeof(lsm
.session
.name
));
2364 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2366 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pids
);
2370 nr_pids
= ret
/ sizeof(int32_t);
2371 if (nr_pids
== 1 && pids
[0] == -1) {
2377 *_enabled
= enabled
;
2379 *_nr_pids
= nr_pids
;
2384 * Regenerate the metadata for a session.
2385 * Return 0 on success, a negative error code on error.
2387 int lttng_regenerate_metadata(const char *session_name
)
2390 struct lttcomm_session_msg lsm
;
2392 if (!session_name
) {
2393 ret
= -LTTNG_ERR_INVALID
;
2397 memset(&lsm
, 0, sizeof(lsm
));
2398 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
2400 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2401 sizeof(lsm
.session
.name
));
2403 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2414 * Deprecated, replaced by lttng_regenerate_metadata.
2416 int lttng_metadata_regenerate(const char *session_name
)
2418 return lttng_regenerate_metadata(session_name
);
2424 static void __attribute__((constructor
)) init(void)
2426 /* Set default session group */
2427 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
2433 static void __attribute__((destructor
)) lttng_ctl_exit(void)
2435 free(tracing_group
);