4 * Linux Trace Toolkit Control Library
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
8 * This library is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License, version 2.1 only,
10 * as published by the Free Software Foundation.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31 #include <common/common.h>
32 #include <common/defaults.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
34 #include <common/uri.h>
35 #include <common/utils.h>
36 #include <lttng/lttng.h>
37 #include <lttng/health-internal.h>
39 #include "filter/filter-ast.h"
40 #include "filter/filter-parser.h"
41 #include "filter/filter-bytecode.h"
42 #include "filter/memstream.h"
43 #include "lttng-ctl-helper.h"
46 static const int print_xml
= 1;
47 #define dbg_printf(fmt, args...) \
48 printf("[debug liblttng-ctl] " fmt, ## args)
50 static const int print_xml
= 0;
51 #define dbg_printf(fmt, args...) \
53 /* do nothing but check printf format */ \
55 printf("[debug liblttnctl] " fmt, ## args); \
60 /* Socket to session daemon for communication */
61 static int sessiond_socket
;
62 static char sessiond_sock_path
[PATH_MAX
];
65 static char *tracing_group
;
71 * Those two variables are used by error.h to silent or control the verbosity of
72 * error message. They are global to the library so application linking with it
73 * are able to compile correctly and also control verbosity of the library.
76 int lttng_opt_verbose
;
79 * Copy string from src to dst and enforce null terminated byte.
82 void lttng_ctl_copy_string(char *dst
, const char *src
, size_t len
)
85 strncpy(dst
, src
, len
);
86 /* Enforce the NULL terminated byte */
94 * Copy domain to lttcomm_session_msg domain.
96 * If domain is unknown, default domain will be the kernel.
99 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
100 struct lttng_domain
*src
)
104 case LTTNG_DOMAIN_KERNEL
:
105 case LTTNG_DOMAIN_UST
:
106 case LTTNG_DOMAIN_JUL
:
107 memcpy(dst
, src
, sizeof(struct lttng_domain
));
110 memset(dst
, 0, sizeof(struct lttng_domain
));
117 * Send lttcomm_session_msg to the session daemon.
119 * On success, returns the number of bytes sent (>=0)
120 * On error, returns -1
122 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
127 ret
= -LTTNG_ERR_NO_SESSIOND
;
131 DBG("LSM cmd type : %d", lsm
->cmd_type
);
133 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
134 sizeof(struct lttcomm_session_msg
));
136 ret
= -LTTNG_ERR_FATAL
;
144 * Send var len data to the session daemon.
146 * On success, returns the number of bytes sent (>=0)
147 * On error, returns -1
149 static int send_session_varlen(void *data
, size_t len
)
154 ret
= -LTTNG_ERR_NO_SESSIOND
;
163 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
165 ret
= -LTTNG_ERR_FATAL
;
173 * Receive data from the sessiond socket.
175 * On success, returns the number of bytes received (>=0)
176 * On error, returns -1 (recvmsg() error) or -ENOTCONN
178 static int recv_data_sessiond(void *buf
, size_t len
)
183 ret
= -LTTNG_ERR_NO_SESSIOND
;
187 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
189 ret
= -LTTNG_ERR_FATAL
;
197 * Check if we are in the specified group.
199 * If yes return 1, else return -1.
202 int lttng_check_tracing_group(void)
204 struct group
*grp_tracing
; /* no free(). See getgrnam(3) */
206 int grp_list_size
, grp_id
, i
;
208 const char *grp_name
= tracing_group
;
210 /* Get GID of group 'tracing' */
211 grp_tracing
= getgrnam(grp_name
);
213 /* If grp_tracing is NULL, the group does not exist. */
217 /* Get number of supplementary group IDs */
218 grp_list_size
= getgroups(0, NULL
);
219 if (grp_list_size
< 0) {
224 /* Alloc group list of the right size */
225 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
230 grp_id
= getgroups(grp_list_size
, grp_list
);
236 for (i
= 0; i
< grp_list_size
; i
++) {
237 if (grp_list
[i
] == grp_tracing
->gr_gid
) {
251 * Try connect to session daemon with sock_path.
253 * Return 0 on success, else -1
255 static int try_connect_sessiond(const char *sock_path
)
259 /* If socket exist, we check if the daemon listens for connect. */
260 ret
= access(sock_path
, F_OK
);
266 ret
= lttcomm_connect_unix_sock(sock_path
);
272 ret
= lttcomm_close_unix_sock(ret
);
274 perror("lttcomm_close_unix_sock");
284 * Set sessiond socket path by putting it in the global sessiond_sock_path
287 * Returns 0 on success, negative value on failure (the sessiond socket path
288 * is somehow too long or ENOMEM).
290 static int set_session_daemon_path(void)
292 int in_tgroup
= 0; /* In tracing group */
298 /* Are we in the tracing group ? */
299 in_tgroup
= lttng_check_tracing_group();
302 if ((uid
== 0) || in_tgroup
) {
303 lttng_ctl_copy_string(sessiond_sock_path
,
304 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
, sizeof(sessiond_sock_path
));
312 ret
= try_connect_sessiond(sessiond_sock_path
);
316 /* Global session daemon not available... */
318 /* ...or not in tracing group (and not root), default */
321 * With GNU C < 2.1, snprintf returns -1 if the target buffer is too small;
322 * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
324 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
325 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
326 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
338 * Connect to the LTTng session daemon.
340 * On success, return 0. On error, return -1.
342 static int connect_sessiond(void)
346 /* Don't try to connect if already connected. */
351 ret
= set_session_daemon_path();
356 /* Connect to the sesssion daemon */
357 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
362 sessiond_socket
= ret
;
372 * Clean disconnect from the session daemon.
373 * On success, return 0. On error, return -1.
375 static int disconnect_sessiond(void)
380 ret
= lttcomm_close_unix_sock(sessiond_socket
);
389 * Ask the session daemon a specific command and put the data into buf.
390 * Takes extra var. len. data as input to send to the session daemon.
392 * Return size of data (only payload, not header) or a negative error code.
395 int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg
*lsm
,
396 void *vardata
, size_t varlen
, void **buf
)
401 struct lttcomm_lttng_msg llm
;
403 ret
= connect_sessiond();
405 ret
= -LTTNG_ERR_NO_SESSIOND
;
409 /* Send command to session daemon */
410 ret
= send_session_msg(lsm
);
412 /* Ret value is a valid lttng error code. */
415 /* Send var len data */
416 ret
= send_session_varlen(vardata
, varlen
);
418 /* Ret value is a valid lttng error code. */
422 /* Get header from data transmission */
423 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
425 /* Ret value is a valid lttng error code. */
429 /* Check error code if OK */
430 if (llm
.ret_code
!= LTTNG_OK
) {
435 size
= llm
.data_size
;
437 /* If client free with size 0 */
445 data
= zmalloc(size
);
451 /* Get payload data */
452 ret
= recv_data_sessiond(data
, size
);
459 * Extra protection not to dereference a NULL pointer. If buf is NULL at
460 * this point, an error is returned and data is freed.
463 ret
= -LTTNG_ERR_INVALID
;
472 disconnect_sessiond();
477 * Create lttng handle and return pointer.
478 * The returned pointer will be NULL in case of malloc() error.
480 struct lttng_handle
*lttng_create_handle(const char *session_name
,
481 struct lttng_domain
*domain
)
483 struct lttng_handle
*handle
= NULL
;
485 if (domain
== NULL
) {
489 handle
= zmalloc(sizeof(struct lttng_handle
));
490 if (handle
== NULL
) {
491 PERROR("malloc handle");
495 /* Copy session name */
496 lttng_ctl_copy_string(handle
->session_name
, session_name
,
497 sizeof(handle
->session_name
));
499 /* Copy lttng domain */
500 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
507 * Destroy handle by free(3) the pointer.
509 void lttng_destroy_handle(struct lttng_handle
*handle
)
515 * Register an outside consumer.
516 * Returns size of returned session payload data or a negative error code.
518 int lttng_register_consumer(struct lttng_handle
*handle
,
519 const char *socket_path
)
521 struct lttcomm_session_msg lsm
;
523 if (handle
== NULL
|| socket_path
== NULL
) {
524 return -LTTNG_ERR_INVALID
;
527 memset(&lsm
, 0, sizeof(lsm
));
528 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
529 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
530 sizeof(lsm
.session
.name
));
531 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
533 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
, sizeof(lsm
.u
.reg
.path
));
535 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
539 * Start tracing for all traces of the session.
540 * Returns size of returned session payload data or a negative error code.
542 int lttng_start_tracing(const char *session_name
)
544 struct lttcomm_session_msg lsm
;
546 if (session_name
== NULL
) {
547 return -LTTNG_ERR_INVALID
;
550 memset(&lsm
, 0, sizeof(lsm
));
551 lsm
.cmd_type
= LTTNG_START_TRACE
;
553 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
554 sizeof(lsm
.session
.name
));
556 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
560 * Stop tracing for all traces of the session.
562 static int _lttng_stop_tracing(const char *session_name
, int wait
)
565 struct lttcomm_session_msg lsm
;
567 if (session_name
== NULL
) {
568 return -LTTNG_ERR_INVALID
;
571 memset(&lsm
, 0, sizeof(lsm
));
572 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
574 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
575 sizeof(lsm
.session
.name
));
577 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
578 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
586 /* Check for data availability */
588 data_ret
= lttng_data_pending(session_name
);
590 /* Return the data available call error. */
596 * Data sleep time before retrying (in usec). Don't sleep if the call
597 * returned value indicates availability.
600 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME
);
602 } while (data_ret
!= 0);
610 * Stop tracing and wait for data availability.
612 int lttng_stop_tracing(const char *session_name
)
614 return _lttng_stop_tracing(session_name
, 1);
618 * Stop tracing but _don't_ wait for data availability.
620 int lttng_stop_tracing_no_wait(const char *session_name
)
622 return _lttng_stop_tracing(session_name
, 0);
626 * Add context to a channel.
628 * If the given channel is NULL, add the contexts to all channels.
629 * The event_name param is ignored.
631 * Returns the size of the returned payload data or a negative error code.
633 int lttng_add_context(struct lttng_handle
*handle
,
634 struct lttng_event_context
*ctx
, const char *event_name
,
635 const char *channel_name
)
637 struct lttcomm_session_msg lsm
;
639 /* Safety check. Both are mandatory */
640 if (handle
== NULL
|| ctx
== NULL
) {
641 return -LTTNG_ERR_INVALID
;
644 memset(&lsm
, 0, sizeof(lsm
));
646 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
648 /* If no channel name, send empty string. */
649 if (channel_name
== NULL
) {
650 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
651 sizeof(lsm
.u
.context
.channel_name
));
653 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
654 sizeof(lsm
.u
.context
.channel_name
));
657 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
659 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
661 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
662 sizeof(lsm
.session
.name
));
664 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
668 * Enable event(s) for a channel.
669 * If no event name is specified, all events are enabled.
670 * If no channel name is specified, the default 'channel0' is used.
671 * Returns size of returned session payload data or a negative error code.
673 int lttng_enable_event(struct lttng_handle
*handle
,
674 struct lttng_event
*ev
, const char *channel_name
)
676 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
681 * Create or enable an event with a filter expression.
683 * Return negative error value on error.
684 * Return size of returned session payload data if OK.
686 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
687 struct lttng_event
*event
, const char *channel_name
,
688 const char *filter_expression
)
690 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
691 filter_expression
, 0, NULL
);
695 * Depending on the event, return a newly allocated JUL filter expression or
696 * NULL if not applicable.
698 * An event with NO loglevel and the name is * will return NULL.
700 static char *set_jul_filter(const char *filter
, struct lttng_event
*ev
)
703 char *jul_filter
= NULL
;
707 /* Don't add filter for the '*' event. */
708 if (ev
->name
[0] != '*') {
710 err
= asprintf(&jul_filter
, "(%s) && (logger_name == \"%s\")", filter
,
713 err
= asprintf(&jul_filter
, "logger_name == \"%s\"", ev
->name
);
721 /* Add loglevel filtering if any for the JUL domain. */
722 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
725 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
731 if (filter
|| jul_filter
) {
734 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
735 jul_filter
? jul_filter
: filter
, op
,
740 jul_filter
= new_filter
;
742 err
= asprintf(&jul_filter
, "int_loglevel %s %d", op
,
758 * Generate the filter bytecode from a give filter expression string. Put the
759 * newly allocated parser context in ctxp and populate the lsm object with the
762 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
764 static int generate_filter(char *filter_expression
,
765 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
768 struct filter_parser_ctx
*ctx
= NULL
;
771 assert(filter_expression
);
776 * Casting const to non-const, as the underlying function will use it in
779 fmem
= lttng_fmemopen((void *) filter_expression
,
780 strlen(filter_expression
), "r");
782 fprintf(stderr
, "Error opening memory as stream\n");
783 ret
= -LTTNG_ERR_FILTER_NOMEM
;
786 ctx
= filter_parser_ctx_alloc(fmem
);
788 fprintf(stderr
, "Error allocating parser\n");
789 ret
= -LTTNG_ERR_FILTER_NOMEM
;
790 goto filter_alloc_error
;
792 ret
= filter_parser_ctx_append_ast(ctx
);
794 fprintf(stderr
, "Parse error\n");
795 ret
= -LTTNG_ERR_FILTER_INVAL
;
798 ret
= filter_visitor_set_parent(ctx
);
800 fprintf(stderr
, "Set parent error\n");
801 ret
= -LTTNG_ERR_FILTER_INVAL
;
805 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
808 fprintf(stderr
, "XML print error\n");
809 ret
= -LTTNG_ERR_FILTER_INVAL
;
814 dbg_printf("Generating IR... ");
816 ret
= filter_visitor_ir_generate(ctx
);
818 fprintf(stderr
, "Generate IR error\n");
819 ret
= -LTTNG_ERR_FILTER_INVAL
;
822 dbg_printf("done\n");
824 dbg_printf("Validating IR... ");
826 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
828 ret
= -LTTNG_ERR_FILTER_INVAL
;
831 dbg_printf("done\n");
833 dbg_printf("Generating bytecode... ");
835 ret
= filter_visitor_bytecode_generate(ctx
);
837 fprintf(stderr
, "Generate bytecode error\n");
838 ret
= -LTTNG_ERR_FILTER_INVAL
;
841 dbg_printf("done\n");
842 dbg_printf("Size of bytecode generated: %u bytes.\n",
843 bytecode_get_len(&ctx
->bytecode
->b
));
845 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
846 + bytecode_get_len(&ctx
->bytecode
->b
);
847 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
849 /* No need to keep the memory stream. */
850 if (fclose(fmem
) != 0) {
859 filter_parser_ctx_free(ctx
);
861 if (fclose(fmem
) != 0) {
869 * Enable event(s) for a channel, possibly with exclusions and a filter.
870 * If no event name is specified, all events are enabled.
871 * If no channel name is specified, the default name is used.
872 * If filter expression is not NULL, the filter is set for the event.
873 * If exclusion count is not zero, the exclusions are set for the event.
874 * Returns size of returned session payload data or a negative error code.
876 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
877 struct lttng_event
*ev
, const char *channel_name
,
878 const char *original_filter_expression
,
879 int exclusion_count
, char **exclusion_list
)
881 struct lttcomm_session_msg lsm
;
884 unsigned int free_filter_expression
= 0;
885 struct filter_parser_ctx
*ctx
= NULL
;
887 * Cast as non-const since we may replace the filter expression
888 * by a dynamically allocated string. Otherwise, the original
889 * string is not modified.
891 char *filter_expression
= (char *) original_filter_expression
;
893 if (handle
== NULL
|| ev
== NULL
) {
894 ret
= -LTTNG_ERR_INVALID
;
898 /* Empty filter string will always be rejected by the parser
899 * anyway, so treat this corner-case early to eliminate
900 * lttng_fmemopen error for 0-byte allocation.
902 if (filter_expression
&& filter_expression
[0] == '\0') {
903 ret
= -LTTNG_ERR_INVALID
;
907 memset(&lsm
, 0, sizeof(lsm
));
909 /* If no channel name, send empty string. */
910 if (channel_name
== NULL
) {
911 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
912 sizeof(lsm
.u
.enable
.channel_name
));
914 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
915 sizeof(lsm
.u
.enable
.channel_name
));
918 if (ev
->name
[0] != '\0') {
919 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
921 lsm
.cmd_type
= LTTNG_ENABLE_ALL_EVENT
;
924 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
925 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
927 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
928 sizeof(lsm
.session
.name
));
929 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
930 lsm
.u
.enable
.bytecode_len
= 0;
933 * For the JUL domain, a filter is enforced except for the enable all
934 * event. This is done to avoid having the event in all sessions thus
935 * filtering by logger name.
937 if (exclusion_count
== 0 && filter_expression
== NULL
&&
938 handle
->domain
.type
!= LTTNG_DOMAIN_JUL
) {
943 * We have either a filter or some exclusions, so we need to set up
944 * a variable-length memory block from where to send the data
947 /* Parse filter expression */
948 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
) {
949 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
) {
952 /* Setup JUL filter if needed. */
953 jul_filter
= set_jul_filter(filter_expression
, ev
);
955 if (!filter_expression
) {
956 /* No JUL and no filter, just skip everything below. */
961 * With a JUL filter, the original filter has been added to it
962 * thus replace the filter expression.
964 filter_expression
= jul_filter
;
965 free_filter_expression
= 1;
969 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
975 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
976 + lsm
.u
.enable
.expression_len
977 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
979 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
983 /* Put exclusion names first in the data */
984 while (exclusion_count
--) {
985 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
986 *(exclusion_list
+ exclusion_count
), LTTNG_SYMBOL_NAME_LEN
);
988 /* Add filter expression next */
989 if (lsm
.u
.enable
.expression_len
!= 0) {
991 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
993 lsm
.u
.enable
.expression_len
);
995 /* Add filter bytecode next */
996 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
998 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
999 + lsm
.u
.enable
.expression_len
,
1001 lsm
.u
.enable
.bytecode_len
);
1004 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, varlen_data
,
1005 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
1006 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
, NULL
);
1010 if (filter_expression
&& ctx
) {
1011 filter_bytecode_free(ctx
);
1012 filter_ir_free(ctx
);
1013 filter_parser_ctx_free(ctx
);
1016 if (free_filter_expression
) {
1018 * The filter expression has been replaced and must be freed as it is
1019 * not the original filter expression received as a parameter.
1021 free(filter_expression
);
1025 * Return directly to the caller and don't ask the sessiond since something
1026 * went wrong in the parsing of data above.
1031 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1036 * Disable event(s) of a channel and domain.
1037 * If no event name is specified, all events are disabled.
1038 * If no channel name is specified, the default 'channel0' is used.
1039 * Returns size of returned session payload data or a negative error code.
1041 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1042 const char *channel_name
)
1044 struct lttcomm_session_msg lsm
;
1046 if (handle
== NULL
) {
1047 return -LTTNG_ERR_INVALID
;
1050 memset(&lsm
, 0, sizeof(lsm
));
1052 /* If no channel name, send empty string. */
1053 if (channel_name
== NULL
) {
1054 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1055 sizeof(lsm
.u
.disable
.channel_name
));
1057 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1058 sizeof(lsm
.u
.disable
.channel_name
));
1061 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1063 if (name
!= NULL
&& *name
!= '*') {
1064 lttng_ctl_copy_string(lsm
.u
.disable
.name
, name
,
1065 sizeof(lsm
.u
.disable
.name
));
1066 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1068 lsm
.cmd_type
= LTTNG_DISABLE_ALL_EVENT
;
1071 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1072 sizeof(lsm
.session
.name
));
1074 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1078 * Enable channel per domain
1079 * Returns size of returned session payload data or a negative error code.
1081 int lttng_enable_channel(struct lttng_handle
*handle
,
1082 struct lttng_channel
*chan
)
1084 struct lttcomm_session_msg lsm
;
1087 * NULL arguments are forbidden. No default values.
1089 if (handle
== NULL
|| chan
== NULL
) {
1090 return -LTTNG_ERR_INVALID
;
1093 memset(&lsm
, 0, sizeof(lsm
));
1095 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(lsm
.u
.channel
.chan
));
1097 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1099 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1101 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1102 sizeof(lsm
.session
.name
));
1104 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1108 * All tracing will be stopped for registered events of the channel.
1109 * Returns size of returned session payload data or a negative error code.
1111 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1113 struct lttcomm_session_msg lsm
;
1115 /* Safety check. Both are mandatory */
1116 if (handle
== NULL
|| name
== NULL
) {
1117 return -LTTNG_ERR_INVALID
;
1120 memset(&lsm
, 0, sizeof(lsm
));
1122 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1124 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1125 sizeof(lsm
.u
.disable
.channel_name
));
1127 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1129 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1130 sizeof(lsm
.session
.name
));
1132 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1136 * Lists all available tracepoints of domain.
1137 * Sets the contents of the events array.
1138 * Returns the number of lttng_event entries in events;
1139 * on error, returns a negative value.
1141 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1142 struct lttng_event
**events
)
1145 struct lttcomm_session_msg lsm
;
1147 if (handle
== NULL
) {
1148 return -LTTNG_ERR_INVALID
;
1151 memset(&lsm
, 0, sizeof(lsm
));
1152 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1153 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1155 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1160 return ret
/ sizeof(struct lttng_event
);
1164 * Lists all available tracepoint fields of domain.
1165 * Sets the contents of the event field array.
1166 * Returns the number of lttng_event_field entries in events;
1167 * on error, returns a negative value.
1169 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1170 struct lttng_event_field
**fields
)
1173 struct lttcomm_session_msg lsm
;
1175 if (handle
== NULL
) {
1176 return -LTTNG_ERR_INVALID
;
1179 memset(&lsm
, 0, sizeof(lsm
));
1180 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1181 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1183 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1188 return ret
/ sizeof(struct lttng_event_field
);
1192 * Returns a human readable string describing
1193 * the error code (a negative value).
1195 const char *lttng_strerror(int code
)
1197 return error_get_str(code
);
1201 * Create a brand new session using name and url for destination.
1203 * Returns LTTNG_OK on success or a negative error code.
1205 int lttng_create_session(const char *name
, const char *url
)
1209 struct lttcomm_session_msg lsm
;
1210 struct lttng_uri
*uris
= NULL
;
1213 return -LTTNG_ERR_INVALID
;
1216 memset(&lsm
, 0, sizeof(lsm
));
1218 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1219 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1221 /* There should never be a data URL */
1222 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1224 return -LTTNG_ERR_INVALID
;
1227 lsm
.u
.uri
.size
= size
;
1229 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1230 sizeof(struct lttng_uri
) * size
, NULL
);
1237 * Destroy session using name.
1238 * Returns size of returned session payload data or a negative error code.
1240 int lttng_destroy_session(const char *session_name
)
1242 struct lttcomm_session_msg lsm
;
1244 if (session_name
== NULL
) {
1245 return -LTTNG_ERR_INVALID
;
1248 memset(&lsm
, 0, sizeof(lsm
));
1249 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1251 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1252 sizeof(lsm
.session
.name
));
1254 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1258 * Ask the session daemon for all available sessions.
1259 * Sets the contents of the sessions array.
1260 * Returns the number of lttng_session entries in sessions;
1261 * on error, returns a negative value.
1263 int lttng_list_sessions(struct lttng_session
**sessions
)
1266 struct lttcomm_session_msg lsm
;
1268 memset(&lsm
, 0, sizeof(lsm
));
1269 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1270 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1275 return ret
/ sizeof(struct lttng_session
);
1279 * Ask the session daemon for all available domains of a session.
1280 * Sets the contents of the domains array.
1281 * Returns the number of lttng_domain entries in domains;
1282 * on error, returns a negative value.
1284 int lttng_list_domains(const char *session_name
,
1285 struct lttng_domain
**domains
)
1288 struct lttcomm_session_msg lsm
;
1290 if (session_name
== NULL
) {
1291 return -LTTNG_ERR_INVALID
;
1294 memset(&lsm
, 0, sizeof(lsm
));
1295 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1297 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1298 sizeof(lsm
.session
.name
));
1300 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1305 return ret
/ sizeof(struct lttng_domain
);
1309 * Ask the session daemon for all available channels of a session.
1310 * Sets the contents of the channels array.
1311 * Returns the number of lttng_channel entries in channels;
1312 * on error, returns a negative value.
1314 int lttng_list_channels(struct lttng_handle
*handle
,
1315 struct lttng_channel
**channels
)
1318 struct lttcomm_session_msg lsm
;
1320 if (handle
== NULL
) {
1321 return -LTTNG_ERR_INVALID
;
1324 memset(&lsm
, 0, sizeof(lsm
));
1325 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1326 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1327 sizeof(lsm
.session
.name
));
1329 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1331 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1336 return ret
/ sizeof(struct lttng_channel
);
1340 * Ask the session daemon for all available events of a session channel.
1341 * Sets the contents of the events array.
1342 * Returns the number of lttng_event entries in events;
1343 * on error, returns a negative value.
1345 int lttng_list_events(struct lttng_handle
*handle
,
1346 const char *channel_name
, struct lttng_event
**events
)
1349 struct lttcomm_session_msg lsm
;
1351 /* Safety check. An handle and channel name are mandatory */
1352 if (handle
== NULL
|| channel_name
== NULL
) {
1353 return -LTTNG_ERR_INVALID
;
1356 memset(&lsm
, 0, sizeof(lsm
));
1357 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1358 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1359 sizeof(lsm
.session
.name
));
1360 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1361 sizeof(lsm
.u
.list
.channel_name
));
1363 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1365 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) events
);
1370 return ret
/ sizeof(struct lttng_event
);
1374 * Sets the tracing_group variable with name.
1375 * This function allocates memory pointed to by tracing_group.
1376 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1378 int lttng_set_tracing_group(const char *name
)
1381 return -LTTNG_ERR_INVALID
;
1384 if (asprintf(&tracing_group
, "%s", name
) < 0) {
1385 return -LTTNG_ERR_FATAL
;
1392 * Returns size of returned session payload data or a negative error code.
1394 int lttng_calibrate(struct lttng_handle
*handle
,
1395 struct lttng_calibrate
*calibrate
)
1397 struct lttcomm_session_msg lsm
;
1399 /* Safety check. NULL pointer are forbidden */
1400 if (handle
== NULL
|| calibrate
== NULL
) {
1401 return -LTTNG_ERR_INVALID
;
1404 memset(&lsm
, 0, sizeof(lsm
));
1405 lsm
.cmd_type
= LTTNG_CALIBRATE
;
1406 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1408 memcpy(&lsm
.u
.calibrate
, calibrate
, sizeof(lsm
.u
.calibrate
));
1410 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1414 * Set default channel attributes.
1415 * If either or both of the arguments are null, attr content is zeroe'd.
1417 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
1418 struct lttng_channel_attr
*attr
)
1421 if (attr
== NULL
|| domain
== NULL
) {
1425 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
1427 /* Same for all domains. */
1428 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1429 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
1430 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
1432 switch (domain
->type
) {
1433 case LTTNG_DOMAIN_KERNEL
:
1434 attr
->switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
1435 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
1436 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
1437 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1438 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1440 case LTTNG_DOMAIN_UST
:
1441 switch (domain
->buf_type
) {
1442 case LTTNG_BUFFER_PER_UID
:
1443 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
1444 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
1445 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
1446 attr
->switch_timer_interval
= DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
1447 attr
->read_timer_interval
= DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
1449 case LTTNG_BUFFER_PER_PID
:
1451 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
1452 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
1453 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
1454 attr
->switch_timer_interval
= DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
1455 attr
->read_timer_interval
= DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
1459 /* Default behavior: leave set to 0. */
1465 * Check if session daemon is alive.
1467 * Return 1 if alive or 0 if not.
1468 * On error returns a negative value.
1470 int lttng_session_daemon_alive(void)
1474 ret
= set_session_daemon_path();
1480 if (*sessiond_sock_path
== '\0') {
1482 * No socket path set. Weird error which means the constructor was not
1488 ret
= try_connect_sessiond(sessiond_sock_path
);
1499 * Set URL for a consumer for a session and domain.
1501 * Return 0 on success, else a negative value.
1503 int lttng_set_consumer_url(struct lttng_handle
*handle
,
1504 const char *control_url
, const char *data_url
)
1508 struct lttcomm_session_msg lsm
;
1509 struct lttng_uri
*uris
= NULL
;
1511 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
1512 return -LTTNG_ERR_INVALID
;
1515 memset(&lsm
, 0, sizeof(lsm
));
1517 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
1519 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1520 sizeof(lsm
.session
.name
));
1521 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1523 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
1525 return -LTTNG_ERR_INVALID
;
1528 lsm
.u
.uri
.size
= size
;
1530 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1531 sizeof(struct lttng_uri
) * size
, NULL
);
1540 int lttng_enable_consumer(struct lttng_handle
*handle
)
1548 int lttng_disable_consumer(struct lttng_handle
*handle
)
1554 * This is an extension of create session that is ONLY and SHOULD only be used
1555 * by the lttng command line program. It exists to avoid using URI parsing in
1558 * We need the date and time for the trace path subdirectory for the case where
1559 * the user does NOT define one using either -o or -U. Using the normal
1560 * lttng_create_session API call, we have no clue on the session daemon side if
1561 * the URL was generated automatically by the client or define by the user.
1563 * So this function "wrapper" is hidden from the public API, takes the datetime
1564 * string and appends it if necessary to the URI subdirectory before sending it
1565 * to the session daemon.
1567 * With this extra function, the lttng_create_session call behavior is not
1568 * changed and the timestamp is appended to the URI on the session daemon side
1571 int _lttng_create_session_ext(const char *name
, const char *url
,
1572 const char *datetime
)
1576 struct lttcomm_session_msg lsm
;
1577 struct lttng_uri
*uris
= NULL
;
1579 if (name
== NULL
|| datetime
== NULL
) {
1580 return -LTTNG_ERR_INVALID
;
1583 memset(&lsm
, 0, sizeof(lsm
));
1585 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1586 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1588 /* There should never be a data URL */
1589 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1591 ret
= -LTTNG_ERR_INVALID
;
1595 lsm
.u
.uri
.size
= size
;
1597 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
1598 /* Don't append datetime if the name was automatically created. */
1599 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
1600 strlen(DEFAULT_SESSION_NAME
) + 1)) {
1601 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
1604 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
1607 PERROR("snprintf uri subdir");
1608 ret
= -LTTNG_ERR_FATAL
;
1613 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1614 sizeof(struct lttng_uri
) * size
, NULL
);
1622 * For a given session name, this call checks if the data is ready to be read
1623 * or is still being extracted by the consumer(s) hence not ready to be used by
1626 int lttng_data_pending(const char *session_name
)
1629 struct lttcomm_session_msg lsm
;
1631 if (session_name
== NULL
) {
1632 return -LTTNG_ERR_INVALID
;
1635 memset(&lsm
, 0, sizeof(lsm
));
1636 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
1638 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1639 sizeof(lsm
.session
.name
));
1641 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1644 * The lttng_ctl_ask_sessiond function negate the return code if it's not
1645 * LTTNG_OK so getting -1 means that the reply ret_code was 1 thus meaning
1646 * that the data is available. Yes it is hackish but for now this is the
1657 * Create a session exclusively used for snapshot.
1659 * Returns LTTNG_OK on success or a negative error code.
1661 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1665 struct lttcomm_session_msg lsm
;
1666 struct lttng_uri
*uris
= NULL
;
1669 return -LTTNG_ERR_INVALID
;
1672 memset(&lsm
, 0, sizeof(lsm
));
1674 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
1675 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1677 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1679 return -LTTNG_ERR_INVALID
;
1682 lsm
.u
.uri
.size
= size
;
1684 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1685 sizeof(struct lttng_uri
) * size
, NULL
);
1692 * Create a session exclusively used for live.
1694 * Returns LTTNG_OK on success or a negative error code.
1696 int lttng_create_session_live(const char *name
, const char *url
,
1697 unsigned int timer_interval
)
1701 struct lttcomm_session_msg lsm
;
1702 struct lttng_uri
*uris
= NULL
;
1705 return -LTTNG_ERR_INVALID
;
1708 memset(&lsm
, 0, sizeof(lsm
));
1710 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
1711 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1714 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1716 ret
= -LTTNG_ERR_INVALID
;
1720 /* file:// is not accepted for live session. */
1721 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
1722 ret
= -LTTNG_ERR_INVALID
;
1729 lsm
.u
.session_live
.nb_uri
= size
;
1730 lsm
.u
.session_live
.timer_interval
= timer_interval
;
1732 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1733 sizeof(struct lttng_uri
) * size
, NULL
);
1743 static void __attribute__((constructor
)) init()
1745 /* Set default session group */
1746 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
1752 static void __attribute__((destructor
)) lttng_ctl_exit()
1754 free(tracing_group
);