Expose monitor timer interval to lttngctl and client
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.c
1 /*
2 * liblttngctl.c
3 *
4 * Linux Trace Toolkit Control Library
5 *
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
7 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * This library is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License, version 2.1 only,
11 * as published by the Free Software Foundation.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this library; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23 #define _LGPL_SOURCE
24 #include <assert.h>
25 #include <grp.h>
26 #include <errno.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <unistd.h>
31
32 #include <common/common.h>
33 #include <common/defaults.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
35 #include <common/uri.h>
36 #include <common/utils.h>
37 #include <lttng/lttng.h>
38 #include <lttng/health-internal.h>
39 #include <lttng/trigger/trigger-internal.h>
40 #include <lttng/endpoint.h>
41 #include <lttng/channel-internal.h>
42
43 #include "filter/filter-ast.h"
44 #include "filter/filter-parser.h"
45 #include "filter/filter-bytecode.h"
46 #include "filter/memstream.h"
47 #include "lttng-ctl-helper.h"
48
49 #ifdef DEBUG
50 static const int print_xml = 1;
51 #define dbg_printf(fmt, args...) \
52 printf("[debug liblttng-ctl] " fmt, ## args)
53 #else
54 static const int print_xml = 0;
55 #define dbg_printf(fmt, args...) \
56 do { \
57 /* do nothing but check printf format */ \
58 if (0) \
59 printf("[debug liblttnctl] " fmt, ## args); \
60 } while (0)
61 #endif
62
63
64 /* Socket to session daemon for communication */
65 static int sessiond_socket;
66 static char sessiond_sock_path[PATH_MAX];
67
68 /* Variables */
69 static char *tracing_group;
70 static int connected;
71
72 /* Global */
73
74 /*
75 * Those two variables are used by error.h to silent or control the verbosity of
76 * error message. They are global to the library so application linking with it
77 * are able to compile correctly and also control verbosity of the library.
78 */
79 int lttng_opt_quiet;
80 int lttng_opt_verbose;
81 int lttng_opt_mi;
82
83 /*
84 * Copy string from src to dst and enforce null terminated byte.
85 */
86 LTTNG_HIDDEN
87 void lttng_ctl_copy_string(char *dst, const char *src, size_t len)
88 {
89 if (src && dst) {
90 strncpy(dst, src, len);
91 /* Enforce the NULL terminated byte */
92 dst[len - 1] = '\0';
93 } else if (dst) {
94 dst[0] = '\0';
95 }
96 }
97
98 /*
99 * Copy domain to lttcomm_session_msg domain.
100 *
101 * If domain is unknown, default domain will be the kernel.
102 */
103 LTTNG_HIDDEN
104 void lttng_ctl_copy_lttng_domain(struct lttng_domain *dst,
105 struct lttng_domain *src)
106 {
107 if (src && dst) {
108 switch (src->type) {
109 case LTTNG_DOMAIN_KERNEL:
110 case LTTNG_DOMAIN_UST:
111 case LTTNG_DOMAIN_JUL:
112 case LTTNG_DOMAIN_LOG4J:
113 case LTTNG_DOMAIN_PYTHON:
114 memcpy(dst, src, sizeof(struct lttng_domain));
115 break;
116 default:
117 memset(dst, 0, sizeof(struct lttng_domain));
118 break;
119 }
120 }
121 }
122
123 /*
124 * Send lttcomm_session_msg to the session daemon.
125 *
126 * On success, returns the number of bytes sent (>=0)
127 * On error, returns -1
128 */
129 static int send_session_msg(struct lttcomm_session_msg *lsm)
130 {
131 int ret;
132
133 if (!connected) {
134 ret = -LTTNG_ERR_NO_SESSIOND;
135 goto end;
136 }
137
138 DBG("LSM cmd type : %d", lsm->cmd_type);
139
140 ret = lttcomm_send_creds_unix_sock(sessiond_socket, lsm,
141 sizeof(struct lttcomm_session_msg));
142 if (ret < 0) {
143 ret = -LTTNG_ERR_FATAL;
144 }
145
146 end:
147 return ret;
148 }
149
150 /*
151 * Send var len data to the session daemon.
152 *
153 * On success, returns the number of bytes sent (>=0)
154 * On error, returns -1
155 */
156 static int send_session_varlen(const void *data, size_t len)
157 {
158 int ret;
159
160 if (!connected) {
161 ret = -LTTNG_ERR_NO_SESSIOND;
162 goto end;
163 }
164
165 if (!data || !len) {
166 ret = 0;
167 goto end;
168 }
169
170 ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
171 if (ret < 0) {
172 ret = -LTTNG_ERR_FATAL;
173 }
174
175 end:
176 return ret;
177 }
178
179 /*
180 * Receive data from the sessiond socket.
181 *
182 * On success, returns the number of bytes received (>=0)
183 * On error, returns -1 (recvmsg() error) or -ENOTCONN
184 */
185 static int recv_data_sessiond(void *buf, size_t len)
186 {
187 int ret;
188
189 if (!connected) {
190 ret = -LTTNG_ERR_NO_SESSIOND;
191 goto end;
192 }
193
194 ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len);
195 if (ret < 0) {
196 ret = -LTTNG_ERR_FATAL;
197 }
198
199 end:
200 return ret;
201 }
202
203 /*
204 * Check if we are in the specified group.
205 *
206 * If yes return 1, else return -1.
207 */
208 LTTNG_HIDDEN
209 int lttng_check_tracing_group(void)
210 {
211 struct group *grp_tracing; /* no free(). See getgrnam(3) */
212 gid_t *grp_list;
213 int grp_list_size, grp_id, i;
214 int ret = -1;
215 const char *grp_name = tracing_group;
216
217 /* Get GID of group 'tracing' */
218 grp_tracing = getgrnam(grp_name);
219 if (!grp_tracing) {
220 /* If grp_tracing is NULL, the group does not exist. */
221 goto end;
222 }
223
224 /* Get number of supplementary group IDs */
225 grp_list_size = getgroups(0, NULL);
226 if (grp_list_size < 0) {
227 PERROR("getgroups");
228 goto end;
229 }
230
231 /* Alloc group list of the right size */
232 grp_list = zmalloc(grp_list_size * sizeof(gid_t));
233 if (!grp_list) {
234 PERROR("malloc");
235 goto end;
236 }
237 grp_id = getgroups(grp_list_size, grp_list);
238 if (grp_id < 0) {
239 PERROR("getgroups");
240 goto free_list;
241 }
242
243 for (i = 0; i < grp_list_size; i++) {
244 if (grp_list[i] == grp_tracing->gr_gid) {
245 ret = 1;
246 break;
247 }
248 }
249
250 free_list:
251 free(grp_list);
252
253 end:
254 return ret;
255 }
256
257 /*
258 * Try connect to session daemon with sock_path.
259 *
260 * Return 0 on success, else -1
261 */
262 static int try_connect_sessiond(const char *sock_path)
263 {
264 int ret;
265
266 /* If socket exist, we check if the daemon listens for connect. */
267 ret = access(sock_path, F_OK);
268 if (ret < 0) {
269 /* Not alive */
270 goto error;
271 }
272
273 ret = lttcomm_connect_unix_sock(sock_path);
274 if (ret < 0) {
275 /* Not alive. */
276 goto error;
277 }
278
279 ret = lttcomm_close_unix_sock(ret);
280 if (ret < 0) {
281 PERROR("lttcomm_close_unix_sock");
282 }
283
284 return 0;
285
286 error:
287 return -1;
288 }
289
290 /*
291 * Set sessiond socket path by putting it in the global sessiond_sock_path
292 * variable.
293 *
294 * Returns 0 on success, negative value on failure (the sessiond socket path
295 * is somehow too long or ENOMEM).
296 */
297 static int set_session_daemon_path(void)
298 {
299 int in_tgroup = 0; /* In tracing group. */
300 uid_t uid;
301
302 uid = getuid();
303
304 if (uid != 0) {
305 /* Are we in the tracing group ? */
306 in_tgroup = lttng_check_tracing_group();
307 }
308
309 if ((uid == 0) || in_tgroup) {
310 lttng_ctl_copy_string(sessiond_sock_path,
311 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, sizeof(sessiond_sock_path));
312 }
313
314 if (uid != 0) {
315 int ret;
316
317 if (in_tgroup) {
318 /* Tracing group. */
319 ret = try_connect_sessiond(sessiond_sock_path);
320 if (ret >= 0) {
321 goto end;
322 }
323 /* Global session daemon not available... */
324 }
325 /* ...or not in tracing group (and not root), default */
326
327 /*
328 * With GNU C < 2.1, snprintf returns -1 if the target buffer
329 * is too small;
330 * With GNU C >= 2.1, snprintf returns the required size
331 * (excluding closing null)
332 */
333 ret = snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
334 DEFAULT_HOME_CLIENT_UNIX_SOCK, utils_get_home_dir());
335 if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) {
336 goto error;
337 }
338 }
339 end:
340 return 0;
341
342 error:
343 return -1;
344 }
345
346 /*
347 * Connect to the LTTng session daemon.
348 *
349 * On success, return 0. On error, return -1.
350 */
351 static int connect_sessiond(void)
352 {
353 int ret;
354
355 /* Don't try to connect if already connected. */
356 if (connected) {
357 return 0;
358 }
359
360 ret = set_session_daemon_path();
361 if (ret < 0) {
362 goto error;
363 }
364
365 /* Connect to the sesssion daemon. */
366 ret = lttcomm_connect_unix_sock(sessiond_sock_path);
367 if (ret < 0) {
368 goto error;
369 }
370
371 sessiond_socket = ret;
372 connected = 1;
373
374 return 0;
375
376 error:
377 return -1;
378 }
379
380 /*
381 * Clean disconnect from the session daemon.
382 *
383 * On success, return 0. On error, return -1.
384 */
385 static int disconnect_sessiond(void)
386 {
387 int ret = 0;
388
389 if (connected) {
390 ret = lttcomm_close_unix_sock(sessiond_socket);
391 sessiond_socket = 0;
392 connected = 0;
393 }
394
395 return ret;
396 }
397
398 static int recv_sessiond_optional_data(size_t len, void **user_buf,
399 size_t *user_len)
400 {
401 int ret = 0;
402 void *buf = NULL;
403
404 if (len) {
405 if (!user_len) {
406 ret = -LTTNG_ERR_INVALID;
407 goto end;
408 }
409
410 buf = zmalloc(len);
411 if (!buf) {
412 ret = -ENOMEM;
413 goto end;
414 }
415
416 ret = recv_data_sessiond(buf, len);
417 if (ret < 0) {
418 goto end;
419 }
420
421 if (!user_buf) {
422 ret = -LTTNG_ERR_INVALID;
423 goto end;
424 }
425
426 /* Move ownership of command header buffer to user. */
427 *user_buf = buf;
428 buf = NULL;
429 *user_len = len;
430 } else {
431 /* No command header. */
432 if (user_len) {
433 *user_len = 0;
434 }
435
436 if (user_buf) {
437 *user_buf = NULL;
438 }
439 }
440
441 end:
442 free(buf);
443 return ret;
444 }
445
446 /*
447 * Ask the session daemon a specific command and put the data into buf.
448 * Takes extra var. len. data as input to send to the session daemon.
449 *
450 * Return size of data (only payload, not header) or a negative error code.
451 */
452 LTTNG_HIDDEN
453 int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg *lsm,
454 const void *vardata, size_t vardata_len,
455 void **user_payload_buf, void **user_cmd_header_buf,
456 size_t *user_cmd_header_len)
457 {
458 int ret;
459 size_t payload_len;
460 struct lttcomm_lttng_msg llm;
461
462 ret = connect_sessiond();
463 if (ret < 0) {
464 ret = -LTTNG_ERR_NO_SESSIOND;
465 goto end;
466 }
467
468 /* Send command to session daemon */
469 ret = send_session_msg(lsm);
470 if (ret < 0) {
471 /* Ret value is a valid lttng error code. */
472 goto end;
473 }
474 /* Send var len data */
475 ret = send_session_varlen(vardata, vardata_len);
476 if (ret < 0) {
477 /* Ret value is a valid lttng error code. */
478 goto end;
479 }
480
481 /* Get header from data transmission */
482 ret = recv_data_sessiond(&llm, sizeof(llm));
483 if (ret < 0) {
484 /* Ret value is a valid lttng error code. */
485 goto end;
486 }
487
488 /* Check error code if OK */
489 if (llm.ret_code != LTTNG_OK) {
490 ret = -llm.ret_code;
491 goto end;
492 }
493
494 /* Get command header from data transmission */
495 ret = recv_sessiond_optional_data(llm.cmd_header_size,
496 user_cmd_header_buf, user_cmd_header_len);
497 if (ret < 0) {
498 goto end;
499 }
500
501 /* Get payload from data transmission */
502 ret = recv_sessiond_optional_data(llm.data_size, user_payload_buf,
503 &payload_len);
504 if (ret < 0) {
505 goto end;
506 }
507
508 ret = llm.data_size;
509
510 end:
511 disconnect_sessiond();
512 return ret;
513 }
514
515 /*
516 * Create lttng handle and return pointer.
517 *
518 * The returned pointer will be NULL in case of malloc() error.
519 */
520 struct lttng_handle *lttng_create_handle(const char *session_name,
521 struct lttng_domain *domain)
522 {
523 struct lttng_handle *handle = NULL;
524
525 handle = zmalloc(sizeof(struct lttng_handle));
526 if (handle == NULL) {
527 PERROR("malloc handle");
528 goto end;
529 }
530
531 /* Copy session name */
532 lttng_ctl_copy_string(handle->session_name, session_name,
533 sizeof(handle->session_name));
534
535 /* Copy lttng domain or leave initialized to 0. */
536 if (domain) {
537 lttng_ctl_copy_lttng_domain(&handle->domain, domain);
538 }
539
540 end:
541 return handle;
542 }
543
544 /*
545 * Destroy handle by free(3) the pointer.
546 */
547 void lttng_destroy_handle(struct lttng_handle *handle)
548 {
549 free(handle);
550 }
551
552 /*
553 * Register an outside consumer.
554 *
555 * Returns size of returned session payload data or a negative error code.
556 */
557 int lttng_register_consumer(struct lttng_handle *handle,
558 const char *socket_path)
559 {
560 struct lttcomm_session_msg lsm;
561
562 if (handle == NULL || socket_path == NULL) {
563 return -LTTNG_ERR_INVALID;
564 }
565
566 memset(&lsm, 0, sizeof(lsm));
567 lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
568 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
569 sizeof(lsm.session.name));
570 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
571
572 lttng_ctl_copy_string(lsm.u.reg.path, socket_path,
573 sizeof(lsm.u.reg.path));
574
575 return lttng_ctl_ask_sessiond(&lsm, NULL);
576 }
577
578 /*
579 * Start tracing for all traces of the session.
580 *
581 * Returns size of returned session payload data or a negative error code.
582 */
583 int lttng_start_tracing(const char *session_name)
584 {
585 struct lttcomm_session_msg lsm;
586
587 if (session_name == NULL) {
588 return -LTTNG_ERR_INVALID;
589 }
590
591 memset(&lsm, 0, sizeof(lsm));
592 lsm.cmd_type = LTTNG_START_TRACE;
593
594 lttng_ctl_copy_string(lsm.session.name, session_name,
595 sizeof(lsm.session.name));
596
597 return lttng_ctl_ask_sessiond(&lsm, NULL);
598 }
599
600 /*
601 * Stop tracing for all traces of the session.
602 */
603 static int _lttng_stop_tracing(const char *session_name, int wait)
604 {
605 int ret, data_ret;
606 struct lttcomm_session_msg lsm;
607
608 if (session_name == NULL) {
609 return -LTTNG_ERR_INVALID;
610 }
611
612 memset(&lsm, 0, sizeof(lsm));
613 lsm.cmd_type = LTTNG_STOP_TRACE;
614
615 lttng_ctl_copy_string(lsm.session.name, session_name,
616 sizeof(lsm.session.name));
617
618 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
619 if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
620 goto error;
621 }
622
623 if (!wait) {
624 goto end;
625 }
626
627 /* Check for data availability */
628 do {
629 data_ret = lttng_data_pending(session_name);
630 if (data_ret < 0) {
631 /* Return the data available call error. */
632 ret = data_ret;
633 goto error;
634 }
635
636 /*
637 * Data sleep time before retrying (in usec). Don't sleep if the
638 * call returned value indicates availability.
639 */
640 if (data_ret) {
641 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME);
642 }
643 } while (data_ret != 0);
644
645 end:
646 error:
647 return ret;
648 }
649
650 /*
651 * Stop tracing and wait for data availability.
652 */
653 int lttng_stop_tracing(const char *session_name)
654 {
655 return _lttng_stop_tracing(session_name, 1);
656 }
657
658 /*
659 * Stop tracing but _don't_ wait for data availability.
660 */
661 int lttng_stop_tracing_no_wait(const char *session_name)
662 {
663 return _lttng_stop_tracing(session_name, 0);
664 }
665
666 /*
667 * Add context to a channel.
668 *
669 * If the given channel is NULL, add the contexts to all channels.
670 * The event_name param is ignored.
671 *
672 * Returns the size of the returned payload data or a negative error code.
673 */
674 int lttng_add_context(struct lttng_handle *handle,
675 struct lttng_event_context *ctx, const char *event_name,
676 const char *channel_name)
677 {
678 int ret;
679 size_t len = 0;
680 char *buf = NULL;
681 struct lttcomm_session_msg lsm;
682
683 /* Safety check. Both are mandatory. */
684 if (handle == NULL || ctx == NULL) {
685 ret = -LTTNG_ERR_INVALID;
686 goto end;
687 }
688
689 memset(&lsm, 0, sizeof(lsm));
690 lsm.cmd_type = LTTNG_ADD_CONTEXT;
691
692 /* If no channel name, send empty string. */
693 if (channel_name == NULL) {
694 lttng_ctl_copy_string(lsm.u.context.channel_name, "",
695 sizeof(lsm.u.context.channel_name));
696 } else {
697 lttng_ctl_copy_string(lsm.u.context.channel_name, channel_name,
698 sizeof(lsm.u.context.channel_name));
699 }
700
701 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
702 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
703 sizeof(lsm.session.name));
704
705 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
706 size_t provider_len, ctx_len;
707 const char *provider_name = ctx->u.app_ctx.provider_name;
708 const char *ctx_name = ctx->u.app_ctx.ctx_name;
709
710 if (!provider_name || !ctx_name) {
711 ret = -LTTNG_ERR_INVALID;
712 goto end;
713 }
714
715 provider_len = strlen(provider_name);
716 if (provider_len == 0) {
717 ret = -LTTNG_ERR_INVALID;
718 goto end;
719 }
720 lsm.u.context.provider_name_len = provider_len;
721
722 ctx_len = strlen(ctx_name);
723 if (ctx_len == 0) {
724 ret = -LTTNG_ERR_INVALID;
725 goto end;
726 }
727 lsm.u.context.context_name_len = ctx_len;
728
729 len = provider_len + ctx_len;
730 buf = zmalloc(len);
731 if (!buf) {
732 ret = -LTTNG_ERR_NOMEM;
733 goto end;
734 }
735
736 memcpy(buf, provider_name, provider_len);
737 memcpy(buf + provider_len, ctx_name, ctx_len);
738 }
739 memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context));
740
741 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
742 /*
743 * Don't leak application addresses to the sessiond.
744 * This is only necessary when ctx is for an app ctx otherwise
745 * the values inside the union (type & config) are overwritten.
746 */
747 lsm.u.context.ctx.u.app_ctx.provider_name = NULL;
748 lsm.u.context.ctx.u.app_ctx.ctx_name = NULL;
749 }
750
751 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, buf, len, NULL);
752 end:
753 free(buf);
754 return ret;
755 }
756
757 /*
758 * Enable event(s) for a channel.
759 *
760 * If no event name is specified, all events are enabled.
761 * If no channel name is specified, the default 'channel0' is used.
762 *
763 * Returns size of returned session payload data or a negative error code.
764 */
765 int lttng_enable_event(struct lttng_handle *handle,
766 struct lttng_event *ev, const char *channel_name)
767 {
768 return lttng_enable_event_with_exclusions(handle, ev, channel_name,
769 NULL, 0, NULL);
770 }
771
772 /*
773 * Create or enable an event with a filter expression.
774 *
775 * Return negative error value on error.
776 * Return size of returned session payload data if OK.
777 */
778 int lttng_enable_event_with_filter(struct lttng_handle *handle,
779 struct lttng_event *event, const char *channel_name,
780 const char *filter_expression)
781 {
782 return lttng_enable_event_with_exclusions(handle, event, channel_name,
783 filter_expression, 0, NULL);
784 }
785
786 /*
787 * Depending on the event, return a newly allocated agent filter expression or
788 * NULL if not applicable.
789 *
790 * An event with NO loglevel and the name is * will return NULL.
791 */
792 static char *set_agent_filter(const char *filter, struct lttng_event *ev)
793 {
794 int err;
795 char *agent_filter = NULL;
796
797 assert(ev);
798
799 /* Don't add filter for the '*' event. */
800 if (ev->name[0] != '*') {
801 if (filter) {
802 err = asprintf(&agent_filter, "(%s) && (logger_name == \"%s\")", filter,
803 ev->name);
804 } else {
805 err = asprintf(&agent_filter, "logger_name == \"%s\"", ev->name);
806 }
807 if (err < 0) {
808 PERROR("asprintf");
809 goto error;
810 }
811 }
812
813 /* Add loglevel filtering if any for the JUL domain. */
814 if (ev->loglevel_type != LTTNG_EVENT_LOGLEVEL_ALL) {
815 char *op;
816
817 if (ev->loglevel_type == LTTNG_EVENT_LOGLEVEL_RANGE) {
818 op = ">=";
819 } else {
820 op = "==";
821 }
822
823 if (filter || agent_filter) {
824 char *new_filter;
825
826 err = asprintf(&new_filter, "(%s) && (int_loglevel %s %d)",
827 agent_filter ? agent_filter : filter, op,
828 ev->loglevel);
829 if (agent_filter) {
830 free(agent_filter);
831 }
832 agent_filter = new_filter;
833 } else {
834 err = asprintf(&agent_filter, "int_loglevel %s %d", op,
835 ev->loglevel);
836 }
837 if (err < 0) {
838 PERROR("asprintf");
839 goto error;
840 }
841 }
842
843 return agent_filter;
844 error:
845 free(agent_filter);
846 return NULL;
847 }
848
849 /*
850 * Generate the filter bytecode from a given filter expression string. Put the
851 * newly allocated parser context in ctxp and populate the lsm object with the
852 * expression len.
853 *
854 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
855 */
856 static int generate_filter(char *filter_expression,
857 struct lttcomm_session_msg *lsm, struct filter_parser_ctx **ctxp)
858 {
859 int ret;
860 struct filter_parser_ctx *ctx = NULL;
861 FILE *fmem = NULL;
862
863 assert(filter_expression);
864 assert(lsm);
865 assert(ctxp);
866
867 /*
868 * Casting const to non-const, as the underlying function will use it in
869 * read-only mode.
870 */
871 fmem = lttng_fmemopen((void *) filter_expression,
872 strlen(filter_expression), "r");
873 if (!fmem) {
874 fprintf(stderr, "Error opening memory as stream\n");
875 ret = -LTTNG_ERR_FILTER_NOMEM;
876 goto error;
877 }
878 ctx = filter_parser_ctx_alloc(fmem);
879 if (!ctx) {
880 fprintf(stderr, "Error allocating parser\n");
881 ret = -LTTNG_ERR_FILTER_NOMEM;
882 goto filter_alloc_error;
883 }
884 ret = filter_parser_ctx_append_ast(ctx);
885 if (ret) {
886 fprintf(stderr, "Parse error\n");
887 ret = -LTTNG_ERR_FILTER_INVAL;
888 goto parse_error;
889 }
890 ret = filter_visitor_set_parent(ctx);
891 if (ret) {
892 fprintf(stderr, "Set parent error\n");
893 ret = -LTTNG_ERR_FILTER_INVAL;
894 goto parse_error;
895 }
896 if (print_xml) {
897 ret = filter_visitor_print_xml(ctx, stdout, 0);
898 if (ret) {
899 fflush(stdout);
900 fprintf(stderr, "XML print error\n");
901 ret = -LTTNG_ERR_FILTER_INVAL;
902 goto parse_error;
903 }
904 }
905
906 dbg_printf("Generating IR... ");
907 fflush(stdout);
908 ret = filter_visitor_ir_generate(ctx);
909 if (ret) {
910 fprintf(stderr, "Generate IR error\n");
911 ret = -LTTNG_ERR_FILTER_INVAL;
912 goto parse_error;
913 }
914 dbg_printf("done\n");
915
916 dbg_printf("Validating IR... ");
917 fflush(stdout);
918 ret = filter_visitor_ir_check_binary_op_nesting(ctx);
919 if (ret) {
920 ret = -LTTNG_ERR_FILTER_INVAL;
921 goto parse_error;
922 }
923 /* Validate strings used as literals in the expression. */
924 ret = filter_visitor_ir_validate_string(ctx);
925 if (ret) {
926 ret = -LTTNG_ERR_FILTER_INVAL;
927 goto parse_error;
928 }
929 dbg_printf("done\n");
930
931 dbg_printf("Generating bytecode... ");
932 fflush(stdout);
933 ret = filter_visitor_bytecode_generate(ctx);
934 if (ret) {
935 fprintf(stderr, "Generate bytecode error\n");
936 ret = -LTTNG_ERR_FILTER_INVAL;
937 goto parse_error;
938 }
939 dbg_printf("done\n");
940 dbg_printf("Size of bytecode generated: %u bytes.\n",
941 bytecode_get_len(&ctx->bytecode->b));
942
943 lsm->u.enable.bytecode_len = sizeof(ctx->bytecode->b)
944 + bytecode_get_len(&ctx->bytecode->b);
945 lsm->u.enable.expression_len = strlen(filter_expression) + 1;
946
947 /* No need to keep the memory stream. */
948 if (fclose(fmem) != 0) {
949 PERROR("fclose");
950 }
951
952 *ctxp = ctx;
953 return 0;
954
955 parse_error:
956 filter_ir_free(ctx);
957 filter_parser_ctx_free(ctx);
958 filter_alloc_error:
959 if (fclose(fmem) != 0) {
960 PERROR("fclose");
961 }
962 error:
963 return ret;
964 }
965
966 /*
967 * Enable event(s) for a channel, possibly with exclusions and a filter.
968 * If no event name is specified, all events are enabled.
969 * If no channel name is specified, the default name is used.
970 * If filter expression is not NULL, the filter is set for the event.
971 * If exclusion count is not zero, the exclusions are set for the event.
972 * Returns size of returned session payload data or a negative error code.
973 */
974 int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
975 struct lttng_event *ev, const char *channel_name,
976 const char *original_filter_expression,
977 int exclusion_count, char **exclusion_list)
978 {
979 struct lttcomm_session_msg lsm;
980 char *varlen_data;
981 int ret = 0;
982 unsigned int free_filter_expression = 0;
983 struct filter_parser_ctx *ctx = NULL;
984 /*
985 * Cast as non-const since we may replace the filter expression
986 * by a dynamically allocated string. Otherwise, the original
987 * string is not modified.
988 */
989 char *filter_expression = (char *) original_filter_expression;
990
991 if (handle == NULL || ev == NULL) {
992 ret = -LTTNG_ERR_INVALID;
993 goto error;
994 }
995
996 /*
997 * Empty filter string will always be rejected by the parser
998 * anyway, so treat this corner-case early to eliminate
999 * lttng_fmemopen error for 0-byte allocation.
1000 */
1001 if (filter_expression && filter_expression[0] == '\0') {
1002 ret = -LTTNG_ERR_INVALID;
1003 goto error;
1004 }
1005
1006 memset(&lsm, 0, sizeof(lsm));
1007
1008 /* If no channel name, send empty string. */
1009 if (channel_name == NULL) {
1010 lttng_ctl_copy_string(lsm.u.enable.channel_name, "",
1011 sizeof(lsm.u.enable.channel_name));
1012 } else {
1013 lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name,
1014 sizeof(lsm.u.enable.channel_name));
1015 }
1016
1017 lsm.cmd_type = LTTNG_ENABLE_EVENT;
1018 if (ev->name[0] == '\0') {
1019 /* Enable all events */
1020 lttng_ctl_copy_string(ev->name, "*", sizeof(ev->name));
1021 }
1022
1023 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1024 /* FIXME: copying non-packed struct to packed struct. */
1025 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
1026
1027 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1028 sizeof(lsm.session.name));
1029 lsm.u.enable.exclusion_count = exclusion_count;
1030 lsm.u.enable.bytecode_len = 0;
1031
1032 /*
1033 * For the JUL domain, a filter is enforced except for the enable all
1034 * event. This is done to avoid having the event in all sessions thus
1035 * filtering by logger name.
1036 */
1037 if (exclusion_count == 0 && filter_expression == NULL &&
1038 (handle->domain.type != LTTNG_DOMAIN_JUL &&
1039 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
1040 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
1041 goto ask_sessiond;
1042 }
1043
1044 /*
1045 * We have either a filter or some exclusions, so we need to set up
1046 * a variable-length memory block from where to send the data.
1047 */
1048
1049 /* Parse filter expression. */
1050 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1051 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1052 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1053 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1054 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1055 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1056 char *agent_filter;
1057
1058 /* Setup JUL filter if needed. */
1059 agent_filter = set_agent_filter(filter_expression, ev);
1060 if (!agent_filter) {
1061 if (!filter_expression) {
1062 /*
1063 * No JUL and no filter, just skip
1064 * everything below.
1065 */
1066 goto ask_sessiond;
1067 }
1068 } else {
1069 /*
1070 * With an agent filter, the original filter has
1071 * been added to it thus replace the filter
1072 * expression.
1073 */
1074 filter_expression = agent_filter;
1075 free_filter_expression = 1;
1076 }
1077 }
1078
1079 ret = generate_filter(filter_expression, &lsm, &ctx);
1080 if (ret) {
1081 goto filter_error;
1082 }
1083 }
1084
1085 varlen_data = zmalloc(lsm.u.enable.bytecode_len
1086 + lsm.u.enable.expression_len
1087 + LTTNG_SYMBOL_NAME_LEN * exclusion_count);
1088 if (!varlen_data) {
1089 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1090 goto mem_error;
1091 }
1092
1093 /* Put exclusion names first in the data. */
1094 while (exclusion_count--) {
1095 strncpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * exclusion_count,
1096 *(exclusion_list + exclusion_count),
1097 LTTNG_SYMBOL_NAME_LEN - 1);
1098 }
1099 /* Add filter expression next. */
1100 if (lsm.u.enable.expression_len != 0) {
1101 memcpy(varlen_data
1102 + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count,
1103 filter_expression,
1104 lsm.u.enable.expression_len);
1105 }
1106 /* Add filter bytecode next. */
1107 if (ctx && lsm.u.enable.bytecode_len != 0) {
1108 memcpy(varlen_data
1109 + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count
1110 + lsm.u.enable.expression_len,
1111 &ctx->bytecode->b,
1112 lsm.u.enable.bytecode_len);
1113 }
1114
1115 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, varlen_data,
1116 (LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count) +
1117 lsm.u.enable.bytecode_len + lsm.u.enable.expression_len,
1118 NULL);
1119 free(varlen_data);
1120
1121 mem_error:
1122 if (filter_expression && ctx) {
1123 filter_bytecode_free(ctx);
1124 filter_ir_free(ctx);
1125 filter_parser_ctx_free(ctx);
1126 }
1127 filter_error:
1128 if (free_filter_expression) {
1129 /*
1130 * The filter expression has been replaced and must be freed as
1131 * it is not the original filter expression received as a
1132 * parameter.
1133 */
1134 free(filter_expression);
1135 }
1136 error:
1137 /*
1138 * Return directly to the caller and don't ask the sessiond since
1139 * something went wrong in the parsing of data above.
1140 */
1141 return ret;
1142
1143 ask_sessiond:
1144 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1145 return ret;
1146 }
1147
1148 int lttng_disable_event_ext(struct lttng_handle *handle,
1149 struct lttng_event *ev, const char *channel_name,
1150 const char *original_filter_expression)
1151 {
1152 struct lttcomm_session_msg lsm;
1153 char *varlen_data;
1154 int ret = 0;
1155 unsigned int free_filter_expression = 0;
1156 struct filter_parser_ctx *ctx = NULL;
1157 /*
1158 * Cast as non-const since we may replace the filter expression
1159 * by a dynamically allocated string. Otherwise, the original
1160 * string is not modified.
1161 */
1162 char *filter_expression = (char *) original_filter_expression;
1163
1164 if (handle == NULL || ev == NULL) {
1165 ret = -LTTNG_ERR_INVALID;
1166 goto error;
1167 }
1168
1169 /*
1170 * Empty filter string will always be rejected by the parser
1171 * anyway, so treat this corner-case early to eliminate
1172 * lttng_fmemopen error for 0-byte allocation.
1173 */
1174 if (filter_expression && filter_expression[0] == '\0') {
1175 ret = -LTTNG_ERR_INVALID;
1176 goto error;
1177 }
1178
1179 memset(&lsm, 0, sizeof(lsm));
1180
1181 /* If no channel name, send empty string. */
1182 if (channel_name == NULL) {
1183 lttng_ctl_copy_string(lsm.u.disable.channel_name, "",
1184 sizeof(lsm.u.disable.channel_name));
1185 } else {
1186 lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name,
1187 sizeof(lsm.u.disable.channel_name));
1188 }
1189
1190 lsm.cmd_type = LTTNG_DISABLE_EVENT;
1191
1192 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1193 /* FIXME: copying non-packed struct to packed struct. */
1194 memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event));
1195
1196 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1197 sizeof(lsm.session.name));
1198 lsm.u.disable.bytecode_len = 0;
1199
1200 /*
1201 * For the JUL domain, a filter is enforced except for the
1202 * disable all event. This is done to avoid having the event in
1203 * all sessions thus filtering by logger name.
1204 */
1205 if (filter_expression == NULL &&
1206 (handle->domain.type != LTTNG_DOMAIN_JUL &&
1207 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
1208 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
1209 goto ask_sessiond;
1210 }
1211
1212 /*
1213 * We have a filter, so we need to set up a variable-length
1214 * memory block from where to send the data.
1215 */
1216
1217 /* Parse filter expression */
1218 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1219 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1220 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1221 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1222 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1223 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1224 char *agent_filter;
1225
1226 /* Setup JUL filter if needed. */
1227 agent_filter = set_agent_filter(filter_expression, ev);
1228 if (!agent_filter) {
1229 if (!filter_expression) {
1230 /*
1231 * No JUL and no filter, just skip
1232 * everything below.
1233 */
1234 goto ask_sessiond;
1235 }
1236 } else {
1237 /*
1238 * With a JUL filter, the original filter has
1239 * been added to it thus replace the filter
1240 * expression.
1241 */
1242 filter_expression = agent_filter;
1243 free_filter_expression = 1;
1244 }
1245 }
1246
1247 ret = generate_filter(filter_expression, &lsm, &ctx);
1248 if (ret) {
1249 goto filter_error;
1250 }
1251 }
1252
1253 varlen_data = zmalloc(lsm.u.disable.bytecode_len
1254 + lsm.u.disable.expression_len);
1255 if (!varlen_data) {
1256 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1257 goto mem_error;
1258 }
1259
1260 /* Add filter expression. */
1261 if (lsm.u.disable.expression_len != 0) {
1262 memcpy(varlen_data,
1263 filter_expression,
1264 lsm.u.disable.expression_len);
1265 }
1266 /* Add filter bytecode next. */
1267 if (ctx && lsm.u.disable.bytecode_len != 0) {
1268 memcpy(varlen_data
1269 + lsm.u.disable.expression_len,
1270 &ctx->bytecode->b,
1271 lsm.u.disable.bytecode_len);
1272 }
1273
1274 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, varlen_data,
1275 lsm.u.disable.bytecode_len + lsm.u.disable.expression_len, NULL);
1276 free(varlen_data);
1277
1278 mem_error:
1279 if (filter_expression && ctx) {
1280 filter_bytecode_free(ctx);
1281 filter_ir_free(ctx);
1282 filter_parser_ctx_free(ctx);
1283 }
1284 filter_error:
1285 if (free_filter_expression) {
1286 /*
1287 * The filter expression has been replaced and must be freed as
1288 * it is not the original filter expression received as a
1289 * parameter.
1290 */
1291 free(filter_expression);
1292 }
1293 error:
1294 /*
1295 * Return directly to the caller and don't ask the sessiond since
1296 * something went wrong in the parsing of data above.
1297 */
1298 return ret;
1299
1300 ask_sessiond:
1301 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1302 return ret;
1303 }
1304
1305 /*
1306 * Disable event(s) of a channel and domain.
1307 * If no event name is specified, all events are disabled.
1308 * If no channel name is specified, the default 'channel0' is used.
1309 * Returns size of returned session payload data or a negative error code.
1310 */
1311 int lttng_disable_event(struct lttng_handle *handle, const char *name,
1312 const char *channel_name)
1313 {
1314 struct lttng_event ev;
1315
1316 memset(&ev, 0, sizeof(ev));
1317 ev.loglevel = -1;
1318 ev.type = LTTNG_EVENT_ALL;
1319 lttng_ctl_copy_string(ev.name, name, sizeof(ev.name));
1320 return lttng_disable_event_ext(handle, &ev, channel_name, NULL);
1321 }
1322
1323 struct lttng_channel *lttng_channel_create(struct lttng_domain *domain)
1324 {
1325 struct lttng_channel *channel = NULL;
1326 struct lttng_channel_extended *extended = NULL;
1327
1328 if (!domain) {
1329 goto error;
1330 }
1331
1332 /* Validate domain. */
1333 switch (domain->type) {
1334 case LTTNG_DOMAIN_UST:
1335 switch (domain->buf_type) {
1336 case LTTNG_BUFFER_PER_UID:
1337 case LTTNG_BUFFER_PER_PID:
1338 break;
1339 default:
1340 goto error;
1341 }
1342 break;
1343 case LTTNG_DOMAIN_KERNEL:
1344 if (domain->buf_type != LTTNG_BUFFER_GLOBAL) {
1345 goto error;
1346 }
1347 break;
1348 default:
1349 goto error;
1350 }
1351
1352 channel = zmalloc(sizeof(*channel));
1353 if (!channel) {
1354 goto error;
1355 }
1356
1357 extended = zmalloc(sizeof(*extended));
1358 if (!extended) {
1359 goto error;
1360 }
1361
1362 channel->attr.extended.ptr = extended;
1363
1364 lttng_channel_set_default_attr(domain, &channel->attr);
1365 return channel;
1366 error:
1367 free(channel);
1368 free(extended);
1369 return NULL;
1370 }
1371
1372 void lttng_channel_destroy(struct lttng_channel *channel)
1373 {
1374 if (!channel) {
1375 return;
1376 }
1377
1378 if (channel->attr.extended.ptr) {
1379 free(channel->attr.extended.ptr);
1380 }
1381 free(channel);
1382 }
1383
1384 /*
1385 * Enable channel per domain
1386 * Returns size of returned session payload data or a negative error code.
1387 */
1388 int lttng_enable_channel(struct lttng_handle *handle,
1389 struct lttng_channel *in_chan)
1390 {
1391 struct lttcomm_session_msg lsm;
1392
1393 /* NULL arguments are forbidden. No default values. */
1394 if (handle == NULL || in_chan == NULL) {
1395 return -LTTNG_ERR_INVALID;
1396 }
1397
1398 memset(&lsm, 0, sizeof(lsm));
1399 memcpy(&lsm.u.channel.chan, in_chan, sizeof(lsm.u.channel.chan));
1400 lsm.u.channel.chan.attr.extended.ptr = NULL;
1401
1402 if (!in_chan->attr.extended.ptr) {
1403 struct lttng_channel *channel;
1404 struct lttng_channel_extended *extended;
1405
1406 channel = lttng_channel_create(&handle->domain);
1407 if (!channel) {
1408 return -LTTNG_ERR_NOMEM;
1409 }
1410
1411 /*
1412 * Create a new channel in order to use default extended
1413 * attribute values.
1414 */
1415 extended = (struct lttng_channel_extended *)
1416 channel->attr.extended.ptr;
1417 memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
1418 lttng_channel_destroy(channel);
1419 } else {
1420 struct lttng_channel_extended *extended;
1421
1422 extended = (struct lttng_channel_extended *)
1423 in_chan->attr.extended.ptr;
1424 memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
1425 }
1426
1427 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
1428 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1429
1430 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1431 sizeof(lsm.session.name));
1432
1433 return lttng_ctl_ask_sessiond(&lsm, NULL);
1434 }
1435
1436 /*
1437 * All tracing will be stopped for registered events of the channel.
1438 * Returns size of returned session payload data or a negative error code.
1439 */
1440 int lttng_disable_channel(struct lttng_handle *handle, const char *name)
1441 {
1442 struct lttcomm_session_msg lsm;
1443
1444 /* Safety check. Both are mandatory. */
1445 if (handle == NULL || name == NULL) {
1446 return -LTTNG_ERR_INVALID;
1447 }
1448
1449 memset(&lsm, 0, sizeof(lsm));
1450
1451 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1452
1453 lttng_ctl_copy_string(lsm.u.disable.channel_name, name,
1454 sizeof(lsm.u.disable.channel_name));
1455
1456 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1457
1458 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1459 sizeof(lsm.session.name));
1460
1461 return lttng_ctl_ask_sessiond(&lsm, NULL);
1462 }
1463
1464 /*
1465 * Add PID to session tracker.
1466 * Return 0 on success else a negative LTTng error code.
1467 */
1468 int lttng_track_pid(struct lttng_handle *handle, int pid)
1469 {
1470 struct lttcomm_session_msg lsm;
1471
1472 /* NULL arguments are forbidden. No default values. */
1473 if (handle == NULL) {
1474 return -LTTNG_ERR_INVALID;
1475 }
1476
1477 memset(&lsm, 0, sizeof(lsm));
1478
1479 lsm.cmd_type = LTTNG_TRACK_PID;
1480 lsm.u.pid_tracker.pid = pid;
1481
1482 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1483
1484 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1485 sizeof(lsm.session.name));
1486
1487 return lttng_ctl_ask_sessiond(&lsm, NULL);
1488 }
1489
1490 /*
1491 * Remove PID from session tracker.
1492 * Return 0 on success else a negative LTTng error code.
1493 */
1494 int lttng_untrack_pid(struct lttng_handle *handle, int pid)
1495 {
1496 struct lttcomm_session_msg lsm;
1497
1498 /* NULL arguments are forbidden. No default values. */
1499 if (handle == NULL) {
1500 return -LTTNG_ERR_INVALID;
1501 }
1502
1503 memset(&lsm, 0, sizeof(lsm));
1504
1505 lsm.cmd_type = LTTNG_UNTRACK_PID;
1506 lsm.u.pid_tracker.pid = pid;
1507
1508 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1509
1510 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1511 sizeof(lsm.session.name));
1512
1513 return lttng_ctl_ask_sessiond(&lsm, NULL);
1514 }
1515
1516 /*
1517 * Lists all available tracepoints of domain.
1518 * Sets the contents of the events array.
1519 * Returns the number of lttng_event entries in events;
1520 * on error, returns a negative value.
1521 */
1522 int lttng_list_tracepoints(struct lttng_handle *handle,
1523 struct lttng_event **events)
1524 {
1525 int ret;
1526 struct lttcomm_session_msg lsm;
1527
1528 if (handle == NULL) {
1529 return -LTTNG_ERR_INVALID;
1530 }
1531
1532 memset(&lsm, 0, sizeof(lsm));
1533 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
1534 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1535
1536 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1537 if (ret < 0) {
1538 return ret;
1539 }
1540
1541 return ret / sizeof(struct lttng_event);
1542 }
1543
1544 /*
1545 * Lists all available tracepoint fields of domain.
1546 * Sets the contents of the event field array.
1547 * Returns the number of lttng_event_field entries in events;
1548 * on error, returns a negative value.
1549 */
1550 int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1551 struct lttng_event_field **fields)
1552 {
1553 int ret;
1554 struct lttcomm_session_msg lsm;
1555
1556 if (handle == NULL) {
1557 return -LTTNG_ERR_INVALID;
1558 }
1559
1560 memset(&lsm, 0, sizeof(lsm));
1561 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
1562 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1563
1564 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
1565 if (ret < 0) {
1566 return ret;
1567 }
1568
1569 return ret / sizeof(struct lttng_event_field);
1570 }
1571
1572 /*
1573 * Lists all available kernel system calls. Allocates and sets the contents of
1574 * the events array.
1575 *
1576 * Returns the number of lttng_event entries in events; on error, returns a
1577 * negative value.
1578 */
1579 int lttng_list_syscalls(struct lttng_event **events)
1580 {
1581 int ret;
1582 struct lttcomm_session_msg lsm;
1583
1584 if (!events) {
1585 return -LTTNG_ERR_INVALID;
1586 }
1587
1588 memset(&lsm, 0, sizeof(lsm));
1589 lsm.cmd_type = LTTNG_LIST_SYSCALLS;
1590 /* Force kernel domain for system calls. */
1591 lsm.domain.type = LTTNG_DOMAIN_KERNEL;
1592
1593 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1594 if (ret < 0) {
1595 return ret;
1596 }
1597
1598 return ret / sizeof(struct lttng_event);
1599 }
1600
1601 /*
1602 * Returns a human readable string describing
1603 * the error code (a negative value).
1604 */
1605 const char *lttng_strerror(int code)
1606 {
1607 return error_get_str(code);
1608 }
1609
1610 /*
1611 * Create a brand new session using name and url for destination.
1612 *
1613 * Returns LTTNG_OK on success or a negative error code.
1614 */
1615 int lttng_create_session(const char *name, const char *url)
1616 {
1617 int ret;
1618 ssize_t size;
1619 struct lttcomm_session_msg lsm;
1620 struct lttng_uri *uris = NULL;
1621
1622 if (name == NULL) {
1623 return -LTTNG_ERR_INVALID;
1624 }
1625
1626 memset(&lsm, 0, sizeof(lsm));
1627
1628 lsm.cmd_type = LTTNG_CREATE_SESSION;
1629 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1630
1631 /* There should never be a data URL */
1632 size = uri_parse_str_urls(url, NULL, &uris);
1633 if (size < 0) {
1634 return -LTTNG_ERR_INVALID;
1635 }
1636
1637 lsm.u.uri.size = size;
1638
1639 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
1640 sizeof(struct lttng_uri) * size, NULL);
1641
1642 free(uris);
1643 return ret;
1644 }
1645
1646 /*
1647 * Destroy session using name.
1648 * Returns size of returned session payload data or a negative error code.
1649 */
1650 static
1651 int _lttng_destroy_session(const char *session_name)
1652 {
1653 struct lttcomm_session_msg lsm;
1654
1655 if (session_name == NULL) {
1656 return -LTTNG_ERR_INVALID;
1657 }
1658
1659 memset(&lsm, 0, sizeof(lsm));
1660 lsm.cmd_type = LTTNG_DESTROY_SESSION;
1661
1662 lttng_ctl_copy_string(lsm.session.name, session_name,
1663 sizeof(lsm.session.name));
1664
1665 return lttng_ctl_ask_sessiond(&lsm, NULL);
1666 }
1667
1668 /*
1669 * Stop the session and wait for the data before destroying it
1670 */
1671 int lttng_destroy_session(const char *session_name)
1672 {
1673 int ret;
1674
1675 /*
1676 * Stop the tracing and wait for the data.
1677 */
1678 ret = _lttng_stop_tracing(session_name, 1);
1679 if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
1680 goto end;
1681 }
1682
1683 ret = _lttng_destroy_session(session_name);
1684 end:
1685 return ret;
1686 }
1687
1688 /*
1689 * Destroy the session without waiting for the data.
1690 */
1691 int lttng_destroy_session_no_wait(const char *session_name)
1692 {
1693 int ret;
1694
1695 /*
1696 * Stop the tracing without waiting for the data.
1697 * The session might already have been stopped, so just
1698 * skip this error.
1699 */
1700 ret = _lttng_stop_tracing(session_name, 0);
1701 if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
1702 goto end;
1703 }
1704
1705 ret = _lttng_destroy_session(session_name);
1706 end:
1707 return ret;
1708 }
1709
1710 /*
1711 * Ask the session daemon for all available sessions.
1712 * Sets the contents of the sessions array.
1713 * Returns the number of lttng_session entries in sessions;
1714 * on error, returns a negative value.
1715 */
1716 int lttng_list_sessions(struct lttng_session **sessions)
1717 {
1718 int ret;
1719 struct lttcomm_session_msg lsm;
1720
1721 memset(&lsm, 0, sizeof(lsm));
1722 lsm.cmd_type = LTTNG_LIST_SESSIONS;
1723 ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions);
1724 if (ret < 0) {
1725 return ret;
1726 }
1727
1728 return ret / sizeof(struct lttng_session);
1729 }
1730
1731 int lttng_set_session_shm_path(const char *session_name,
1732 const char *shm_path)
1733 {
1734 struct lttcomm_session_msg lsm;
1735
1736 if (session_name == NULL) {
1737 return -LTTNG_ERR_INVALID;
1738 }
1739
1740 memset(&lsm, 0, sizeof(lsm));
1741 lsm.cmd_type = LTTNG_SET_SESSION_SHM_PATH;
1742
1743 lttng_ctl_copy_string(lsm.session.name, session_name,
1744 sizeof(lsm.session.name));
1745 lttng_ctl_copy_string(lsm.u.set_shm_path.shm_path, shm_path,
1746 sizeof(lsm.u.set_shm_path.shm_path));
1747
1748 return lttng_ctl_ask_sessiond(&lsm, NULL);
1749 }
1750
1751 /*
1752 * Ask the session daemon for all available domains of a session.
1753 * Sets the contents of the domains array.
1754 * Returns the number of lttng_domain entries in domains;
1755 * on error, returns a negative value.
1756 */
1757 int lttng_list_domains(const char *session_name,
1758 struct lttng_domain **domains)
1759 {
1760 int ret;
1761 struct lttcomm_session_msg lsm;
1762
1763 if (session_name == NULL) {
1764 return -LTTNG_ERR_INVALID;
1765 }
1766
1767 memset(&lsm, 0, sizeof(lsm));
1768 lsm.cmd_type = LTTNG_LIST_DOMAINS;
1769
1770 lttng_ctl_copy_string(lsm.session.name, session_name,
1771 sizeof(lsm.session.name));
1772
1773 ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains);
1774 if (ret < 0) {
1775 return ret;
1776 }
1777
1778 return ret / sizeof(struct lttng_domain);
1779 }
1780
1781 /*
1782 * Ask the session daemon for all available channels of a session.
1783 * Sets the contents of the channels array.
1784 * Returns the number of lttng_channel entries in channels;
1785 * on error, returns a negative value.
1786 */
1787 int lttng_list_channels(struct lttng_handle *handle,
1788 struct lttng_channel **channels)
1789 {
1790 int ret;
1791 size_t channel_count, i;
1792 const size_t channel_size = sizeof(struct lttng_channel) +
1793 sizeof(struct lttng_channel_extended);
1794 struct lttcomm_session_msg lsm;
1795 void *extended_at;
1796
1797 if (handle == NULL) {
1798 ret = -LTTNG_ERR_INVALID;
1799 goto end;
1800 }
1801
1802 memset(&lsm, 0, sizeof(lsm));
1803 lsm.cmd_type = LTTNG_LIST_CHANNELS;
1804 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1805 sizeof(lsm.session.name));
1806
1807 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1808
1809 ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
1810 if (ret < 0) {
1811 goto end;
1812 }
1813
1814 if (ret % channel_size) {
1815 ret = -LTTNG_ERR_UNK;
1816 free(*channels);
1817 *channels = NULL;
1818 goto end;
1819 }
1820 channel_count = (size_t) ret / channel_size;
1821
1822 /* Set extended info pointers */
1823 extended_at = ((void *) *channels) +
1824 channel_count * sizeof(struct lttng_channel);
1825 for (i = 0; i < channel_count; i++) {
1826 struct lttng_channel *chan = &(*channels)[i];
1827
1828 chan->attr.extended.ptr = extended_at;
1829 extended_at += sizeof(struct lttng_channel_extended);
1830 }
1831
1832 ret = (int) channel_count;
1833 end:
1834 return ret;
1835 }
1836
1837 /*
1838 * Ask the session daemon for all available events of a session channel.
1839 * Sets the contents of the events array.
1840 * Returns the number of lttng_event entries in events;
1841 * on error, returns a negative value.
1842 */
1843 int lttng_list_events(struct lttng_handle *handle,
1844 const char *channel_name, struct lttng_event **events)
1845 {
1846 int ret;
1847 struct lttcomm_session_msg lsm;
1848 struct lttcomm_event_command_header *cmd_header = NULL;
1849 size_t cmd_header_len;
1850 uint32_t nb_events, i;
1851 void *extended_at;
1852
1853 /* Safety check. An handle and channel name are mandatory */
1854 if (handle == NULL || channel_name == NULL) {
1855 return -LTTNG_ERR_INVALID;
1856 }
1857
1858 memset(&lsm, 0, sizeof(lsm));
1859 lsm.cmd_type = LTTNG_LIST_EVENTS;
1860 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1861 sizeof(lsm.session.name));
1862 lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name,
1863 sizeof(lsm.u.list.channel_name));
1864 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1865
1866 ret = lttng_ctl_ask_sessiond_varlen(&lsm, NULL, 0, (void **) events,
1867 (void **) &cmd_header, &cmd_header_len);
1868 if (ret < 0) {
1869 goto error;
1870 }
1871
1872 /* Set number of events and free command header */
1873 nb_events = cmd_header->nb_events;
1874 if (nb_events > INT_MAX) {
1875 ret = -EOVERFLOW;
1876 goto error;
1877 }
1878 ret = (int) nb_events;
1879 free(cmd_header);
1880 cmd_header = NULL;
1881
1882 /* Set extended info pointers */
1883 extended_at = ((void*) (*events)) +
1884 nb_events * sizeof(struct lttng_event);
1885
1886 for (i = 0; i < nb_events; i++) {
1887 struct lttcomm_event_extended_header *ext_header;
1888 struct lttng_event *event = &(*events)[i];
1889
1890 event->extended.ptr = extended_at;
1891 ext_header =
1892 (struct lttcomm_event_extended_header *) extended_at;
1893 extended_at += sizeof(*ext_header);
1894 extended_at += ext_header->filter_len;
1895 extended_at +=
1896 ext_header->nb_exclusions * LTTNG_SYMBOL_NAME_LEN;
1897 }
1898
1899 return ret;
1900 error:
1901 free(cmd_header);
1902 free(*events);
1903 return ret;
1904 }
1905
1906 int lttng_event_get_filter_expression(struct lttng_event *event,
1907 const char **filter_expression)
1908 {
1909 int ret = 0;
1910 struct lttcomm_event_extended_header *ext_header;
1911
1912 if (!event || !filter_expression) {
1913 ret = -LTTNG_ERR_INVALID;
1914 goto end;
1915 }
1916
1917 ext_header = event->extended.ptr;
1918
1919 if (!ext_header) {
1920 /*
1921 * This can happen since the lttng_event structure is
1922 * used for other tasks where this pointer is never set.
1923 */
1924 *filter_expression = NULL;
1925 goto end;
1926 }
1927
1928 if (ext_header->filter_len) {
1929 *filter_expression = ((const char *) (ext_header)) +
1930 sizeof(*ext_header);
1931 } else {
1932 *filter_expression = NULL;
1933 }
1934
1935 end:
1936 return ret;
1937 }
1938
1939 int lttng_event_get_exclusion_name_count(struct lttng_event *event)
1940 {
1941 int ret;
1942 struct lttcomm_event_extended_header *ext_header;
1943
1944 if (!event) {
1945 ret = -LTTNG_ERR_INVALID;
1946 goto end;
1947 }
1948
1949 ext_header = event->extended.ptr;
1950 if (!ext_header) {
1951 /*
1952 * This can happen since the lttng_event structure is
1953 * used for other tasks where this pointer is never set.
1954 */
1955 ret = 0;
1956 goto end;
1957 }
1958
1959 if (ext_header->nb_exclusions > INT_MAX) {
1960 ret = -LTTNG_ERR_OVERFLOW;
1961 goto end;
1962 }
1963 ret = (int) ext_header->nb_exclusions;
1964 end:
1965 return ret;
1966 }
1967
1968 int lttng_event_get_exclusion_name(struct lttng_event *event,
1969 size_t index, const char **exclusion_name)
1970 {
1971 int ret = 0;
1972 struct lttcomm_event_extended_header *ext_header;
1973 void *at;
1974
1975 if (!event || !exclusion_name) {
1976 ret = -LTTNG_ERR_INVALID;
1977 goto end;
1978 }
1979
1980 ext_header = event->extended.ptr;
1981 if (!ext_header) {
1982 ret = -LTTNG_ERR_INVALID;
1983 goto end;
1984 }
1985
1986 if (index >= ext_header->nb_exclusions) {
1987 ret = -LTTNG_ERR_INVALID;
1988 goto end;
1989 }
1990
1991 at = (void *) ext_header + sizeof(*ext_header);
1992 at += ext_header->filter_len;
1993 at += index * LTTNG_SYMBOL_NAME_LEN;
1994 *exclusion_name = at;
1995
1996 end:
1997 return ret;
1998 }
1999
2000 /*
2001 * Sets the tracing_group variable with name.
2002 * This function allocates memory pointed to by tracing_group.
2003 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2004 */
2005 int lttng_set_tracing_group(const char *name)
2006 {
2007 if (name == NULL) {
2008 return -LTTNG_ERR_INVALID;
2009 }
2010
2011 if (asprintf(&tracing_group, "%s", name) < 0) {
2012 return -LTTNG_ERR_FATAL;
2013 }
2014
2015 return 0;
2016 }
2017
2018 int lttng_calibrate(struct lttng_handle *handle,
2019 struct lttng_calibrate *calibrate)
2020 {
2021 /*
2022 * This command was removed in LTTng 2.9.
2023 */
2024 return -LTTNG_ERR_UND;
2025 }
2026
2027 /*
2028 * Set default channel attributes.
2029 * If either or both of the arguments are null, attr content is zeroe'd.
2030 */
2031 void lttng_channel_set_default_attr(struct lttng_domain *domain,
2032 struct lttng_channel_attr *attr)
2033 {
2034 struct lttng_channel_extended *extended =
2035 (struct lttng_channel_extended *) attr->extended.ptr;
2036
2037 /* Safety check */
2038 if (attr == NULL || domain == NULL) {
2039 return;
2040 }
2041
2042 memset(attr, 0, sizeof(struct lttng_channel_attr));
2043
2044 /* Same for all domains. */
2045 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
2046 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
2047 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
2048
2049 switch (domain->type) {
2050 case LTTNG_DOMAIN_KERNEL:
2051 attr->switch_timer_interval =
2052 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
2053 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
2054 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
2055 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
2056 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
2057 if (extended) {
2058 extended->monitor_timer_interval =
2059 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER;
2060 }
2061 break;
2062 case LTTNG_DOMAIN_UST:
2063 switch (domain->buf_type) {
2064 case LTTNG_BUFFER_PER_UID:
2065 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
2066 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
2067 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
2068 attr->switch_timer_interval =
2069 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
2070 attr->read_timer_interval =
2071 DEFAULT_UST_UID_CHANNEL_READ_TIMER;
2072 if (extended) {
2073 extended->monitor_timer_interval =
2074 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER;
2075 }
2076 break;
2077 case LTTNG_BUFFER_PER_PID:
2078 default:
2079 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
2080 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
2081 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
2082 attr->switch_timer_interval =
2083 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
2084 attr->read_timer_interval =
2085 DEFAULT_UST_PID_CHANNEL_READ_TIMER;
2086 if (extended) {
2087 extended->monitor_timer_interval =
2088 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER;
2089 }
2090 break;
2091 }
2092 default:
2093 /* Default behavior: leave set to 0. */
2094 break;
2095 }
2096
2097 attr->extended.ptr = extended;
2098 }
2099
2100 int lttng_channel_get_discarded_event_count(struct lttng_channel *channel,
2101 uint64_t *discarded_events)
2102 {
2103 int ret = 0;
2104 struct lttng_channel_extended *chan_ext;
2105
2106 if (!channel || !discarded_events) {
2107 ret = -LTTNG_ERR_INVALID;
2108 goto end;
2109 }
2110
2111 chan_ext = channel->attr.extended.ptr;
2112 if (!chan_ext) {
2113 /*
2114 * This can happen since the lttng_channel structure is
2115 * used for other tasks where this pointer is never set.
2116 */
2117 *discarded_events = 0;
2118 goto end;
2119 }
2120
2121 *discarded_events = chan_ext->discarded_events;
2122 end:
2123 return ret;
2124 }
2125
2126 int lttng_channel_get_lost_packet_count(struct lttng_channel *channel,
2127 uint64_t *lost_packets)
2128 {
2129 int ret = 0;
2130 struct lttng_channel_extended *chan_ext;
2131
2132 if (!channel || !lost_packets) {
2133 ret = -LTTNG_ERR_INVALID;
2134 goto end;
2135 }
2136
2137 chan_ext = channel->attr.extended.ptr;
2138 if (!chan_ext) {
2139 /*
2140 * This can happen since the lttng_channel structure is
2141 * used for other tasks where this pointer is never set.
2142 */
2143 *lost_packets = 0;
2144 goto end;
2145 }
2146
2147 *lost_packets = chan_ext->lost_packets;
2148 end:
2149 return ret;
2150 }
2151
2152 int lttng_channel_get_monitor_timer_interval(struct lttng_channel *chan,
2153 uint64_t *monitor_timer_interval)
2154 {
2155 int ret = 0;
2156
2157 if (!chan || !monitor_timer_interval) {
2158 ret = -LTTNG_ERR_INVALID;
2159 goto end;
2160 }
2161
2162 if (!chan->attr.extended.ptr) {
2163 ret = -LTTNG_ERR_INVALID;
2164 goto end;
2165 }
2166
2167 *monitor_timer_interval = ((struct lttng_channel_extended *)
2168 chan->attr.extended.ptr)->monitor_timer_interval;
2169 end:
2170 return ret;
2171 }
2172
2173 int lttng_channel_set_monitor_timer_interval(struct lttng_channel *chan,
2174 uint64_t monitor_timer_interval)
2175 {
2176 int ret = 0;
2177
2178 if (!chan || !chan->attr.extended.ptr) {
2179 ret = -LTTNG_ERR_INVALID;
2180 goto end;
2181 }
2182
2183 ((struct lttng_channel_extended *)
2184 chan->attr.extended.ptr)->monitor_timer_interval =
2185 monitor_timer_interval;
2186 end:
2187 return ret;
2188 }
2189
2190 /*
2191 * Check if session daemon is alive.
2192 *
2193 * Return 1 if alive or 0 if not.
2194 * On error returns a negative value.
2195 */
2196 int lttng_session_daemon_alive(void)
2197 {
2198 int ret;
2199
2200 ret = set_session_daemon_path();
2201 if (ret < 0) {
2202 /* Error. */
2203 return ret;
2204 }
2205
2206 if (*sessiond_sock_path == '\0') {
2207 /*
2208 * No socket path set. Weird error which means the constructor
2209 * was not called.
2210 */
2211 assert(0);
2212 }
2213
2214 ret = try_connect_sessiond(sessiond_sock_path);
2215 if (ret < 0) {
2216 /* Not alive. */
2217 return 0;
2218 }
2219
2220 /* Is alive. */
2221 return 1;
2222 }
2223
2224 /*
2225 * Set URL for a consumer for a session and domain.
2226 *
2227 * Return 0 on success, else a negative value.
2228 */
2229 int lttng_set_consumer_url(struct lttng_handle *handle,
2230 const char *control_url, const char *data_url)
2231 {
2232 int ret;
2233 ssize_t size;
2234 struct lttcomm_session_msg lsm;
2235 struct lttng_uri *uris = NULL;
2236
2237 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
2238 return -LTTNG_ERR_INVALID;
2239 }
2240
2241 memset(&lsm, 0, sizeof(lsm));
2242
2243 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
2244
2245 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
2246 sizeof(lsm.session.name));
2247 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
2248
2249 size = uri_parse_str_urls(control_url, data_url, &uris);
2250 if (size < 0) {
2251 return -LTTNG_ERR_INVALID;
2252 }
2253
2254 lsm.u.uri.size = size;
2255
2256 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
2257 sizeof(struct lttng_uri) * size, NULL);
2258
2259 free(uris);
2260 return ret;
2261 }
2262
2263 /*
2264 * [OBSOLETE]
2265 */
2266 int lttng_enable_consumer(struct lttng_handle *handle)
2267 {
2268 return -ENOSYS;
2269 }
2270
2271 /*
2272 * [OBSOLETE]
2273 */
2274 int lttng_disable_consumer(struct lttng_handle *handle)
2275 {
2276 return -ENOSYS;
2277 }
2278
2279 /*
2280 * This is an extension of create session that is ONLY and SHOULD only be used
2281 * by the lttng command line program. It exists to avoid using URI parsing in
2282 * the lttng client.
2283 *
2284 * We need the date and time for the trace path subdirectory for the case where
2285 * the user does NOT define one using either -o or -U. Using the normal
2286 * lttng_create_session API call, we have no clue on the session daemon side if
2287 * the URL was generated automatically by the client or define by the user.
2288 *
2289 * So this function "wrapper" is hidden from the public API, takes the datetime
2290 * string and appends it if necessary to the URI subdirectory before sending it
2291 * to the session daemon.
2292 *
2293 * With this extra function, the lttng_create_session call behavior is not
2294 * changed and the timestamp is appended to the URI on the session daemon side
2295 * if necessary.
2296 */
2297 int _lttng_create_session_ext(const char *name, const char *url,
2298 const char *datetime)
2299 {
2300 int ret;
2301 ssize_t size;
2302 struct lttcomm_session_msg lsm;
2303 struct lttng_uri *uris = NULL;
2304
2305 if (name == NULL || datetime == NULL) {
2306 return -LTTNG_ERR_INVALID;
2307 }
2308
2309 memset(&lsm, 0, sizeof(lsm));
2310
2311 lsm.cmd_type = LTTNG_CREATE_SESSION;
2312 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
2313
2314 /* There should never be a data URL. */
2315 size = uri_parse_str_urls(url, NULL, &uris);
2316 if (size < 0) {
2317 ret = -LTTNG_ERR_INVALID;
2318 goto error;
2319 }
2320
2321 lsm.u.uri.size = size;
2322
2323 if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
2324 /* Don't append datetime if the name was automatically created. */
2325 if (strncmp(name, DEFAULT_SESSION_NAME "-",
2326 strlen(DEFAULT_SESSION_NAME) + 1)) {
2327 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s",
2328 name, datetime);
2329 } else {
2330 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name);
2331 }
2332 if (ret < 0) {
2333 PERROR("snprintf uri subdir");
2334 ret = -LTTNG_ERR_FATAL;
2335 goto error;
2336 }
2337 }
2338
2339 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
2340 sizeof(struct lttng_uri) * size, NULL);
2341
2342 error:
2343 free(uris);
2344 return ret;
2345 }
2346
2347 /*
2348 * For a given session name, this call checks if the data is ready to be read
2349 * or is still being extracted by the consumer(s) hence not ready to be used by
2350 * any readers.
2351 */
2352 int lttng_data_pending(const char *session_name)
2353 {
2354 int ret;
2355 struct lttcomm_session_msg lsm;
2356 uint8_t *pending = NULL;
2357
2358 if (session_name == NULL) {
2359 return -LTTNG_ERR_INVALID;
2360 }
2361
2362 memset(&lsm, 0, sizeof(lsm));
2363 lsm.cmd_type = LTTNG_DATA_PENDING;
2364
2365 lttng_ctl_copy_string(lsm.session.name, session_name,
2366 sizeof(lsm.session.name));
2367
2368 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending);
2369 if (ret < 0) {
2370 goto end;
2371 } else if (ret != 1) {
2372 /* Unexpected payload size */
2373 ret = -LTTNG_ERR_INVALID;
2374 goto end;
2375 }
2376
2377 ret = (int) *pending;
2378 end:
2379 free(pending);
2380 return ret;
2381 }
2382
2383 /*
2384 * Create a session exclusively used for snapshot.
2385 *
2386 * Returns LTTNG_OK on success or a negative error code.
2387 */
2388 int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
2389 {
2390 int ret;
2391 ssize_t size;
2392 struct lttcomm_session_msg lsm;
2393 struct lttng_uri *uris = NULL;
2394
2395 if (name == NULL) {
2396 return -LTTNG_ERR_INVALID;
2397 }
2398
2399 memset(&lsm, 0, sizeof(lsm));
2400
2401 lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT;
2402 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
2403
2404 size = uri_parse_str_urls(snapshot_url, NULL, &uris);
2405 if (size < 0) {
2406 return -LTTNG_ERR_INVALID;
2407 }
2408
2409 lsm.u.uri.size = size;
2410
2411 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
2412 sizeof(struct lttng_uri) * size, NULL);
2413
2414 free(uris);
2415 return ret;
2416 }
2417
2418 /*
2419 * Create a session exclusively used for live.
2420 *
2421 * Returns LTTNG_OK on success or a negative error code.
2422 */
2423 int lttng_create_session_live(const char *name, const char *url,
2424 unsigned int timer_interval)
2425 {
2426 int ret;
2427 ssize_t size;
2428 struct lttcomm_session_msg lsm;
2429 struct lttng_uri *uris = NULL;
2430
2431 if (name == NULL || timer_interval == 0) {
2432 return -LTTNG_ERR_INVALID;
2433 }
2434
2435 memset(&lsm, 0, sizeof(lsm));
2436
2437 lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE;
2438 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
2439
2440 if (url) {
2441 size = uri_parse_str_urls(url, NULL, &uris);
2442 if (size <= 0) {
2443 ret = -LTTNG_ERR_INVALID;
2444 goto end;
2445 }
2446
2447 /* file:// is not accepted for live session. */
2448 if (uris[0].dtype == LTTNG_DST_PATH) {
2449 ret = -LTTNG_ERR_INVALID;
2450 goto end;
2451 }
2452 } else {
2453 size = 0;
2454 }
2455
2456 lsm.u.session_live.nb_uri = size;
2457 lsm.u.session_live.timer_interval = timer_interval;
2458
2459 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
2460 sizeof(struct lttng_uri) * size, NULL);
2461
2462 end:
2463 free(uris);
2464 return ret;
2465 }
2466
2467 /*
2468 * List PIDs in the tracker.
2469 *
2470 * enabled is set to whether the PID tracker is enabled.
2471 * pids is set to an allocated array of PIDs currently tracked. On
2472 * success, pids must be freed by the caller.
2473 * nr_pids is set to the number of entries contained by the pids array.
2474 *
2475 * Returns 0 on success, else a negative LTTng error code.
2476 */
2477 int lttng_list_tracker_pids(struct lttng_handle *handle,
2478 int *_enabled, int32_t **_pids, size_t *_nr_pids)
2479 {
2480 int ret;
2481 int enabled = 1;
2482 struct lttcomm_session_msg lsm;
2483 size_t nr_pids;
2484 int32_t *pids;
2485
2486 if (handle == NULL) {
2487 return -LTTNG_ERR_INVALID;
2488 }
2489
2490 memset(&lsm, 0, sizeof(lsm));
2491 lsm.cmd_type = LTTNG_LIST_TRACKER_PIDS;
2492 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
2493 sizeof(lsm.session.name));
2494 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
2495
2496 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pids);
2497 if (ret < 0) {
2498 return ret;
2499 }
2500 nr_pids = ret / sizeof(int32_t);
2501 if (nr_pids == 1 && pids[0] == -1) {
2502 free(pids);
2503 pids = NULL;
2504 enabled = 0;
2505 nr_pids = 0;
2506 }
2507 *_enabled = enabled;
2508 *_pids = pids;
2509 *_nr_pids = nr_pids;
2510 return 0;
2511 }
2512
2513 /*
2514 * Regenerate the metadata for a session.
2515 * Return 0 on success, a negative error code on error.
2516 */
2517 int lttng_regenerate_metadata(const char *session_name)
2518 {
2519 int ret;
2520 struct lttcomm_session_msg lsm;
2521
2522 if (!session_name) {
2523 ret = -LTTNG_ERR_INVALID;
2524 goto end;
2525 }
2526
2527 memset(&lsm, 0, sizeof(lsm));
2528 lsm.cmd_type = LTTNG_REGENERATE_METADATA;
2529
2530 lttng_ctl_copy_string(lsm.session.name, session_name,
2531 sizeof(lsm.session.name));
2532
2533 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
2534 if (ret < 0) {
2535 goto end;
2536 }
2537
2538 ret = 0;
2539 end:
2540 return ret;
2541 }
2542
2543 /*
2544 * Deprecated, replaced by lttng_regenerate_metadata.
2545 */
2546 int lttng_metadata_regenerate(const char *session_name)
2547 {
2548 return lttng_regenerate_metadata(session_name);
2549 }
2550
2551 /*
2552 * Regenerate the statedump of a session.
2553 * Return 0 on success, a negative error code on error.
2554 */
2555 int lttng_regenerate_statedump(const char *session_name)
2556 {
2557 int ret;
2558 struct lttcomm_session_msg lsm;
2559
2560 if (!session_name) {
2561 ret = -LTTNG_ERR_INVALID;
2562 goto end;
2563 }
2564
2565 memset(&lsm, 0, sizeof(lsm));
2566 lsm.cmd_type = LTTNG_REGENERATE_STATEDUMP;
2567
2568 lttng_ctl_copy_string(lsm.session.name, session_name,
2569 sizeof(lsm.session.name));
2570
2571 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
2572 if (ret < 0) {
2573 goto end;
2574 }
2575
2576 ret = 0;
2577 end:
2578 return ret;
2579 }
2580
2581 int lttng_register_trigger(struct lttng_trigger *trigger)
2582 {
2583 int ret;
2584 struct lttcomm_session_msg lsm;
2585 char *trigger_buf = NULL;
2586 ssize_t trigger_size;
2587
2588 if (!trigger) {
2589 ret = -LTTNG_ERR_INVALID;
2590 goto end;
2591 }
2592
2593 if (!lttng_trigger_validate(trigger)) {
2594 ret = -LTTNG_ERR_INVALID;
2595 goto end;
2596 }
2597
2598 trigger_size = lttng_trigger_serialize(trigger, NULL);
2599 if (trigger_size < 0) {
2600 ret = -LTTNG_ERR_UNK;
2601 goto end;
2602 }
2603
2604 trigger_buf = zmalloc(trigger_size);
2605 if (!trigger_buf) {
2606 ret = -LTTNG_ERR_NOMEM;
2607 goto end;
2608 }
2609
2610 memset(&lsm, 0, sizeof(lsm));
2611 lsm.cmd_type = LTTNG_REGISTER_TRIGGER;
2612 if (lttng_trigger_serialize(trigger, trigger_buf) < 0) {
2613 ret = -LTTNG_ERR_UNK;
2614 goto end;
2615 }
2616
2617 lsm.u.trigger.length = (uint32_t) trigger_size;
2618 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, trigger_buf,
2619 trigger_size, NULL);
2620 end:
2621 free(trigger_buf);
2622 return ret;
2623 }
2624
2625 int lttng_unregister_trigger(struct lttng_trigger *trigger)
2626 {
2627 int ret;
2628 struct lttcomm_session_msg lsm;
2629 char *trigger_buf = NULL;
2630 ssize_t trigger_size;
2631
2632 if (!trigger) {
2633 ret = -LTTNG_ERR_INVALID;
2634 goto end;
2635 }
2636
2637 if (!lttng_trigger_validate(trigger)) {
2638 ret = -LTTNG_ERR_INVALID;
2639 goto end;
2640 }
2641
2642 trigger_size = lttng_trigger_serialize(trigger, NULL);
2643 if (trigger_size < 0) {
2644 ret = -LTTNG_ERR_UNK;
2645 goto end;
2646 }
2647
2648 trigger_buf = zmalloc(trigger_size);
2649 if (!trigger_buf) {
2650 ret = -LTTNG_ERR_NOMEM;
2651 goto end;
2652 }
2653
2654 memset(&lsm, 0, sizeof(lsm));
2655 lsm.cmd_type = LTTNG_UNREGISTER_TRIGGER;
2656 if (lttng_trigger_serialize(trigger, trigger_buf) < 0) {
2657 ret = -LTTNG_ERR_UNK;
2658 goto end;
2659 }
2660
2661 lsm.u.trigger.length = (uint32_t) trigger_size;
2662 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, trigger_buf,
2663 trigger_size, NULL);
2664 end:
2665 free(trigger_buf);
2666 return ret;
2667 }
2668
2669 /*
2670 * lib constructor.
2671 */
2672 static void __attribute__((constructor)) init(void)
2673 {
2674 /* Set default session group */
2675 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
2676 }
2677
2678 /*
2679 * lib destructor.
2680 */
2681 static void __attribute__((destructor)) lttng_ctl_exit(void)
2682 {
2683 free(tracing_group);
2684 }
This page took 0.121236 seconds and 5 git commands to generate.