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
) {
728 err
= asprintf(&jul_filter
, "%s && int_loglevel %s %d", filter
, op
,
731 err
= asprintf(&jul_filter
, "int_loglevel %s %d", op
,
747 * Enable event(s) for a channel, possibly with exclusions and a filter.
748 * If no event name is specified, all events are enabled.
749 * If no channel name is specified, the default name is used.
750 * If filter expression is not NULL, the filter is set for the event.
751 * If exclusion count is not zero, the exclusions are set for the event.
752 * Returns size of returned session payload data or a negative error code.
754 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
755 struct lttng_event
*ev
, const char *channel_name
,
756 const char *filter_expression
,
757 int exclusion_count
, char **exclusion_list
)
759 struct lttcomm_session_msg lsm
;
760 char *varlen_data
, *jul_filter
= NULL
;
762 struct filter_parser_ctx
*ctx
= NULL
;
765 if (handle
== NULL
|| ev
== NULL
) {
766 return -LTTNG_ERR_INVALID
;
769 /* Empty filter string will always be rejected by the parser
770 * anyway, so treat this corner-case early to eliminate
771 * lttng_fmemopen error for 0-byte allocation.
773 if (filter_expression
&& filter_expression
[0] == '\0') {
774 return -LTTNG_ERR_INVALID
;
777 memset(&lsm
, 0, sizeof(lsm
));
779 /* If no channel name, send empty string. */
780 if (channel_name
== NULL
) {
781 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
782 sizeof(lsm
.u
.enable
.channel_name
));
784 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
785 sizeof(lsm
.u
.enable
.channel_name
));
788 if (ev
->name
[0] != '\0') {
789 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
791 lsm
.cmd_type
= LTTNG_ENABLE_ALL_EVENT
;
794 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
795 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
797 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
798 sizeof(lsm
.session
.name
));
799 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
800 lsm
.u
.enable
.bytecode_len
= 0;
803 * For the JUL domain, a filter is enforced except for the enable all
804 * event. This is done to avoid having the event in all sessions thus
805 * filtering by logger name.
807 if (exclusion_count
== 0 && filter_expression
== NULL
&&
808 handle
->domain
.type
!= LTTNG_DOMAIN_JUL
) {
813 * We have either a filter or some exclusions, so we need to set up
814 * a variable-length memory block from where to send the data
817 /* Parse filter expression */
818 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
) {
819 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
) {
820 /* Setup JUL filter if needed. */
821 filter_expression
= set_jul_filter(filter_expression
, ev
);
822 if (!filter_expression
) {
828 * casting const to non-const, as the underlying function will
829 * use it in read-only mode.
831 fmem
= lttng_fmemopen((void *) filter_expression
,
832 strlen(filter_expression
), "r");
834 fprintf(stderr
, "Error opening memory as stream\n");
836 return -LTTNG_ERR_FILTER_NOMEM
;
838 ctx
= filter_parser_ctx_alloc(fmem
);
840 fprintf(stderr
, "Error allocating parser\n");
841 ret
= -LTTNG_ERR_FILTER_NOMEM
;
842 goto filter_alloc_error
;
844 ret
= filter_parser_ctx_append_ast(ctx
);
846 fprintf(stderr
, "Parse error\n");
847 ret
= -LTTNG_ERR_FILTER_INVAL
;
850 ret
= filter_visitor_set_parent(ctx
);
852 fprintf(stderr
, "Set parent error\n");
853 ret
= -LTTNG_ERR_FILTER_INVAL
;
857 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
860 fprintf(stderr
, "XML print error\n");
861 ret
= -LTTNG_ERR_FILTER_INVAL
;
866 dbg_printf("Generating IR... ");
868 ret
= filter_visitor_ir_generate(ctx
);
870 fprintf(stderr
, "Generate IR error\n");
871 ret
= -LTTNG_ERR_FILTER_INVAL
;
874 dbg_printf("done\n");
876 dbg_printf("Validating IR... ");
878 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
880 ret
= -LTTNG_ERR_FILTER_INVAL
;
883 dbg_printf("done\n");
885 dbg_printf("Generating bytecode... ");
887 ret
= filter_visitor_bytecode_generate(ctx
);
889 fprintf(stderr
, "Generate bytecode error\n");
890 ret
= -LTTNG_ERR_FILTER_INVAL
;
893 dbg_printf("done\n");
894 dbg_printf("Size of bytecode generated: %u bytes.\n",
895 bytecode_get_len(&ctx
->bytecode
->b
));
897 lsm
.u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
898 + bytecode_get_len(&ctx
->bytecode
->b
);
899 lsm
.u
.enable
.expression_len
= strlen(filter_expression
) + 1;
902 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
903 + lsm
.u
.enable
.expression_len
904 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
906 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
907 goto varlen_alloc_error
;
909 /* Put exclusion names first in the data */
910 while (exclusion_count
--) {
911 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
912 *(exclusion_list
+ exclusion_count
),
913 LTTNG_SYMBOL_NAME_LEN
);
915 /* Add filter expression next */
916 if (lsm
.u
.enable
.expression_len
!= 0) {
918 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
920 lsm
.u
.enable
.expression_len
);
922 /* Add filter bytecode next */
923 if (lsm
.u
.enable
.bytecode_len
!= 0) {
925 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
926 + lsm
.u
.enable
.expression_len
,
928 lsm
.u
.enable
.bytecode_len
);
931 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, varlen_data
,
932 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
933 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
,
938 if (filter_expression
) {
939 filter_bytecode_free(ctx
);
941 filter_parser_ctx_free(ctx
);
942 if (fclose(fmem
) != 0) {
950 filter_bytecode_free(ctx
);
952 filter_parser_ctx_free(ctx
);
954 if (fclose(fmem
) != 0) {
961 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
966 * Disable event(s) of a channel and domain.
967 * If no event name is specified, all events are disabled.
968 * If no channel name is specified, the default 'channel0' is used.
969 * Returns size of returned session payload data or a negative error code.
971 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
972 const char *channel_name
)
974 struct lttcomm_session_msg lsm
;
976 if (handle
== NULL
) {
977 return -LTTNG_ERR_INVALID
;
980 memset(&lsm
, 0, sizeof(lsm
));
982 /* If no channel name, send empty string. */
983 if (channel_name
== NULL
) {
984 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
985 sizeof(lsm
.u
.disable
.channel_name
));
987 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
988 sizeof(lsm
.u
.disable
.channel_name
));
991 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
994 lttng_ctl_copy_string(lsm
.u
.disable
.name
, name
,
995 sizeof(lsm
.u
.disable
.name
));
996 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
998 lsm
.cmd_type
= LTTNG_DISABLE_ALL_EVENT
;
1001 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1002 sizeof(lsm
.session
.name
));
1004 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1008 * Enable channel per domain
1009 * Returns size of returned session payload data or a negative error code.
1011 int lttng_enable_channel(struct lttng_handle
*handle
,
1012 struct lttng_channel
*chan
)
1014 struct lttcomm_session_msg lsm
;
1017 * NULL arguments are forbidden. No default values.
1019 if (handle
== NULL
|| chan
== NULL
) {
1020 return -LTTNG_ERR_INVALID
;
1023 memset(&lsm
, 0, sizeof(lsm
));
1025 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(lsm
.u
.channel
.chan
));
1027 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1029 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1031 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1032 sizeof(lsm
.session
.name
));
1034 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1038 * All tracing will be stopped for registered events of the channel.
1039 * Returns size of returned session payload data or a negative error code.
1041 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1043 struct lttcomm_session_msg lsm
;
1045 /* Safety check. Both are mandatory */
1046 if (handle
== NULL
|| name
== NULL
) {
1047 return -LTTNG_ERR_INVALID
;
1050 memset(&lsm
, 0, sizeof(lsm
));
1052 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1054 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1055 sizeof(lsm
.u
.disable
.channel_name
));
1057 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1059 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1060 sizeof(lsm
.session
.name
));
1062 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1066 * Lists all available tracepoints of domain.
1067 * Sets the contents of the events array.
1068 * Returns the number of lttng_event entries in events;
1069 * on error, returns a negative value.
1071 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1072 struct lttng_event
**events
)
1075 struct lttcomm_session_msg lsm
;
1077 if (handle
== NULL
) {
1078 return -LTTNG_ERR_INVALID
;
1081 memset(&lsm
, 0, sizeof(lsm
));
1082 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1083 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1085 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1090 return ret
/ sizeof(struct lttng_event
);
1094 * Lists all available tracepoint fields of domain.
1095 * Sets the contents of the event field array.
1096 * Returns the number of lttng_event_field entries in events;
1097 * on error, returns a negative value.
1099 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1100 struct lttng_event_field
**fields
)
1103 struct lttcomm_session_msg lsm
;
1105 if (handle
== NULL
) {
1106 return -LTTNG_ERR_INVALID
;
1109 memset(&lsm
, 0, sizeof(lsm
));
1110 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1111 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1113 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1118 return ret
/ sizeof(struct lttng_event_field
);
1122 * Returns a human readable string describing
1123 * the error code (a negative value).
1125 const char *lttng_strerror(int code
)
1127 return error_get_str(code
);
1131 * Create a brand new session using name and url for destination.
1133 * Returns LTTNG_OK on success or a negative error code.
1135 int lttng_create_session(const char *name
, const char *url
)
1139 struct lttcomm_session_msg lsm
;
1140 struct lttng_uri
*uris
= NULL
;
1143 return -LTTNG_ERR_INVALID
;
1146 memset(&lsm
, 0, sizeof(lsm
));
1148 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1149 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1151 /* There should never be a data URL */
1152 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1154 return -LTTNG_ERR_INVALID
;
1157 lsm
.u
.uri
.size
= size
;
1159 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1160 sizeof(struct lttng_uri
) * size
, NULL
);
1167 * Destroy session using name.
1168 * Returns size of returned session payload data or a negative error code.
1170 int lttng_destroy_session(const char *session_name
)
1172 struct lttcomm_session_msg lsm
;
1174 if (session_name
== NULL
) {
1175 return -LTTNG_ERR_INVALID
;
1178 memset(&lsm
, 0, sizeof(lsm
));
1179 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1181 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1182 sizeof(lsm
.session
.name
));
1184 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1188 * Ask the session daemon for all available sessions.
1189 * Sets the contents of the sessions array.
1190 * Returns the number of lttng_session entries in sessions;
1191 * on error, returns a negative value.
1193 int lttng_list_sessions(struct lttng_session
**sessions
)
1196 struct lttcomm_session_msg lsm
;
1198 memset(&lsm
, 0, sizeof(lsm
));
1199 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1200 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1205 return ret
/ sizeof(struct lttng_session
);
1209 * Ask the session daemon for all available domains of a session.
1210 * Sets the contents of the domains array.
1211 * Returns the number of lttng_domain entries in domains;
1212 * on error, returns a negative value.
1214 int lttng_list_domains(const char *session_name
,
1215 struct lttng_domain
**domains
)
1218 struct lttcomm_session_msg lsm
;
1220 if (session_name
== NULL
) {
1221 return -LTTNG_ERR_INVALID
;
1224 memset(&lsm
, 0, sizeof(lsm
));
1225 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1227 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1228 sizeof(lsm
.session
.name
));
1230 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1235 return ret
/ sizeof(struct lttng_domain
);
1239 * Ask the session daemon for all available channels of a session.
1240 * Sets the contents of the channels array.
1241 * Returns the number of lttng_channel entries in channels;
1242 * on error, returns a negative value.
1244 int lttng_list_channels(struct lttng_handle
*handle
,
1245 struct lttng_channel
**channels
)
1248 struct lttcomm_session_msg lsm
;
1250 if (handle
== NULL
) {
1251 return -LTTNG_ERR_INVALID
;
1254 memset(&lsm
, 0, sizeof(lsm
));
1255 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1256 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1257 sizeof(lsm
.session
.name
));
1259 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1261 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1266 return ret
/ sizeof(struct lttng_channel
);
1270 * Ask the session daemon for all available events of a session channel.
1271 * Sets the contents of the events array.
1272 * Returns the number of lttng_event entries in events;
1273 * on error, returns a negative value.
1275 int lttng_list_events(struct lttng_handle
*handle
,
1276 const char *channel_name
, struct lttng_event
**events
)
1279 struct lttcomm_session_msg lsm
;
1281 /* Safety check. An handle and channel name are mandatory */
1282 if (handle
== NULL
|| channel_name
== NULL
) {
1283 return -LTTNG_ERR_INVALID
;
1286 memset(&lsm
, 0, sizeof(lsm
));
1287 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1288 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1289 sizeof(lsm
.session
.name
));
1290 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1291 sizeof(lsm
.u
.list
.channel_name
));
1293 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1295 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) events
);
1300 return ret
/ sizeof(struct lttng_event
);
1304 * Sets the tracing_group variable with name.
1305 * This function allocates memory pointed to by tracing_group.
1306 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1308 int lttng_set_tracing_group(const char *name
)
1311 return -LTTNG_ERR_INVALID
;
1314 if (asprintf(&tracing_group
, "%s", name
) < 0) {
1315 return -LTTNG_ERR_FATAL
;
1322 * Returns size of returned session payload data or a negative error code.
1324 int lttng_calibrate(struct lttng_handle
*handle
,
1325 struct lttng_calibrate
*calibrate
)
1327 struct lttcomm_session_msg lsm
;
1329 /* Safety check. NULL pointer are forbidden */
1330 if (handle
== NULL
|| calibrate
== NULL
) {
1331 return -LTTNG_ERR_INVALID
;
1334 memset(&lsm
, 0, sizeof(lsm
));
1335 lsm
.cmd_type
= LTTNG_CALIBRATE
;
1336 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1338 memcpy(&lsm
.u
.calibrate
, calibrate
, sizeof(lsm
.u
.calibrate
));
1340 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1344 * Set default channel attributes.
1345 * If either or both of the arguments are null, attr content is zeroe'd.
1347 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
1348 struct lttng_channel_attr
*attr
)
1351 if (attr
== NULL
|| domain
== NULL
) {
1355 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
1357 /* Same for all domains. */
1358 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1359 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
1360 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
1362 switch (domain
->type
) {
1363 case LTTNG_DOMAIN_KERNEL
:
1364 attr
->switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
1365 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
1366 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
1367 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1368 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1370 case LTTNG_DOMAIN_UST
:
1371 switch (domain
->buf_type
) {
1372 case LTTNG_BUFFER_PER_UID
:
1373 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
1374 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
1375 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
1376 attr
->switch_timer_interval
= DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
1377 attr
->read_timer_interval
= DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
1379 case LTTNG_BUFFER_PER_PID
:
1381 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
1382 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
1383 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
1384 attr
->switch_timer_interval
= DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
1385 attr
->read_timer_interval
= DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
1389 /* Default behavior: leave set to 0. */
1395 * Check if session daemon is alive.
1397 * Return 1 if alive or 0 if not.
1398 * On error returns a negative value.
1400 int lttng_session_daemon_alive(void)
1404 ret
= set_session_daemon_path();
1410 if (*sessiond_sock_path
== '\0') {
1412 * No socket path set. Weird error which means the constructor was not
1418 ret
= try_connect_sessiond(sessiond_sock_path
);
1429 * Set URL for a consumer for a session and domain.
1431 * Return 0 on success, else a negative value.
1433 int lttng_set_consumer_url(struct lttng_handle
*handle
,
1434 const char *control_url
, const char *data_url
)
1438 struct lttcomm_session_msg lsm
;
1439 struct lttng_uri
*uris
= NULL
;
1441 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
1442 return -LTTNG_ERR_INVALID
;
1445 memset(&lsm
, 0, sizeof(lsm
));
1447 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
1449 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1450 sizeof(lsm
.session
.name
));
1451 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1453 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
1455 return -LTTNG_ERR_INVALID
;
1458 lsm
.u
.uri
.size
= size
;
1460 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1461 sizeof(struct lttng_uri
) * size
, NULL
);
1470 int lttng_enable_consumer(struct lttng_handle
*handle
)
1478 int lttng_disable_consumer(struct lttng_handle
*handle
)
1484 * This is an extension of create session that is ONLY and SHOULD only be used
1485 * by the lttng command line program. It exists to avoid using URI parsing in
1488 * We need the date and time for the trace path subdirectory for the case where
1489 * the user does NOT define one using either -o or -U. Using the normal
1490 * lttng_create_session API call, we have no clue on the session daemon side if
1491 * the URL was generated automatically by the client or define by the user.
1493 * So this function "wrapper" is hidden from the public API, takes the datetime
1494 * string and appends it if necessary to the URI subdirectory before sending it
1495 * to the session daemon.
1497 * With this extra function, the lttng_create_session call behavior is not
1498 * changed and the timestamp is appended to the URI on the session daemon side
1501 int _lttng_create_session_ext(const char *name
, const char *url
,
1502 const char *datetime
)
1506 struct lttcomm_session_msg lsm
;
1507 struct lttng_uri
*uris
= NULL
;
1509 if (name
== NULL
|| datetime
== NULL
) {
1510 return -LTTNG_ERR_INVALID
;
1513 memset(&lsm
, 0, sizeof(lsm
));
1515 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1516 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1518 /* There should never be a data URL */
1519 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1521 ret
= -LTTNG_ERR_INVALID
;
1525 lsm
.u
.uri
.size
= size
;
1527 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
1528 /* Don't append datetime if the name was automatically created. */
1529 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
1530 strlen(DEFAULT_SESSION_NAME
) + 1)) {
1531 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
1534 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
1537 PERROR("snprintf uri subdir");
1538 ret
= -LTTNG_ERR_FATAL
;
1543 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1544 sizeof(struct lttng_uri
) * size
, NULL
);
1552 * For a given session name, this call checks if the data is ready to be read
1553 * or is still being extracted by the consumer(s) hence not ready to be used by
1556 int lttng_data_pending(const char *session_name
)
1559 struct lttcomm_session_msg lsm
;
1561 if (session_name
== NULL
) {
1562 return -LTTNG_ERR_INVALID
;
1565 memset(&lsm
, 0, sizeof(lsm
));
1566 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
1568 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1569 sizeof(lsm
.session
.name
));
1571 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1574 * The lttng_ctl_ask_sessiond function negate the return code if it's not
1575 * LTTNG_OK so getting -1 means that the reply ret_code was 1 thus meaning
1576 * that the data is available. Yes it is hackish but for now this is the
1587 * Create a session exclusively used for snapshot.
1589 * Returns LTTNG_OK on success or a negative error code.
1591 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1595 struct lttcomm_session_msg lsm
;
1596 struct lttng_uri
*uris
= NULL
;
1599 return -LTTNG_ERR_INVALID
;
1602 memset(&lsm
, 0, sizeof(lsm
));
1604 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
1605 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1607 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1609 return -LTTNG_ERR_INVALID
;
1612 lsm
.u
.uri
.size
= size
;
1614 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1615 sizeof(struct lttng_uri
) * size
, NULL
);
1622 * Create a session exclusively used for live.
1624 * Returns LTTNG_OK on success or a negative error code.
1626 int lttng_create_session_live(const char *name
, const char *url
,
1627 unsigned int timer_interval
)
1631 struct lttcomm_session_msg lsm
;
1632 struct lttng_uri
*uris
= NULL
;
1635 return -LTTNG_ERR_INVALID
;
1638 memset(&lsm
, 0, sizeof(lsm
));
1640 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
1641 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1644 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1646 ret
= -LTTNG_ERR_INVALID
;
1650 /* file:// is not accepted for live session. */
1651 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
1652 ret
= -LTTNG_ERR_INVALID
;
1659 lsm
.u
.session_live
.nb_uri
= size
;
1660 lsm
.u
.session_live
.timer_interval
= timer_interval
;
1662 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1663 sizeof(struct lttng_uri
) * size
, NULL
);
1673 static void __attribute__((constructor
)) init()
1675 /* Set default session group */
1676 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
1682 static void __attribute__((destructor
)) lttng_ctl_exit()
1684 free(tracing_group
);