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
32 #include <common/common.h>
33 #include <common/defaults.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35 #include <common/uri.h>
36 #include <common/utils.h>
37 #include <lttng/lttng.h>
38 #include <lttng/health-internal.h>
40 #include "filter/filter-ast.h"
41 #include "filter/filter-parser.h"
42 #include "filter/filter-bytecode.h"
43 #include "filter/memstream.h"
44 #include "lttng-ctl-helper.h"
47 static const int print_xml
= 1;
48 #define dbg_printf(fmt, args...) \
49 printf("[debug liblttng-ctl] " fmt, ## args)
51 static const int print_xml
= 0;
52 #define dbg_printf(fmt, args...) \
54 /* do nothing but check printf format */ \
56 printf("[debug liblttnctl] " fmt, ## args); \
61 /* Socket to session daemon for communication */
62 static int sessiond_socket
;
63 static char sessiond_sock_path
[PATH_MAX
];
66 static char *tracing_group
;
72 * Those two variables are used by error.h to silent or control the verbosity of
73 * error message. They are global to the library so application linking with it
74 * are able to compile correctly and also control verbosity of the library.
77 int lttng_opt_verbose
;
81 * Copy string from src to dst and enforce null terminated byte.
84 void lttng_ctl_copy_string(char *dst
, const char *src
, size_t len
)
87 strncpy(dst
, src
, len
);
88 /* Enforce the NULL terminated byte */
96 * Copy domain to lttcomm_session_msg domain.
98 * If domain is unknown, default domain will be the kernel.
101 void lttng_ctl_copy_lttng_domain(struct lttng_domain
*dst
,
102 struct lttng_domain
*src
)
106 case LTTNG_DOMAIN_KERNEL
:
107 case LTTNG_DOMAIN_UST
:
108 case LTTNG_DOMAIN_JUL
:
109 case LTTNG_DOMAIN_LOG4J
:
110 case LTTNG_DOMAIN_PYTHON
:
111 memcpy(dst
, src
, sizeof(struct lttng_domain
));
114 memset(dst
, 0, sizeof(struct lttng_domain
));
121 * Send lttcomm_session_msg to the session daemon.
123 * On success, returns the number of bytes sent (>=0)
124 * On error, returns -1
126 static int send_session_msg(struct lttcomm_session_msg
*lsm
)
131 ret
= -LTTNG_ERR_NO_SESSIOND
;
135 DBG("LSM cmd type : %d", lsm
->cmd_type
);
137 ret
= lttcomm_send_creds_unix_sock(sessiond_socket
, lsm
,
138 sizeof(struct lttcomm_session_msg
));
140 ret
= -LTTNG_ERR_FATAL
;
148 * Send var len data to the session daemon.
150 * On success, returns the number of bytes sent (>=0)
151 * On error, returns -1
153 static int send_session_varlen(void *data
, size_t len
)
158 ret
= -LTTNG_ERR_NO_SESSIOND
;
167 ret
= lttcomm_send_unix_sock(sessiond_socket
, data
, len
);
169 ret
= -LTTNG_ERR_FATAL
;
177 * Receive data from the sessiond socket.
179 * On success, returns the number of bytes received (>=0)
180 * On error, returns -1 (recvmsg() error) or -ENOTCONN
182 static int recv_data_sessiond(void *buf
, size_t len
)
187 ret
= -LTTNG_ERR_NO_SESSIOND
;
191 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
193 ret
= -LTTNG_ERR_FATAL
;
201 * Check if we are in the specified group.
203 * If yes return 1, else return -1.
206 int lttng_check_tracing_group(void)
208 struct group
*grp_tracing
; /* no free(). See getgrnam(3) */
210 int grp_list_size
, grp_id
, i
;
212 const char *grp_name
= tracing_group
;
214 /* Get GID of group 'tracing' */
215 grp_tracing
= getgrnam(grp_name
);
217 /* If grp_tracing is NULL, the group does not exist. */
221 /* Get number of supplementary group IDs */
222 grp_list_size
= getgroups(0, NULL
);
223 if (grp_list_size
< 0) {
228 /* Alloc group list of the right size */
229 grp_list
= zmalloc(grp_list_size
* sizeof(gid_t
));
234 grp_id
= getgroups(grp_list_size
, grp_list
);
240 for (i
= 0; i
< grp_list_size
; i
++) {
241 if (grp_list
[i
] == grp_tracing
->gr_gid
) {
255 * Try connect to session daemon with sock_path.
257 * Return 0 on success, else -1
259 static int try_connect_sessiond(const char *sock_path
)
263 /* If socket exist, we check if the daemon listens for connect. */
264 ret
= access(sock_path
, F_OK
);
270 ret
= lttcomm_connect_unix_sock(sock_path
);
276 ret
= lttcomm_close_unix_sock(ret
);
278 PERROR("lttcomm_close_unix_sock");
288 * Set sessiond socket path by putting it in the global sessiond_sock_path
291 * Returns 0 on success, negative value on failure (the sessiond socket path
292 * is somehow too long or ENOMEM).
294 static int set_session_daemon_path(void)
296 int in_tgroup
= 0; /* In tracing group */
302 /* Are we in the tracing group ? */
303 in_tgroup
= lttng_check_tracing_group();
306 if ((uid
== 0) || in_tgroup
) {
307 lttng_ctl_copy_string(sessiond_sock_path
,
308 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
, sizeof(sessiond_sock_path
));
316 ret
= try_connect_sessiond(sessiond_sock_path
);
320 /* Global session daemon not available... */
322 /* ...or not in tracing group (and not root), default */
325 * With GNU C < 2.1, snprintf returns -1 if the target buffer is too small;
326 * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
328 ret
= snprintf(sessiond_sock_path
, sizeof(sessiond_sock_path
),
329 DEFAULT_HOME_CLIENT_UNIX_SOCK
, utils_get_home_dir());
330 if ((ret
< 0) || (ret
>= sizeof(sessiond_sock_path
))) {
342 * Connect to the LTTng session daemon.
344 * On success, return 0. On error, return -1.
346 static int connect_sessiond(void)
350 /* Don't try to connect if already connected. */
355 ret
= set_session_daemon_path();
360 /* Connect to the sesssion daemon */
361 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
366 sessiond_socket
= ret
;
376 * Clean disconnect from the session daemon.
377 * On success, return 0. On error, return -1.
379 static int disconnect_sessiond(void)
384 ret
= lttcomm_close_unix_sock(sessiond_socket
);
393 * Ask the session daemon a specific command and put the data into buf.
394 * Takes extra var. len. data as input to send to the session daemon.
396 * Return size of data (only payload, not header) or a negative error code.
399 int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg
*lsm
,
400 void *vardata
, size_t varlen
, void **buf
)
405 struct lttcomm_lttng_msg llm
;
407 ret
= connect_sessiond();
409 ret
= -LTTNG_ERR_NO_SESSIOND
;
413 /* Send command to session daemon */
414 ret
= send_session_msg(lsm
);
416 /* Ret value is a valid lttng error code. */
419 /* Send var len data */
420 ret
= send_session_varlen(vardata
, varlen
);
422 /* Ret value is a valid lttng error code. */
426 /* Get header from data transmission */
427 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
429 /* Ret value is a valid lttng error code. */
433 /* Check error code if OK */
434 if (llm
.ret_code
!= LTTNG_OK
) {
439 size
= llm
.data_size
;
441 /* If client free with size 0 */
449 data
= zmalloc(size
);
455 /* Get payload data */
456 ret
= recv_data_sessiond(data
, size
);
463 * Extra protection not to dereference a NULL pointer. If buf is NULL at
464 * this point, an error is returned and data is freed.
467 ret
= -LTTNG_ERR_INVALID
;
476 disconnect_sessiond();
481 * Create lttng handle and return pointer.
482 * The returned pointer will be NULL in case of malloc() error.
484 struct lttng_handle
*lttng_create_handle(const char *session_name
,
485 struct lttng_domain
*domain
)
487 struct lttng_handle
*handle
= 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 or leave initialized to 0. */
501 lttng_ctl_copy_lttng_domain(&handle
->domain
, domain
);
509 * Destroy handle by free(3) the pointer.
511 void lttng_destroy_handle(struct lttng_handle
*handle
)
517 * Register an outside consumer.
518 * Returns size of returned session payload data or a negative error code.
520 int lttng_register_consumer(struct lttng_handle
*handle
,
521 const char *socket_path
)
523 struct lttcomm_session_msg lsm
;
525 if (handle
== NULL
|| socket_path
== NULL
) {
526 return -LTTNG_ERR_INVALID
;
529 memset(&lsm
, 0, sizeof(lsm
));
530 lsm
.cmd_type
= LTTNG_REGISTER_CONSUMER
;
531 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
532 sizeof(lsm
.session
.name
));
533 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
535 lttng_ctl_copy_string(lsm
.u
.reg
.path
, socket_path
, sizeof(lsm
.u
.reg
.path
));
537 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
541 * Start tracing for all traces of the session.
542 * Returns size of returned session payload data or a negative error code.
544 int lttng_start_tracing(const char *session_name
)
546 struct lttcomm_session_msg lsm
;
548 if (session_name
== NULL
) {
549 return -LTTNG_ERR_INVALID
;
552 memset(&lsm
, 0, sizeof(lsm
));
553 lsm
.cmd_type
= LTTNG_START_TRACE
;
555 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
556 sizeof(lsm
.session
.name
));
558 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
562 * Stop tracing for all traces of the session.
564 static int _lttng_stop_tracing(const char *session_name
, int wait
)
567 struct lttcomm_session_msg lsm
;
569 if (session_name
== NULL
) {
570 return -LTTNG_ERR_INVALID
;
573 memset(&lsm
, 0, sizeof(lsm
));
574 lsm
.cmd_type
= LTTNG_STOP_TRACE
;
576 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
577 sizeof(lsm
.session
.name
));
579 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
580 if (ret
< 0 && ret
!= -LTTNG_ERR_TRACE_ALREADY_STOPPED
) {
588 /* Check for data availability */
590 data_ret
= lttng_data_pending(session_name
);
592 /* Return the data available call error. */
598 * Data sleep time before retrying (in usec). Don't sleep if the call
599 * returned value indicates availability.
602 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME
);
604 } while (data_ret
!= 0);
612 * Stop tracing and wait for data availability.
614 int lttng_stop_tracing(const char *session_name
)
616 return _lttng_stop_tracing(session_name
, 1);
620 * Stop tracing but _don't_ wait for data availability.
622 int lttng_stop_tracing_no_wait(const char *session_name
)
624 return _lttng_stop_tracing(session_name
, 0);
628 * Add context to a channel.
630 * If the given channel is NULL, add the contexts to all channels.
631 * The event_name param is ignored.
633 * Returns the size of the returned payload data or a negative error code.
635 int lttng_add_context(struct lttng_handle
*handle
,
636 struct lttng_event_context
*ctx
, const char *event_name
,
637 const char *channel_name
)
639 struct lttcomm_session_msg lsm
;
641 /* Safety check. Both are mandatory */
642 if (handle
== NULL
|| ctx
== NULL
) {
643 return -LTTNG_ERR_INVALID
;
646 memset(&lsm
, 0, sizeof(lsm
));
648 lsm
.cmd_type
= LTTNG_ADD_CONTEXT
;
650 /* If no channel name, send empty string. */
651 if (channel_name
== NULL
) {
652 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, "",
653 sizeof(lsm
.u
.context
.channel_name
));
655 lttng_ctl_copy_string(lsm
.u
.context
.channel_name
, channel_name
,
656 sizeof(lsm
.u
.context
.channel_name
));
659 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
661 memcpy(&lsm
.u
.context
.ctx
, ctx
, sizeof(struct lttng_event_context
));
663 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
664 sizeof(lsm
.session
.name
));
666 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
670 * Enable event(s) for a channel.
671 * If no event name is specified, all events are enabled.
672 * If no channel name is specified, the default 'channel0' is used.
673 * Returns size of returned session payload data or a negative error code.
675 int lttng_enable_event(struct lttng_handle
*handle
,
676 struct lttng_event
*ev
, const char *channel_name
)
678 return lttng_enable_event_with_exclusions(handle
, ev
, channel_name
,
683 * Create or enable an event with a filter expression.
685 * Return negative error value on error.
686 * Return size of returned session payload data if OK.
688 int lttng_enable_event_with_filter(struct lttng_handle
*handle
,
689 struct lttng_event
*event
, const char *channel_name
,
690 const char *filter_expression
)
692 return lttng_enable_event_with_exclusions(handle
, event
, channel_name
,
693 filter_expression
, 0, NULL
);
697 * Depending on the event, return a newly allocated agent filter expression or
698 * NULL if not applicable.
700 * An event with NO loglevel and the name is * will return NULL.
702 static char *set_agent_filter(const char *filter
, struct lttng_event
*ev
)
705 char *agent_filter
= NULL
;
709 /* Don't add filter for the '*' event. */
710 if (ev
->name
[0] != '*') {
712 err
= asprintf(&agent_filter
, "(%s) && (logger_name == \"%s\")", filter
,
715 err
= asprintf(&agent_filter
, "logger_name == \"%s\"", ev
->name
);
723 /* Add loglevel filtering if any for the JUL domain. */
724 if (ev
->loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
727 if (ev
->loglevel_type
== LTTNG_EVENT_LOGLEVEL_RANGE
) {
733 if (filter
|| agent_filter
) {
736 err
= asprintf(&new_filter
, "(%s) && (int_loglevel %s %d)",
737 agent_filter
? agent_filter
: filter
, op
,
742 agent_filter
= new_filter
;
744 err
= asprintf(&agent_filter
, "int_loglevel %s %d", op
,
760 * Generate the filter bytecode from a give filter expression string. Put the
761 * newly allocated parser context in ctxp and populate the lsm object with the
764 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
766 static int generate_filter(char *filter_expression
,
767 struct lttcomm_session_msg
*lsm
, struct filter_parser_ctx
**ctxp
)
770 struct filter_parser_ctx
*ctx
= NULL
;
773 assert(filter_expression
);
778 * Casting const to non-const, as the underlying function will use it in
781 fmem
= lttng_fmemopen((void *) filter_expression
,
782 strlen(filter_expression
), "r");
784 fprintf(stderr
, "Error opening memory as stream\n");
785 ret
= -LTTNG_ERR_FILTER_NOMEM
;
788 ctx
= filter_parser_ctx_alloc(fmem
);
790 fprintf(stderr
, "Error allocating parser\n");
791 ret
= -LTTNG_ERR_FILTER_NOMEM
;
792 goto filter_alloc_error
;
794 ret
= filter_parser_ctx_append_ast(ctx
);
796 fprintf(stderr
, "Parse error\n");
797 ret
= -LTTNG_ERR_FILTER_INVAL
;
800 ret
= filter_visitor_set_parent(ctx
);
802 fprintf(stderr
, "Set parent error\n");
803 ret
= -LTTNG_ERR_FILTER_INVAL
;
807 ret
= filter_visitor_print_xml(ctx
, stdout
, 0);
810 fprintf(stderr
, "XML print error\n");
811 ret
= -LTTNG_ERR_FILTER_INVAL
;
816 dbg_printf("Generating IR... ");
818 ret
= filter_visitor_ir_generate(ctx
);
820 fprintf(stderr
, "Generate IR error\n");
821 ret
= -LTTNG_ERR_FILTER_INVAL
;
824 dbg_printf("done\n");
826 dbg_printf("Validating IR... ");
828 ret
= filter_visitor_ir_check_binary_op_nesting(ctx
);
830 ret
= -LTTNG_ERR_FILTER_INVAL
;
833 /* Validate strings used as literals in the expression */
834 ret
= filter_visitor_ir_validate_string(ctx
);
836 ret
= -LTTNG_ERR_FILTER_INVAL
;
839 dbg_printf("done\n");
841 dbg_printf("Generating bytecode... ");
843 ret
= filter_visitor_bytecode_generate(ctx
);
845 fprintf(stderr
, "Generate bytecode error\n");
846 ret
= -LTTNG_ERR_FILTER_INVAL
;
849 dbg_printf("done\n");
850 dbg_printf("Size of bytecode generated: %u bytes.\n",
851 bytecode_get_len(&ctx
->bytecode
->b
));
853 lsm
->u
.enable
.bytecode_len
= sizeof(ctx
->bytecode
->b
)
854 + bytecode_get_len(&ctx
->bytecode
->b
);
855 lsm
->u
.enable
.expression_len
= strlen(filter_expression
) + 1;
857 /* No need to keep the memory stream. */
858 if (fclose(fmem
) != 0) {
867 filter_parser_ctx_free(ctx
);
869 if (fclose(fmem
) != 0) {
877 * Enable event(s) for a channel, possibly with exclusions and a filter.
878 * If no event name is specified, all events are enabled.
879 * If no channel name is specified, the default name is used.
880 * If filter expression is not NULL, the filter is set for the event.
881 * If exclusion count is not zero, the exclusions are set for the event.
882 * Returns size of returned session payload data or a negative error code.
884 int lttng_enable_event_with_exclusions(struct lttng_handle
*handle
,
885 struct lttng_event
*ev
, const char *channel_name
,
886 const char *original_filter_expression
,
887 int exclusion_count
, char **exclusion_list
)
889 struct lttcomm_session_msg lsm
;
892 unsigned int free_filter_expression
= 0;
893 struct filter_parser_ctx
*ctx
= NULL
;
895 * Cast as non-const since we may replace the filter expression
896 * by a dynamically allocated string. Otherwise, the original
897 * string is not modified.
899 char *filter_expression
= (char *) original_filter_expression
;
901 if (handle
== NULL
|| ev
== NULL
) {
902 ret
= -LTTNG_ERR_INVALID
;
906 /* Empty filter string will always be rejected by the parser
907 * anyway, so treat this corner-case early to eliminate
908 * lttng_fmemopen error for 0-byte allocation.
910 if (filter_expression
&& filter_expression
[0] == '\0') {
911 ret
= -LTTNG_ERR_INVALID
;
915 memset(&lsm
, 0, sizeof(lsm
));
917 /* If no channel name, send empty string. */
918 if (channel_name
== NULL
) {
919 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, "",
920 sizeof(lsm
.u
.enable
.channel_name
));
922 lttng_ctl_copy_string(lsm
.u
.enable
.channel_name
, channel_name
,
923 sizeof(lsm
.u
.enable
.channel_name
));
926 lsm
.cmd_type
= LTTNG_ENABLE_EVENT
;
927 if (ev
->name
[0] == '\0') {
928 /* Enable all events */
929 lttng_ctl_copy_string(ev
->name
, "*", sizeof(ev
->name
));
932 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
933 /* FIXME: copying non-packed struct to packed struct. */
934 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(lsm
.u
.enable
.event
));
936 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
937 sizeof(lsm
.session
.name
));
938 lsm
.u
.enable
.exclusion_count
= exclusion_count
;
939 lsm
.u
.enable
.bytecode_len
= 0;
942 * For the JUL domain, a filter is enforced except for the enable all
943 * event. This is done to avoid having the event in all sessions thus
944 * filtering by logger name.
946 if (exclusion_count
== 0 && filter_expression
== NULL
&&
947 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
948 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
949 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
954 * We have either a filter or some exclusions, so we need to set up
955 * a variable-length memory block from where to send the data
958 /* Parse filter expression */
959 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
960 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
961 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
962 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
963 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
964 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
967 /* Setup JUL filter if needed. */
968 agent_filter
= set_agent_filter(filter_expression
, ev
);
970 if (!filter_expression
) {
971 /* No JUL and no filter, just skip everything below. */
976 * With an agent filter, the original filter has been added to
977 * it thus replace the filter expression.
979 filter_expression
= agent_filter
;
980 free_filter_expression
= 1;
984 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
990 varlen_data
= zmalloc(lsm
.u
.enable
.bytecode_len
991 + lsm
.u
.enable
.expression_len
992 + LTTNG_SYMBOL_NAME_LEN
* exclusion_count
);
994 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
998 /* Put exclusion names first in the data */
999 while (exclusion_count
--) {
1000 strncpy(varlen_data
+ LTTNG_SYMBOL_NAME_LEN
* exclusion_count
,
1001 *(exclusion_list
+ exclusion_count
), LTTNG_SYMBOL_NAME_LEN
);
1003 /* Add filter expression next */
1004 if (lsm
.u
.enable
.expression_len
!= 0) {
1006 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
,
1008 lsm
.u
.enable
.expression_len
);
1010 /* Add filter bytecode next */
1011 if (ctx
&& lsm
.u
.enable
.bytecode_len
!= 0) {
1013 + LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
1014 + lsm
.u
.enable
.expression_len
,
1016 lsm
.u
.enable
.bytecode_len
);
1019 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, varlen_data
,
1020 (LTTNG_SYMBOL_NAME_LEN
* lsm
.u
.enable
.exclusion_count
) +
1021 lsm
.u
.enable
.bytecode_len
+ lsm
.u
.enable
.expression_len
, NULL
);
1025 if (filter_expression
&& ctx
) {
1026 filter_bytecode_free(ctx
);
1027 filter_ir_free(ctx
);
1028 filter_parser_ctx_free(ctx
);
1031 if (free_filter_expression
) {
1033 * The filter expression has been replaced and must be freed as it is
1034 * not the original filter expression received as a parameter.
1036 free(filter_expression
);
1040 * Return directly to the caller and don't ask the sessiond since something
1041 * went wrong in the parsing of data above.
1046 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1050 int lttng_disable_event_ext(struct lttng_handle
*handle
,
1051 struct lttng_event
*ev
, const char *channel_name
,
1052 const char *original_filter_expression
)
1054 struct lttcomm_session_msg lsm
;
1057 unsigned int free_filter_expression
= 0;
1058 struct filter_parser_ctx
*ctx
= NULL
;
1060 * Cast as non-const since we may replace the filter expression
1061 * by a dynamically allocated string. Otherwise, the original
1062 * string is not modified.
1064 char *filter_expression
= (char *) original_filter_expression
;
1066 if (handle
== NULL
|| ev
== NULL
) {
1067 ret
= -LTTNG_ERR_INVALID
;
1071 /* Empty filter string will always be rejected by the parser
1072 * anyway, so treat this corner-case early to eliminate
1073 * lttng_fmemopen error for 0-byte allocation.
1075 if (filter_expression
&& filter_expression
[0] == '\0') {
1076 ret
= -LTTNG_ERR_INVALID
;
1080 memset(&lsm
, 0, sizeof(lsm
));
1082 /* If no channel name, send empty string. */
1083 if (channel_name
== NULL
) {
1084 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, "",
1085 sizeof(lsm
.u
.disable
.channel_name
));
1087 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, channel_name
,
1088 sizeof(lsm
.u
.disable
.channel_name
));
1091 lsm
.cmd_type
= LTTNG_DISABLE_EVENT
;
1093 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1094 /* FIXME: copying non-packed struct to packed struct. */
1095 memcpy(&lsm
.u
.disable
.event
, ev
, sizeof(lsm
.u
.disable
.event
));
1097 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1098 sizeof(lsm
.session
.name
));
1099 lsm
.u
.disable
.bytecode_len
= 0;
1102 * For the JUL domain, a filter is enforced except for the
1103 * disable all event. This is done to avoid having the event in
1104 * all sessions thus filtering by logger name.
1106 if (filter_expression
== NULL
&&
1107 (handle
->domain
.type
!= LTTNG_DOMAIN_JUL
&&
1108 handle
->domain
.type
!= LTTNG_DOMAIN_LOG4J
&&
1109 handle
->domain
.type
!= LTTNG_DOMAIN_PYTHON
)) {
1114 * We have a filter, so we need to set up a variable-length
1115 * memory block from where to send the data.
1118 /* Parse filter expression */
1119 if (filter_expression
!= NULL
|| handle
->domain
.type
== LTTNG_DOMAIN_JUL
1120 || handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
1121 || handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1122 if (handle
->domain
.type
== LTTNG_DOMAIN_JUL
||
1123 handle
->domain
.type
== LTTNG_DOMAIN_LOG4J
||
1124 handle
->domain
.type
== LTTNG_DOMAIN_PYTHON
) {
1127 /* Setup JUL filter if needed. */
1128 agent_filter
= set_agent_filter(filter_expression
, ev
);
1129 if (!agent_filter
) {
1130 if (!filter_expression
) {
1131 /* No JUL and no filter, just skip everything below. */
1136 * With a JUL filter, the original filter has been added to it
1137 * thus replace the filter expression.
1139 filter_expression
= agent_filter
;
1140 free_filter_expression
= 1;
1144 ret
= generate_filter(filter_expression
, &lsm
, &ctx
);
1150 varlen_data
= zmalloc(lsm
.u
.disable
.bytecode_len
1151 + lsm
.u
.disable
.expression_len
);
1153 ret
= -LTTNG_ERR_EXCLUSION_NOMEM
;
1157 /* Add filter expression */
1158 if (lsm
.u
.disable
.expression_len
!= 0) {
1161 lsm
.u
.disable
.expression_len
);
1163 /* Add filter bytecode next */
1164 if (ctx
&& lsm
.u
.disable
.bytecode_len
!= 0) {
1166 + lsm
.u
.disable
.expression_len
,
1168 lsm
.u
.disable
.bytecode_len
);
1171 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, varlen_data
,
1172 lsm
.u
.disable
.bytecode_len
+ lsm
.u
.disable
.expression_len
, NULL
);
1176 if (filter_expression
&& ctx
) {
1177 filter_bytecode_free(ctx
);
1178 filter_ir_free(ctx
);
1179 filter_parser_ctx_free(ctx
);
1182 if (free_filter_expression
) {
1184 * The filter expression has been replaced and must be freed as it is
1185 * not the original filter expression received as a parameter.
1187 free(filter_expression
);
1191 * Return directly to the caller and don't ask the sessiond since something
1192 * went wrong in the parsing of data above.
1197 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1202 * Disable event(s) of a channel and domain.
1203 * If no event name is specified, all events are disabled.
1204 * If no channel name is specified, the default 'channel0' is used.
1205 * Returns size of returned session payload data or a negative error code.
1207 int lttng_disable_event(struct lttng_handle
*handle
, const char *name
,
1208 const char *channel_name
)
1210 struct lttng_event ev
;
1212 memset(&ev
, 0, sizeof(ev
));
1214 ev
.type
= LTTNG_EVENT_ALL
;
1215 lttng_ctl_copy_string(ev
.name
, name
, sizeof(ev
.name
));
1216 return lttng_disable_event_ext(handle
, &ev
, channel_name
, NULL
);
1220 * Enable channel per domain
1221 * Returns size of returned session payload data or a negative error code.
1223 int lttng_enable_channel(struct lttng_handle
*handle
,
1224 struct lttng_channel
*chan
)
1226 struct lttcomm_session_msg lsm
;
1229 * NULL arguments are forbidden. No default values.
1231 if (handle
== NULL
|| chan
== NULL
) {
1232 return -LTTNG_ERR_INVALID
;
1235 memset(&lsm
, 0, sizeof(lsm
));
1237 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(lsm
.u
.channel
.chan
));
1239 lsm
.cmd_type
= LTTNG_ENABLE_CHANNEL
;
1241 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1243 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1244 sizeof(lsm
.session
.name
));
1246 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1250 * All tracing will be stopped for registered events of the channel.
1251 * Returns size of returned session payload data or a negative error code.
1253 int lttng_disable_channel(struct lttng_handle
*handle
, const char *name
)
1255 struct lttcomm_session_msg lsm
;
1257 /* Safety check. Both are mandatory */
1258 if (handle
== NULL
|| name
== NULL
) {
1259 return -LTTNG_ERR_INVALID
;
1262 memset(&lsm
, 0, sizeof(lsm
));
1264 lsm
.cmd_type
= LTTNG_DISABLE_CHANNEL
;
1266 lttng_ctl_copy_string(lsm
.u
.disable
.channel_name
, name
,
1267 sizeof(lsm
.u
.disable
.channel_name
));
1269 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1271 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1272 sizeof(lsm
.session
.name
));
1274 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1278 * Add PID to session tracker.
1279 * Return 0 on success else a negative LTTng error code.
1281 int lttng_track_pid(struct lttng_handle
*handle
, int pid
)
1283 struct lttcomm_session_msg lsm
;
1286 * NULL arguments are forbidden. No default values.
1288 if (handle
== NULL
) {
1289 return -LTTNG_ERR_INVALID
;
1292 memset(&lsm
, 0, sizeof(lsm
));
1294 lsm
.cmd_type
= LTTNG_TRACK_PID
;
1295 lsm
.u
.pid_tracker
.pid
= pid
;
1297 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1299 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1300 sizeof(lsm
.session
.name
));
1302 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1306 * Remove PID from session tracker.
1307 * Return 0 on success else a negative LTTng error code.
1309 int lttng_untrack_pid(struct lttng_handle
*handle
, int pid
)
1311 struct lttcomm_session_msg lsm
;
1314 * NULL arguments are forbidden. No default values.
1316 if (handle
== NULL
) {
1317 return -LTTNG_ERR_INVALID
;
1320 memset(&lsm
, 0, sizeof(lsm
));
1322 lsm
.cmd_type
= LTTNG_UNTRACK_PID
;
1323 lsm
.u
.pid_tracker
.pid
= pid
;
1325 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1327 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1328 sizeof(lsm
.session
.name
));
1330 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1334 * Lists all available tracepoints of domain.
1335 * Sets the contents of the events array.
1336 * Returns the number of lttng_event entries in events;
1337 * on error, returns a negative value.
1339 int lttng_list_tracepoints(struct lttng_handle
*handle
,
1340 struct lttng_event
**events
)
1343 struct lttcomm_session_msg lsm
;
1345 if (handle
== NULL
) {
1346 return -LTTNG_ERR_INVALID
;
1349 memset(&lsm
, 0, sizeof(lsm
));
1350 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINTS
;
1351 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1353 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1358 return ret
/ sizeof(struct lttng_event
);
1362 * Lists all available tracepoint fields of domain.
1363 * Sets the contents of the event field array.
1364 * Returns the number of lttng_event_field entries in events;
1365 * on error, returns a negative value.
1367 int lttng_list_tracepoint_fields(struct lttng_handle
*handle
,
1368 struct lttng_event_field
**fields
)
1371 struct lttcomm_session_msg lsm
;
1373 if (handle
== NULL
) {
1374 return -LTTNG_ERR_INVALID
;
1377 memset(&lsm
, 0, sizeof(lsm
));
1378 lsm
.cmd_type
= LTTNG_LIST_TRACEPOINT_FIELDS
;
1379 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1381 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) fields
);
1386 return ret
/ sizeof(struct lttng_event_field
);
1390 * Lists all available kernel system calls. Allocates and sets the contents of
1393 * Returns the number of lttng_event entries in events; on error, returns a
1396 int lttng_list_syscalls(struct lttng_event
**events
)
1399 struct lttcomm_session_msg lsm
;
1402 return -LTTNG_ERR_INVALID
;
1405 memset(&lsm
, 0, sizeof(lsm
));
1406 lsm
.cmd_type
= LTTNG_LIST_SYSCALLS
;
1407 /* Force kernel domain for system calls. */
1408 lsm
.domain
.type
= LTTNG_DOMAIN_KERNEL
;
1410 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) events
);
1415 return ret
/ sizeof(struct lttng_event
);
1419 * Returns a human readable string describing
1420 * the error code (a negative value).
1422 const char *lttng_strerror(int code
)
1424 return error_get_str(code
);
1428 * Create a brand new session using name and url for destination.
1430 * Returns LTTNG_OK on success or a negative error code.
1432 int lttng_create_session(const char *name
, const char *url
)
1436 struct lttcomm_session_msg lsm
;
1437 struct lttng_uri
*uris
= NULL
;
1440 return -LTTNG_ERR_INVALID
;
1443 memset(&lsm
, 0, sizeof(lsm
));
1445 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1446 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1448 /* There should never be a data URL */
1449 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1451 return -LTTNG_ERR_INVALID
;
1454 lsm
.u
.uri
.size
= size
;
1456 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1457 sizeof(struct lttng_uri
) * size
, NULL
);
1464 * Destroy session using name.
1465 * Returns size of returned session payload data or a negative error code.
1467 int lttng_destroy_session(const char *session_name
)
1469 struct lttcomm_session_msg lsm
;
1471 if (session_name
== NULL
) {
1472 return -LTTNG_ERR_INVALID
;
1475 memset(&lsm
, 0, sizeof(lsm
));
1476 lsm
.cmd_type
= LTTNG_DESTROY_SESSION
;
1478 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1479 sizeof(lsm
.session
.name
));
1481 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1485 * Ask the session daemon for all available sessions.
1486 * Sets the contents of the sessions array.
1487 * Returns the number of lttng_session entries in sessions;
1488 * on error, returns a negative value.
1490 int lttng_list_sessions(struct lttng_session
**sessions
)
1493 struct lttcomm_session_msg lsm
;
1495 memset(&lsm
, 0, sizeof(lsm
));
1496 lsm
.cmd_type
= LTTNG_LIST_SESSIONS
;
1497 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) sessions
);
1502 return ret
/ sizeof(struct lttng_session
);
1505 int lttng_set_session_shm_path(const char *session_name
,
1506 const char *shm_path
)
1508 struct lttcomm_session_msg lsm
;
1510 if (session_name
== NULL
) {
1511 return -LTTNG_ERR_INVALID
;
1514 memset(&lsm
, 0, sizeof(lsm
));
1515 lsm
.cmd_type
= LTTNG_SET_SESSION_SHM_PATH
;
1517 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1518 sizeof(lsm
.session
.name
));
1519 lttng_ctl_copy_string(lsm
.u
.set_shm_path
.shm_path
, shm_path
,
1520 sizeof(lsm
.u
.set_shm_path
.shm_path
));
1522 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1526 * Ask the session daemon for all available domains of a session.
1527 * Sets the contents of the domains array.
1528 * Returns the number of lttng_domain entries in domains;
1529 * on error, returns a negative value.
1531 int lttng_list_domains(const char *session_name
,
1532 struct lttng_domain
**domains
)
1535 struct lttcomm_session_msg lsm
;
1537 if (session_name
== NULL
) {
1538 return -LTTNG_ERR_INVALID
;
1541 memset(&lsm
, 0, sizeof(lsm
));
1542 lsm
.cmd_type
= LTTNG_LIST_DOMAINS
;
1544 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1545 sizeof(lsm
.session
.name
));
1547 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) domains
);
1552 return ret
/ sizeof(struct lttng_domain
);
1556 * Ask the session daemon for all available channels of a session.
1557 * Sets the contents of the channels array.
1558 * Returns the number of lttng_channel entries in channels;
1559 * on error, returns a negative value.
1561 int lttng_list_channels(struct lttng_handle
*handle
,
1562 struct lttng_channel
**channels
)
1565 struct lttcomm_session_msg lsm
;
1567 if (handle
== NULL
) {
1568 return -LTTNG_ERR_INVALID
;
1571 memset(&lsm
, 0, sizeof(lsm
));
1572 lsm
.cmd_type
= LTTNG_LIST_CHANNELS
;
1573 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1574 sizeof(lsm
.session
.name
));
1576 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1578 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) channels
);
1583 return ret
/ sizeof(struct lttng_channel
);
1587 * Ask the session daemon for all available events of a session channel.
1588 * Sets the contents of the events array.
1589 * Returns the number of lttng_event entries in events;
1590 * on error, returns a negative value.
1592 int lttng_list_events(struct lttng_handle
*handle
,
1593 const char *channel_name
, struct lttng_event
**events
)
1596 struct lttcomm_session_msg lsm
;
1598 /* Safety check. An handle and channel name are mandatory */
1599 if (handle
== NULL
|| channel_name
== NULL
) {
1600 return -LTTNG_ERR_INVALID
;
1603 memset(&lsm
, 0, sizeof(lsm
));
1604 lsm
.cmd_type
= LTTNG_LIST_EVENTS
;
1605 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1606 sizeof(lsm
.session
.name
));
1607 lttng_ctl_copy_string(lsm
.u
.list
.channel_name
, channel_name
,
1608 sizeof(lsm
.u
.list
.channel_name
));
1610 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1612 ret
= lttng_ctl_ask_sessiond(&lsm
, (void**) events
);
1617 return ret
/ sizeof(struct lttng_event
);
1621 * Sets the tracing_group variable with name.
1622 * This function allocates memory pointed to by tracing_group.
1623 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1625 int lttng_set_tracing_group(const char *name
)
1628 return -LTTNG_ERR_INVALID
;
1631 if (asprintf(&tracing_group
, "%s", name
) < 0) {
1632 return -LTTNG_ERR_FATAL
;
1639 * Returns size of returned session payload data or a negative error code.
1641 int lttng_calibrate(struct lttng_handle
*handle
,
1642 struct lttng_calibrate
*calibrate
)
1644 struct lttcomm_session_msg lsm
;
1646 /* Safety check. NULL pointer are forbidden */
1647 if (handle
== NULL
|| calibrate
== NULL
) {
1648 return -LTTNG_ERR_INVALID
;
1651 memset(&lsm
, 0, sizeof(lsm
));
1652 lsm
.cmd_type
= LTTNG_CALIBRATE
;
1653 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1655 memcpy(&lsm
.u
.calibrate
, calibrate
, sizeof(lsm
.u
.calibrate
));
1657 return lttng_ctl_ask_sessiond(&lsm
, NULL
);
1661 * Set default channel attributes.
1662 * If either or both of the arguments are null, attr content is zeroe'd.
1664 void lttng_channel_set_default_attr(struct lttng_domain
*domain
,
1665 struct lttng_channel_attr
*attr
)
1668 if (attr
== NULL
|| domain
== NULL
) {
1672 memset(attr
, 0, sizeof(struct lttng_channel_attr
));
1674 /* Same for all domains. */
1675 attr
->overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
1676 attr
->tracefile_size
= DEFAULT_CHANNEL_TRACEFILE_SIZE
;
1677 attr
->tracefile_count
= DEFAULT_CHANNEL_TRACEFILE_COUNT
;
1679 switch (domain
->type
) {
1680 case LTTNG_DOMAIN_KERNEL
:
1681 attr
->switch_timer_interval
= DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER
;
1682 attr
->read_timer_interval
= DEFAULT_KERNEL_CHANNEL_READ_TIMER
;
1683 attr
->subbuf_size
= default_get_kernel_channel_subbuf_size();
1684 attr
->num_subbuf
= DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM
;
1685 attr
->output
= DEFAULT_KERNEL_CHANNEL_OUTPUT
;
1687 case LTTNG_DOMAIN_UST
:
1688 switch (domain
->buf_type
) {
1689 case LTTNG_BUFFER_PER_UID
:
1690 attr
->subbuf_size
= default_get_ust_uid_channel_subbuf_size();
1691 attr
->num_subbuf
= DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM
;
1692 attr
->output
= DEFAULT_UST_UID_CHANNEL_OUTPUT
;
1693 attr
->switch_timer_interval
= DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER
;
1694 attr
->read_timer_interval
= DEFAULT_UST_UID_CHANNEL_READ_TIMER
;
1696 case LTTNG_BUFFER_PER_PID
:
1698 attr
->subbuf_size
= default_get_ust_pid_channel_subbuf_size();
1699 attr
->num_subbuf
= DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM
;
1700 attr
->output
= DEFAULT_UST_PID_CHANNEL_OUTPUT
;
1701 attr
->switch_timer_interval
= DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER
;
1702 attr
->read_timer_interval
= DEFAULT_UST_PID_CHANNEL_READ_TIMER
;
1706 /* Default behavior: leave set to 0. */
1712 * Check if session daemon is alive.
1714 * Return 1 if alive or 0 if not.
1715 * On error returns a negative value.
1717 int lttng_session_daemon_alive(void)
1721 ret
= set_session_daemon_path();
1727 if (*sessiond_sock_path
== '\0') {
1729 * No socket path set. Weird error which means the constructor was not
1735 ret
= try_connect_sessiond(sessiond_sock_path
);
1746 * Set URL for a consumer for a session and domain.
1748 * Return 0 on success, else a negative value.
1750 int lttng_set_consumer_url(struct lttng_handle
*handle
,
1751 const char *control_url
, const char *data_url
)
1755 struct lttcomm_session_msg lsm
;
1756 struct lttng_uri
*uris
= NULL
;
1758 if (handle
== NULL
|| (control_url
== NULL
&& data_url
== NULL
)) {
1759 return -LTTNG_ERR_INVALID
;
1762 memset(&lsm
, 0, sizeof(lsm
));
1764 lsm
.cmd_type
= LTTNG_SET_CONSUMER_URI
;
1766 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
1767 sizeof(lsm
.session
.name
));
1768 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
1770 size
= uri_parse_str_urls(control_url
, data_url
, &uris
);
1772 return -LTTNG_ERR_INVALID
;
1775 lsm
.u
.uri
.size
= size
;
1777 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1778 sizeof(struct lttng_uri
) * size
, NULL
);
1787 int lttng_enable_consumer(struct lttng_handle
*handle
)
1795 int lttng_disable_consumer(struct lttng_handle
*handle
)
1801 * This is an extension of create session that is ONLY and SHOULD only be used
1802 * by the lttng command line program. It exists to avoid using URI parsing in
1805 * We need the date and time for the trace path subdirectory for the case where
1806 * the user does NOT define one using either -o or -U. Using the normal
1807 * lttng_create_session API call, we have no clue on the session daemon side if
1808 * the URL was generated automatically by the client or define by the user.
1810 * So this function "wrapper" is hidden from the public API, takes the datetime
1811 * string and appends it if necessary to the URI subdirectory before sending it
1812 * to the session daemon.
1814 * With this extra function, the lttng_create_session call behavior is not
1815 * changed and the timestamp is appended to the URI on the session daemon side
1818 int _lttng_create_session_ext(const char *name
, const char *url
,
1819 const char *datetime
)
1823 struct lttcomm_session_msg lsm
;
1824 struct lttng_uri
*uris
= NULL
;
1826 if (name
== NULL
|| datetime
== NULL
) {
1827 return -LTTNG_ERR_INVALID
;
1830 memset(&lsm
, 0, sizeof(lsm
));
1832 lsm
.cmd_type
= LTTNG_CREATE_SESSION
;
1833 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1835 /* There should never be a data URL */
1836 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1838 ret
= -LTTNG_ERR_INVALID
;
1842 lsm
.u
.uri
.size
= size
;
1844 if (size
> 0 && uris
[0].dtype
!= LTTNG_DST_PATH
&& strlen(uris
[0].subdir
) == 0) {
1845 /* Don't append datetime if the name was automatically created. */
1846 if (strncmp(name
, DEFAULT_SESSION_NAME
"-",
1847 strlen(DEFAULT_SESSION_NAME
) + 1)) {
1848 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s-%s",
1851 ret
= snprintf(uris
[0].subdir
, sizeof(uris
[0].subdir
), "%s", name
);
1854 PERROR("snprintf uri subdir");
1855 ret
= -LTTNG_ERR_FATAL
;
1860 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1861 sizeof(struct lttng_uri
) * size
, NULL
);
1869 * For a given session name, this call checks if the data is ready to be read
1870 * or is still being extracted by the consumer(s) hence not ready to be used by
1873 int lttng_data_pending(const char *session_name
)
1876 struct lttcomm_session_msg lsm
;
1878 if (session_name
== NULL
) {
1879 return -LTTNG_ERR_INVALID
;
1882 memset(&lsm
, 0, sizeof(lsm
));
1883 lsm
.cmd_type
= LTTNG_DATA_PENDING
;
1885 lttng_ctl_copy_string(lsm
.session
.name
, session_name
,
1886 sizeof(lsm
.session
.name
));
1888 ret
= lttng_ctl_ask_sessiond(&lsm
, NULL
);
1891 * The lttng_ctl_ask_sessiond function negate the return code if it's not
1892 * LTTNG_OK so getting -1 means that the reply ret_code was 1 thus meaning
1893 * that the data is available. Yes it is hackish but for now this is the
1904 * Create a session exclusively used for snapshot.
1906 * Returns LTTNG_OK on success or a negative error code.
1908 int lttng_create_session_snapshot(const char *name
, const char *snapshot_url
)
1912 struct lttcomm_session_msg lsm
;
1913 struct lttng_uri
*uris
= NULL
;
1916 return -LTTNG_ERR_INVALID
;
1919 memset(&lsm
, 0, sizeof(lsm
));
1921 lsm
.cmd_type
= LTTNG_CREATE_SESSION_SNAPSHOT
;
1922 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1924 size
= uri_parse_str_urls(snapshot_url
, NULL
, &uris
);
1926 return -LTTNG_ERR_INVALID
;
1929 lsm
.u
.uri
.size
= size
;
1931 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1932 sizeof(struct lttng_uri
) * size
, NULL
);
1939 * Create a session exclusively used for live.
1941 * Returns LTTNG_OK on success or a negative error code.
1943 int lttng_create_session_live(const char *name
, const char *url
,
1944 unsigned int timer_interval
)
1948 struct lttcomm_session_msg lsm
;
1949 struct lttng_uri
*uris
= NULL
;
1951 if (name
== NULL
|| timer_interval
== 0) {
1952 return -LTTNG_ERR_INVALID
;
1955 memset(&lsm
, 0, sizeof(lsm
));
1957 lsm
.cmd_type
= LTTNG_CREATE_SESSION_LIVE
;
1958 lttng_ctl_copy_string(lsm
.session
.name
, name
, sizeof(lsm
.session
.name
));
1961 size
= uri_parse_str_urls(url
, NULL
, &uris
);
1963 ret
= -LTTNG_ERR_INVALID
;
1967 /* file:// is not accepted for live session. */
1968 if (uris
[0].dtype
== LTTNG_DST_PATH
) {
1969 ret
= -LTTNG_ERR_INVALID
;
1976 lsm
.u
.session_live
.nb_uri
= size
;
1977 lsm
.u
.session_live
.timer_interval
= timer_interval
;
1979 ret
= lttng_ctl_ask_sessiond_varlen(&lsm
, uris
,
1980 sizeof(struct lttng_uri
) * size
, NULL
);
1988 * List PIDs in the tracker.
1990 * @enabled is set to whether the PID tracker is enabled.
1991 * @pids is set to an allocated array of PIDs currently tracked. On
1992 * success, @pids must be freed by the caller.
1993 * @nr_pids is set to the number of entries contained by the @pids array.
1995 * Returns 0 on success, else a negative LTTng error code.
1997 int lttng_list_tracker_pids(struct lttng_handle
*handle
,
1998 int *_enabled
, int32_t **_pids
, size_t *_nr_pids
)
2002 struct lttcomm_session_msg lsm
;
2006 if (handle
== NULL
) {
2007 return -LTTNG_ERR_INVALID
;
2010 memset(&lsm
, 0, sizeof(lsm
));
2011 lsm
.cmd_type
= LTTNG_LIST_TRACKER_PIDS
;
2012 lttng_ctl_copy_string(lsm
.session
.name
, handle
->session_name
,
2013 sizeof(lsm
.session
.name
));
2014 lttng_ctl_copy_lttng_domain(&lsm
.domain
, &handle
->domain
);
2016 ret
= lttng_ctl_ask_sessiond(&lsm
, (void **) &pids
);
2020 nr_pids
= ret
/ sizeof(int32_t);
2021 if (nr_pids
== 1 && pids
[0] == -1) {
2027 *_enabled
= enabled
;
2029 *_nr_pids
= nr_pids
;
2036 static void __attribute__((constructor
)) init()
2038 /* Set default session group */
2039 lttng_set_tracing_group(DEFAULT_TRACING_GROUP
);
2045 static void __attribute__((destructor
)) lttng_ctl_exit()
2047 free(tracing_group
);