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>
39 #include <lttng/trigger/trigger-internal.h>
40 #include <lttng/endpoint.h>
41 #include <lttng/channel-internal.h>
43 #include "filter/filter-ast.h"
44 #include "filter/filter-parser.h"
45 #include "filter/filter-bytecode.h"
46 #include "filter/memstream.h"
47 #include "lttng-ctl-helper.h"
50 static const int print_xml
= 1;
51 #define dbg_printf(fmt, args...) \
52 printf("[debug liblttng-ctl] " fmt, ## args)
54 static const int print_xml
= 0;
55 #define dbg_printf(fmt, args...) \
57 /* do nothing but check printf format */ \
59 printf("[debug liblttnctl] " fmt, ## args); \
64 /* Socket to session daemon for communication */
65 static int sessiond_socket
;
66 static char sessiond_sock_path
[PATH_MAX
];
69 static char *tracing_group
;
75 * Those two variables are used by error.h to silent or control the verbosity of
76 * error message. They are global to the library so application linking with it
77 * are able to compile correctly and also control verbosity of the library.
80 int lttng_opt_verbose
;
84 * Copy string from src to dst and enforce null terminated byte.
87 void lttng_ctl_copy_string(char *dst
, const char *src
, size_t len
)
90 strncpy(dst
, src
, len
);
91 /* Enforce the NULL terminated byte */
99 * Copy domain to lttcomm_session_msg domain.
101 * If domain is unknown, default domain will be the kernel.
104 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
105 struct lttng_domain
*src
)
109 case LTTNG_DOMAIN_KERNEL
:
110 case LTTNG_DOMAIN_UST
:
111 case LTTNG_DOMAIN_JUL
:
112 case LTTNG_DOMAIN_LOG4J
:
113 case LTTNG_DOMAIN_PYTHON
:
114 memcpy(dst
, src
, sizeof(struct lttng_domain
));
117 memset(dst
, 0, sizeof(struct lttng_domain
));
124 * Send lttcomm_session_msg to the session daemon.
126 * On success, returns the number of bytes sent (>=0)
127 * On error, returns -1
129 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
134 ret
= -LTTNG_ERR_NO_SESSIOND
;
138 DBG("LSM cmd type : %d", lsm
->cmd_type
);
140 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
141 sizeof(struct lttcomm_session_msg
));
143 ret
= -LTTNG_ERR_FATAL
;
151 * Send var len data to the session daemon.
153 * On success, returns the number of bytes sent (>=0)
154 * On error, returns -1
156 static int send_session_varlen(const void *data
, size_t len
)
161 ret
= -LTTNG_ERR_NO_SESSIOND
;
170 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
172 ret
= -LTTNG_ERR_FATAL
;
180 * Receive data from the sessiond socket.
182 * On success, returns the number of bytes received (>=0)
183 * On error, returns -1 (recvmsg() error) or -ENOTCONN
185 static int recv_data_sessiond(void *buf
, size_t len
)
190 ret
= -LTTNG_ERR_NO_SESSIOND
;
194 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
196 ret
= -LTTNG_ERR_FATAL
;
204 * Check if we are in the specified group.
206 * If yes return 1, else return -1.
209 int lttng_check_tracing_group(void)
211 struct group
*grp_tracing
; /* no free(). See getgrnam(3) */
213 int grp_list_size
, grp_id
, i
;
215 const char *grp_name
= tracing_group
;
217 /* Get GID of group 'tracing' */
218 grp_tracing
= getgrnam(grp_name
);
220 /* If grp_tracing is NULL, the group does not exist. */
224 /* Get number of supplementary group IDs */
225 grp_list_size
= getgroups(0, NULL
);
226 if (grp_list_size
< 0) {
231 /* Alloc group list of the right size */
232 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
237 grp_id
= getgroups(grp_list_size
, grp_list
);
243 for (i
= 0; i
< grp_list_size
; i
++) {
244 if (grp_list
[i
] == grp_tracing
->gr_gid
) {
258 * Try connect to session daemon with sock_path.
260 * Return 0 on success, else -1
262 static int try_connect_sessiond(const char *sock_path
)
266 /* If socket exist, we check if the daemon listens for connect. */
267 ret
= access(sock_path
, F_OK
);
273 ret
= lttcomm_connect_unix_sock(sock_path
);
279 ret
= lttcomm_close_unix_sock(ret
);
281 PERROR("lttcomm_close_unix_sock");
291 * Set sessiond socket path by putting it in the global sessiond_sock_path
294 * Returns 0 on success, negative value on failure (the sessiond socket path
295 * is somehow too long or ENOMEM).
297 static int set_session_daemon_path(void)
299 int in_tgroup
= 0; /* In tracing group. */
305 /* Are we in the tracing group ? */
306 in_tgroup
= lttng_check_tracing_group();
309 if ((uid
== 0) || in_tgroup
) {
310 lttng_ctl_copy_string(sessiond_sock_path
,
311 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
, sizeof(sessiond_sock_path
));
319 ret
= try_connect_sessiond(sessiond_sock_path
);
323 /* Global session daemon not available... */
325 /* ...or not in tracing group (and not root), default */
328 * With GNU C < 2.1, snprintf returns -1 if the target buffer
330 * With GNU C >= 2.1, snprintf returns the required size
331 * (excluding closing null)
333 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
334 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
335 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
347 * Connect to the LTTng session daemon.
349 * On success, return 0. On error, return -1.
351 static int connect_sessiond(void)
355 /* Don't try to connect if already connected. */
360 ret
= set_session_daemon_path();
365 /* Connect to the sesssion daemon. */
366 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
371 sessiond_socket
= ret
;
381 * Clean disconnect from the session daemon.
383 * On success, return 0. On error, return -1.
385 static int disconnect_sessiond(void)
390 ret
= lttcomm_close_unix_sock(sessiond_socket
);
398 static int recv_sessiond_optional_data(size_t len
, void **user_buf
,
406 ret
= -LTTNG_ERR_INVALID
;
416 ret
= recv_data_sessiond(buf
, len
);
422 ret
= -LTTNG_ERR_INVALID
;
426 /* Move ownership of command header buffer to user. */
431 /* No command header. */
447 * Ask the session daemon a specific command and put the data into buf.
448 * Takes extra var. len. data as input to send to the session daemon.
450 * Return size of data (only payload, not header) or a negative error code.
453 int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg
*lsm
,
454 const void *vardata
, size_t vardata_len
,
455 void **user_payload_buf
, void **user_cmd_header_buf
,
456 size_t *user_cmd_header_len
)
460 struct lttcomm_lttng_msg llm
;
462 ret
= connect_sessiond();
464 ret
= -LTTNG_ERR_NO_SESSIOND
;
468 /* Send command to session daemon */
469 ret
= send_session_msg(lsm
);
471 /* Ret value is a valid lttng error code. */
474 /* Send var len data */
475 ret
= send_session_varlen(vardata
, vardata_len
);
477 /* Ret value is a valid lttng error code. */
481 /* Get header from data transmission */
482 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
484 /* Ret value is a valid lttng error code. */
488 /* Check error code if OK */
489 if (llm
.ret_code
!= LTTNG_OK
) {
494 /* Get command header from data transmission */
495 ret
= recv_sessiond_optional_data(llm
.cmd_header_size
,
496 user_cmd_header_buf
, user_cmd_header_len
);
501 /* Get payload from data transmission */
502 ret
= recv_sessiond_optional_data(llm
.data_size
, user_payload_buf
,
511 disconnect_sessiond();
516 * Create lttng handle and return pointer.
518 * The returned pointer will be NULL in case of malloc() error.
520 struct lttng_handle
*lttng_create_handle(const char *session_name
,
521 struct lttng_domain
*domain
)
523 struct lttng_handle
*handle
= NULL
;
525 handle
= zmalloc(sizeof(struct lttng_handle
));
526 if (handle
== NULL
) {
527 PERROR("malloc handle");
531 /* Copy session name */
532 lttng_ctl_copy_string(handle
->session_name
, session_name
,
533 sizeof(handle
->session_name
));
535 /* Copy lttng domain or leave initialized to 0. */
537 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
545 * Destroy handle by free(3) the pointer.
547 void lttng_destroy_handle(struct lttng_handle
*handle
)
553 * Register an outside consumer.
555 * Returns size of returned session payload data or a negative error code.
557 int lttng_register_consumer(struct lttng_handle
*handle
,
558 const char *socket_path
)
560 struct lttcomm_session_msg lsm
;
562 if (handle
== NULL
|| socket_path
== NULL
) {
563 return -LTTNG_ERR_INVALID
;
566 memset(&lsm
, 0, sizeof(lsm
));
567 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
568 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
569 sizeof(lsm
.session
.name
));
570 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
572 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
,
573 sizeof(lsm
.u
.reg
.path
));
575 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
579 * Start tracing for all traces of the session.
581 * Returns size of returned session payload data or a negative error code.
583 int lttng_start_tracing(const char *session_name
)
585 struct lttcomm_session_msg lsm
;
587 if (session_name
== NULL
) {
588 return -LTTNG_ERR_INVALID
;
591 memset(&lsm
, 0, sizeof(lsm
));
592 lsm
.cmd_type
= LTTNG_START_TRACE
;
594 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
595 sizeof(lsm
.session
.name
));
597 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
601 * Stop tracing for all traces of the session.
603 static int _lttng_stop_tracing(const char *session_name
, int wait
)
606 struct lttcomm_session_msg lsm
;
608 if (session_name
== NULL
) {
609 return -LTTNG_ERR_INVALID
;
612 memset(&lsm
, 0, sizeof(lsm
));
613 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
615 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
616 sizeof(lsm
.session
.name
));
618 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
619 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
627 /* Check for data availability */
629 data_ret
= lttng_data_pending(session_name
);
631 /* Return the data available call error. */
637 * Data sleep time before retrying (in usec). Don't sleep if the
638 * call returned value indicates availability.
641 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME
);
643 } while (data_ret
!= 0);
651 * Stop tracing and wait for data availability.
653 int lttng_stop_tracing(const char *session_name
)
655 return _lttng_stop_tracing(session_name
, 1);
659 * Stop tracing but _don't_ wait for data availability.
661 int lttng_stop_tracing_no_wait(const char *session_name
)
663 return _lttng_stop_tracing(session_name
, 0);
667 * Add context to a channel.
669 * If the given channel is NULL, add the contexts to all channels.
670 * The event_name param is ignored.
672 * Returns the size of the returned payload data or a negative error code.
674 int lttng_add_context(struct lttng_handle
*handle
,
675 struct lttng_event_context
*ctx
, const char *event_name
,
676 const char *channel_name
)
681 struct lttcomm_session_msg lsm
;
683 /* Safety check. Both are mandatory. */
684 if (handle
== NULL
|| ctx
== NULL
) {
685 ret
= -LTTNG_ERR_INVALID
;
689 memset(&lsm
, 0, sizeof(lsm
));
690 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
692 /* If no channel name, send empty string. */
693 if (channel_name
== NULL
) {
694 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
695 sizeof(lsm
.u
.context
.channel_name
));
697 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
698 sizeof(lsm
.u
.context
.channel_name
));
701 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
702 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
703 sizeof(lsm
.session
.name
));
705 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
706 size_t provider_len
, ctx_len
;
707 const char *provider_name
= ctx
->u
.app_ctx
.provider_name
;
708 const char *ctx_name
= ctx
->u
.app_ctx
.ctx_name
;
710 if (!provider_name
|| !ctx_name
) {
711 ret
= -LTTNG_ERR_INVALID
;
715 provider_len
= strlen(provider_name
);
716 if (provider_len
== 0) {
717 ret
= -LTTNG_ERR_INVALID
;
720 lsm
.u
.context
.provider_name_len
= provider_len
;
722 ctx_len
= strlen(ctx_name
);
724 ret
= -LTTNG_ERR_INVALID
;
727 lsm
.u
.context
.context_name_len
= ctx_len
;
729 len
= provider_len
+ ctx_len
;
732 ret
= -LTTNG_ERR_NOMEM
;
736 memcpy(buf
, provider_name
, provider_len
);
737 memcpy(buf
+ provider_len
, ctx_name
, ctx_len
);
739 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
741 if (ctx
->ctx
== LTTNG_EVENT_CONTEXT_APP_CONTEXT
) {
743 * Don't leak application addresses to the sessiond.
744 * This is only necessary when ctx is for an app ctx otherwise
745 * the values inside the union (type & config) are overwritten.
747 lsm
.u
.context
.ctx
.u
.app_ctx
.provider_name
= NULL
;
748 lsm
.u
.context
.ctx
.u
.app_ctx
.ctx_name
= NULL
;
751 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, buf
, len
, NULL
);
758 * Enable event(s) for a channel.
760 * If no event name is specified, all events are enabled.
761 * If no channel name is specified, the default 'channel0' is used.
763 * Returns size of returned session payload data or a negative error code.
765 int lttng_enable_event(struct lttng_handle
*handle
,
766 struct lttng_event
*ev
, const char *channel_name
)
768 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
773 * Create or enable an event with a filter expression.
775 * Return negative error value on error.
776 * Return size of returned session payload data if OK.
778 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
779 struct lttng_event
*event
, const char *channel_name
,
780 const char *filter_expression
)
782 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
783 filter_expression
, 0, NULL
);
787 * Depending on the event, return a newly allocated agent filter expression or
788 * NULL if not applicable.
790 * An event with NO loglevel and the name is * will return NULL.
792 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
795 char *agent_filter
= NULL
;
799 /* Don't add filter for the '*' event. */
800 if (ev
->name
[0] != '*') {
802 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
805 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
813 /* Add loglevel filtering if any for the JUL domain. */
814 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
817 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
823 if (filter
|| agent_filter
) {
826 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
827 agent_filter
? agent_filter
: filter
, op
,
832 agent_filter
= new_filter
;
834 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
850 * Generate the filter bytecode from a given filter expression string. Put the
851 * newly allocated parser context in ctxp and populate the lsm object with the
854 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
856 static int generate_filter(char *filter_expression
,
857 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
860 struct filter_parser_ctx
*ctx
= NULL
;
863 assert(filter_expression
);
868 * Casting const to non-const, as the underlying function will use it in
871 fmem
= lttng_fmemopen((void *) filter_expression
,
872 strlen(filter_expression
), "r");
874 fprintf(stderr
, "Error opening memory as stream\n");
875 ret
= -LTTNG_ERR_FILTER_NOMEM
;
878 ctx
= filter_parser_ctx_alloc(fmem
);
880 fprintf(stderr
, "Error allocating parser\n");
881 ret
= -LTTNG_ERR_FILTER_NOMEM
;
882 goto filter_alloc_error
;
884 ret
= filter_parser_ctx_append_ast(ctx
);
886 fprintf(stderr
, "Parse error\n");
887 ret
= -LTTNG_ERR_FILTER_INVAL
;
890 ret
= filter_visitor_set_parent(ctx
);
892 fprintf(stderr
, "Set parent error\n");
893 ret
= -LTTNG_ERR_FILTER_INVAL
;
897 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
900 fprintf(stderr
, "XML print error\n");
901 ret
= -LTTNG_ERR_FILTER_INVAL
;
906 dbg_printf("Generating IR... ");
908 ret
= filter_visitor_ir_generate(ctx
);
910 fprintf(stderr
, "Generate IR error\n");
911 ret
= -LTTNG_ERR_FILTER_INVAL
;
914 dbg_printf("done\n");
916 dbg_printf("Validating IR... ");
918 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
920 ret
= -LTTNG_ERR_FILTER_INVAL
;
923 /* Validate strings used as literals in the expression. */
924 ret
= filter_visitor_ir_validate_string(ctx
);
926 ret
= -LTTNG_ERR_FILTER_INVAL
;
929 dbg_printf("done\n");
931 dbg_printf("Generating bytecode... ");
933 ret
= filter_visitor_bytecode_generate(ctx
);
935 fprintf(stderr
, "Generate bytecode error\n");
936 ret
= -LTTNG_ERR_FILTER_INVAL
;
939 dbg_printf("done\n");
940 dbg_printf("Size of bytecode generated: %u bytes.\n",
941 bytecode_get_len(&ctx
->bytecode
->b
));
943 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
944 + bytecode_get_len(&ctx
->bytecode
->b
);
945 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
947 /* No need to keep the memory stream. */
948 if (fclose(fmem
) != 0) {
957 filter_parser_ctx_free(ctx
);
959 if (fclose(fmem
) != 0) {
967 * Enable event(s) for a channel, possibly with exclusions and a filter.
968 * If no event name is specified, all events are enabled.
969 * If no channel name is specified, the default name is used.
970 * If filter expression is not NULL, the filter is set for the event.
971 * If exclusion count is not zero, the exclusions are set for the event.
972 * Returns size of returned session payload data or a negative error code.
974 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
975 struct lttng_event
*ev
, const char *channel_name
,
976 const char *original_filter_expression
,
977 int exclusion_count
, char **exclusion_list
)
979 struct lttcomm_session_msg lsm
;
982 unsigned int free_filter_expression
= 0;
983 struct filter_parser_ctx
*ctx
= NULL
;
985 * Cast as non-const since we may replace the filter expression
986 * by a dynamically allocated string. Otherwise, the original
987 * string is not modified.
989 char *filter_expression
= (char *) original_filter_expression
;
991 if (handle
== NULL
|| ev
== NULL
) {
992 ret
= -LTTNG_ERR_INVALID
;
997 * Empty filter string will always be rejected by the parser
998 * anyway, so treat this corner-case early to eliminate
999 * lttng_fmemopen error for 0-byte allocation.
1001 if (filter_expression
&& filter_expression
[0] == '\0') {
1002 ret
= -LTTNG_ERR_INVALID
;
1006 memset(&lsm
, 0, sizeof(lsm
));
1008 /* If no channel name, send empty string. */
1009 if (channel_name
== NULL
) {
1010 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
1011 sizeof(lsm
.u
.enable
.channel_name
));
1013 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
1014 sizeof(lsm
.u
.enable
.channel_name
));
1017 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
1018 if (ev
->name
[0] == '\0') {
1019 /* Enable all events */
1020 lttng_ctl_copy_string(ev
->name
, "*", sizeof(ev
->name
));
1023 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1024 /* FIXME: copying non-packed struct to packed struct. */
1025 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
1027 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1028 sizeof(lsm
.session
.name
));
1029 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
1030 lsm
.u
.enable
.bytecode_len
= 0;
1033 * For the JUL domain, a filter is enforced except for the enable all
1034 * event. This is done to avoid having the event in all sessions thus
1035 * filtering by logger name.
1037 if (exclusion_count
== 0 && filter_expression
== NULL
&&
1038 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1039 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1040 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1045 * We have either a filter or some exclusions, so we need to set up
1046 * a variable-length memory block from where to send the data.
1049 /* Parse filter expression. */
1050 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1051 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1052 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1053 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1054 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1055 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1058 /* Setup JUL filter if needed. */
1059 agent_filter
= set_agent_filter(filter_expression
, ev
);
1060 if (!agent_filter
) {
1061 if (!filter_expression
) {
1063 * No JUL and no filter, just skip
1070 * With an agent filter, the original filter has
1071 * been added to it thus replace the filter
1074 filter_expression
= agent_filter
;
1075 free_filter_expression
= 1;
1079 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1085 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
1086 + lsm
.u
.enable
.expression_len
1087 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
1089 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1093 /* Put exclusion names first in the data. */
1094 while (exclusion_count
--) {
1095 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
1096 *(exclusion_list
+ exclusion_count
),
1097 LTTNG_SYMBOL_NAME_LEN
- 1);
1099 /* Add filter expression next. */
1100 if (lsm
.u
.enable
.expression_len
!= 0) {
1102 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
1104 lsm
.u
.enable
.expression_len
);
1106 /* Add filter bytecode next. */
1107 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1109 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
1110 + lsm
.u
.enable
.expression_len
,
1112 lsm
.u
.enable
.bytecode_len
);
1115 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1116 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
1117 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
,
1122 if (filter_expression
&& ctx
) {
1123 filter_bytecode_free(ctx
);
1124 filter_ir_free(ctx
);
1125 filter_parser_ctx_free(ctx
);
1128 if (free_filter_expression
) {
1130 * The filter expression has been replaced and must be freed as
1131 * it is not the original filter expression received as a
1134 free(filter_expression
);
1138 * Return directly to the caller and don't ask the sessiond since
1139 * something went wrong in the parsing of data above.
1144 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1148 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1149 struct lttng_event
*ev
, const char *channel_name
,
1150 const char *original_filter_expression
)
1152 struct lttcomm_session_msg lsm
;
1155 unsigned int free_filter_expression
= 0;
1156 struct filter_parser_ctx
*ctx
= NULL
;
1158 * Cast as non-const since we may replace the filter expression
1159 * by a dynamically allocated string. Otherwise, the original
1160 * string is not modified.
1162 char *filter_expression
= (char *) original_filter_expression
;
1164 if (handle
== NULL
|| ev
== NULL
) {
1165 ret
= -LTTNG_ERR_INVALID
;
1170 * Empty filter string will always be rejected by the parser
1171 * anyway, so treat this corner-case early to eliminate
1172 * lttng_fmemopen error for 0-byte allocation.
1174 if (filter_expression
&& filter_expression
[0] == '\0') {
1175 ret
= -LTTNG_ERR_INVALID
;
1179 memset(&lsm
, 0, sizeof(lsm
));
1181 /* If no channel name, send empty string. */
1182 if (channel_name
== NULL
) {
1183 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1184 sizeof(lsm
.u
.disable
.channel_name
));
1186 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1187 sizeof(lsm
.u
.disable
.channel_name
));
1190 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1192 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1193 /* FIXME: copying non-packed struct to packed struct. */
1194 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1196 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1197 sizeof(lsm
.session
.name
));
1198 lsm
.u
.disable
.bytecode_len
= 0;
1201 * For the JUL domain, a filter is enforced except for the
1202 * disable all event. This is done to avoid having the event in
1203 * all sessions thus filtering by logger name.
1205 if (filter_expression
== NULL
&&
1206 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1207 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1208 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1213 * We have a filter, so we need to set up a variable-length
1214 * memory block from where to send the data.
1217 /* Parse filter expression */
1218 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1219 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1220 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1221 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1222 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1223 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1226 /* Setup JUL filter if needed. */
1227 agent_filter
= set_agent_filter(filter_expression
, ev
);
1228 if (!agent_filter
) {
1229 if (!filter_expression
) {
1231 * No JUL and no filter, just skip
1238 * With a JUL filter, the original filter has
1239 * been added to it thus replace the filter
1242 filter_expression
= agent_filter
;
1243 free_filter_expression
= 1;
1247 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1253 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1254 + lsm
.u
.disable
.expression_len
);
1256 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1260 /* Add filter expression. */
1261 if (lsm
.u
.disable
.expression_len
!= 0) {
1264 lsm
.u
.disable
.expression_len
);
1266 /* Add filter bytecode next. */
1267 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1269 + lsm
.u
.disable
.expression_len
,
1271 lsm
.u
.disable
.bytecode_len
);
1274 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, varlen_data
,
1275 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1279 if (filter_expression
&& ctx
) {
1280 filter_bytecode_free(ctx
);
1281 filter_ir_free(ctx
);
1282 filter_parser_ctx_free(ctx
);
1285 if (free_filter_expression
) {
1287 * The filter expression has been replaced and must be freed as
1288 * it is not the original filter expression received as a
1291 free(filter_expression
);
1295 * Return directly to the caller and don't ask the sessiond since
1296 * something went wrong in the parsing of data above.
1301 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1306 * Disable event(s) of a channel and domain.
1307 * If no event name is specified, all events are disabled.
1308 * If no channel name is specified, the default 'channel0' is used.
1309 * Returns size of returned session payload data or a negative error code.
1311 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1312 const char *channel_name
)
1314 struct lttng_event ev
;
1316 memset(&ev
, 0, sizeof(ev
));
1318 ev
.type
= LTTNG_EVENT_ALL
;
1319 lttng_ctl_copy_string(ev
.name
, name
, sizeof(ev
.name
));
1320 return lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1323 struct lttng_channel
*lttng_channel_create(struct lttng_domain
*domain
)
1325 struct lttng_channel
*channel
= NULL
;
1326 struct lttng_channel_extended
*extended
= NULL
;
1332 /* Validate domain. */
1333 switch (domain
->type
) {
1334 case LTTNG_DOMAIN_UST
:
1335 switch (domain
->buf_type
) {
1336 case LTTNG_BUFFER_PER_UID
:
1337 case LTTNG_BUFFER_PER_PID
:
1343 case LTTNG_DOMAIN_KERNEL
:
1344 if (domain
->buf_type
!= LTTNG_BUFFER_GLOBAL
) {
1352 channel
= zmalloc(sizeof(*channel
));
1357 extended
= zmalloc(sizeof(*extended
));
1362 channel
->attr
.extended
.ptr
= extended
;
1364 lttng_channel_set_default_attr(domain
, &channel
->attr
);
1372 void lttng_channel_destroy(struct lttng_channel
*channel
)
1378 if (channel
->attr
.extended
.ptr
) {
1379 free(channel
->attr
.extended
.ptr
);
1385 * Enable channel per domain
1386 * Returns size of returned session payload data or a negative error code.
1388 int lttng_enable_channel(struct lttng_handle
*handle
,
1389 struct lttng_channel
*in_chan
)
1391 struct lttcomm_session_msg lsm
;
1393 /* NULL arguments are forbidden. No default values. */
1394 if (handle
== NULL
|| in_chan
== NULL
) {
1395 return -LTTNG_ERR_INVALID
;
1398 memset(&lsm
, 0, sizeof(lsm
));
1399 memcpy(&lsm
.u
.channel
.chan
, in_chan
, sizeof(lsm
.u
.channel
.chan
));
1400 lsm
.u
.channel
.chan
.attr
.extended
.ptr
= NULL
;
1402 if (!in_chan
->attr
.extended
.ptr
) {
1403 struct lttng_channel
*channel
;
1404 struct lttng_channel_extended
*extended
;
1406 channel
= lttng_channel_create(&handle
->domain
);
1408 return -LTTNG_ERR_NOMEM
;
1412 * Create a new channel in order to use default extended
1415 extended
= (struct lttng_channel_extended
*)
1416 channel
->attr
.extended
.ptr
;
1417 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1418 lttng_channel_destroy(channel
);
1420 struct lttng_channel_extended
*extended
;
1422 extended
= (struct lttng_channel_extended
*)
1423 in_chan
->attr
.extended
.ptr
;
1424 memcpy(&lsm
.u
.channel
.extended
, extended
, sizeof(*extended
));
1427 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1428 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1430 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1431 sizeof(lsm
.session
.name
));
1433 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1437 * All tracing will be stopped for registered events of the channel.
1438 * Returns size of returned session payload data or a negative error code.
1440 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1442 struct lttcomm_session_msg lsm
;
1444 /* Safety check. Both are mandatory. */
1445 if (handle
== NULL
|| name
== NULL
) {
1446 return -LTTNG_ERR_INVALID
;
1449 memset(&lsm
, 0, sizeof(lsm
));
1451 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1453 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1454 sizeof(lsm
.u
.disable
.channel_name
));
1456 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1458 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1459 sizeof(lsm
.session
.name
));
1461 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1465 * Add PID to session tracker.
1466 * Return 0 on success else a negative LTTng error code.
1468 int lttng_track_pid(struct lttng_handle
*handle
, int pid
)
1470 struct lttcomm_session_msg lsm
;
1472 /* NULL arguments are forbidden. No default values. */
1473 if (handle
== NULL
) {
1474 return -LTTNG_ERR_INVALID
;
1477 memset(&lsm
, 0, sizeof(lsm
));
1479 lsm
.cmd_type
= LTTNG_TRACK_PID
;
1480 lsm
.u
.pid_tracker
.pid
= pid
;
1482 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1484 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1485 sizeof(lsm
.session
.name
));
1487 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1491 * Remove PID from session tracker.
1492 * Return 0 on success else a negative LTTng error code.
1494 int lttng_untrack_pid(struct lttng_handle
*handle
, int pid
)
1496 struct lttcomm_session_msg lsm
;
1498 /* NULL arguments are forbidden. No default values. */
1499 if (handle
== NULL
) {
1500 return -LTTNG_ERR_INVALID
;
1503 memset(&lsm
, 0, sizeof(lsm
));
1505 lsm
.cmd_type
= LTTNG_UNTRACK_PID
;
1506 lsm
.u
.pid_tracker
.pid
= pid
;
1508 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1510 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1511 sizeof(lsm
.session
.name
));
1513 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1517 * Lists all available tracepoints of domain.
1518 * Sets the contents of the events array.
1519 * Returns the number of lttng_event entries in events;
1520 * on error, returns a negative value.
1522 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1523 struct lttng_event
**events
)
1526 struct lttcomm_session_msg lsm
;
1528 if (handle
== NULL
) {
1529 return -LTTNG_ERR_INVALID
;
1532 memset(&lsm
, 0, sizeof(lsm
));
1533 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1534 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1536 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1541 return ret
/ sizeof(struct lttng_event
);
1545 * Lists all available tracepoint fields of domain.
1546 * Sets the contents of the event field array.
1547 * Returns the number of lttng_event_field entries in events;
1548 * on error, returns a negative value.
1550 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1551 struct lttng_event_field
**fields
)
1554 struct lttcomm_session_msg lsm
;
1556 if (handle
== NULL
) {
1557 return -LTTNG_ERR_INVALID
;
1560 memset(&lsm
, 0, sizeof(lsm
));
1561 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1562 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1564 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1569 return ret
/ sizeof(struct lttng_event_field
);
1573 * Lists all available kernel system calls. Allocates and sets the contents of
1576 * Returns the number of lttng_event entries in events; on error, returns a
1579 int lttng_list_syscalls(struct lttng_event
**events
)
1582 struct lttcomm_session_msg lsm
;
1585 return -LTTNG_ERR_INVALID
;
1588 memset(&lsm
, 0, sizeof(lsm
));
1589 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1590 /* Force kernel domain for system calls. */
1591 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1593 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1598 return ret
/ sizeof(struct lttng_event
);
1602 * Returns a human readable string describing
1603 * the error code (a negative value).
1605 const char *lttng_strerror(int code
)
1607 return error_get_str(code
);
1611 * Create a brand new session using name and url for destination.
1613 * Returns LTTNG_OK on success or a negative error code.
1615 int lttng_create_session(const char *name
, const char *url
)
1619 struct lttcomm_session_msg lsm
;
1620 struct lttng_uri
*uris
= NULL
;
1623 return -LTTNG_ERR_INVALID
;
1626 memset(&lsm
, 0, sizeof(lsm
));
1628 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1629 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1631 /* There should never be a data URL */
1632 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1634 return -LTTNG_ERR_INVALID
;
1637 lsm
.u
.uri
.size
= size
;
1639 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
1640 sizeof(struct lttng_uri
) * size
, NULL
);
1647 * Destroy session using name.
1648 * Returns size of returned session payload data or a negative error code.
1651 int _lttng_destroy_session(const char *session_name
)
1653 struct lttcomm_session_msg lsm
;
1655 if (session_name
== NULL
) {
1656 return -LTTNG_ERR_INVALID
;
1659 memset(&lsm
, 0, sizeof(lsm
));
1660 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1662 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1663 sizeof(lsm
.session
.name
));
1665 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1669 * Stop the session and wait for the data before destroying it
1671 int lttng_destroy_session(const char *session_name
)
1676 * Stop the tracing and wait for the data.
1678 ret
= _lttng_stop_tracing(session_name
, 1);
1679 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
1683 ret
= _lttng_destroy_session(session_name
);
1689 * Destroy the session without waiting for the data.
1691 int lttng_destroy_session_no_wait(const char *session_name
)
1696 * Stop the tracing without waiting for the data.
1697 * The session might already have been stopped, so just
1700 ret
= _lttng_stop_tracing(session_name
, 0);
1701 if (ret
&& ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
1705 ret
= _lttng_destroy_session(session_name
);
1711 * Ask the session daemon for all available sessions.
1712 * Sets the contents of the sessions array.
1713 * Returns the number of lttng_session entries in sessions;
1714 * on error, returns a negative value.
1716 int lttng_list_sessions(struct lttng_session
**sessions
)
1719 struct lttcomm_session_msg lsm
;
1721 memset(&lsm
, 0, sizeof(lsm
));
1722 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1723 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1728 return ret
/ sizeof(struct lttng_session
);
1731 int lttng_set_session_shm_path(const char *session_name
,
1732 const char *shm_path
)
1734 struct lttcomm_session_msg lsm
;
1736 if (session_name
== NULL
) {
1737 return -LTTNG_ERR_INVALID
;
1740 memset(&lsm
, 0, sizeof(lsm
));
1741 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
1743 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1744 sizeof(lsm
.session
.name
));
1745 lttng_ctl_copy_string(lsm
.u
.set_shm_path
.shm_path
, shm_path
,
1746 sizeof(lsm
.u
.set_shm_path
.shm_path
));
1748 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1752 * Ask the session daemon for all available domains of a session.
1753 * Sets the contents of the domains array.
1754 * Returns the number of lttng_domain entries in domains;
1755 * on error, returns a negative value.
1757 int lttng_list_domains(const char *session_name
,
1758 struct lttng_domain
**domains
)
1761 struct lttcomm_session_msg lsm
;
1763 if (session_name
== NULL
) {
1764 return -LTTNG_ERR_INVALID
;
1767 memset(&lsm
, 0, sizeof(lsm
));
1768 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1770 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1771 sizeof(lsm
.session
.name
));
1773 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1778 return ret
/ sizeof(struct lttng_domain
);
1782 * Ask the session daemon for all available channels of a session.
1783 * Sets the contents of the channels array.
1784 * Returns the number of lttng_channel entries in channels;
1785 * on error, returns a negative value.
1787 int lttng_list_channels(struct lttng_handle
*handle
,
1788 struct lttng_channel
**channels
)
1791 size_t channel_count
, i
;
1792 const size_t channel_size
= sizeof(struct lttng_channel
) +
1793 sizeof(struct lttng_channel_extended
);
1794 struct lttcomm_session_msg lsm
;
1797 if (handle
== NULL
) {
1798 ret
= -LTTNG_ERR_INVALID
;
1802 memset(&lsm
, 0, sizeof(lsm
));
1803 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1804 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1805 sizeof(lsm
.session
.name
));
1807 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1809 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1814 if (ret
% channel_size
) {
1815 ret
= -LTTNG_ERR_UNK
;
1820 channel_count
= (size_t) ret
/ channel_size
;
1822 /* Set extended info pointers */
1823 extended_at
= ((void *) *channels
) +
1824 channel_count
* sizeof(struct lttng_channel
);
1825 for (i
= 0; i
< channel_count
; i
++) {
1826 struct lttng_channel
*chan
= &(*channels
)[i
];
1828 chan
->attr
.extended
.ptr
= extended_at
;
1829 extended_at
+= sizeof(struct lttng_channel_extended
);
1832 ret
= (int) channel_count
;
1838 * Ask the session daemon for all available events of a session channel.
1839 * Sets the contents of the events array.
1840 * Returns the number of lttng_event entries in events;
1841 * on error, returns a negative value.
1843 int lttng_list_events(struct lttng_handle
*handle
,
1844 const char *channel_name
, struct lttng_event
**events
)
1847 struct lttcomm_session_msg lsm
;
1848 struct lttcomm_event_command_header
*cmd_header
= NULL
;
1849 size_t cmd_header_len
;
1850 uint32_t nb_events
, i
;
1853 /* Safety check. An handle and channel name are mandatory */
1854 if (handle
== NULL
|| channel_name
== NULL
) {
1855 return -LTTNG_ERR_INVALID
;
1858 memset(&lsm
, 0, sizeof(lsm
));
1859 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1860 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1861 sizeof(lsm
.session
.name
));
1862 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1863 sizeof(lsm
.u
.list
.channel_name
));
1864 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1866 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, NULL
, 0, (void **) events
,
1867 (void **) &cmd_header
, &cmd_header_len
);
1872 /* Set number of events and free command header */
1873 nb_events
= cmd_header
->nb_events
;
1874 if (nb_events
> INT_MAX
) {
1878 ret
= (int) nb_events
;
1882 /* Set extended info pointers */
1883 extended_at
= ((void*) (*events
)) +
1884 nb_events
* sizeof(struct lttng_event
);
1886 for (i
= 0; i
< nb_events
; i
++) {
1887 struct lttcomm_event_extended_header
*ext_header
;
1888 struct lttng_event
*event
= &(*events
)[i
];
1890 event
->extended
.ptr
= extended_at
;
1892 (struct lttcomm_event_extended_header
*) extended_at
;
1893 extended_at
+= sizeof(*ext_header
);
1894 extended_at
+= ext_header
->filter_len
;
1896 ext_header
->nb_exclusions
* LTTNG_SYMBOL_NAME_LEN
;
1906 int lttng_event_get_filter_expression(struct lttng_event
*event
,
1907 const char **filter_expression
)
1910 struct lttcomm_event_extended_header
*ext_header
;
1912 if (!event
|| !filter_expression
) {
1913 ret
= -LTTNG_ERR_INVALID
;
1917 ext_header
= event
->extended
.ptr
;
1921 * This can happen since the lttng_event structure is
1922 * used for other tasks where this pointer is never set.
1924 *filter_expression
= NULL
;
1928 if (ext_header
->filter_len
) {
1929 *filter_expression
= ((const char *) (ext_header
)) +
1930 sizeof(*ext_header
);
1932 *filter_expression
= NULL
;
1939 int lttng_event_get_exclusion_name_count(struct lttng_event
*event
)
1942 struct lttcomm_event_extended_header
*ext_header
;
1945 ret
= -LTTNG_ERR_INVALID
;
1949 ext_header
= event
->extended
.ptr
;
1952 * This can happen since the lttng_event structure is
1953 * used for other tasks where this pointer is never set.
1959 if (ext_header
->nb_exclusions
> INT_MAX
) {
1960 ret
= -LTTNG_ERR_OVERFLOW
;
1963 ret
= (int) ext_header
->nb_exclusions
;
1968 int lttng_event_get_exclusion_name(struct lttng_event
*event
,
1969 size_t index
, const char **exclusion_name
)
1972 struct lttcomm_event_extended_header
*ext_header
;
1975 if (!event
|| !exclusion_name
) {
1976 ret
= -LTTNG_ERR_INVALID
;
1980 ext_header
= event
->extended
.ptr
;
1982 ret
= -LTTNG_ERR_INVALID
;
1986 if (index
>= ext_header
->nb_exclusions
) {
1987 ret
= -LTTNG_ERR_INVALID
;
1991 at
= (void *) ext_header
+ sizeof(*ext_header
);
1992 at
+= ext_header
->filter_len
;
1993 at
+= index
* LTTNG_SYMBOL_NAME_LEN
;
1994 *exclusion_name
= at
;
2001 * Sets the tracing_group variable with name.
2002 * This function allocates memory pointed to by tracing_group.
2003 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2005 int lttng_set_tracing_group(const char *name
)
2008 return -LTTNG_ERR_INVALID
;
2011 if (asprintf(&tracing_group
, "%s", name
) < 0) {
2012 return -LTTNG_ERR_FATAL
;
2018 int lttng_calibrate(struct lttng_handle
*handle
,
2019 struct lttng_calibrate
*calibrate
)
2022 * This command was removed in LTTng 2.9.
2024 return -LTTNG_ERR_UND
;
2028 * Set default channel attributes.
2029 * If either or both of the arguments are null, attr content is zeroe'd.
2031 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
2032 struct lttng_channel_attr
*attr
)
2034 struct lttng_channel_extended
*extended
=
2035 (struct lttng_channel_extended
*) attr
->extended
.ptr
;
2038 if (attr
== NULL
|| domain
== NULL
) {
2042 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
2044 /* Same for all domains. */
2045 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2046 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
2047 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
2049 switch (domain
->type
) {
2050 case LTTNG_DOMAIN_KERNEL
:
2051 attr
->switch_timer_interval
=
2052 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
2053 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
2054 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
2055 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
2056 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
2058 extended
->monitor_timer_interval
=
2059 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER
;
2062 case LTTNG_DOMAIN_UST
:
2063 switch (domain
->buf_type
) {
2064 case LTTNG_BUFFER_PER_UID
:
2065 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
2066 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
2067 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
2068 attr
->switch_timer_interval
=
2069 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
2070 attr
->read_timer_interval
=
2071 DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
2073 extended
->monitor_timer_interval
=
2074 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER
;
2077 case LTTNG_BUFFER_PER_PID
:
2079 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
2080 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
2081 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
2082 attr
->switch_timer_interval
=
2083 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
2084 attr
->read_timer_interval
=
2085 DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
2087 extended
->monitor_timer_interval
=
2088 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER
;
2093 /* Default behavior: leave set to 0. */
2097 attr
->extended
.ptr
= extended
;
2100 int lttng_channel_get_discarded_event_count(struct lttng_channel
*channel
,
2101 uint64_t *discarded_events
)
2104 struct lttng_channel_extended
*chan_ext
;
2106 if (!channel
|| !discarded_events
) {
2107 ret
= -LTTNG_ERR_INVALID
;
2111 chan_ext
= channel
->attr
.extended
.ptr
;
2114 * This can happen since the lttng_channel structure is
2115 * used for other tasks where this pointer is never set.
2117 *discarded_events
= 0;
2121 *discarded_events
= chan_ext
->discarded_events
;
2126 int lttng_channel_get_lost_packet_count(struct lttng_channel
*channel
,
2127 uint64_t *lost_packets
)
2130 struct lttng_channel_extended
*chan_ext
;
2132 if (!channel
|| !lost_packets
) {
2133 ret
= -LTTNG_ERR_INVALID
;
2137 chan_ext
= channel
->attr
.extended
.ptr
;
2140 * This can happen since the lttng_channel structure is
2141 * used for other tasks where this pointer is never set.
2147 *lost_packets
= chan_ext
->lost_packets
;
2152 int lttng_channel_get_monitor_timer_interval(struct lttng_channel
*chan
,
2153 uint64_t *monitor_timer_interval
)
2157 if (!chan
|| !monitor_timer_interval
) {
2158 ret
= -LTTNG_ERR_INVALID
;
2162 if (!chan
->attr
.extended
.ptr
) {
2163 ret
= -LTTNG_ERR_INVALID
;
2167 *monitor_timer_interval
= ((struct lttng_channel_extended
*)
2168 chan
->attr
.extended
.ptr
)->monitor_timer_interval
;
2173 int lttng_channel_set_monitor_timer_interval(struct lttng_channel
*chan
,
2174 uint64_t monitor_timer_interval
)
2178 if (!chan
|| !chan
->attr
.extended
.ptr
) {
2179 ret
= -LTTNG_ERR_INVALID
;
2183 ((struct lttng_channel_extended
*)
2184 chan
->attr
.extended
.ptr
)->monitor_timer_interval
=
2185 monitor_timer_interval
;
2191 * Check if session daemon is alive.
2193 * Return 1 if alive or 0 if not.
2194 * On error returns a negative value.
2196 int lttng_session_daemon_alive(void)
2200 ret
= set_session_daemon_path();
2206 if (*sessiond_sock_path
== '\0') {
2208 * No socket path set. Weird error which means the constructor
2214 ret
= try_connect_sessiond(sessiond_sock_path
);
2225 * Set URL for a consumer for a session and domain.
2227 * Return 0 on success, else a negative value.
2229 int lttng_set_consumer_url(struct lttng_handle
*handle
,
2230 const char *control_url
, const char *data_url
)
2234 struct lttcomm_session_msg lsm
;
2235 struct lttng_uri
*uris
= NULL
;
2237 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
2238 return -LTTNG_ERR_INVALID
;
2241 memset(&lsm
, 0, sizeof(lsm
));
2243 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
2245 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2246 sizeof(lsm
.session
.name
));
2247 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2249 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
2251 return -LTTNG_ERR_INVALID
;
2254 lsm
.u
.uri
.size
= size
;
2256 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2257 sizeof(struct lttng_uri
) * size
, NULL
);
2266 int lttng_enable_consumer(struct lttng_handle
*handle
)
2274 int lttng_disable_consumer(struct lttng_handle
*handle
)
2280 * This is an extension of create session that is ONLY and SHOULD only be used
2281 * by the lttng command line program. It exists to avoid using URI parsing in
2284 * We need the date and time for the trace path subdirectory for the case where
2285 * the user does NOT define one using either -o or -U. Using the normal
2286 * lttng_create_session API call, we have no clue on the session daemon side if
2287 * the URL was generated automatically by the client or define by the user.
2289 * So this function "wrapper" is hidden from the public API, takes the datetime
2290 * string and appends it if necessary to the URI subdirectory before sending it
2291 * to the session daemon.
2293 * With this extra function, the lttng_create_session call behavior is not
2294 * changed and the timestamp is appended to the URI on the session daemon side
2297 int _lttng_create_session_ext(const char *name
, const char *url
,
2298 const char *datetime
)
2302 struct lttcomm_session_msg lsm
;
2303 struct lttng_uri
*uris
= NULL
;
2305 if (name
== NULL
|| datetime
== NULL
) {
2306 return -LTTNG_ERR_INVALID
;
2309 memset(&lsm
, 0, sizeof(lsm
));
2311 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
2312 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2314 /* There should never be a data URL. */
2315 size
= uri_parse_str_urls(url
, NULL
, &uris
);
2317 ret
= -LTTNG_ERR_INVALID
;
2321 lsm
.u
.uri
.size
= size
;
2323 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
2324 /* Don't append datetime if the name was automatically created. */
2325 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
2326 strlen(DEFAULT_SESSION_NAME
) + 1)) {
2327 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
2330 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
2333 PERROR("snprintf uri subdir");
2334 ret
= -LTTNG_ERR_FATAL
;
2339 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2340 sizeof(struct lttng_uri
) * size
, NULL
);
2348 * For a given session name, this call checks if the data is ready to be read
2349 * or is still being extracted by the consumer(s) hence not ready to be used by
2352 int lttng_data_pending(const char *session_name
)
2355 struct lttcomm_session_msg lsm
;
2356 uint8_t *pending
= NULL
;
2358 if (session_name
== NULL
) {
2359 return -LTTNG_ERR_INVALID
;
2362 memset(&lsm
, 0, sizeof(lsm
));
2363 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
2365 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2366 sizeof(lsm
.session
.name
));
2368 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pending
);
2371 } else if (ret
!= 1) {
2372 /* Unexpected payload size */
2373 ret
= -LTTNG_ERR_INVALID
;
2377 ret
= (int) *pending
;
2384 * Create a session exclusively used for snapshot.
2386 * Returns LTTNG_OK on success or a negative error code.
2388 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
2392 struct lttcomm_session_msg lsm
;
2393 struct lttng_uri
*uris
= NULL
;
2396 return -LTTNG_ERR_INVALID
;
2399 memset(&lsm
, 0, sizeof(lsm
));
2401 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
2402 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2404 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
2406 return -LTTNG_ERR_INVALID
;
2409 lsm
.u
.uri
.size
= size
;
2411 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2412 sizeof(struct lttng_uri
) * size
, NULL
);
2419 * Create a session exclusively used for live.
2421 * Returns LTTNG_OK on success or a negative error code.
2423 int lttng_create_session_live(const char *name
, const char *url
,
2424 unsigned int timer_interval
)
2428 struct lttcomm_session_msg lsm
;
2429 struct lttng_uri
*uris
= NULL
;
2431 if (name
== NULL
|| timer_interval
== 0) {
2432 return -LTTNG_ERR_INVALID
;
2435 memset(&lsm
, 0, sizeof(lsm
));
2437 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
2438 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
2441 size
= uri_parse_str_urls(url
, NULL
, &uris
);
2443 ret
= -LTTNG_ERR_INVALID
;
2447 /* file:// is not accepted for live session. */
2448 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
2449 ret
= -LTTNG_ERR_INVALID
;
2456 lsm
.u
.session_live
.nb_uri
= size
;
2457 lsm
.u
.session_live
.timer_interval
= timer_interval
;
2459 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, uris
,
2460 sizeof(struct lttng_uri
) * size
, NULL
);
2468 * List PIDs in the tracker.
2470 * enabled is set to whether the PID tracker is enabled.
2471 * pids is set to an allocated array of PIDs currently tracked. On
2472 * success, pids must be freed by the caller.
2473 * nr_pids is set to the number of entries contained by the pids array.
2475 * Returns 0 on success, else a negative LTTng error code.
2477 int lttng_list_tracker_pids(struct lttng_handle
*handle
,
2478 int *_enabled
, int32_t **_pids
, size_t *_nr_pids
)
2482 struct lttcomm_session_msg lsm
;
2486 if (handle
== NULL
) {
2487 return -LTTNG_ERR_INVALID
;
2490 memset(&lsm
, 0, sizeof(lsm
));
2491 lsm
.cmd_type
= LTTNG_LIST_TRACKER_PIDS
;
2492 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2493 sizeof(lsm
.session
.name
));
2494 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2496 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pids
);
2500 nr_pids
= ret
/ sizeof(int32_t);
2501 if (nr_pids
== 1 && pids
[0] == -1) {
2507 *_enabled
= enabled
;
2509 *_nr_pids
= nr_pids
;
2514 * Regenerate the metadata for a session.
2515 * Return 0 on success, a negative error code on error.
2517 int lttng_regenerate_metadata(const char *session_name
)
2520 struct lttcomm_session_msg lsm
;
2522 if (!session_name
) {
2523 ret
= -LTTNG_ERR_INVALID
;
2527 memset(&lsm
, 0, sizeof(lsm
));
2528 lsm
.cmd_type
= LTTNG_REGENERATE_METADATA
;
2530 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2531 sizeof(lsm
.session
.name
));
2533 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2544 * Deprecated, replaced by lttng_regenerate_metadata.
2546 int lttng_metadata_regenerate(const char *session_name
)
2548 return lttng_regenerate_metadata(session_name
);
2552 * Regenerate the statedump of a session.
2553 * Return 0 on success, a negative error code on error.
2555 int lttng_regenerate_statedump(const char *session_name
)
2558 struct lttcomm_session_msg lsm
;
2560 if (!session_name
) {
2561 ret
= -LTTNG_ERR_INVALID
;
2565 memset(&lsm
, 0, sizeof(lsm
));
2566 lsm
.cmd_type
= LTTNG_REGENERATE_STATEDUMP
;
2568 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
2569 sizeof(lsm
.session
.name
));
2571 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
2581 int lttng_register_trigger(struct lttng_trigger
*trigger
)
2584 struct lttcomm_session_msg lsm
;
2585 char *trigger_buf
= NULL
;
2586 ssize_t trigger_size
;
2589 ret
= -LTTNG_ERR_INVALID
;
2593 if (!lttng_trigger_validate(trigger
)) {
2594 ret
= -LTTNG_ERR_INVALID
;
2598 trigger_size
= lttng_trigger_serialize(trigger
, NULL
);
2599 if (trigger_size
< 0) {
2600 ret
= -LTTNG_ERR_UNK
;
2604 trigger_buf
= zmalloc(trigger_size
);
2606 ret
= -LTTNG_ERR_NOMEM
;
2610 memset(&lsm
, 0, sizeof(lsm
));
2611 lsm
.cmd_type
= LTTNG_REGISTER_TRIGGER
;
2612 if (lttng_trigger_serialize(trigger
, trigger_buf
) < 0) {
2613 ret
= -LTTNG_ERR_UNK
;
2617 lsm
.u
.trigger
.length
= (uint32_t) trigger_size
;
2618 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, trigger_buf
,
2619 trigger_size
, NULL
);
2625 int lttng_unregister_trigger(struct lttng_trigger
*trigger
)
2628 struct lttcomm_session_msg lsm
;
2629 char *trigger_buf
= NULL
;
2630 ssize_t trigger_size
;
2633 ret
= -LTTNG_ERR_INVALID
;
2637 if (!lttng_trigger_validate(trigger
)) {
2638 ret
= -LTTNG_ERR_INVALID
;
2642 trigger_size
= lttng_trigger_serialize(trigger
, NULL
);
2643 if (trigger_size
< 0) {
2644 ret
= -LTTNG_ERR_UNK
;
2648 trigger_buf
= zmalloc(trigger_size
);
2650 ret
= -LTTNG_ERR_NOMEM
;
2654 memset(&lsm
, 0, sizeof(lsm
));
2655 lsm
.cmd_type
= LTTNG_UNREGISTER_TRIGGER
;
2656 if (lttng_trigger_serialize(trigger
, trigger_buf
) < 0) {
2657 ret
= -LTTNG_ERR_UNK
;
2661 lsm
.u
.trigger
.length
= (uint32_t) trigger_size
;
2662 ret
= lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm
, trigger_buf
,
2663 trigger_size
, NULL
);
2672 static void __attribute__((constructor
)) init(void)
2674 /* Set default session group */
2675 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
2681 static void __attribute__((destructor
)) lttng_ctl_exit(void)
2683 free(tracing_group
);