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
= malloc(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
= (void*) malloc(size
);
447 /* Get payload data */
448 ret
= recv_data_sessiond(data
, size
);
455 * Extra protection not to dereference a NULL pointer. If buf is NULL at
456 * this point, an error is returned and data is freed.
459 ret
= -LTTNG_ERR_INVALID
;
468 disconnect_sessiond();
473 * Create lttng handle and return pointer.
474 * The returned pointer will be NULL in case of malloc() error.
476 struct lttng_handle
*lttng_create_handle(const char *session_name
,
477 struct lttng_domain
*domain
)
479 struct lttng_handle
*handle
= NULL
;
481 if (domain
== NULL
) {
485 handle
= malloc(sizeof(struct lttng_handle
));
486 if (handle
== NULL
) {
487 PERROR("malloc handle");
491 /* Copy session name */
492 lttng_ctl_copy_string(handle
->session_name
, session_name
,
493 sizeof(handle
->session_name
));
495 /* Copy lttng domain */
496 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
503 * Destroy handle by free(3) the pointer.
505 void lttng_destroy_handle(struct lttng_handle
*handle
)
511 * Register an outside consumer.
512 * Returns size of returned session payload data or a negative error code.
514 int lttng_register_consumer(struct lttng_handle
*handle
,
515 const char *socket_path
)
517 struct lttcomm_session_msg lsm
;
519 if (handle
== NULL
|| socket_path
== NULL
) {
520 return -LTTNG_ERR_INVALID
;
523 memset(&lsm
, 0, sizeof(lsm
));
524 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
525 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
526 sizeof(lsm
.session
.name
));
527 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
529 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
, sizeof(lsm
.u
.reg
.path
));
531 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
535 * Start tracing for all traces of the session.
536 * Returns size of returned session payload data or a negative error code.
538 int lttng_start_tracing(const char *session_name
)
540 struct lttcomm_session_msg lsm
;
542 if (session_name
== NULL
) {
543 return -LTTNG_ERR_INVALID
;
546 memset(&lsm
, 0, sizeof(lsm
));
547 lsm
.cmd_type
= LTTNG_START_TRACE
;
549 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
550 sizeof(lsm
.session
.name
));
552 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
556 * Stop tracing for all traces of the session.
558 static int _lttng_stop_tracing(const char *session_name
, int wait
)
561 struct lttcomm_session_msg lsm
;
563 if (session_name
== NULL
) {
564 return -LTTNG_ERR_INVALID
;
567 memset(&lsm
, 0, sizeof(lsm
));
568 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
570 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
571 sizeof(lsm
.session
.name
));
573 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
574 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
582 /* Check for data availability */
584 data_ret
= lttng_data_pending(session_name
);
586 /* Return the data available call error. */
592 * Data sleep time before retrying (in usec). Don't sleep if the call
593 * returned value indicates availability.
596 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME
);
598 } while (data_ret
!= 0);
606 * Stop tracing and wait for data availability.
608 int lttng_stop_tracing(const char *session_name
)
610 return _lttng_stop_tracing(session_name
, 1);
614 * Stop tracing but _don't_ wait for data availability.
616 int lttng_stop_tracing_no_wait(const char *session_name
)
618 return _lttng_stop_tracing(session_name
, 0);
622 * Add context to a channel.
624 * If the given channel is NULL, add the contexts to all channels.
625 * The event_name param is ignored.
627 * Returns the size of the returned payload data or a negative error code.
629 int lttng_add_context(struct lttng_handle
*handle
,
630 struct lttng_event_context
*ctx
, const char *event_name
,
631 const char *channel_name
)
633 struct lttcomm_session_msg lsm
;
635 /* Safety check. Both are mandatory */
636 if (handle
== NULL
|| ctx
== NULL
) {
637 return -LTTNG_ERR_INVALID
;
640 memset(&lsm
, 0, sizeof(lsm
));
642 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
644 /* If no channel name, send empty string. */
645 if (channel_name
== NULL
) {
646 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
647 sizeof(lsm
.u
.context
.channel_name
));
649 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
650 sizeof(lsm
.u
.context
.channel_name
));
653 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
655 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
657 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
658 sizeof(lsm
.session
.name
));
660 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
664 * Enable event(s) for a channel.
665 * If no event name is specified, all events are enabled.
666 * If no channel name is specified, the default 'channel0' is used.
667 * Returns size of returned session payload data or a negative error code.
669 int lttng_enable_event(struct lttng_handle
*handle
,
670 struct lttng_event
*ev
, const char *channel_name
)
672 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
677 * Create or enable an event with a filter expression.
679 * Return negative error value on error.
680 * Return size of returned session payload data if OK.
682 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
683 struct lttng_event
*event
, const char *channel_name
,
684 const char *filter_expression
)
686 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
687 filter_expression
, 0, NULL
);
691 * Depending on the event, return a newly allocated JUL filter expression or
692 * NULL if not applicable.
694 * An event with NO loglevel and the name is * will return NULL.
696 static char *set_jul_filter(const char *filter
, struct lttng_event
*ev
)
699 char *jul_filter
= NULL
;
703 /* Don't add filter for the '*' event. */
704 if (ev
->name
[0] != '*') {
706 err
= asprintf(&jul_filter
, "%s && logger_name == \"%s\"", filter
,
709 err
= asprintf(&jul_filter
, "logger_name == \"%s\"", ev
->name
);
717 /* Add loglevel filtering if any for the JUL domain. */
718 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
721 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
727 if (filter
|| jul_filter
) {
730 err
= asprintf(&new_filter
, "%s && int_loglevel %s %d",
731 jul_filter
? jul_filter
: filter
, op
,
736 jul_filter
= new_filter
;
738 err
= asprintf(&jul_filter
, "int_loglevel %s %d", op
,
754 * Generate the filter bytecode from a give filter expression string. Put the
755 * newly allocated parser context in ctxp and populate the lsm object with the
758 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
760 static int generate_filter(char *filter_expression
,
761 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
764 struct filter_parser_ctx
*ctx
= NULL
;
767 assert(filter_expression
);
772 * Casting const to non-const, as the underlying function will use it in
775 fmem
= lttng_fmemopen((void *) filter_expression
,
776 strlen(filter_expression
), "r");
778 fprintf(stderr
, "Error opening memory as stream\n");
779 ret
= -LTTNG_ERR_FILTER_NOMEM
;
782 ctx
= filter_parser_ctx_alloc(fmem
);
784 fprintf(stderr
, "Error allocating parser\n");
785 ret
= -LTTNG_ERR_FILTER_NOMEM
;
786 goto filter_alloc_error
;
788 ret
= filter_parser_ctx_append_ast(ctx
);
790 fprintf(stderr
, "Parse error\n");
791 ret
= -LTTNG_ERR_FILTER_INVAL
;
794 ret
= filter_visitor_set_parent(ctx
);
796 fprintf(stderr
, "Set parent error\n");
797 ret
= -LTTNG_ERR_FILTER_INVAL
;
801 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
804 fprintf(stderr
, "XML print error\n");
805 ret
= -LTTNG_ERR_FILTER_INVAL
;
810 dbg_printf("Generating IR... ");
812 ret
= filter_visitor_ir_generate(ctx
);
814 fprintf(stderr
, "Generate IR error\n");
815 ret
= -LTTNG_ERR_FILTER_INVAL
;
818 dbg_printf("done\n");
820 dbg_printf("Validating IR... ");
822 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
824 ret
= -LTTNG_ERR_FILTER_INVAL
;
827 dbg_printf("done\n");
829 dbg_printf("Generating bytecode... ");
831 ret
= filter_visitor_bytecode_generate(ctx
);
833 fprintf(stderr
, "Generate bytecode error\n");
834 ret
= -LTTNG_ERR_FILTER_INVAL
;
837 dbg_printf("done\n");
838 dbg_printf("Size of bytecode generated: %u bytes.\n",
839 bytecode_get_len(&ctx
->bytecode
->b
));
841 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
842 + bytecode_get_len(&ctx
->bytecode
->b
);
843 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
845 /* No need to keep the memory stream. */
846 if (fclose(fmem
) != 0) {
854 filter_bytecode_free(ctx
);
856 filter_parser_ctx_free(ctx
);
858 if (fclose(fmem
) != 0) {
866 * Enable event(s) for a channel, possibly with exclusions and a filter.
867 * If no event name is specified, all events are enabled.
868 * If no channel name is specified, the default name is used.
869 * If filter expression is not NULL, the filter is set for the event.
870 * If exclusion count is not zero, the exclusions are set for the event.
871 * Returns size of returned session payload data or a negative error code.
873 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
874 struct lttng_event
*ev
, const char *channel_name
,
875 const char *original_filter_expression
,
876 int exclusion_count
, char **exclusion_list
)
878 struct lttcomm_session_msg lsm
;
881 unsigned int free_filter_expression
= 0;
882 struct filter_parser_ctx
*ctx
= NULL
;
884 * Cast as non-const since we may replace the filter expression
885 * by a dynamically allocated string. Otherwise, the original
886 * string is not modified.
888 char *filter_expression
= (char *) original_filter_expression
;
890 if (handle
== NULL
|| ev
== NULL
) {
891 ret
= -LTTNG_ERR_INVALID
;
895 /* Empty filter string will always be rejected by the parser
896 * anyway, so treat this corner-case early to eliminate
897 * lttng_fmemopen error for 0-byte allocation.
899 if (filter_expression
&& filter_expression
[0] == '\0') {
900 ret
= -LTTNG_ERR_INVALID
;
904 memset(&lsm
, 0, sizeof(lsm
));
906 /* If no channel name, send empty string. */
907 if (channel_name
== NULL
) {
908 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
909 sizeof(lsm
.u
.enable
.channel_name
));
911 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
912 sizeof(lsm
.u
.enable
.channel_name
));
915 if (ev
->name
[0] != '\0') {
916 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
918 lsm
.cmd_type
= LTTNG_ENABLE_ALL_EVENT
;
921 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
922 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
924 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
925 sizeof(lsm
.session
.name
));
926 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
927 lsm
.u
.enable
.bytecode_len
= 0;
930 * For the JUL domain, a filter is enforced except for the enable all
931 * event. This is done to avoid having the event in all sessions thus
932 * filtering by logger name.
934 if (exclusion_count
== 0 && filter_expression
== NULL
&&
935 handle
->domain
.type
!= LTTNG_DOMAIN_JUL
) {
940 * We have either a filter or some exclusions, so we need to set up
941 * a variable-length memory block from where to send the data
944 /* Parse filter expression */
945 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
) {
946 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
) {
949 /* Setup JUL filter if needed. */
950 jul_filter
= set_jul_filter(filter_expression
, ev
);
952 if (!filter_expression
) {
953 /* No JUL and no filter, just skip everything below. */
958 * With a JUL filter, the original filter has been added to it
959 * thus replace the filter expression.
961 filter_expression
= jul_filter
;
962 free_filter_expression
= 1;
966 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
972 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
973 + lsm
.u
.enable
.expression_len
974 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
976 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
980 /* Put exclusion names first in the data */
981 while (exclusion_count
--) {
982 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
983 *(exclusion_list
+ exclusion_count
), LTTNG_SYMBOL_NAME_LEN
);
985 /* Add filter expression next */
986 if (lsm
.u
.enable
.expression_len
!= 0) {
988 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
990 lsm
.u
.enable
.expression_len
);
992 /* Add filter bytecode next */
993 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
995 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
996 + lsm
.u
.enable
.expression_len
,
998 lsm
.u
.enable
.bytecode_len
);
1001 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, varlen_data
,
1002 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
1003 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
, NULL
);
1007 if (filter_expression
) {
1008 filter_bytecode_free(ctx
);
1009 filter_ir_free(ctx
);
1010 filter_parser_ctx_free(ctx
);
1011 if (free_filter_expression
) {
1013 * The filter expression has been replaced and must be
1014 * freed as it is not the original filter expression
1015 * received as a parameter.
1017 free(filter_expression
);
1022 * Return directly to the caller and don't ask the sessiond since something
1023 * went wrong in the parsing of data above.
1028 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1033 * Disable event(s) of a channel and domain.
1034 * If no event name is specified, all events are disabled.
1035 * If no channel name is specified, the default 'channel0' is used.
1036 * Returns size of returned session payload data or a negative error code.
1038 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1039 const char *channel_name
)
1041 struct lttcomm_session_msg lsm
;
1043 if (handle
== NULL
) {
1044 return -LTTNG_ERR_INVALID
;
1047 memset(&lsm
, 0, sizeof(lsm
));
1049 /* If no channel name, send empty string. */
1050 if (channel_name
== NULL
) {
1051 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1052 sizeof(lsm
.u
.disable
.channel_name
));
1054 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1055 sizeof(lsm
.u
.disable
.channel_name
));
1058 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1061 lttng_ctl_copy_string(lsm
.u
.disable
.name
, name
,
1062 sizeof(lsm
.u
.disable
.name
));
1063 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1065 lsm
.cmd_type
= LTTNG_DISABLE_ALL_EVENT
;
1068 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1069 sizeof(lsm
.session
.name
));
1071 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1075 * Enable channel per domain
1076 * Returns size of returned session payload data or a negative error code.
1078 int lttng_enable_channel(struct lttng_handle
*handle
,
1079 struct lttng_channel
*chan
)
1081 struct lttcomm_session_msg lsm
;
1084 * NULL arguments are forbidden. No default values.
1086 if (handle
== NULL
|| chan
== NULL
) {
1087 return -LTTNG_ERR_INVALID
;
1090 memset(&lsm
, 0, sizeof(lsm
));
1092 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(lsm
.u
.channel
.chan
));
1094 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1096 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1098 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1099 sizeof(lsm
.session
.name
));
1101 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1105 * All tracing will be stopped for registered events of the channel.
1106 * Returns size of returned session payload data or a negative error code.
1108 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1110 struct lttcomm_session_msg lsm
;
1112 /* Safety check. Both are mandatory */
1113 if (handle
== NULL
|| name
== NULL
) {
1114 return -LTTNG_ERR_INVALID
;
1117 memset(&lsm
, 0, sizeof(lsm
));
1119 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1121 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1122 sizeof(lsm
.u
.disable
.channel_name
));
1124 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1126 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1127 sizeof(lsm
.session
.name
));
1129 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1133 * Lists all available tracepoints of domain.
1134 * Sets the contents of the events array.
1135 * Returns the number of lttng_event entries in events;
1136 * on error, returns a negative value.
1138 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1139 struct lttng_event
**events
)
1142 struct lttcomm_session_msg lsm
;
1144 if (handle
== NULL
) {
1145 return -LTTNG_ERR_INVALID
;
1148 memset(&lsm
, 0, sizeof(lsm
));
1149 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1150 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1152 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1157 return ret
/ sizeof(struct lttng_event
);
1161 * Lists all available tracepoint fields of domain.
1162 * Sets the contents of the event field array.
1163 * Returns the number of lttng_event_field entries in events;
1164 * on error, returns a negative value.
1166 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1167 struct lttng_event_field
**fields
)
1170 struct lttcomm_session_msg lsm
;
1172 if (handle
== NULL
) {
1173 return -LTTNG_ERR_INVALID
;
1176 memset(&lsm
, 0, sizeof(lsm
));
1177 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1178 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1180 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1185 return ret
/ sizeof(struct lttng_event_field
);
1189 * Returns a human readable string describing
1190 * the error code (a negative value).
1192 const char *lttng_strerror(int code
)
1194 return error_get_str(code
);
1198 * Create a brand new session using name and url for destination.
1200 * Returns LTTNG_OK on success or a negative error code.
1202 int lttng_create_session(const char *name
, const char *url
)
1206 struct lttcomm_session_msg lsm
;
1207 struct lttng_uri
*uris
= NULL
;
1210 return -LTTNG_ERR_INVALID
;
1213 memset(&lsm
, 0, sizeof(lsm
));
1215 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1216 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1218 /* There should never be a data URL */
1219 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1221 return -LTTNG_ERR_INVALID
;
1224 lsm
.u
.uri
.size
= size
;
1226 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1227 sizeof(struct lttng_uri
) * size
, NULL
);
1234 * Destroy session using name.
1235 * Returns size of returned session payload data or a negative error code.
1237 int lttng_destroy_session(const char *session_name
)
1239 struct lttcomm_session_msg lsm
;
1241 if (session_name
== NULL
) {
1242 return -LTTNG_ERR_INVALID
;
1245 memset(&lsm
, 0, sizeof(lsm
));
1246 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1248 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1249 sizeof(lsm
.session
.name
));
1251 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1255 * Ask the session daemon for all available sessions.
1256 * Sets the contents of the sessions array.
1257 * Returns the number of lttng_session entries in sessions;
1258 * on error, returns a negative value.
1260 int lttng_list_sessions(struct lttng_session
**sessions
)
1263 struct lttcomm_session_msg lsm
;
1265 memset(&lsm
, 0, sizeof(lsm
));
1266 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1267 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1272 return ret
/ sizeof(struct lttng_session
);
1276 * Ask the session daemon for all available domains of a session.
1277 * Sets the contents of the domains array.
1278 * Returns the number of lttng_domain entries in domains;
1279 * on error, returns a negative value.
1281 int lttng_list_domains(const char *session_name
,
1282 struct lttng_domain
**domains
)
1285 struct lttcomm_session_msg lsm
;
1287 if (session_name
== NULL
) {
1288 return -LTTNG_ERR_INVALID
;
1291 memset(&lsm
, 0, sizeof(lsm
));
1292 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1294 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1295 sizeof(lsm
.session
.name
));
1297 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1302 return ret
/ sizeof(struct lttng_domain
);
1306 * Ask the session daemon for all available channels of a session.
1307 * Sets the contents of the channels array.
1308 * Returns the number of lttng_channel entries in channels;
1309 * on error, returns a negative value.
1311 int lttng_list_channels(struct lttng_handle
*handle
,
1312 struct lttng_channel
**channels
)
1315 struct lttcomm_session_msg lsm
;
1317 if (handle
== NULL
) {
1318 return -LTTNG_ERR_INVALID
;
1321 memset(&lsm
, 0, sizeof(lsm
));
1322 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1323 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1324 sizeof(lsm
.session
.name
));
1326 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1328 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1333 return ret
/ sizeof(struct lttng_channel
);
1337 * Ask the session daemon for all available events of a session channel.
1338 * Sets the contents of the events array.
1339 * Returns the number of lttng_event entries in events;
1340 * on error, returns a negative value.
1342 int lttng_list_events(struct lttng_handle
*handle
,
1343 const char *channel_name
, struct lttng_event
**events
)
1346 struct lttcomm_session_msg lsm
;
1348 /* Safety check. An handle and channel name are mandatory */
1349 if (handle
== NULL
|| channel_name
== NULL
) {
1350 return -LTTNG_ERR_INVALID
;
1353 memset(&lsm
, 0, sizeof(lsm
));
1354 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1355 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1356 sizeof(lsm
.session
.name
));
1357 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1358 sizeof(lsm
.u
.list
.channel_name
));
1360 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1362 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) events
);
1367 return ret
/ sizeof(struct lttng_event
);
1371 * Sets the tracing_group variable with name.
1372 * This function allocates memory pointed to by tracing_group.
1373 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1375 int lttng_set_tracing_group(const char *name
)
1378 return -LTTNG_ERR_INVALID
;
1381 if (asprintf(&tracing_group
, "%s", name
) < 0) {
1382 return -LTTNG_ERR_FATAL
;
1389 * Returns size of returned session payload data or a negative error code.
1391 int lttng_calibrate(struct lttng_handle
*handle
,
1392 struct lttng_calibrate
*calibrate
)
1394 struct lttcomm_session_msg lsm
;
1396 /* Safety check. NULL pointer are forbidden */
1397 if (handle
== NULL
|| calibrate
== NULL
) {
1398 return -LTTNG_ERR_INVALID
;
1401 memset(&lsm
, 0, sizeof(lsm
));
1402 lsm
.cmd_type
= LTTNG_CALIBRATE
;
1403 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1405 memcpy(&lsm
.u
.calibrate
, calibrate
, sizeof(lsm
.u
.calibrate
));
1407 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1411 * Set default channel attributes.
1412 * If either or both of the arguments are null, attr content is zeroe'd.
1414 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
1415 struct lttng_channel_attr
*attr
)
1418 if (attr
== NULL
|| domain
== NULL
) {
1422 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
1424 /* Same for all domains. */
1425 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1426 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
1427 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
1429 switch (domain
->type
) {
1430 case LTTNG_DOMAIN_KERNEL
:
1431 attr
->switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
1432 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
1433 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
1434 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1435 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1437 case LTTNG_DOMAIN_UST
:
1438 switch (domain
->buf_type
) {
1439 case LTTNG_BUFFER_PER_UID
:
1440 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
1441 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
1442 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
1443 attr
->switch_timer_interval
= DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
1444 attr
->read_timer_interval
= DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
1446 case LTTNG_BUFFER_PER_PID
:
1448 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
1449 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
1450 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
1451 attr
->switch_timer_interval
= DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
1452 attr
->read_timer_interval
= DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
1456 /* Default behavior: leave set to 0. */
1462 * Check if session daemon is alive.
1464 * Return 1 if alive or 0 if not.
1465 * On error returns a negative value.
1467 int lttng_session_daemon_alive(void)
1471 ret
= set_session_daemon_path();
1477 if (*sessiond_sock_path
== '\0') {
1479 * No socket path set. Weird error which means the constructor was not
1485 ret
= try_connect_sessiond(sessiond_sock_path
);
1496 * Set URL for a consumer for a session and domain.
1498 * Return 0 on success, else a negative value.
1500 int lttng_set_consumer_url(struct lttng_handle
*handle
,
1501 const char *control_url
, const char *data_url
)
1505 struct lttcomm_session_msg lsm
;
1506 struct lttng_uri
*uris
= NULL
;
1508 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
1509 return -LTTNG_ERR_INVALID
;
1512 memset(&lsm
, 0, sizeof(lsm
));
1514 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
1516 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1517 sizeof(lsm
.session
.name
));
1518 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1520 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
1522 return -LTTNG_ERR_INVALID
;
1525 lsm
.u
.uri
.size
= size
;
1527 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1528 sizeof(struct lttng_uri
) * size
, NULL
);
1537 int lttng_enable_consumer(struct lttng_handle
*handle
)
1545 int lttng_disable_consumer(struct lttng_handle
*handle
)
1551 * This is an extension of create session that is ONLY and SHOULD only be used
1552 * by the lttng command line program. It exists to avoid using URI parsing in
1555 * We need the date and time for the trace path subdirectory for the case where
1556 * the user does NOT define one using either -o or -U. Using the normal
1557 * lttng_create_session API call, we have no clue on the session daemon side if
1558 * the URL was generated automatically by the client or define by the user.
1560 * So this function "wrapper" is hidden from the public API, takes the datetime
1561 * string and appends it if necessary to the URI subdirectory before sending it
1562 * to the session daemon.
1564 * With this extra function, the lttng_create_session call behavior is not
1565 * changed and the timestamp is appended to the URI on the session daemon side
1568 int _lttng_create_session_ext(const char *name
, const char *url
,
1569 const char *datetime
)
1573 struct lttcomm_session_msg lsm
;
1574 struct lttng_uri
*uris
= NULL
;
1576 if (name
== NULL
|| datetime
== NULL
) {
1577 return -LTTNG_ERR_INVALID
;
1580 memset(&lsm
, 0, sizeof(lsm
));
1582 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1583 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1585 /* There should never be a data URL */
1586 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1588 ret
= -LTTNG_ERR_INVALID
;
1592 lsm
.u
.uri
.size
= size
;
1594 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
1595 /* Don't append datetime if the name was automatically created. */
1596 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
1597 strlen(DEFAULT_SESSION_NAME
) + 1)) {
1598 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
1601 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
1604 PERROR("snprintf uri subdir");
1605 ret
= -LTTNG_ERR_FATAL
;
1610 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1611 sizeof(struct lttng_uri
) * size
, NULL
);
1619 * For a given session name, this call checks if the data is ready to be read
1620 * or is still being extracted by the consumer(s) hence not ready to be used by
1623 int lttng_data_pending(const char *session_name
)
1626 struct lttcomm_session_msg lsm
;
1628 if (session_name
== NULL
) {
1629 return -LTTNG_ERR_INVALID
;
1632 memset(&lsm
, 0, sizeof(lsm
));
1633 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
1635 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1636 sizeof(lsm
.session
.name
));
1638 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1641 * The lttng_ctl_ask_sessiond function negate the return code if it's not
1642 * LTTNG_OK so getting -1 means that the reply ret_code was 1 thus meaning
1643 * that the data is available. Yes it is hackish but for now this is the
1654 * Create a session exclusively used for snapshot.
1656 * Returns LTTNG_OK on success or a negative error code.
1658 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1662 struct lttcomm_session_msg lsm
;
1663 struct lttng_uri
*uris
= NULL
;
1666 return -LTTNG_ERR_INVALID
;
1669 memset(&lsm
, 0, sizeof(lsm
));
1671 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
1672 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1674 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1676 return -LTTNG_ERR_INVALID
;
1679 lsm
.u
.uri
.size
= size
;
1681 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1682 sizeof(struct lttng_uri
) * size
, NULL
);
1689 * Create a session exclusively used for live.
1691 * Returns LTTNG_OK on success or a negative error code.
1693 int lttng_create_session_live(const char *name
, const char *url
,
1694 unsigned int timer_interval
)
1698 struct lttcomm_session_msg lsm
;
1699 struct lttng_uri
*uris
= NULL
;
1702 return -LTTNG_ERR_INVALID
;
1705 memset(&lsm
, 0, sizeof(lsm
));
1707 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
1708 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1711 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1713 ret
= -LTTNG_ERR_INVALID
;
1717 /* file:// is not accepted for live session. */
1718 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
1719 ret
= -LTTNG_ERR_INVALID
;
1726 lsm
.u
.session_live
.nb_uri
= size
;
1727 lsm
.u
.session_live
.timer_interval
= timer_interval
;
1729 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1730 sizeof(struct lttng_uri
) * size
, NULL
);
1740 static void __attribute__((constructor
)) init()
1742 /* Set default session group */
1743 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
1749 static void __attribute__((destructor
)) lttng_ctl_exit()
1751 free(tracing_group
);