Fix: conversion from KB to bytes overflow on arm32
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.c
1 /*
2 * lttng-ctl.c
3 *
4 * Linux Trace Toolkit Control Library
5 *
6 * Copyright (C) 2011 EfficiOS Inc.
7 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * SPDX-License-Identifier: LGPL-2.1-only
10 *
11 */
12
13 #define _LGPL_SOURCE
14 #include <assert.h>
15 #include <grp.h>
16 #include <stdio.h>
17 #include <stdlib.h>
18 #include <stdint.h>
19 #include <string.h>
20 #include <unistd.h>
21
22 #include <common/bytecode/bytecode.h>
23 #include <common/common.h>
24 #include <common/compat/errno.h>
25 #include <common/compat/string.h>
26 #include <common/defaults.h>
27 #include <common/dynamic-array.h>
28 #include <common/dynamic-buffer.h>
29 #include <common/payload-view.h>
30 #include <common/payload.h>
31 #include <common/sessiond-comm/sessiond-comm.h>
32 #include <common/tracker.h>
33 #include <common/unix.h>
34 #include <common/uri.h>
35 #include <common/utils.h>
36 #include <lttng/channel-internal.h>
37 #include <lttng/destruction-handle.h>
38 #include <lttng/endpoint.h>
39 #include <lttng/error-query-internal.h>
40 #include <lttng/event-internal.h>
41 #include <lttng/health-internal.h>
42 #include <lttng/lttng-error.h>
43 #include <lttng/lttng.h>
44 #include <lttng/session-descriptor-internal.h>
45 #include <lttng/session-internal.h>
46 #include <lttng/trigger/trigger-internal.h>
47 #include <lttng/userspace-probe-internal.h>
48
49 #include "lttng-ctl-helper.h"
50 #include <common/filter/filter-ast.h>
51 #include <common/filter/filter-parser.h>
52 #include <common/filter/memstream.h>
53
54 #define COPY_DOMAIN_PACKED(dst, src) \
55 do { \
56 struct lttng_domain _tmp_domain; \
57 \
58 lttng_ctl_copy_lttng_domain(&_tmp_domain, &src); \
59 dst = _tmp_domain; \
60 } while (0)
61
62 /* Socket to session daemon for communication */
63 static int sessiond_socket = -1;
64 static char sessiond_sock_path[PATH_MAX];
65
66 /* Variables */
67 static char *tracing_group;
68 static int connected;
69
70 /* Global */
71
72 /*
73 * Those two variables are used by error.h to silent or control the verbosity of
74 * error message. They are global to the library so application linking with it
75 * are able to compile correctly and also control verbosity of the library.
76 */
77 int lttng_opt_quiet;
78 int lttng_opt_verbose;
79 int lttng_opt_mi;
80
81 /*
82 * Copy domain to lttcomm_session_msg domain.
83 *
84 * If domain is unknown, default domain will be the kernel.
85 */
86 LTTNG_HIDDEN
87 void lttng_ctl_copy_lttng_domain(struct lttng_domain *dst,
88 struct lttng_domain *src)
89 {
90 if (src && dst) {
91 switch (src->type) {
92 case LTTNG_DOMAIN_KERNEL:
93 case LTTNG_DOMAIN_UST:
94 case LTTNG_DOMAIN_JUL:
95 case LTTNG_DOMAIN_LOG4J:
96 case LTTNG_DOMAIN_PYTHON:
97 memcpy(dst, src, sizeof(struct lttng_domain));
98 break;
99 default:
100 memset(dst, 0, sizeof(struct lttng_domain));
101 break;
102 }
103 }
104 }
105
106 /*
107 * Send lttcomm_session_msg to the session daemon.
108 *
109 * On success, returns the number of bytes sent (>=0)
110 * On error, returns -1
111 */
112 static int send_session_msg(struct lttcomm_session_msg *lsm)
113 {
114 int ret;
115
116 if (!connected) {
117 ret = -LTTNG_ERR_NO_SESSIOND;
118 goto end;
119 }
120
121 DBG("LSM cmd type: '%s' (%d)", lttcomm_sessiond_command_str(lsm->cmd_type),
122 lsm->cmd_type);
123
124 ret = lttcomm_send_creds_unix_sock(sessiond_socket, lsm,
125 sizeof(struct lttcomm_session_msg));
126 if (ret < 0) {
127 ret = -LTTNG_ERR_FATAL;
128 }
129
130 end:
131 return ret;
132 }
133
134 /*
135 * Send var len data to the session daemon.
136 *
137 * On success, returns the number of bytes sent (>=0)
138 * On error, returns -1
139 */
140 static int send_session_varlen(const void *data, size_t len)
141 {
142 int ret;
143
144 if (!connected) {
145 ret = -LTTNG_ERR_NO_SESSIOND;
146 goto end;
147 }
148
149 if (!data || !len) {
150 ret = 0;
151 goto end;
152 }
153
154 ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
155 if (ret < 0) {
156 ret = -LTTNG_ERR_FATAL;
157 }
158
159 end:
160 return ret;
161 }
162
163 /*
164 * Send file descriptors to the session daemon.
165 *
166 * On success, returns the number of bytes sent (>=0)
167 * On error, returns -1
168 */
169 static int send_session_fds(const int *fds, size_t nb_fd)
170 {
171 int ret;
172
173 if (!connected) {
174 ret = -LTTNG_ERR_NO_SESSIOND;
175 goto end;
176 }
177
178 if (!fds || !nb_fd) {
179 ret = 0;
180 goto end;
181 }
182
183 ret = lttcomm_send_fds_unix_sock(sessiond_socket, fds, nb_fd);
184 if (ret < 0) {
185 ret = -LTTNG_ERR_FATAL;
186 }
187
188 end:
189 return ret;
190 }
191
192 /*
193 * Receive data from the sessiond socket.
194 *
195 * On success, returns the number of bytes received (>=0)
196 * On error, returns a negative lttng_error_code.
197 */
198 static int recv_data_sessiond(void *buf, size_t len)
199 {
200 int ret;
201
202 assert(len > 0);
203
204 if (!connected) {
205 ret = -LTTNG_ERR_NO_SESSIOND;
206 goto end;
207 }
208
209 ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len);
210 if (ret < 0) {
211 ret = -LTTNG_ERR_FATAL;
212 } else if (ret == 0) {
213 ret = -LTTNG_ERR_NO_SESSIOND;
214 }
215
216 end:
217 return ret;
218 }
219
220 /*
221 * Receive a payload from the session daemon by appending to an existing
222 * payload.
223 * On success, returns the number of bytes received (>=0)
224 * On error, returns a negative lttng_error_code.
225 */
226 static int recv_payload_sessiond(struct lttng_payload *payload, size_t len)
227 {
228 int ret;
229 const size_t original_payload_size = payload->buffer.size;
230
231 ret = lttng_dynamic_buffer_set_size(
232 &payload->buffer, payload->buffer.size + len);
233 if (ret) {
234 ret = -LTTNG_ERR_NOMEM;
235 goto end;
236 }
237
238 ret = recv_data_sessiond(
239 payload->buffer.data + original_payload_size, len);
240 end:
241 return ret;
242 }
243
244 /*
245 * Check if we are in the specified group.
246 *
247 * If yes return 1, else return -1.
248 */
249 LTTNG_HIDDEN
250 int lttng_check_tracing_group(void)
251 {
252 gid_t *grp_list, tracing_gid;
253 int grp_list_size, grp_id, i;
254 int ret = -1;
255 const char *grp_name = tracing_group;
256
257 /* Get GID of group 'tracing' */
258 if (utils_get_group_id(grp_name, false, &tracing_gid)) {
259 /* If grp_tracing is NULL, the group does not exist. */
260 goto end;
261 }
262
263 /* Get number of supplementary group IDs */
264 grp_list_size = getgroups(0, NULL);
265 if (grp_list_size < 0) {
266 PERROR("getgroups");
267 goto end;
268 }
269
270 /* Alloc group list of the right size */
271 grp_list = zmalloc(grp_list_size * sizeof(gid_t));
272 if (!grp_list) {
273 PERROR("malloc");
274 goto end;
275 }
276 grp_id = getgroups(grp_list_size, grp_list);
277 if (grp_id < 0) {
278 PERROR("getgroups");
279 goto free_list;
280 }
281
282 for (i = 0; i < grp_list_size; i++) {
283 if (grp_list[i] == tracing_gid) {
284 ret = 1;
285 break;
286 }
287 }
288
289 free_list:
290 free(grp_list);
291
292 end:
293 return ret;
294 }
295
296 static enum lttng_error_code check_enough_available_memory(
297 uint64_t num_bytes_requested_per_cpu)
298 {
299 int ret;
300 enum lttng_error_code ret_code;
301 long num_cpu;
302 uint64_t best_mem_info;
303 uint64_t num_bytes_requested_total;
304
305 /*
306 * Get the number of CPU currently online to compute the amount of
307 * memory needed to create a buffer for every CPU.
308 */
309 num_cpu = sysconf(_SC_NPROCESSORS_ONLN);
310 if (num_cpu == -1) {
311 ret_code = LTTNG_ERR_FATAL;
312 goto end;
313 }
314
315 if (num_bytes_requested_per_cpu > UINT64_MAX / (uint64_t) num_cpu) {
316 /* Overflow */
317 ret_code = LTTNG_ERR_OVERFLOW;
318 goto end;
319 }
320
321 num_bytes_requested_total =
322 num_bytes_requested_per_cpu * (uint64_t) num_cpu;
323
324 /*
325 * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
326 * reliable estimate we can get but it is only exposed by the kernel
327 * since 3.14. (See Linux kernel commit:
328 * 34e431b0ae398fc54ea69ff85ec700722c9da773)
329 */
330 ret = utils_get_memory_available(&best_mem_info);
331 if (ret >= 0) {
332 goto success;
333 }
334
335 /*
336 * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This
337 * is a sanity check for obvious user error.
338 */
339 ret = utils_get_memory_total(&best_mem_info);
340 if (ret >= 0) {
341 goto success;
342 }
343
344 /* No valid source of information. */
345 ret_code = LTTNG_ERR_NOMEM;
346 goto end;
347
348 success:
349 if (best_mem_info >= num_bytes_requested_total) {
350 ret_code = LTTNG_OK;
351 } else {
352 ret_code = LTTNG_ERR_NOMEM;
353 }
354 end:
355 return ret_code;
356 }
357
358 /*
359 * Try connect to session daemon with sock_path.
360 *
361 * Return 0 on success, else -1
362 */
363 static int try_connect_sessiond(const char *sock_path)
364 {
365 int ret;
366
367 /* If socket exist, we check if the daemon listens for connect. */
368 ret = access(sock_path, F_OK);
369 if (ret < 0) {
370 /* Not alive */
371 goto error;
372 }
373
374 ret = lttcomm_connect_unix_sock(sock_path);
375 if (ret < 0) {
376 /* Not alive. */
377 goto error;
378 }
379
380 ret = lttcomm_close_unix_sock(ret);
381 if (ret < 0) {
382 PERROR("lttcomm_close_unix_sock");
383 }
384
385 return 0;
386
387 error:
388 return -1;
389 }
390
391 /*
392 * Set sessiond socket path by putting it in the global sessiond_sock_path
393 * variable.
394 *
395 * Returns 0 on success, negative value on failure (the sessiond socket path
396 * is somehow too long or ENOMEM).
397 */
398 static int set_session_daemon_path(void)
399 {
400 int in_tgroup = 0; /* In tracing group. */
401 uid_t uid;
402
403 uid = getuid();
404
405 if (uid != 0) {
406 /* Are we in the tracing group ? */
407 in_tgroup = lttng_check_tracing_group();
408 }
409
410 if ((uid == 0) || in_tgroup == 1) {
411 const int ret = lttng_strncpy(sessiond_sock_path,
412 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK,
413 sizeof(sessiond_sock_path));
414
415 if (ret) {
416 goto error;
417 }
418 }
419
420 if (uid != 0) {
421 int ret;
422
423 if (in_tgroup) {
424 /* Tracing group. */
425 ret = try_connect_sessiond(sessiond_sock_path);
426 if (ret >= 0) {
427 goto end;
428 }
429 /* Global session daemon not available... */
430 }
431 /* ...or not in tracing group (and not root), default */
432
433 /*
434 * With GNU C < 2.1, snprintf returns -1 if the target buffer
435 * is too small;
436 * With GNU C >= 2.1, snprintf returns the required size
437 * (excluding closing null)
438 */
439 ret = snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
440 DEFAULT_HOME_CLIENT_UNIX_SOCK, utils_get_home_dir());
441 if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) {
442 goto error;
443 }
444 }
445 end:
446 return 0;
447
448 error:
449 return -1;
450 }
451
452 /*
453 * Connect to the LTTng session daemon.
454 *
455 * On success, return the socket's file descriptor. On error, return -1.
456 */
457 LTTNG_HIDDEN int connect_sessiond(void)
458 {
459 int ret;
460
461 ret = set_session_daemon_path();
462 if (ret < 0) {
463 goto error;
464 }
465
466 /* Connect to the sesssion daemon. */
467 ret = lttcomm_connect_unix_sock(sessiond_sock_path);
468 if (ret < 0) {
469 goto error;
470 }
471
472 return ret;
473
474 error:
475 return -1;
476 }
477
478 static void reset_global_sessiond_connection_state(void)
479 {
480 sessiond_socket = -1;
481 connected = 0;
482 }
483
484 /*
485 * Clean disconnect from the session daemon.
486 *
487 * On success, return 0. On error, return -1.
488 */
489 static int disconnect_sessiond(void)
490 {
491 int ret = 0;
492
493 if (connected) {
494 ret = lttcomm_close_unix_sock(sessiond_socket);
495 reset_global_sessiond_connection_state();
496 }
497
498 return ret;
499 }
500
501 static int recv_sessiond_optional_data(size_t len, void **user_buf,
502 size_t *user_len)
503 {
504 int ret = 0;
505 void *buf = NULL;
506
507 if (len) {
508 if (!user_len) {
509 ret = -LTTNG_ERR_INVALID;
510 goto end;
511 }
512
513 buf = zmalloc(len);
514 if (!buf) {
515 ret = -ENOMEM;
516 goto end;
517 }
518
519 ret = recv_data_sessiond(buf, len);
520 if (ret < 0) {
521 goto end;
522 }
523
524 if (!user_buf) {
525 ret = -LTTNG_ERR_INVALID;
526 goto end;
527 }
528
529 /* Move ownership of command header buffer to user. */
530 *user_buf = buf;
531 buf = NULL;
532 *user_len = len;
533 } else {
534 /* No command header. */
535 if (user_len) {
536 *user_len = 0;
537 }
538
539 if (user_buf) {
540 *user_buf = NULL;
541 }
542 }
543
544 end:
545 free(buf);
546 return ret;
547 }
548
549 /*
550 * Ask the session daemon a specific command and put the data into buf.
551 * Takes extra var. len. data and file descriptors as input to send to the
552 * session daemon.
553 *
554 * Return size of data (only payload, not header) or a negative error code.
555 */
556 LTTNG_HIDDEN
557 int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg *lsm,
558 const int *fds, size_t nb_fd, const void *vardata,
559 size_t vardata_len, void **user_payload_buf,
560 void **user_cmd_header_buf, size_t *user_cmd_header_len)
561 {
562 int ret;
563 size_t payload_len;
564 struct lttcomm_lttng_msg llm;
565
566 ret = connect_sessiond();
567 if (ret < 0) {
568 ret = -LTTNG_ERR_NO_SESSIOND;
569 goto end;
570 } else {
571 sessiond_socket = ret;
572 connected = 1;
573 }
574
575 ret = send_session_msg(lsm);
576 if (ret < 0) {
577 /* Ret value is a valid lttng error code. */
578 goto end;
579 }
580 /* Send var len data */
581 ret = send_session_varlen(vardata, vardata_len);
582 if (ret < 0) {
583 /* Ret value is a valid lttng error code. */
584 goto end;
585 }
586
587 /* Send fds */
588 ret = send_session_fds(fds, nb_fd);
589 if (ret < 0) {
590 /* Ret value is a valid lttng error code. */
591 goto end;
592 }
593
594 /* Get header from data transmission */
595 ret = recv_data_sessiond(&llm, sizeof(llm));
596 if (ret < 0) {
597 /* Ret value is a valid lttng error code. */
598 goto end;
599 }
600
601 /* Check error code if OK */
602 if (llm.ret_code != LTTNG_OK) {
603 ret = -llm.ret_code;
604 goto end;
605 }
606
607 /* Get command header from data transmission */
608 ret = recv_sessiond_optional_data(llm.cmd_header_size,
609 user_cmd_header_buf, user_cmd_header_len);
610 if (ret < 0) {
611 goto end;
612 }
613
614 /* Get payload from data transmission */
615 ret = recv_sessiond_optional_data(llm.data_size, user_payload_buf,
616 &payload_len);
617 if (ret < 0) {
618 goto end;
619 }
620
621 ret = llm.data_size;
622
623 end:
624 disconnect_sessiond();
625 return ret;
626 }
627
628 LTTNG_HIDDEN
629 int lttng_ctl_ask_sessiond_payload(struct lttng_payload_view *message,
630 struct lttng_payload *reply)
631 {
632 int ret;
633 struct lttcomm_lttng_msg llm;
634 const int fd_count = lttng_payload_view_get_fd_handle_count(message);
635
636 assert(reply->buffer.size == 0);
637 assert(lttng_dynamic_pointer_array_get_count(&reply->_fd_handles) == 0);
638
639 ret = connect_sessiond();
640 if (ret < 0) {
641 ret = -LTTNG_ERR_NO_SESSIOND;
642 goto end;
643 } else {
644 sessiond_socket = ret;
645 connected = 1;
646 }
647
648 /* Send command to session daemon */
649 ret = lttcomm_send_creds_unix_sock(sessiond_socket, message->buffer.data,
650 message->buffer.size);
651 if (ret < 0) {
652 ret = -LTTNG_ERR_FATAL;
653 goto end;
654 }
655
656 if (fd_count > 0) {
657 ret = lttcomm_send_payload_view_fds_unix_sock(sessiond_socket,
658 message);
659 if (ret < 0) {
660 ret = -LTTNG_ERR_FATAL;
661 goto end;
662 }
663 }
664
665 /* Get header from data transmission */
666 ret = recv_payload_sessiond(reply, sizeof(llm));
667 if (ret < 0) {
668 /* Ret value is a valid lttng error code. */
669 goto end;
670 }
671
672 llm = *((typeof(llm) *) reply->buffer.data);
673
674 /* Check error code if OK */
675 if (llm.ret_code != LTTNG_OK) {
676 if (llm.ret_code < LTTNG_OK || llm.ret_code >= LTTNG_ERR_NR) {
677 /* Invalid error code received. */
678 ret = -LTTNG_ERR_UNK;
679 } else {
680 ret = -llm.ret_code;
681 }
682 goto end;
683 }
684
685 if (llm.cmd_header_size > 0) {
686 ret = recv_payload_sessiond(reply, llm.cmd_header_size);
687 if (ret < 0) {
688 goto end;
689 }
690 }
691
692 /* Get command header from data transmission */
693 if (llm.data_size > 0) {
694 ret = recv_payload_sessiond(reply, llm.data_size);
695 if (ret < 0) {
696 goto end;
697 }
698 }
699
700 if (llm.fd_count > 0) {
701 ret = lttcomm_recv_payload_fds_unix_sock(
702 sessiond_socket, llm.fd_count, reply);
703 if (ret < 0) {
704 goto end;
705 }
706 }
707
708 /* Don't return the llm header to the caller. */
709 memmove(reply->buffer.data, reply->buffer.data + sizeof(llm),
710 reply->buffer.size - sizeof(llm));
711 ret = lttng_dynamic_buffer_set_size(
712 &reply->buffer, reply->buffer.size - sizeof(llm));
713 if (ret) {
714 /* Can't happen as size is reduced. */
715 abort();
716 }
717
718 ret = reply->buffer.size;
719
720 end:
721 disconnect_sessiond();
722 return ret;
723 }
724
725 /*
726 * Create lttng handle and return pointer.
727 *
728 * The returned pointer will be NULL in case of malloc() error.
729 */
730 struct lttng_handle *lttng_create_handle(const char *session_name,
731 struct lttng_domain *domain)
732 {
733 int ret;
734 struct lttng_handle *handle = NULL;
735
736 handle = zmalloc(sizeof(struct lttng_handle));
737 if (handle == NULL) {
738 PERROR("malloc handle");
739 goto end;
740 }
741
742 /* Copy session name */
743 ret = lttng_strncpy(handle->session_name, session_name ? : "",
744 sizeof(handle->session_name));
745 if (ret) {
746 goto error;
747 }
748
749 /* Copy lttng domain or leave initialized to 0. */
750 if (domain) {
751 lttng_ctl_copy_lttng_domain(&handle->domain, domain);
752 }
753
754 end:
755 return handle;
756 error:
757 free(handle);
758 return NULL;
759 }
760
761 /*
762 * Destroy handle by free(3) the pointer.
763 */
764 void lttng_destroy_handle(struct lttng_handle *handle)
765 {
766 free(handle);
767 }
768
769 /*
770 * Register an outside consumer.
771 *
772 * Returns size of returned session payload data or a negative error code.
773 */
774 int lttng_register_consumer(struct lttng_handle *handle,
775 const char *socket_path)
776 {
777 int ret;
778 struct lttcomm_session_msg lsm;
779
780 if (handle == NULL || socket_path == NULL) {
781 ret = -LTTNG_ERR_INVALID;
782 goto end;
783 }
784
785 memset(&lsm, 0, sizeof(lsm));
786 lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
787 ret = lttng_strncpy(lsm.session.name, handle->session_name,
788 sizeof(lsm.session.name));
789 if (ret) {
790 ret = -LTTNG_ERR_INVALID;
791 goto end;
792 }
793
794 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
795
796 ret = lttng_strncpy(lsm.u.reg.path, socket_path,
797 sizeof(lsm.u.reg.path));
798 if (ret) {
799 ret = -LTTNG_ERR_INVALID;
800 goto end;
801 }
802
803 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
804 end:
805 return ret;
806 }
807
808 /*
809 * Start tracing for all traces of the session.
810 *
811 * Returns size of returned session payload data or a negative error code.
812 */
813 int lttng_start_tracing(const char *session_name)
814 {
815 int ret;
816 struct lttcomm_session_msg lsm;
817
818 if (session_name == NULL) {
819 ret = -LTTNG_ERR_INVALID;
820 goto end;
821 }
822
823 memset(&lsm, 0, sizeof(lsm));
824 lsm.cmd_type = LTTNG_START_TRACE;
825
826 ret = lttng_strncpy(lsm.session.name, session_name,
827 sizeof(lsm.session.name));
828 if (ret) {
829 ret = -LTTNG_ERR_INVALID;
830 goto end;
831 }
832
833 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
834 end:
835 return ret;
836 }
837
838 /*
839 * Stop tracing for all traces of the session.
840 */
841 static int _lttng_stop_tracing(const char *session_name, int wait)
842 {
843 int ret, data_ret;
844 struct lttcomm_session_msg lsm;
845
846 if (session_name == NULL) {
847 ret = -LTTNG_ERR_INVALID;
848 goto error;
849 }
850
851 memset(&lsm, 0, sizeof(lsm));
852 lsm.cmd_type = LTTNG_STOP_TRACE;
853
854 ret = lttng_strncpy(lsm.session.name, session_name,
855 sizeof(lsm.session.name));
856 if (ret) {
857 ret = -LTTNG_ERR_INVALID;
858 goto error;
859 }
860
861 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
862 if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
863 goto error;
864 }
865
866 if (!wait) {
867 goto end;
868 }
869
870 /* Check for data availability */
871 do {
872 data_ret = lttng_data_pending(session_name);
873 if (data_ret < 0) {
874 /* Return the data available call error. */
875 ret = data_ret;
876 goto error;
877 }
878
879 /*
880 * Data sleep time before retrying (in usec). Don't sleep if the
881 * call returned value indicates availability.
882 */
883 if (data_ret) {
884 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US);
885 }
886 } while (data_ret != 0);
887
888 end:
889 error:
890 return ret;
891 }
892
893 /*
894 * Stop tracing and wait for data availability.
895 */
896 int lttng_stop_tracing(const char *session_name)
897 {
898 return _lttng_stop_tracing(session_name, 1);
899 }
900
901 /*
902 * Stop tracing but _don't_ wait for data availability.
903 */
904 int lttng_stop_tracing_no_wait(const char *session_name)
905 {
906 return _lttng_stop_tracing(session_name, 0);
907 }
908
909 /*
910 * Add context to a channel.
911 *
912 * If the given channel is NULL, add the contexts to all channels.
913 * The event_name param is ignored.
914 *
915 * Returns the size of the returned payload data or a negative error code.
916 */
917 int lttng_add_context(struct lttng_handle *handle,
918 struct lttng_event_context *ctx, const char *event_name,
919 const char *channel_name)
920 {
921 int ret;
922 size_t len = 0;
923 char *buf = NULL;
924 struct lttcomm_session_msg lsm;
925
926 /* Safety check. Both are mandatory. */
927 if (handle == NULL || ctx == NULL) {
928 ret = -LTTNG_ERR_INVALID;
929 goto end;
930 }
931
932 memset(&lsm, 0, sizeof(lsm));
933 lsm.cmd_type = LTTNG_ADD_CONTEXT;
934
935 /* If no channel name, send empty string. */
936 ret = lttng_strncpy(lsm.u.context.channel_name, channel_name ?: "",
937 sizeof(lsm.u.context.channel_name));
938 if (ret) {
939 ret = -LTTNG_ERR_INVALID;
940 goto end;
941 }
942
943 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
944 ret = lttng_strncpy(lsm.session.name, handle->session_name,
945 sizeof(lsm.session.name));
946 if (ret) {
947 ret = -LTTNG_ERR_INVALID;
948 goto end;
949 }
950
951 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
952 size_t provider_len, ctx_len;
953 const char *provider_name = ctx->u.app_ctx.provider_name;
954 const char *ctx_name = ctx->u.app_ctx.ctx_name;
955
956 if (!provider_name || !ctx_name) {
957 ret = -LTTNG_ERR_INVALID;
958 goto end;
959 }
960
961 provider_len = strlen(provider_name);
962 if (provider_len == 0) {
963 ret = -LTTNG_ERR_INVALID;
964 goto end;
965 }
966 lsm.u.context.provider_name_len = provider_len;
967
968 ctx_len = strlen(ctx_name);
969 if (ctx_len == 0) {
970 ret = -LTTNG_ERR_INVALID;
971 goto end;
972 }
973 lsm.u.context.context_name_len = ctx_len;
974
975 len = provider_len + ctx_len;
976 buf = zmalloc(len);
977 if (!buf) {
978 ret = -LTTNG_ERR_NOMEM;
979 goto end;
980 }
981
982 memcpy(buf, provider_name, provider_len);
983 memcpy(buf + provider_len, ctx_name, ctx_len);
984 }
985 memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context));
986
987 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
988 /*
989 * Don't leak application addresses to the sessiond.
990 * This is only necessary when ctx is for an app ctx otherwise
991 * the values inside the union (type & config) are overwritten.
992 */
993 lsm.u.context.ctx.u.app_ctx.provider_name = NULL;
994 lsm.u.context.ctx.u.app_ctx.ctx_name = NULL;
995 }
996
997 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, buf, len, NULL);
998 end:
999 free(buf);
1000 return ret;
1001 }
1002
1003 /*
1004 * Enable event(s) for a channel.
1005 *
1006 * If no event name is specified, all events are enabled.
1007 * If no channel name is specified, the default 'channel0' is used.
1008 *
1009 * Returns size of returned session payload data or a negative error code.
1010 */
1011 int lttng_enable_event(struct lttng_handle *handle,
1012 struct lttng_event *ev, const char *channel_name)
1013 {
1014 return lttng_enable_event_with_exclusions(handle, ev, channel_name,
1015 NULL, 0, NULL);
1016 }
1017
1018 /*
1019 * Create or enable an event with a filter expression.
1020 *
1021 * Return negative error value on error.
1022 * Return size of returned session payload data if OK.
1023 */
1024 int lttng_enable_event_with_filter(struct lttng_handle *handle,
1025 struct lttng_event *event, const char *channel_name,
1026 const char *filter_expression)
1027 {
1028 return lttng_enable_event_with_exclusions(handle, event, channel_name,
1029 filter_expression, 0, NULL);
1030 }
1031
1032 /*
1033 * Depending on the event, return a newly allocated agent filter expression or
1034 * NULL if not applicable.
1035 *
1036 * An event with NO loglevel and the name is * will return NULL.
1037 */
1038 static char *set_agent_filter(const char *filter, struct lttng_event *ev)
1039 {
1040 int err;
1041 char *agent_filter = NULL;
1042
1043 assert(ev);
1044
1045 /* Don't add filter for the '*' event. */
1046 if (strcmp(ev->name, "*") != 0) {
1047 if (filter) {
1048 err = asprintf(&agent_filter, "(%s) && (logger_name == \"%s\")", filter,
1049 ev->name);
1050 } else {
1051 err = asprintf(&agent_filter, "logger_name == \"%s\"", ev->name);
1052 }
1053 if (err < 0) {
1054 PERROR("asprintf");
1055 goto error;
1056 }
1057 }
1058
1059 /* Add loglevel filtering if any for the JUL domain. */
1060 if (ev->loglevel_type != LTTNG_EVENT_LOGLEVEL_ALL) {
1061 const char *op;
1062
1063 if (ev->loglevel_type == LTTNG_EVENT_LOGLEVEL_RANGE) {
1064 op = ">=";
1065 } else {
1066 op = "==";
1067 }
1068
1069 if (filter || agent_filter) {
1070 char *new_filter;
1071
1072 err = asprintf(&new_filter, "(%s) && (int_loglevel %s %d)",
1073 agent_filter ? agent_filter : filter, op,
1074 ev->loglevel);
1075 if (agent_filter) {
1076 free(agent_filter);
1077 }
1078 agent_filter = new_filter;
1079 } else {
1080 err = asprintf(&agent_filter, "int_loglevel %s %d", op,
1081 ev->loglevel);
1082 }
1083 if (err < 0) {
1084 PERROR("asprintf");
1085 goto error;
1086 }
1087 }
1088
1089 return agent_filter;
1090 error:
1091 free(agent_filter);
1092 return NULL;
1093 }
1094
1095 /*
1096 * Enable event(s) for a channel, possibly with exclusions and a filter.
1097 * If no event name is specified, all events are enabled.
1098 * If no channel name is specified, the default name is used.
1099 * If filter expression is not NULL, the filter is set for the event.
1100 * If exclusion count is not zero, the exclusions are set for the event.
1101 * Returns size of returned session payload data or a negative error code.
1102 */
1103 int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
1104 struct lttng_event *ev, const char *channel_name,
1105 const char *original_filter_expression,
1106 int exclusion_count, char **exclusion_list)
1107 {
1108 struct lttcomm_session_msg lsm;
1109 struct lttng_payload payload;
1110 int ret = 0, i;
1111 unsigned int free_filter_expression = 0;
1112 struct filter_parser_ctx *ctx = NULL;
1113
1114 /*
1115 * We have either a filter or some exclusions, so we need to set up
1116 * a variable-length payload from where to send the data.
1117 */
1118 lttng_payload_init(&payload);
1119
1120 /*
1121 * Cast as non-const since we may replace the filter expression
1122 * by a dynamically allocated string. Otherwise, the original
1123 * string is not modified.
1124 */
1125 char *filter_expression = (char *) original_filter_expression;
1126
1127 if (handle == NULL || ev == NULL) {
1128 ret = -LTTNG_ERR_INVALID;
1129 goto error;
1130 }
1131
1132 /*
1133 * Empty filter string will always be rejected by the parser
1134 * anyway, so treat this corner-case early to eliminate
1135 * lttng_fmemopen error for 0-byte allocation.
1136 */
1137 if (filter_expression && filter_expression[0] == '\0') {
1138 ret = -LTTNG_ERR_INVALID;
1139 goto error;
1140 }
1141
1142 memset(&lsm, 0, sizeof(lsm));
1143
1144 /* If no channel name, send empty string. */
1145 ret = lttng_strncpy(lsm.u.enable.channel_name, channel_name ?: "",
1146 sizeof(lsm.u.enable.channel_name));
1147 if (ret) {
1148 ret = -LTTNG_ERR_INVALID;
1149 goto error;
1150 }
1151
1152 lsm.cmd_type = LTTNG_ENABLE_EVENT;
1153 if (ev->name[0] == '\0') {
1154 /* Enable all events. */
1155 ret = lttng_strncpy(ev->name, "*", sizeof(ev->name));
1156 assert(ret == 0);
1157 }
1158
1159 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1160 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
1161
1162 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1163 sizeof(lsm.session.name));
1164 if (ret) {
1165 ret = -LTTNG_ERR_INVALID;
1166 goto error;
1167 }
1168
1169 lsm.u.enable.exclusion_count = exclusion_count;
1170 lsm.u.enable.bytecode_len = 0;
1171
1172 /* Parse filter expression. */
1173 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1174 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1175 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1176 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1177 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1178 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1179 char *agent_filter;
1180
1181 /* Setup JUL filter if needed. */
1182 agent_filter = set_agent_filter(filter_expression, ev);
1183 if (!agent_filter) {
1184 if (!filter_expression) {
1185 /*
1186 * No JUL and no filter, just skip
1187 * everything below.
1188 */
1189 goto ask_sessiond;
1190 }
1191 } else {
1192 /*
1193 * With an agent filter, the original filter has
1194 * been added to it thus replace the filter
1195 * expression.
1196 */
1197 filter_expression = agent_filter;
1198 free_filter_expression = 1;
1199 }
1200 }
1201
1202 ret = filter_parser_ctx_create_from_filter_expression(filter_expression, &ctx);
1203 if (ret) {
1204 goto filter_error;
1205 }
1206
1207 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
1208 + bytecode_get_len(&ctx->bytecode->b);
1209 lsm.u.enable.expression_len = strlen(filter_expression) + 1;
1210 }
1211
1212 ret = lttng_dynamic_buffer_set_capacity(&payload.buffer,
1213 lsm.u.enable.bytecode_len +
1214 lsm.u.enable.expression_len +
1215 LTTNG_SYMBOL_NAME_LEN *
1216 exclusion_count);
1217 if (ret) {
1218 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1219 goto mem_error;
1220 }
1221
1222 /* Put exclusion names first in the data. */
1223 for (i = 0; i < exclusion_count; i++) {
1224 size_t exclusion_len;
1225
1226 exclusion_len = lttng_strnlen(exclusion_list[i],
1227 LTTNG_SYMBOL_NAME_LEN);
1228 if (exclusion_len == LTTNG_SYMBOL_NAME_LEN) {
1229 /* Exclusion is not NULL-terminated. */
1230 ret = -LTTNG_ERR_INVALID;
1231 goto mem_error;
1232 }
1233
1234 ret = lttng_dynamic_buffer_append(&payload.buffer,
1235 exclusion_list[i], exclusion_len);
1236 if (ret) {
1237 goto mem_error;
1238 }
1239
1240 /*
1241 * Padding the rest of the entry with zeros. Every exclusion
1242 * entries take LTTNG_SYMBOL_NAME_LEN bytes in the buffer.
1243 */
1244 ret = lttng_dynamic_buffer_set_size(&payload.buffer,
1245 LTTNG_SYMBOL_NAME_LEN * (i + 1));
1246 if (ret) {
1247 goto mem_error;
1248 }
1249 }
1250
1251 /* Add filter expression next. */
1252 if (filter_expression) {
1253 ret = lttng_dynamic_buffer_append(&payload.buffer,
1254 filter_expression, lsm.u.enable.expression_len);
1255 if (ret) {
1256 goto mem_error;
1257 }
1258 }
1259 /* Add filter bytecode next. */
1260 if (ctx && lsm.u.enable.bytecode_len != 0) {
1261 ret = lttng_dynamic_buffer_append(&payload.buffer,
1262 &ctx->bytecode->b, lsm.u.enable.bytecode_len);
1263 if (ret) {
1264 goto mem_error;
1265 }
1266 }
1267 if (ev->extended.ptr) {
1268 struct lttng_event_extended *ev_ext =
1269 (struct lttng_event_extended *) ev->extended.ptr;
1270
1271 if (ev_ext->probe_location) {
1272 /*
1273 * lttng_userspace_probe_location_serialize returns the
1274 * number of bytes that was appended to the buffer.
1275 */
1276 ret = lttng_userspace_probe_location_serialize(
1277 ev_ext->probe_location, &payload);
1278 if (ret < 0) {
1279 goto mem_error;
1280 }
1281
1282 /*
1283 * Set the size of the userspace probe location element
1284 * of the buffer so that the receiving side knows where
1285 * to split it.
1286 */
1287 lsm.u.enable.userspace_probe_location_len = ret;
1288 }
1289 }
1290
1291 {
1292 struct lttng_payload_view view = lttng_payload_view_from_payload(
1293 &payload, 0, -1);
1294 int fd_count = lttng_payload_view_get_fd_handle_count(&view);
1295 int fd_to_send;
1296
1297 if (fd_count < 0) {
1298 goto mem_error;
1299 }
1300
1301 assert(fd_count == 0 || fd_count == 1);
1302 if (fd_count == 1) {
1303 struct fd_handle *h =
1304 lttng_payload_view_pop_fd_handle(&view);
1305
1306 if (!h) {
1307 goto mem_error;
1308 }
1309
1310 fd_to_send = fd_handle_get_fd(h);
1311 fd_handle_put(h);
1312 }
1313
1314 ret = lttng_ctl_ask_sessiond_fds_varlen(&lsm,
1315 fd_count ? &fd_to_send : NULL, fd_count,
1316 view.buffer.size ? view.buffer.data : NULL,
1317 view.buffer.size, NULL, NULL, 0);
1318 }
1319
1320 mem_error:
1321 if (filter_expression && ctx) {
1322 filter_bytecode_free(ctx);
1323 filter_ir_free(ctx);
1324 filter_parser_ctx_free(ctx);
1325 }
1326 filter_error:
1327 if (free_filter_expression) {
1328 /*
1329 * The filter expression has been replaced and must be freed as
1330 * it is not the original filter expression received as a
1331 * parameter.
1332 */
1333 free(filter_expression);
1334 }
1335 error:
1336 /*
1337 * Return directly to the caller and don't ask the sessiond since
1338 * something went wrong in the parsing of data above.
1339 */
1340 lttng_payload_reset(&payload);
1341 return ret;
1342
1343 ask_sessiond:
1344 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1345 return ret;
1346 }
1347
1348 int lttng_disable_event_ext(struct lttng_handle *handle,
1349 struct lttng_event *ev, const char *channel_name,
1350 const char *original_filter_expression)
1351 {
1352 struct lttcomm_session_msg lsm;
1353 char *varlen_data;
1354 int ret = 0;
1355 unsigned int free_filter_expression = 0;
1356 struct filter_parser_ctx *ctx = NULL;
1357 /*
1358 * Cast as non-const since we may replace the filter expression
1359 * by a dynamically allocated string. Otherwise, the original
1360 * string is not modified.
1361 */
1362 char *filter_expression = (char *) original_filter_expression;
1363
1364 if (handle == NULL || ev == NULL) {
1365 ret = -LTTNG_ERR_INVALID;
1366 goto error;
1367 }
1368
1369 /*
1370 * Empty filter string will always be rejected by the parser
1371 * anyway, so treat this corner-case early to eliminate
1372 * lttng_fmemopen error for 0-byte allocation.
1373 */
1374 if (filter_expression && filter_expression[0] == '\0') {
1375 ret = -LTTNG_ERR_INVALID;
1376 goto error;
1377 }
1378
1379 memset(&lsm, 0, sizeof(lsm));
1380
1381 /* If no channel name, send empty string. */
1382 ret = lttng_strncpy(lsm.u.disable.channel_name, channel_name ?: "",
1383 sizeof(lsm.u.disable.channel_name));
1384 if (ret) {
1385 ret = -LTTNG_ERR_INVALID;
1386 goto error;
1387 }
1388
1389 lsm.cmd_type = LTTNG_DISABLE_EVENT;
1390
1391 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1392 memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event));
1393
1394 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1395 sizeof(lsm.session.name));
1396 if (ret) {
1397 ret = -LTTNG_ERR_INVALID;
1398 goto error;
1399 }
1400
1401 lsm.u.disable.bytecode_len = 0;
1402
1403 /*
1404 * For the JUL domain, a filter is enforced except for the
1405 * disable all event. This is done to avoid having the event in
1406 * all sessions thus filtering by logger name.
1407 */
1408 if (filter_expression == NULL &&
1409 (handle->domain.type != LTTNG_DOMAIN_JUL &&
1410 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
1411 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
1412 goto ask_sessiond;
1413 }
1414
1415 /*
1416 * We have a filter, so we need to set up a variable-length
1417 * memory block from where to send the data.
1418 */
1419
1420 /* Parse filter expression */
1421 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1422 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1423 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1424 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1425 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1426 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1427 char *agent_filter;
1428
1429 /* Setup JUL filter if needed. */
1430 agent_filter = set_agent_filter(filter_expression, ev);
1431 if (!agent_filter) {
1432 if (!filter_expression) {
1433 /*
1434 * No JUL and no filter, just skip
1435 * everything below.
1436 */
1437 goto ask_sessiond;
1438 }
1439 } else {
1440 /*
1441 * With a JUL filter, the original filter has
1442 * been added to it thus replace the filter
1443 * expression.
1444 */
1445 filter_expression = agent_filter;
1446 free_filter_expression = 1;
1447 }
1448 }
1449
1450 ret = filter_parser_ctx_create_from_filter_expression(filter_expression, &ctx);
1451 if (ret) {
1452 goto filter_error;
1453 }
1454
1455 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
1456 + bytecode_get_len(&ctx->bytecode->b);
1457 lsm.u.enable.expression_len = strlen(filter_expression) + 1;
1458 }
1459
1460 varlen_data = zmalloc(lsm.u.disable.bytecode_len
1461 + lsm.u.disable.expression_len);
1462 if (!varlen_data) {
1463 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1464 goto mem_error;
1465 }
1466
1467 /* Add filter expression. */
1468 if (lsm.u.disable.expression_len != 0) {
1469 memcpy(varlen_data,
1470 filter_expression,
1471 lsm.u.disable.expression_len);
1472 }
1473 /* Add filter bytecode next. */
1474 if (ctx && lsm.u.disable.bytecode_len != 0) {
1475 memcpy(varlen_data
1476 + lsm.u.disable.expression_len,
1477 &ctx->bytecode->b,
1478 lsm.u.disable.bytecode_len);
1479 }
1480
1481 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, varlen_data,
1482 lsm.u.disable.bytecode_len + lsm.u.disable.expression_len, NULL);
1483 free(varlen_data);
1484
1485 mem_error:
1486 if (filter_expression && ctx) {
1487 filter_bytecode_free(ctx);
1488 filter_ir_free(ctx);
1489 filter_parser_ctx_free(ctx);
1490 }
1491 filter_error:
1492 if (free_filter_expression) {
1493 /*
1494 * The filter expression has been replaced and must be freed as
1495 * it is not the original filter expression received as a
1496 * parameter.
1497 */
1498 free(filter_expression);
1499 }
1500 error:
1501 /*
1502 * Return directly to the caller and don't ask the sessiond since
1503 * something went wrong in the parsing of data above.
1504 */
1505 return ret;
1506
1507 ask_sessiond:
1508 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1509 return ret;
1510 }
1511
1512 /*
1513 * Disable event(s) of a channel and domain.
1514 * If no event name is specified, all events are disabled.
1515 * If no channel name is specified, the default 'channel0' is used.
1516 * Returns size of returned session payload data or a negative error code.
1517 */
1518 int lttng_disable_event(struct lttng_handle *handle, const char *name,
1519 const char *channel_name)
1520 {
1521 int ret;
1522 struct lttng_event ev;
1523
1524 memset(&ev, 0, sizeof(ev));
1525 ev.loglevel = -1;
1526 ev.type = LTTNG_EVENT_ALL;
1527 ret = lttng_strncpy(ev.name, name ?: "", sizeof(ev.name));
1528 if (ret) {
1529 ret = -LTTNG_ERR_INVALID;
1530 goto end;
1531 }
1532
1533 ret = lttng_disable_event_ext(handle, &ev, channel_name, NULL);
1534 end:
1535 return ret;
1536 }
1537
1538 struct lttng_channel *lttng_channel_create(struct lttng_domain *domain)
1539 {
1540 struct lttng_channel *channel = NULL;
1541 struct lttng_channel_extended *extended = NULL;
1542
1543 if (!domain) {
1544 goto error;
1545 }
1546
1547 /* Validate domain. */
1548 switch (domain->type) {
1549 case LTTNG_DOMAIN_UST:
1550 switch (domain->buf_type) {
1551 case LTTNG_BUFFER_PER_UID:
1552 case LTTNG_BUFFER_PER_PID:
1553 break;
1554 default:
1555 goto error;
1556 }
1557 break;
1558 case LTTNG_DOMAIN_KERNEL:
1559 if (domain->buf_type != LTTNG_BUFFER_GLOBAL) {
1560 goto error;
1561 }
1562 break;
1563 default:
1564 goto error;
1565 }
1566
1567 channel = zmalloc(sizeof(*channel));
1568 if (!channel) {
1569 goto error;
1570 }
1571
1572 extended = zmalloc(sizeof(*extended));
1573 if (!extended) {
1574 goto error;
1575 }
1576
1577 channel->attr.extended.ptr = extended;
1578
1579 lttng_channel_set_default_attr(domain, &channel->attr);
1580 return channel;
1581 error:
1582 free(channel);
1583 free(extended);
1584 return NULL;
1585 }
1586
1587 void lttng_channel_destroy(struct lttng_channel *channel)
1588 {
1589 if (!channel) {
1590 return;
1591 }
1592
1593 if (channel->attr.extended.ptr) {
1594 free(channel->attr.extended.ptr);
1595 }
1596 free(channel);
1597 }
1598
1599 /*
1600 * Enable channel per domain
1601 * Returns size of returned session payload data or a negative error code.
1602 */
1603 int lttng_enable_channel(struct lttng_handle *handle,
1604 struct lttng_channel *in_chan)
1605 {
1606 enum lttng_error_code ret_code;
1607 int ret;
1608 struct lttcomm_session_msg lsm;
1609 uint64_t total_buffer_size_needed_per_cpu = 0;
1610
1611 /* NULL arguments are forbidden. No default values. */
1612 if (handle == NULL || in_chan == NULL) {
1613 return -LTTNG_ERR_INVALID;
1614 }
1615
1616 memset(&lsm, 0, sizeof(lsm));
1617 memcpy(&lsm.u.channel.chan, in_chan, sizeof(lsm.u.channel.chan));
1618 lsm.u.channel.chan.attr.extended.ptr = NULL;
1619
1620 if (!in_chan->attr.extended.ptr) {
1621 struct lttng_channel *channel;
1622 struct lttng_channel_extended *extended;
1623
1624 channel = lttng_channel_create(&handle->domain);
1625 if (!channel) {
1626 return -LTTNG_ERR_NOMEM;
1627 }
1628
1629 /*
1630 * Create a new channel in order to use default extended
1631 * attribute values.
1632 */
1633 extended = (struct lttng_channel_extended *)
1634 channel->attr.extended.ptr;
1635 memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
1636 lttng_channel_destroy(channel);
1637 } else {
1638 struct lttng_channel_extended *extended;
1639
1640 extended = (struct lttng_channel_extended *)
1641 in_chan->attr.extended.ptr;
1642 memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
1643 }
1644
1645 /*
1646 * Verify that the amount of memory required to create the requested
1647 * buffer is available on the system at the moment.
1648 */
1649 if (lsm.u.channel.chan.attr.num_subbuf >
1650 UINT64_MAX / lsm.u.channel.chan.attr.subbuf_size) {
1651 /* Overflow */
1652 ret = -LTTNG_ERR_OVERFLOW;
1653 goto end;
1654 }
1655
1656 total_buffer_size_needed_per_cpu = lsm.u.channel.chan.attr.num_subbuf *
1657 lsm.u.channel.chan.attr.subbuf_size;
1658 ret_code = check_enough_available_memory(
1659 total_buffer_size_needed_per_cpu);
1660 if (ret_code != LTTNG_OK) {
1661 ret = -ret_code;
1662 goto end;
1663 }
1664
1665 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
1666 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1667
1668 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1669 sizeof(lsm.session.name));
1670 if (ret) {
1671 ret = -LTTNG_ERR_INVALID;
1672 goto end;
1673 }
1674
1675 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1676 end:
1677 return ret;
1678 }
1679
1680 /*
1681 * All tracing will be stopped for registered events of the channel.
1682 * Returns size of returned session payload data or a negative error code.
1683 */
1684 int lttng_disable_channel(struct lttng_handle *handle, const char *name)
1685 {
1686 int ret;
1687 struct lttcomm_session_msg lsm;
1688
1689 /* Safety check. Both are mandatory. */
1690 if (handle == NULL || name == NULL) {
1691 return -LTTNG_ERR_INVALID;
1692 }
1693
1694 memset(&lsm, 0, sizeof(lsm));
1695
1696 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1697
1698 ret = lttng_strncpy(lsm.u.disable.channel_name, name,
1699 sizeof(lsm.u.disable.channel_name));
1700 if (ret) {
1701 ret = -LTTNG_ERR_INVALID;
1702 goto end;
1703 }
1704
1705 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1706
1707 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1708 sizeof(lsm.session.name));
1709 if (ret) {
1710 ret = -LTTNG_ERR_INVALID;
1711 goto end;
1712 }
1713
1714 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1715 end:
1716 return ret;
1717 }
1718
1719 /*
1720 * Lists all available tracepoints of domain.
1721 * Sets the contents of the events array.
1722 * Returns the number of lttng_event entries in events;
1723 * on error, returns a negative value.
1724 */
1725 int lttng_list_tracepoints(struct lttng_handle *handle,
1726 struct lttng_event **events)
1727 {
1728 int ret;
1729 struct lttcomm_session_msg lsm;
1730
1731 if (handle == NULL) {
1732 return -LTTNG_ERR_INVALID;
1733 }
1734
1735 memset(&lsm, 0, sizeof(lsm));
1736 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
1737 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1738
1739 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1740 if (ret < 0) {
1741 return ret;
1742 }
1743
1744 return ret / sizeof(struct lttng_event);
1745 }
1746
1747 /*
1748 * Lists all available tracepoint fields of domain.
1749 * Sets the contents of the event field array.
1750 * Returns the number of lttng_event_field entries in events;
1751 * on error, returns a negative value.
1752 */
1753 int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1754 struct lttng_event_field **fields)
1755 {
1756 int ret;
1757 struct lttcomm_session_msg lsm;
1758
1759 if (handle == NULL) {
1760 return -LTTNG_ERR_INVALID;
1761 }
1762
1763 memset(&lsm, 0, sizeof(lsm));
1764 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
1765 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1766
1767 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
1768 if (ret < 0) {
1769 return ret;
1770 }
1771
1772 return ret / sizeof(struct lttng_event_field);
1773 }
1774
1775 /*
1776 * Lists all available kernel system calls. Allocates and sets the contents of
1777 * the events array.
1778 *
1779 * Returns the number of lttng_event entries in events; on error, returns a
1780 * negative value.
1781 */
1782 int lttng_list_syscalls(struct lttng_event **events)
1783 {
1784 int ret;
1785 struct lttcomm_session_msg lsm;
1786
1787 if (!events) {
1788 return -LTTNG_ERR_INVALID;
1789 }
1790
1791 memset(&lsm, 0, sizeof(lsm));
1792 lsm.cmd_type = LTTNG_LIST_SYSCALLS;
1793 /* Force kernel domain for system calls. */
1794 lsm.domain.type = LTTNG_DOMAIN_KERNEL;
1795
1796 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1797 if (ret < 0) {
1798 return ret;
1799 }
1800
1801 return ret / sizeof(struct lttng_event);
1802 }
1803
1804 /*
1805 * Returns a human readable string describing
1806 * the error code (a negative value).
1807 */
1808 const char *lttng_strerror(int code)
1809 {
1810 return error_get_str(code);
1811 }
1812
1813 enum lttng_error_code lttng_create_session_ext(
1814 struct lttng_session_descriptor *session_descriptor)
1815 {
1816 enum lttng_error_code ret_code;
1817 struct lttcomm_session_msg lsm = {
1818 .cmd_type = LTTNG_CREATE_SESSION_EXT,
1819 };
1820 void *reply = NULL;
1821 struct lttng_buffer_view reply_view;
1822 int reply_ret;
1823 bool sessiond_must_generate_ouput;
1824 struct lttng_dynamic_buffer payload;
1825 int ret;
1826 size_t descriptor_size;
1827 struct lttng_session_descriptor *descriptor_reply = NULL;
1828
1829 lttng_dynamic_buffer_init(&payload);
1830 if (!session_descriptor) {
1831 ret_code = LTTNG_ERR_INVALID;
1832 goto end;
1833 }
1834
1835 sessiond_must_generate_ouput =
1836 !lttng_session_descriptor_is_output_destination_initialized(
1837 session_descriptor);
1838 if (sessiond_must_generate_ouput) {
1839 const char *home_dir = utils_get_home_dir();
1840 size_t home_dir_len = home_dir ? strlen(home_dir) + 1 : 0;
1841
1842 if (!home_dir || home_dir_len > LTTNG_PATH_MAX) {
1843 ret_code = LTTNG_ERR_FATAL;
1844 goto end;
1845 }
1846
1847 lsm.u.create_session.home_dir_size = (uint16_t) home_dir_len;
1848 ret = lttng_dynamic_buffer_append(&payload, home_dir,
1849 home_dir_len);
1850 if (ret) {
1851 ret_code = LTTNG_ERR_NOMEM;
1852 goto end;
1853 }
1854 }
1855
1856 descriptor_size = payload.size;
1857 ret = lttng_session_descriptor_serialize(session_descriptor,
1858 &payload);
1859 if (ret) {
1860 ret_code = LTTNG_ERR_INVALID;
1861 goto end;
1862 }
1863 descriptor_size = payload.size - descriptor_size;
1864 lsm.u.create_session.session_descriptor_size = descriptor_size;
1865
1866 /* Command returns a session descriptor on success. */
1867 reply_ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, payload.data,
1868 payload.size, &reply);
1869 if (reply_ret < 0) {
1870 ret_code = -reply_ret;
1871 goto end;
1872 } else if (reply_ret == 0) {
1873 /* Socket unexpectedly closed by the session daemon. */
1874 ret_code = LTTNG_ERR_FATAL;
1875 goto end;
1876 }
1877
1878 reply_view = lttng_buffer_view_init(reply, 0, reply_ret);
1879 ret = lttng_session_descriptor_create_from_buffer(&reply_view,
1880 &descriptor_reply);
1881 if (ret < 0) {
1882 ret_code = LTTNG_ERR_FATAL;
1883 goto end;
1884 }
1885 ret_code = LTTNG_OK;
1886 lttng_session_descriptor_assign(session_descriptor, descriptor_reply);
1887 end:
1888 free(reply);
1889 lttng_dynamic_buffer_reset(&payload);
1890 lttng_session_descriptor_destroy(descriptor_reply);
1891 return ret_code;
1892 }
1893
1894 /*
1895 * Create a new session using name and url for destination.
1896 *
1897 * Return 0 on success else a negative LTTng error code.
1898 */
1899 int lttng_create_session(const char *name, const char *url)
1900 {
1901 int ret;
1902 ssize_t size;
1903 struct lttng_uri *uris = NULL;
1904 struct lttng_session_descriptor *descriptor = NULL;
1905 enum lttng_error_code ret_code;
1906
1907 if (!name) {
1908 ret = -LTTNG_ERR_INVALID;
1909 goto end;
1910 }
1911
1912 size = uri_parse_str_urls(url, NULL, &uris);
1913 if (size < 0) {
1914 ret = -LTTNG_ERR_INVALID;
1915 goto end;
1916 }
1917 switch (size) {
1918 case 0:
1919 descriptor = lttng_session_descriptor_create(name);
1920 break;
1921 case 1:
1922 if (uris[0].dtype != LTTNG_DST_PATH) {
1923 ret = -LTTNG_ERR_INVALID;
1924 goto end;
1925 }
1926 descriptor = lttng_session_descriptor_local_create(name,
1927 uris[0].dst.path);
1928 break;
1929 case 2:
1930 descriptor = lttng_session_descriptor_network_create(name, url,
1931 NULL);
1932 break;
1933 default:
1934 ret = -LTTNG_ERR_INVALID;
1935 goto end;
1936 }
1937 if (!descriptor) {
1938 ret = -LTTNG_ERR_INVALID;
1939 goto end;
1940 }
1941 ret_code = lttng_create_session_ext(descriptor);
1942 ret = ret_code == LTTNG_OK ? 0 : -ret_code;
1943 end:
1944 lttng_session_descriptor_destroy(descriptor);
1945 free(uris);
1946 return ret;
1947 }
1948
1949 /*
1950 * Create a session exclusively used for snapshot.
1951 *
1952 * Return 0 on success else a negative LTTng error code.
1953 */
1954 int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
1955 {
1956 int ret;
1957 enum lttng_error_code ret_code;
1958 ssize_t size;
1959 struct lttng_uri *uris = NULL;
1960 struct lttng_session_descriptor *descriptor = NULL;
1961
1962 if (!name) {
1963 ret = -LTTNG_ERR_INVALID;
1964 goto end;
1965 }
1966
1967 size = uri_parse_str_urls(snapshot_url, NULL, &uris);
1968 if (size < 0) {
1969 ret = -LTTNG_ERR_INVALID;
1970 goto end;
1971 }
1972 /*
1973 * If the user does not specify a custom subdir, use the session name.
1974 */
1975 if (size > 0 && uris[0].dtype != LTTNG_DST_PATH &&
1976 strlen(uris[0].subdir) == 0) {
1977 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s",
1978 name);
1979 if (ret < 0) {
1980 PERROR("Failed to set session name as network destination sub-directory");
1981 ret = -LTTNG_ERR_FATAL;
1982 goto end;
1983 } else if (ret >= sizeof(uris[0].subdir)) {
1984 /* Truncated output. */
1985 ret = -LTTNG_ERR_INVALID;
1986 goto end;
1987 }
1988 }
1989
1990 switch (size) {
1991 case 0:
1992 descriptor = lttng_session_descriptor_snapshot_create(name);
1993 break;
1994 case 1:
1995 if (uris[0].dtype != LTTNG_DST_PATH) {
1996 ret = -LTTNG_ERR_INVALID;
1997 goto end;
1998 }
1999 descriptor = lttng_session_descriptor_snapshot_local_create(
2000 name,
2001 uris[0].dst.path);
2002 break;
2003 case 2:
2004 descriptor = lttng_session_descriptor_snapshot_network_create(
2005 name,
2006 snapshot_url,
2007 NULL);
2008 break;
2009 default:
2010 ret = -LTTNG_ERR_INVALID;
2011 goto end;
2012 }
2013 if (!descriptor) {
2014 ret = -LTTNG_ERR_INVALID;
2015 goto end;
2016 }
2017 ret_code = lttng_create_session_ext(descriptor);
2018 ret = ret_code == LTTNG_OK ? 0 : -ret_code;
2019 end:
2020 lttng_session_descriptor_destroy(descriptor);
2021 free(uris);
2022 return ret;
2023 }
2024
2025 /*
2026 * Create a session exclusively used for live.
2027 *
2028 * Return 0 on success else a negative LTTng error code.
2029 */
2030 int lttng_create_session_live(const char *name, const char *url,
2031 unsigned int timer_interval)
2032 {
2033 int ret;
2034 enum lttng_error_code ret_code;
2035 struct lttng_session_descriptor *descriptor = NULL;
2036
2037 if (!name) {
2038 ret = -LTTNG_ERR_INVALID;
2039 goto end;
2040 }
2041
2042 if (url) {
2043 descriptor = lttng_session_descriptor_live_network_create(
2044 name, url, NULL, timer_interval);
2045 } else {
2046 descriptor = lttng_session_descriptor_live_create(
2047 name, timer_interval);
2048 }
2049 if (!descriptor) {
2050 ret = -LTTNG_ERR_INVALID;
2051 goto end;
2052 }
2053 ret_code = lttng_create_session_ext(descriptor);
2054 ret = ret_code == LTTNG_OK ? 0 : -ret_code;
2055 end:
2056 lttng_session_descriptor_destroy(descriptor);
2057 return ret;
2058 }
2059
2060 /*
2061 * Stop the session and wait for the data before destroying it
2062 *
2063 * Return 0 on success else a negative LTTng error code.
2064 */
2065 int lttng_destroy_session(const char *session_name)
2066 {
2067 int ret;
2068 enum lttng_error_code ret_code;
2069 enum lttng_destruction_handle_status status;
2070 struct lttng_destruction_handle *handle = NULL;
2071
2072 /*
2073 * Stop the tracing and wait for the data to be
2074 * consumed.
2075 */
2076 ret = _lttng_stop_tracing(session_name, 1);
2077 if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
2078 goto end;
2079 }
2080
2081 ret_code = lttng_destroy_session_ext(session_name, &handle);
2082 if (ret_code != LTTNG_OK) {
2083 ret = (int) -ret_code;
2084 goto end;
2085 }
2086 assert(handle);
2087
2088 /* Block until the completion of the destruction of the session. */
2089 status = lttng_destruction_handle_wait_for_completion(handle, -1);
2090 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED) {
2091 ret = -LTTNG_ERR_UNK;
2092 goto end;
2093 }
2094
2095 status = lttng_destruction_handle_get_result(handle, &ret_code);
2096 if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
2097 ret = -LTTNG_ERR_UNK;
2098 goto end;
2099 }
2100 ret = ret_code == LTTNG_OK ? 0 : -ret_code;
2101 end:
2102 lttng_destruction_handle_destroy(handle);
2103 return ret;
2104 }
2105
2106 /*
2107 * Destroy the session without waiting for the data.
2108 */
2109 int lttng_destroy_session_no_wait(const char *session_name)
2110 {
2111 enum lttng_error_code ret_code;
2112
2113 ret_code = lttng_destroy_session_ext(session_name, NULL);
2114 return ret_code == LTTNG_OK ? 0 : -ret_code;
2115 }
2116
2117 /*
2118 * Ask the session daemon for all available sessions.
2119 * Sets the contents of the sessions array.
2120 * Returns the number of lttng_session entries in sessions;
2121 * on error, returns a negative value.
2122 */
2123 int lttng_list_sessions(struct lttng_session **out_sessions)
2124 {
2125 int ret;
2126 struct lttcomm_session_msg lsm;
2127 const size_t session_size = sizeof(struct lttng_session) +
2128 sizeof(struct lttng_session_extended);
2129 size_t session_count, i;
2130 struct lttng_session_extended *sessions_extended_begin;
2131 struct lttng_session *sessions = NULL;
2132
2133 memset(&lsm, 0, sizeof(lsm));
2134 lsm.cmd_type = LTTNG_LIST_SESSIONS;
2135 /*
2136 * Initialize out_sessions to NULL so it is initialized when
2137 * lttng_list_sessions returns 0, thus allowing *out_sessions to
2138 * be subsequently freed.
2139 */
2140 *out_sessions = NULL;
2141 ret = lttng_ctl_ask_sessiond(&lsm, (void**) &sessions);
2142 if (ret <= 0) {
2143 goto end;
2144 }
2145 if (!sessions) {
2146 ret = -LTTNG_ERR_FATAL;
2147 goto end;
2148 }
2149
2150 if (ret % session_size) {
2151 ret = -LTTNG_ERR_UNK;
2152 free(sessions);
2153 goto end;
2154 }
2155 session_count = (size_t) ret / session_size;
2156 sessions_extended_begin = (struct lttng_session_extended *)
2157 (&sessions[session_count]);
2158
2159 /* Set extended session info pointers. */
2160 for (i = 0; i < session_count; i++) {
2161 struct lttng_session *session = &sessions[i];
2162 struct lttng_session_extended *extended =
2163 &(sessions_extended_begin[i]);
2164
2165 session->extended.ptr = extended;
2166 }
2167
2168 ret = (int) session_count;
2169 *out_sessions = sessions;
2170 end:
2171 return ret;
2172 }
2173
2174 enum lttng_error_code lttng_session_get_creation_time(
2175 const struct lttng_session *session, uint64_t *creation_time)
2176 {
2177 enum lttng_error_code ret = LTTNG_OK;
2178 struct lttng_session_extended *extended;
2179
2180 if (!session || !creation_time || !session->extended.ptr) {
2181 ret = LTTNG_ERR_INVALID;
2182 goto end;
2183 }
2184
2185 extended = session->extended.ptr;
2186 if (!extended->creation_time.is_set) {
2187 /* Not created on the session daemon yet. */
2188 ret = LTTNG_ERR_SESSION_NOT_EXIST;
2189 goto end;
2190 }
2191 *creation_time = extended->creation_time.value;
2192 end:
2193 return ret;
2194 }
2195
2196 int lttng_set_session_shm_path(const char *session_name,
2197 const char *shm_path)
2198 {
2199 int ret;
2200 struct lttcomm_session_msg lsm;
2201
2202 if (session_name == NULL) {
2203 return -LTTNG_ERR_INVALID;
2204 }
2205
2206 memset(&lsm, 0, sizeof(lsm));
2207 lsm.cmd_type = LTTNG_SET_SESSION_SHM_PATH;
2208
2209 ret = lttng_strncpy(lsm.session.name, session_name,
2210 sizeof(lsm.session.name));
2211 if (ret) {
2212 ret = -LTTNG_ERR_INVALID;
2213 goto end;
2214 }
2215
2216 ret = lttng_strncpy(lsm.u.set_shm_path.shm_path, shm_path ?: "",
2217 sizeof(lsm.u.set_shm_path.shm_path));
2218 if (ret) {
2219 ret = -LTTNG_ERR_INVALID;
2220 goto end;
2221 }
2222
2223 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
2224 end:
2225 return ret;
2226 }
2227
2228 /*
2229 * Ask the session daemon for all available domains of a session.
2230 * Sets the contents of the domains array.
2231 * Returns the number of lttng_domain entries in domains;
2232 * on error, returns a negative value.
2233 */
2234 int lttng_list_domains(const char *session_name,
2235 struct lttng_domain **domains)
2236 {
2237 int ret;
2238 struct lttcomm_session_msg lsm;
2239
2240 if (session_name == NULL) {
2241 ret = -LTTNG_ERR_INVALID;
2242 goto error;
2243 }
2244
2245 memset(&lsm, 0, sizeof(lsm));
2246 lsm.cmd_type = LTTNG_LIST_DOMAINS;
2247
2248 ret = lttng_strncpy(lsm.session.name, session_name,
2249 sizeof(lsm.session.name));
2250 if (ret) {
2251 ret = -LTTNG_ERR_INVALID;
2252 goto error;
2253 }
2254
2255 ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains);
2256 if (ret < 0) {
2257 goto error;
2258 }
2259
2260 return ret / sizeof(struct lttng_domain);
2261 error:
2262 return ret;
2263 }
2264
2265 /*
2266 * Ask the session daemon for all available channels of a session.
2267 * Sets the contents of the channels array.
2268 * Returns the number of lttng_channel entries in channels;
2269 * on error, returns a negative value.
2270 */
2271 int lttng_list_channels(struct lttng_handle *handle,
2272 struct lttng_channel **channels)
2273 {
2274 int ret;
2275 size_t channel_count, i;
2276 const size_t channel_size = sizeof(struct lttng_channel) +
2277 sizeof(struct lttng_channel_extended);
2278 struct lttcomm_session_msg lsm;
2279 void *extended_at;
2280
2281 if (handle == NULL) {
2282 ret = -LTTNG_ERR_INVALID;
2283 goto end;
2284 }
2285
2286 memset(&lsm, 0, sizeof(lsm));
2287 lsm.cmd_type = LTTNG_LIST_CHANNELS;
2288 ret = lttng_strncpy(lsm.session.name, handle->session_name,
2289 sizeof(lsm.session.name));
2290 if (ret) {
2291 ret = -LTTNG_ERR_INVALID;
2292 goto end;
2293 }
2294
2295 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
2296
2297 ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
2298 if (ret < 0) {
2299 goto end;
2300 }
2301
2302 if (ret % channel_size) {
2303 ret = -LTTNG_ERR_UNK;
2304 free(*channels);
2305 *channels = NULL;
2306 goto end;
2307 }
2308 channel_count = (size_t) ret / channel_size;
2309
2310 /* Set extended info pointers */
2311 extended_at = ((void *) *channels) +
2312 channel_count * sizeof(struct lttng_channel);
2313 for (i = 0; i < channel_count; i++) {
2314 struct lttng_channel *chan = &(*channels)[i];
2315
2316 chan->attr.extended.ptr = extended_at;
2317 extended_at += sizeof(struct lttng_channel_extended);
2318 }
2319
2320 ret = (int) channel_count;
2321 end:
2322 return ret;
2323 }
2324
2325 /*
2326 * Ask the session daemon for all available events of a session channel.
2327 * Sets the contents of the events array.
2328 * Returns the number of lttng_event entries in events;
2329 * on error, returns a negative value.
2330 */
2331 int lttng_list_events(struct lttng_handle *handle,
2332 const char *channel_name, struct lttng_event **events)
2333 {
2334 int ret;
2335 struct lttcomm_session_msg lsm = {};
2336 const struct lttcomm_event_command_header *cmd_header = NULL;
2337 uint32_t nb_events, i;
2338 const void *comm_ext_at;
2339 struct lttng_dynamic_buffer listing;
2340 size_t storage_req;
2341 struct lttng_payload payload;
2342 struct lttng_payload payload_copy;
2343 struct lttng_payload_view lsm_view =
2344 lttng_payload_view_init_from_buffer(
2345 (const char *) &lsm, 0, sizeof(lsm));
2346 struct lttng_buffer_view cmd_header_view;
2347 struct lttng_buffer_view cmd_payload_view;
2348 struct lttng_buffer_view flat_events_view;
2349 struct lttng_buffer_view ext_view;
2350
2351 /* Safety check. An handle and channel name are mandatory */
2352 if (handle == NULL || channel_name == NULL) {
2353 ret = -LTTNG_ERR_INVALID;
2354 goto end;
2355 }
2356
2357 lttng_payload_init(&payload);
2358 lttng_payload_init(&payload_copy);
2359
2360 lsm.cmd_type = LTTNG_LIST_EVENTS;
2361 ret = lttng_strncpy(lsm.session.name, handle->session_name,
2362 sizeof(lsm.session.name));
2363 if (ret) {
2364 ret = -LTTNG_ERR_INVALID;
2365 goto end;
2366 }
2367
2368 ret = lttng_strncpy(lsm.u.list.channel_name, channel_name,
2369 sizeof(lsm.u.list.channel_name));
2370 if (ret) {
2371 ret = -LTTNG_ERR_INVALID;
2372 goto end;
2373 }
2374
2375 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
2376
2377 ret = lttng_ctl_ask_sessiond_payload(&lsm_view, &payload);
2378 if (ret < 0) {
2379 goto end;
2380 }
2381
2382 /*
2383 * A copy of the payload is performed since it will be
2384 * consumed twice. Consuming the same payload twice is invalid since
2385 * it will cause any received file descriptor to become "shared"
2386 * between different instances of the resulting objects.
2387 */
2388 ret = lttng_payload_copy(&payload, &payload_copy);
2389 if (ret) {
2390 ret = -LTTNG_ERR_NOMEM;
2391 goto end;
2392 }
2393
2394 cmd_header_view = lttng_buffer_view_from_dynamic_buffer(
2395 &payload.buffer, 0, sizeof(*cmd_header));
2396 if (!lttng_buffer_view_is_valid(&cmd_header_view)) {
2397 ret = -LTTNG_ERR_INVALID_PROTOCOL;
2398 goto end;
2399 }
2400
2401 cmd_header = (typeof(cmd_header)) cmd_header_view.data;
2402
2403 /* Set number of events and free command header */
2404 nb_events = cmd_header->nb_events;
2405 if (nb_events > INT_MAX) {
2406 ret = -LTTNG_ERR_OVERFLOW;
2407 goto end;
2408 }
2409
2410 cmd_payload_view = lttng_buffer_view_from_dynamic_buffer(
2411 &payload.buffer, sizeof(*cmd_header), -1);
2412
2413 /*
2414 * The buffer that is returned must contain a "flat" version of
2415 * the events that are returned. In other words, all pointers
2416 * within an lttng_event must point to a location within the returned
2417 * buffer so that the user may free everything by simply calling free()
2418 * on the returned buffer. This is needed in order to maintain API
2419 * compatibility.
2420 *
2421 * A first pass is performed to compute the size of the buffer that
2422 * must be allocated. A second pass is then performed to setup
2423 * the returned events so that their members always point within the
2424 * buffer.
2425 *
2426 * The layout of the returned buffer is as follows:
2427 * - struct lttng_event[nb_events],
2428 * - nb_events times the following:
2429 * - struct lttng_event_extended,
2430 * - flattened version of userspace_probe_location
2431 * - filter_expression
2432 * - exclusions
2433 * - padding to align to 64-bits
2434 */
2435 ext_view = lttng_buffer_view_from_view(&cmd_payload_view,
2436 nb_events * sizeof(struct lttng_event), -1);
2437 comm_ext_at = ext_view.data;
2438 storage_req = nb_events * sizeof(struct lttng_event);
2439 {
2440 struct lttng_payload_view payload_view =
2441 lttng_payload_view_from_payload(&payload, 0, -1);
2442
2443 for (i = 0; i < nb_events; i++) {
2444 const struct lttcomm_event_extended_header *ext_comm =
2445 (struct lttcomm_event_extended_header *)
2446 comm_ext_at;
2447 int probe_storage_req = 0;
2448
2449 comm_ext_at += sizeof(*ext_comm);
2450 comm_ext_at += ext_comm->filter_len;
2451 comm_ext_at += ext_comm->nb_exclusions *
2452 LTTNG_SYMBOL_NAME_LEN;
2453
2454 if (ext_comm->userspace_probe_location_len) {
2455 struct lttng_userspace_probe_location
2456 *probe_location = NULL;
2457 struct lttng_payload_view probe_location_view = lttng_payload_view_from_view(
2458 &payload_view,
2459 (const char *) comm_ext_at -
2460 payload_view.buffer.data,
2461 ext_comm->userspace_probe_location_len);
2462
2463 if (!lttng_payload_view_is_valid(&probe_location_view)) {
2464 ret = -LTTNG_ERR_PROBE_LOCATION_INVAL;
2465 goto end;
2466 }
2467
2468 /*
2469 * Create a temporary userspace probe location
2470 * to determine the size needed by a "flattened"
2471 * version of that same probe location.
2472 */
2473 ret = lttng_userspace_probe_location_create_from_payload(
2474 &probe_location_view,
2475 &probe_location);
2476 if (ret < 0) {
2477 ret = -LTTNG_ERR_PROBE_LOCATION_INVAL;
2478 goto end;
2479 }
2480
2481 ret = lttng_userspace_probe_location_flatten(
2482 probe_location, NULL);
2483 lttng_userspace_probe_location_destroy(
2484 probe_location);
2485 if (ret < 0) {
2486 ret = -LTTNG_ERR_PROBE_LOCATION_INVAL;
2487 goto end;
2488 }
2489
2490 probe_storage_req = ret;
2491 comm_ext_at += ext_comm->userspace_probe_location_len;
2492 }
2493
2494 storage_req += sizeof(struct lttng_event_extended);
2495 storage_req += ext_comm->filter_len;
2496 storage_req += ext_comm->nb_exclusions *
2497 LTTNG_SYMBOL_NAME_LEN;
2498 /* Padding to ensure the flat probe is aligned. */
2499 storage_req = ALIGN_TO(storage_req, sizeof(uint64_t));
2500 storage_req += probe_storage_req;
2501 }
2502 }
2503
2504 lttng_dynamic_buffer_init(&listing);
2505 /*
2506 * We must ensure that "listing" is never resized so as to preserve
2507 * the validity of the flattened objects.
2508 */
2509 ret = lttng_dynamic_buffer_set_capacity(&listing, storage_req);
2510 if (ret) {
2511 ret = -LTTNG_ERR_NOMEM;
2512 goto end;
2513 }
2514
2515 cmd_payload_view = lttng_buffer_view_from_dynamic_buffer(
2516 &payload_copy.buffer, sizeof(*cmd_header), -1);
2517 flat_events_view = lttng_buffer_view_from_view(&cmd_payload_view, 0,
2518 nb_events * sizeof(struct lttng_event));
2519 ret = lttng_dynamic_buffer_append_view(&listing, &flat_events_view);
2520 if (ret) {
2521 ret = -LTTNG_ERR_NOMEM;
2522 goto free_dynamic_buffer;
2523 }
2524
2525 ext_view = lttng_buffer_view_from_view(&cmd_payload_view,
2526 nb_events * sizeof(struct lttng_event), -1);
2527 comm_ext_at = ext_view.data;
2528
2529 {
2530 struct lttng_payload_view payload_copy_view =
2531 lttng_payload_view_from_payload(
2532 &payload_copy, 0, -1);
2533
2534 for (i = 0; i < nb_events; i++) {
2535 struct lttng_event *event = (typeof(event))(
2536 listing.data +
2537 (sizeof(struct lttng_event) * i));
2538 const struct lttcomm_event_extended_header *ext_comm =
2539 (typeof(ext_comm)) comm_ext_at;
2540 struct lttng_event_extended *event_extended =
2541 (typeof(event_extended))(listing.data +
2542 listing.size);
2543
2544 /* Insert struct lttng_event_extended. */
2545 ret = lttng_dynamic_buffer_set_size(&listing,
2546 listing.size + sizeof(*event_extended));
2547 if (ret) {
2548 ret = -LTTNG_ERR_NOMEM;
2549 goto free_dynamic_buffer;
2550 }
2551 event->extended.ptr = event_extended;
2552
2553 comm_ext_at += sizeof(*ext_comm);
2554
2555 /* Insert filter expression. */
2556 if (ext_comm->filter_len) {
2557 event_extended->filter_expression =
2558 listing.data + listing.size;
2559 ret = lttng_dynamic_buffer_append(&listing,
2560 comm_ext_at,
2561 ext_comm->filter_len);
2562 if (ret) {
2563 ret = -LTTNG_ERR_NOMEM;
2564 goto free_dynamic_buffer;
2565 }
2566 comm_ext_at += ext_comm->filter_len;
2567 }
2568
2569 /* Insert exclusions. */
2570 if (ext_comm->nb_exclusions) {
2571 event_extended->exclusions.count =
2572 ext_comm->nb_exclusions;
2573 event_extended->exclusions.strings =
2574 listing.data + listing.size;
2575
2576 ret = lttng_dynamic_buffer_append(&listing,
2577 comm_ext_at,
2578 ext_comm->nb_exclusions *
2579 LTTNG_SYMBOL_NAME_LEN);
2580 if (ret) {
2581 ret = -LTTNG_ERR_NOMEM;
2582 goto free_dynamic_buffer;
2583 }
2584 comm_ext_at += ext_comm->nb_exclusions *
2585 LTTNG_SYMBOL_NAME_LEN;
2586 }
2587
2588 /* Insert padding to align to 64-bits. */
2589 ret = lttng_dynamic_buffer_set_size(&listing,
2590 ALIGN_TO(listing.size,
2591 sizeof(uint64_t)));
2592 if (ret) {
2593 ret = -LTTNG_ERR_NOMEM;
2594 goto free_dynamic_buffer;
2595 }
2596
2597 /* Insert flattened userspace probe location. */
2598 if (ext_comm->userspace_probe_location_len) {
2599 struct lttng_userspace_probe_location
2600 *probe_location = NULL;
2601 struct lttng_payload_view probe_location_view = lttng_payload_view_from_view(
2602 &payload_copy_view,
2603 (const char *) comm_ext_at -
2604 payload_copy_view.buffer.data,
2605 ext_comm->userspace_probe_location_len);
2606
2607 if (!lttng_payload_view_is_valid(&probe_location_view)) {
2608 ret = -LTTNG_ERR_PROBE_LOCATION_INVAL;
2609 goto free_dynamic_buffer;
2610 }
2611
2612 ret = lttng_userspace_probe_location_create_from_payload(
2613 &probe_location_view,
2614 &probe_location);
2615 if (ret < 0) {
2616 ret = -LTTNG_ERR_PROBE_LOCATION_INVAL;
2617 goto free_dynamic_buffer;
2618 }
2619
2620 event_extended->probe_location = (struct lttng_userspace_probe_location
2621 *) (listing.data +
2622 listing.size);
2623 ret = lttng_userspace_probe_location_flatten(
2624 probe_location, &listing);
2625 lttng_userspace_probe_location_destroy(
2626 probe_location);
2627 if (ret < 0) {
2628 ret = -LTTNG_ERR_PROBE_LOCATION_INVAL;
2629 goto free_dynamic_buffer;
2630 }
2631
2632 comm_ext_at += ext_comm->userspace_probe_location_len;
2633 }
2634 }
2635 }
2636
2637 /* Don't reset listing buffer as we return its content. */
2638 *events = (struct lttng_event *) listing.data;
2639 lttng_dynamic_buffer_init(&listing);
2640 ret = (int) nb_events;
2641 free_dynamic_buffer:
2642 lttng_dynamic_buffer_reset(&listing);
2643 end:
2644 lttng_payload_reset(&payload);
2645 lttng_payload_reset(&payload_copy);
2646 return ret;
2647 }
2648
2649 /*
2650 * Sets the tracing_group variable with name.
2651 * This function allocates memory pointed to by tracing_group.
2652 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
2653 */
2654 int lttng_set_tracing_group(const char *name)
2655 {
2656 char *new_group;
2657 if (name == NULL) {
2658 return -LTTNG_ERR_INVALID;
2659 }
2660
2661 if (asprintf(&new_group, "%s", name) < 0) {
2662 return -LTTNG_ERR_FATAL;
2663 }
2664
2665 free(tracing_group);
2666 tracing_group = new_group;
2667 new_group = NULL;
2668
2669 return 0;
2670 }
2671
2672 int lttng_calibrate(struct lttng_handle *handle,
2673 struct lttng_calibrate *calibrate)
2674 {
2675 /*
2676 * This command was removed in LTTng 2.9.
2677 */
2678 return -LTTNG_ERR_UND;
2679 }
2680
2681 /*
2682 * Set default channel attributes.
2683 * If either or both of the arguments are null, attr content is zeroe'd.
2684 */
2685 void lttng_channel_set_default_attr(struct lttng_domain *domain,
2686 struct lttng_channel_attr *attr)
2687 {
2688 struct lttng_channel_extended *extended;
2689
2690 /* Safety check */
2691 if (attr == NULL || domain == NULL) {
2692 return;
2693 }
2694
2695 extended = (struct lttng_channel_extended *) attr->extended.ptr;
2696 memset(attr, 0, sizeof(struct lttng_channel_attr));
2697
2698 /* Same for all domains. */
2699 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
2700 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
2701 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
2702
2703 switch (domain->type) {
2704 case LTTNG_DOMAIN_KERNEL:
2705 attr->switch_timer_interval =
2706 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
2707 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
2708 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
2709 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
2710 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
2711 if (extended) {
2712 extended->monitor_timer_interval =
2713 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER;
2714 extended->blocking_timeout =
2715 DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT;
2716 }
2717 break;
2718 case LTTNG_DOMAIN_UST:
2719 switch (domain->buf_type) {
2720 case LTTNG_BUFFER_PER_UID:
2721 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
2722 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
2723 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
2724 attr->switch_timer_interval =
2725 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
2726 attr->read_timer_interval =
2727 DEFAULT_UST_UID_CHANNEL_READ_TIMER;
2728 if (extended) {
2729 extended->monitor_timer_interval =
2730 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER;
2731 extended->blocking_timeout =
2732 DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT;
2733 }
2734 break;
2735 case LTTNG_BUFFER_PER_PID:
2736 default:
2737 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
2738 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
2739 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
2740 attr->switch_timer_interval =
2741 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
2742 attr->read_timer_interval =
2743 DEFAULT_UST_PID_CHANNEL_READ_TIMER;
2744 if (extended) {
2745 extended->monitor_timer_interval =
2746 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER;
2747 extended->blocking_timeout =
2748 DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT;
2749 }
2750 break;
2751 }
2752 default:
2753 /* Default behavior: leave set to 0. */
2754 break;
2755 }
2756
2757 attr->extended.ptr = extended;
2758 }
2759
2760 int lttng_channel_get_discarded_event_count(struct lttng_channel *channel,
2761 uint64_t *discarded_events)
2762 {
2763 int ret = 0;
2764 struct lttng_channel_extended *chan_ext;
2765
2766 if (!channel || !discarded_events) {
2767 ret = -LTTNG_ERR_INVALID;
2768 goto end;
2769 }
2770
2771 chan_ext = channel->attr.extended.ptr;
2772 if (!chan_ext) {
2773 /*
2774 * This can happen since the lttng_channel structure is
2775 * used for other tasks where this pointer is never set.
2776 */
2777 *discarded_events = 0;
2778 goto end;
2779 }
2780
2781 *discarded_events = chan_ext->discarded_events;
2782 end:
2783 return ret;
2784 }
2785
2786 int lttng_channel_get_lost_packet_count(struct lttng_channel *channel,
2787 uint64_t *lost_packets)
2788 {
2789 int ret = 0;
2790 struct lttng_channel_extended *chan_ext;
2791
2792 if (!channel || !lost_packets) {
2793 ret = -LTTNG_ERR_INVALID;
2794 goto end;
2795 }
2796
2797 chan_ext = channel->attr.extended.ptr;
2798 if (!chan_ext) {
2799 /*
2800 * This can happen since the lttng_channel structure is
2801 * used for other tasks where this pointer is never set.
2802 */
2803 *lost_packets = 0;
2804 goto end;
2805 }
2806
2807 *lost_packets = chan_ext->lost_packets;
2808 end:
2809 return ret;
2810 }
2811
2812 int lttng_channel_get_monitor_timer_interval(struct lttng_channel *chan,
2813 uint64_t *monitor_timer_interval)
2814 {
2815 int ret = 0;
2816
2817 if (!chan || !monitor_timer_interval) {
2818 ret = -LTTNG_ERR_INVALID;
2819 goto end;
2820 }
2821
2822 if (!chan->attr.extended.ptr) {
2823 ret = -LTTNG_ERR_INVALID;
2824 goto end;
2825 }
2826
2827 *monitor_timer_interval = ((struct lttng_channel_extended *)
2828 chan->attr.extended.ptr)->monitor_timer_interval;
2829 end:
2830 return ret;
2831 }
2832
2833 int lttng_channel_set_monitor_timer_interval(struct lttng_channel *chan,
2834 uint64_t monitor_timer_interval)
2835 {
2836 int ret = 0;
2837
2838 if (!chan || !chan->attr.extended.ptr) {
2839 ret = -LTTNG_ERR_INVALID;
2840 goto end;
2841 }
2842
2843 ((struct lttng_channel_extended *)
2844 chan->attr.extended.ptr)->monitor_timer_interval =
2845 monitor_timer_interval;
2846 end:
2847 return ret;
2848 }
2849
2850 int lttng_channel_get_blocking_timeout(struct lttng_channel *chan,
2851 int64_t *blocking_timeout)
2852 {
2853 int ret = 0;
2854
2855 if (!chan || !blocking_timeout) {
2856 ret = -LTTNG_ERR_INVALID;
2857 goto end;
2858 }
2859
2860 if (!chan->attr.extended.ptr) {
2861 ret = -LTTNG_ERR_INVALID;
2862 goto end;
2863 }
2864
2865 *blocking_timeout = ((struct lttng_channel_extended *)
2866 chan->attr.extended.ptr)->blocking_timeout;
2867 end:
2868 return ret;
2869 }
2870
2871 int lttng_channel_set_blocking_timeout(struct lttng_channel *chan,
2872 int64_t blocking_timeout)
2873 {
2874 int ret = 0;
2875 int64_t msec_timeout;
2876
2877 if (!chan || !chan->attr.extended.ptr) {
2878 ret = -LTTNG_ERR_INVALID;
2879 goto end;
2880 }
2881
2882 if (blocking_timeout < 0 && blocking_timeout != -1) {
2883 ret = -LTTNG_ERR_INVALID;
2884 goto end;
2885 }
2886
2887 /*
2888 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2889 * us to accept a narrower range of values (msecs expressed as a signed
2890 * 32-bit integer).
2891 */
2892 msec_timeout = blocking_timeout / 1000;
2893 if (msec_timeout != (int32_t) msec_timeout) {
2894 ret = -LTTNG_ERR_INVALID;
2895 goto end;
2896 }
2897
2898 ((struct lttng_channel_extended *)
2899 chan->attr.extended.ptr)->blocking_timeout =
2900 blocking_timeout;
2901 end:
2902 return ret;
2903 }
2904
2905 /*
2906 * Check if session daemon is alive.
2907 *
2908 * Return 1 if alive or 0 if not.
2909 * On error returns a negative value.
2910 */
2911 int lttng_session_daemon_alive(void)
2912 {
2913 int ret;
2914
2915 ret = set_session_daemon_path();
2916 if (ret < 0) {
2917 /* Error. */
2918 return ret;
2919 }
2920
2921 if (*sessiond_sock_path == '\0') {
2922 /*
2923 * No socket path set. Weird error which means the constructor
2924 * was not called.
2925 */
2926 assert(0);
2927 }
2928
2929 ret = try_connect_sessiond(sessiond_sock_path);
2930 if (ret < 0) {
2931 /* Not alive. */
2932 return 0;
2933 }
2934
2935 /* Is alive. */
2936 return 1;
2937 }
2938
2939 /*
2940 * Set URL for a consumer for a session and domain.
2941 *
2942 * Return 0 on success, else a negative value.
2943 */
2944 int lttng_set_consumer_url(struct lttng_handle *handle,
2945 const char *control_url, const char *data_url)
2946 {
2947 int ret;
2948 ssize_t size;
2949 struct lttcomm_session_msg lsm;
2950 struct lttng_uri *uris = NULL;
2951
2952 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
2953 ret = -LTTNG_ERR_INVALID;
2954 goto error;
2955 }
2956
2957 memset(&lsm, 0, sizeof(lsm));
2958
2959 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
2960
2961 ret = lttng_strncpy(lsm.session.name, handle->session_name,
2962 sizeof(lsm.session.name));
2963 if (ret) {
2964 ret = -LTTNG_ERR_INVALID;
2965 goto error;
2966 }
2967
2968 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
2969
2970 size = uri_parse_str_urls(control_url, data_url, &uris);
2971 if (size < 0) {
2972 ret = -LTTNG_ERR_INVALID;
2973 goto error;
2974 }
2975
2976 lsm.u.uri.size = size;
2977
2978 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
2979 sizeof(struct lttng_uri) * size, NULL);
2980
2981 free(uris);
2982 error:
2983 return ret;
2984 }
2985
2986 /*
2987 * [OBSOLETE]
2988 */
2989 int lttng_enable_consumer(struct lttng_handle *handle);
2990 int lttng_enable_consumer(struct lttng_handle *handle)
2991 {
2992 return -ENOSYS;
2993 }
2994
2995 /*
2996 * [OBSOLETE]
2997 */
2998 int lttng_disable_consumer(struct lttng_handle *handle);
2999 int lttng_disable_consumer(struct lttng_handle *handle)
3000 {
3001 return -ENOSYS;
3002 }
3003
3004 /*
3005 * [OBSOLETE]
3006 */
3007 int _lttng_create_session_ext(const char *name, const char *url,
3008 const char *datetime);
3009 int _lttng_create_session_ext(const char *name, const char *url,
3010 const char *datetime)
3011 {
3012 return -ENOSYS;
3013 }
3014
3015 /*
3016 * For a given session name, this call checks if the data is ready to be read
3017 * or is still being extracted by the consumer(s) hence not ready to be used by
3018 * any readers.
3019 */
3020 int lttng_data_pending(const char *session_name)
3021 {
3022 int ret;
3023 struct lttcomm_session_msg lsm;
3024 uint8_t *pending = NULL;
3025
3026 if (session_name == NULL) {
3027 return -LTTNG_ERR_INVALID;
3028 }
3029
3030 memset(&lsm, 0, sizeof(lsm));
3031 lsm.cmd_type = LTTNG_DATA_PENDING;
3032
3033 ret = lttng_strncpy(lsm.session.name, session_name,
3034 sizeof(lsm.session.name));
3035 if (ret) {
3036 ret = -LTTNG_ERR_INVALID;
3037 goto end;
3038 }
3039
3040 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending);
3041 if (ret < 0) {
3042 goto end;
3043 } else if (ret != 1) {
3044 /* Unexpected payload size */
3045 ret = -LTTNG_ERR_INVALID;
3046 goto end;
3047 } else if (!pending) {
3048 /* Internal error. */
3049 ret = -LTTNG_ERR_UNK;
3050 goto end;
3051 }
3052
3053 ret = (int) *pending;
3054 end:
3055 free(pending);
3056 return ret;
3057 }
3058
3059 /*
3060 * Regenerate the metadata for a session.
3061 * Return 0 on success, a negative error code on error.
3062 */
3063 int lttng_regenerate_metadata(const char *session_name)
3064 {
3065 int ret;
3066 struct lttcomm_session_msg lsm;
3067
3068 if (!session_name) {
3069 ret = -LTTNG_ERR_INVALID;
3070 goto end;
3071 }
3072
3073 memset(&lsm, 0, sizeof(lsm));
3074 lsm.cmd_type = LTTNG_REGENERATE_METADATA;
3075
3076 ret = lttng_strncpy(lsm.session.name, session_name,
3077 sizeof(lsm.session.name));
3078 if (ret) {
3079 ret = -LTTNG_ERR_INVALID;
3080 goto end;
3081 }
3082
3083 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
3084 if (ret < 0) {
3085 goto end;
3086 }
3087
3088 ret = 0;
3089 end:
3090 return ret;
3091 }
3092
3093 /*
3094 * Deprecated, replaced by lttng_regenerate_metadata.
3095 */
3096 int lttng_metadata_regenerate(const char *session_name)
3097 {
3098 return lttng_regenerate_metadata(session_name);
3099 }
3100
3101 /*
3102 * Regenerate the statedump of a session.
3103 * Return 0 on success, a negative error code on error.
3104 */
3105 int lttng_regenerate_statedump(const char *session_name)
3106 {
3107 int ret;
3108 struct lttcomm_session_msg lsm;
3109
3110 if (!session_name) {
3111 ret = -LTTNG_ERR_INVALID;
3112 goto end;
3113 }
3114
3115 memset(&lsm, 0, sizeof(lsm));
3116 lsm.cmd_type = LTTNG_REGENERATE_STATEDUMP;
3117
3118 ret = lttng_strncpy(lsm.session.name, session_name,
3119 sizeof(lsm.session.name));
3120 if (ret) {
3121 ret = -LTTNG_ERR_INVALID;
3122 goto end;
3123 }
3124
3125 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
3126 if (ret < 0) {
3127 goto end;
3128 }
3129
3130 ret = 0;
3131 end:
3132 return ret;
3133 }
3134
3135 static
3136 int _lttng_register_trigger(struct lttng_trigger *trigger, const char *name,
3137 bool generate_name)
3138 {
3139 int ret;
3140 struct lttcomm_session_msg lsm = {
3141 .cmd_type = LTTNG_REGISTER_TRIGGER,
3142 .u.trigger.is_trigger_anonymous = !name && !generate_name,
3143 };
3144 struct lttcomm_session_msg *message_lsm;
3145 struct lttng_payload message;
3146 struct lttng_payload reply;
3147 struct lttng_trigger *reply_trigger = NULL;
3148 enum lttng_domain_type domain_type;
3149 const struct lttng_credentials user_creds = {
3150 .uid = LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3151 .gid = LTTNG_OPTIONAL_INIT_UNSET,
3152 };
3153 const char *unused_trigger_name = NULL;
3154 enum lttng_trigger_status trigger_status;
3155
3156 lttng_payload_init(&message);
3157 lttng_payload_init(&reply);
3158
3159 if (!trigger) {
3160 ret = -LTTNG_ERR_INVALID;
3161 goto end;
3162 }
3163
3164 trigger_status = lttng_trigger_get_name(trigger, &unused_trigger_name);
3165 if (trigger_status != LTTNG_TRIGGER_STATUS_UNSET) {
3166 /* Re-using already registered trigger. */
3167 ret = -LTTNG_ERR_INVALID;
3168 goto end;
3169 }
3170
3171 if (name) {
3172 trigger_status = lttng_trigger_set_name(trigger, name);
3173 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
3174 ret = -LTTNG_ERR_NOMEM;
3175 goto end;
3176 }
3177 }
3178
3179 if (!trigger->creds.uid.is_set) {
3180 /* Use the client's credentials as the trigger credentials. */
3181 lttng_trigger_set_credentials(trigger, &user_creds);
3182 } else {
3183 /*
3184 * Validate that either the current trigger credentials and the
3185 * client credentials are identical or that the current user is
3186 * root. The root user can register, unregister triggers for
3187 * himself and other users.
3188 *
3189 * This check is also present on the sessiond side, using the
3190 * credentials passed on the socket. These check are all
3191 * "safety" checks.
3192 */
3193 const struct lttng_credentials *trigger_creds =
3194 lttng_trigger_get_credentials(trigger);
3195
3196 if (!lttng_credentials_is_equal_uid(trigger_creds, &user_creds)) {
3197 if (lttng_credentials_get_uid(&user_creds) != 0) {
3198 ret = -LTTNG_ERR_EPERM;
3199 goto end_unset_name;
3200 }
3201 }
3202 }
3203
3204 if (!lttng_trigger_validate(trigger)) {
3205 ret = -LTTNG_ERR_INVALID_TRIGGER;
3206 goto end_unset_name;
3207 }
3208
3209 domain_type = lttng_trigger_get_underlying_domain_type_restriction(
3210 trigger);
3211
3212 lsm.domain.type = domain_type;
3213
3214 ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
3215 if (ret) {
3216 ret = -LTTNG_ERR_NOMEM;
3217 goto end_unset_name;
3218 }
3219
3220 ret = lttng_trigger_serialize(trigger, &message);
3221 if (ret < 0) {
3222 ret = -LTTNG_ERR_UNK;
3223 goto end_unset_name;
3224 }
3225
3226 /*
3227 * This is needed to populate the trigger object size for the command
3228 * header.
3229 */
3230 message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
3231
3232 message_lsm->u.trigger.length = (uint32_t) message.buffer.size - sizeof(lsm);
3233
3234 {
3235 struct lttng_payload_view message_view =
3236 lttng_payload_view_from_payload(
3237 &message, 0, -1);
3238
3239 message_lsm->fd_count = lttng_payload_view_get_fd_handle_count(
3240 &message_view);
3241 ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
3242 if (ret < 0) {
3243 goto end_unset_name;
3244 }
3245 }
3246
3247 {
3248 struct lttng_payload_view reply_view =
3249 lttng_payload_view_from_payload(
3250 &reply, 0, reply.buffer.size);
3251
3252 ret = lttng_trigger_create_from_payload(
3253 &reply_view, &reply_trigger);
3254 if (ret < 0) {
3255 ret = -LTTNG_ERR_INVALID_PROTOCOL;
3256 goto end_unset_name;
3257 }
3258 }
3259
3260 if (name || generate_name) {
3261 ret = lttng_trigger_assign_name(trigger, reply_trigger);
3262 if (ret < 0) {
3263 ret = -LTTNG_ERR_NOMEM;
3264 goto end;
3265 }
3266 }
3267
3268 ret = 0;
3269 goto end;
3270
3271 end_unset_name:
3272 trigger_status = lttng_trigger_set_name(trigger, NULL);
3273 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
3274 ret = -LTTNG_ERR_UNK;
3275 }
3276 end:
3277 lttng_payload_reset(&message);
3278 lttng_payload_reset(&reply);
3279 lttng_trigger_destroy(reply_trigger);
3280 return ret;
3281 }
3282
3283 int lttng_register_trigger(struct lttng_trigger *trigger)
3284 {
3285 /* Register an anonymous trigger. */
3286 return _lttng_register_trigger(trigger, NULL, false);
3287 }
3288
3289 enum lttng_error_code lttng_register_trigger_with_name(
3290 struct lttng_trigger *trigger, const char *name)
3291 {
3292 const int ret = _lttng_register_trigger(trigger, name, false);
3293
3294 return ret == 0 ? LTTNG_OK : (enum lttng_error_code) -ret;
3295 }
3296
3297 enum lttng_error_code lttng_register_trigger_with_automatic_name(
3298 struct lttng_trigger *trigger)
3299 {
3300 const int ret = _lttng_register_trigger(trigger, false, true);
3301
3302 return ret == 0 ? LTTNG_OK : (enum lttng_error_code) -ret;
3303 }
3304
3305 enum lttng_error_code lttng_error_query_execute(
3306 const struct lttng_error_query *query,
3307 const struct lttng_endpoint *endpoint,
3308 struct lttng_error_query_results **results)
3309 {
3310 int ret;
3311 enum lttng_error_code ret_code;
3312 struct lttcomm_session_msg lsm = {
3313 .cmd_type = LTTNG_EXECUTE_ERROR_QUERY,
3314 };
3315 struct lttng_payload message;
3316 struct lttng_payload reply;
3317 struct lttcomm_session_msg *message_lsm;
3318
3319 lttng_payload_init(&message);
3320 lttng_payload_init(&reply);
3321
3322 if (!query || !results) {
3323 ret_code = LTTNG_ERR_INVALID;
3324 goto end;
3325 }
3326
3327 if (endpoint != lttng_session_daemon_command_endpoint) {
3328 ret_code = LTTNG_ERR_INVALID_ERROR_QUERY_TARGET;
3329 goto end;
3330 }
3331
3332 ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
3333 if (ret) {
3334 ret_code = LTTNG_ERR_NOMEM;
3335 goto end;
3336 }
3337
3338 ret = lttng_error_query_serialize(query, &message);
3339 if (ret) {
3340 ret_code = LTTNG_ERR_UNK;
3341 goto end;
3342 }
3343
3344 message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
3345 message_lsm->u.error_query.length =
3346 (uint32_t) message.buffer.size - sizeof(lsm);
3347
3348 {
3349 struct lttng_payload_view message_view =
3350 lttng_payload_view_from_payload(
3351 &message, 0, -1);
3352
3353 message_lsm->fd_count = lttng_payload_view_get_fd_handle_count(
3354 &message_view);
3355 ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
3356 if (ret < 0) {
3357 ret_code = -ret;
3358 goto end;
3359 }
3360 }
3361
3362 {
3363 ssize_t reply_create_ret;
3364 struct lttng_payload_view reply_view =
3365 lttng_payload_view_from_payload(
3366 &reply, 0, reply.buffer.size);
3367
3368 reply_create_ret = lttng_error_query_results_create_from_payload(
3369 &reply_view, results);
3370 if (reply_create_ret < 0) {
3371 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
3372 goto end;
3373 }
3374 }
3375
3376 ret_code = LTTNG_OK;
3377 end:
3378 lttng_payload_reset(&message);
3379 lttng_payload_reset(&reply);
3380 return ret_code;
3381 }
3382
3383 int lttng_unregister_trigger(const struct lttng_trigger *trigger)
3384 {
3385 int ret;
3386 struct lttcomm_session_msg lsm;
3387 struct lttcomm_session_msg *message_lsm;
3388 struct lttng_payload message;
3389 struct lttng_payload reply;
3390 struct lttng_trigger *copy = NULL;
3391 const struct lttng_credentials user_creds = {
3392 .uid = LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3393 .gid = LTTNG_OPTIONAL_INIT_UNSET,
3394 };
3395
3396 lttng_payload_init(&message);
3397 lttng_payload_init(&reply);
3398
3399 if (!trigger) {
3400 ret = -LTTNG_ERR_INVALID;
3401 goto end;
3402 }
3403
3404 copy = lttng_trigger_copy(trigger);
3405 if (!copy) {
3406 ret = -LTTNG_ERR_UNK;
3407 goto end;
3408 }
3409
3410 if (!copy->creds.uid.is_set) {
3411 /* Use the client credentials as the trigger credentials */
3412 lttng_trigger_set_credentials(copy, &user_creds);
3413 } else {
3414 /*
3415 * Validate that either the current trigger credentials and the
3416 * client credentials are identical or that the current user is
3417 * root. The root user can register, unregister triggers for
3418 * himself and other users.
3419 *
3420 * This check is also present on the sessiond side, using the
3421 * credentials passed on the socket. These check are all
3422 * "safety" checks.
3423 */
3424 const struct lttng_credentials *trigger_creds =
3425 lttng_trigger_get_credentials(copy);
3426 if (!lttng_credentials_is_equal_uid(trigger_creds, &user_creds)) {
3427 if (lttng_credentials_get_uid(&user_creds) != 0) {
3428 ret = -LTTNG_ERR_EPERM;
3429 goto end;
3430 }
3431 }
3432 }
3433
3434 if (!lttng_trigger_validate(copy)) {
3435 ret = -LTTNG_ERR_INVALID_TRIGGER;
3436 goto end;
3437 }
3438
3439 memset(&lsm, 0, sizeof(lsm));
3440 lsm.cmd_type = LTTNG_UNREGISTER_TRIGGER;
3441
3442 ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
3443 if (ret) {
3444 ret = -LTTNG_ERR_NOMEM;
3445 goto end;
3446 }
3447
3448 ret = lttng_trigger_serialize(copy, &message);
3449 if (ret < 0) {
3450 ret = -LTTNG_ERR_UNK;
3451 goto end;
3452 }
3453
3454 /*
3455 * This is needed to populate the trigger object size for the command
3456 * header and number of fds sent.
3457 */
3458 message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
3459
3460 message_lsm->u.trigger.length = (uint32_t) message.buffer.size - sizeof(lsm);
3461
3462 {
3463 struct lttng_payload_view message_view =
3464 lttng_payload_view_from_payload(
3465 &message, 0, -1);
3466
3467 /*
3468 * Update the message header with the number of fd that will be
3469 * sent.
3470 */
3471 message_lsm->fd_count = lttng_payload_view_get_fd_handle_count(
3472 &message_view);
3473
3474 ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
3475 if (ret < 0) {
3476 goto end;
3477 }
3478 }
3479
3480 ret = 0;
3481 end:
3482 lttng_trigger_destroy(copy);
3483 lttng_payload_reset(&message);
3484 lttng_payload_reset(&reply);
3485 return ret;
3486 }
3487
3488 /*
3489 * Ask the session daemon for all registered triggers for the current user.
3490 *
3491 * Allocates and return an lttng_triggers set.
3492 * On error, returns a suitable lttng_error_code.
3493 */
3494 enum lttng_error_code lttng_list_triggers(struct lttng_triggers **triggers)
3495 {
3496 int ret;
3497 enum lttng_error_code ret_code = LTTNG_OK;
3498 struct lttcomm_session_msg lsm = { .cmd_type = LTTNG_LIST_TRIGGERS };
3499 struct lttng_triggers *local_triggers = NULL;
3500 struct lttng_payload reply;
3501 struct lttng_payload_view lsm_view =
3502 lttng_payload_view_init_from_buffer(
3503 (const char *) &lsm, 0, sizeof(lsm));
3504
3505 lttng_payload_init(&reply);
3506
3507 ret = lttng_ctl_ask_sessiond_payload(&lsm_view, &reply);
3508 if (ret < 0) {
3509 ret_code = (enum lttng_error_code) -ret;
3510 goto end;
3511 }
3512
3513 {
3514 struct lttng_payload_view reply_view =
3515 lttng_payload_view_from_payload(
3516 &reply, 0, reply.buffer.size);
3517
3518 ret = lttng_triggers_create_from_payload(
3519 &reply_view, &local_triggers);
3520 if (ret < 0) {
3521 ret_code = LTTNG_ERR_FATAL;
3522 goto end;
3523 }
3524 }
3525
3526 *triggers = local_triggers;
3527 local_triggers = NULL;
3528 end:
3529 lttng_payload_reset(&reply);
3530 lttng_triggers_destroy(local_triggers);
3531 return ret_code;
3532 }
3533
3534 /*
3535 * lib constructor.
3536 */
3537 static void __attribute__((constructor)) init(void)
3538 {
3539 /* Set default session group */
3540 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
3541 }
3542
3543 /*
3544 * lib destructor.
3545 */
3546 static void __attribute__((destructor)) lttng_ctl_exit(void)
3547 {
3548 free(tracing_group);
3549 }
This page took 0.143217 seconds and 4 git commands to generate.