1743e7546c1071713aff10d9f10c73ad30ee955a
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.cpp
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 <grp.h>
15 #include <stdio.h>
16 #include <stdlib.h>
17 #include <stdint.h>
18 #include <string.h>
19 #include <unistd.h>
20
21 #include <common/bytecode/bytecode.h>
22 #include <common/align.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.hpp>
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 LTTNG_EXPORT int lttng_opt_quiet;
78 LTTNG_EXPORT int lttng_opt_verbose;
79 LTTNG_EXPORT 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 void lttng_ctl_copy_lttng_domain(struct lttng_domain *dst,
87 struct lttng_domain *src)
88 {
89 if (src && dst) {
90 switch (src->type) {
91 case LTTNG_DOMAIN_KERNEL:
92 case LTTNG_DOMAIN_UST:
93 case LTTNG_DOMAIN_JUL:
94 case LTTNG_DOMAIN_LOG4J:
95 case LTTNG_DOMAIN_PYTHON:
96 memcpy(dst, src, sizeof(struct lttng_domain));
97 break;
98 default:
99 memset(dst, 0, sizeof(struct lttng_domain));
100 break;
101 }
102 }
103 }
104
105 /*
106 * Send lttcomm_session_msg to the session daemon.
107 *
108 * On success, returns the number of bytes sent (>=0)
109 * On error, returns -1
110 */
111 static int send_session_msg(struct lttcomm_session_msg *lsm)
112 {
113 int ret;
114
115 if (!connected) {
116 ret = -LTTNG_ERR_NO_SESSIOND;
117 goto end;
118 }
119
120 DBG("LSM cmd type: '%s' (%d)", lttcomm_sessiond_command_str((lttcomm_sessiond_command) lsm->cmd_type),
121 lsm->cmd_type);
122
123 ret = lttcomm_send_creds_unix_sock(sessiond_socket, lsm,
124 sizeof(struct lttcomm_session_msg));
125 if (ret < 0) {
126 ret = -LTTNG_ERR_FATAL;
127 }
128
129 end:
130 return ret;
131 }
132
133 /*
134 * Send var len data to the session daemon.
135 *
136 * On success, returns the number of bytes sent (>=0)
137 * On error, returns -1
138 */
139 static int send_session_varlen(const void *data, size_t len)
140 {
141 int ret;
142
143 if (!connected) {
144 ret = -LTTNG_ERR_NO_SESSIOND;
145 goto end;
146 }
147
148 if (!data || !len) {
149 ret = 0;
150 goto end;
151 }
152
153 ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
154 if (ret < 0) {
155 ret = -LTTNG_ERR_FATAL;
156 }
157
158 end:
159 return ret;
160 }
161
162 /*
163 * Send file descriptors to the session daemon.
164 *
165 * On success, returns the number of bytes sent (>=0)
166 * On error, returns -1
167 */
168 static int send_session_fds(const int *fds, size_t nb_fd)
169 {
170 int ret;
171
172 if (!connected) {
173 ret = -LTTNG_ERR_NO_SESSIOND;
174 goto end;
175 }
176
177 if (!fds || !nb_fd) {
178 ret = 0;
179 goto end;
180 }
181
182 ret = lttcomm_send_fds_unix_sock(sessiond_socket, fds, nb_fd);
183 if (ret < 0) {
184 ret = -LTTNG_ERR_FATAL;
185 }
186
187 end:
188 return ret;
189 }
190
191 /*
192 * Receive data from the sessiond socket.
193 *
194 * On success, returns the number of bytes received (>=0)
195 * On error, returns a negative lttng_error_code.
196 */
197 static int recv_data_sessiond(void *buf, size_t len)
198 {
199 int ret;
200
201 LTTNG_ASSERT(len > 0);
202
203 if (!connected) {
204 ret = -LTTNG_ERR_NO_SESSIOND;
205 goto end;
206 }
207
208 ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len);
209 if (ret < 0) {
210 ret = -LTTNG_ERR_FATAL;
211 } else if (ret == 0) {
212 ret = -LTTNG_ERR_NO_SESSIOND;
213 }
214
215 end:
216 return ret;
217 }
218
219 /*
220 * Receive a payload from the session daemon by appending to an existing
221 * payload.
222 * On success, returns the number of bytes received (>=0)
223 * On error, returns a negative lttng_error_code.
224 */
225 static int recv_payload_sessiond(struct lttng_payload *payload, size_t len)
226 {
227 int ret;
228 const size_t original_payload_size = payload->buffer.size;
229
230 ret = lttng_dynamic_buffer_set_size(
231 &payload->buffer, payload->buffer.size + len);
232 if (ret) {
233 ret = -LTTNG_ERR_NOMEM;
234 goto end;
235 }
236
237 ret = recv_data_sessiond(
238 payload->buffer.data + original_payload_size, len);
239 end:
240 return ret;
241 }
242
243 /*
244 * Check if we are in the specified group.
245 *
246 * If yes return 1, else return -1.
247 */
248 int lttng_check_tracing_group(void)
249 {
250 gid_t *grp_list, tracing_gid;
251 int grp_list_size, grp_id, i;
252 int ret = -1;
253 const char *grp_name = tracing_group;
254
255 /* Get GID of group 'tracing' */
256 if (utils_get_group_id(grp_name, false, &tracing_gid)) {
257 /* If grp_tracing is NULL, the group does not exist. */
258 goto end;
259 }
260
261 /* Get number of supplementary group IDs */
262 grp_list_size = getgroups(0, NULL);
263 if (grp_list_size < 0) {
264 PERROR("getgroups");
265 goto end;
266 }
267
268 /* Alloc group list of the right size */
269 grp_list = (gid_t *) zmalloc(grp_list_size * sizeof(gid_t));
270 if (!grp_list) {
271 PERROR("malloc");
272 goto end;
273 }
274 grp_id = getgroups(grp_list_size, grp_list);
275 if (grp_id < 0) {
276 PERROR("getgroups");
277 goto free_list;
278 }
279
280 for (i = 0; i < grp_list_size; i++) {
281 if (grp_list[i] == tracing_gid) {
282 ret = 1;
283 break;
284 }
285 }
286
287 free_list:
288 free(grp_list);
289
290 end:
291 return ret;
292 }
293
294 static enum lttng_error_code check_enough_available_memory(
295 uint64_t num_bytes_requested_per_cpu)
296 {
297 int ret;
298 enum lttng_error_code ret_code;
299 long num_cpu;
300 uint64_t best_mem_info;
301 uint64_t num_bytes_requested_total;
302
303 /*
304 * Get the number of CPU currently online to compute the amount of
305 * memory needed to create a buffer for every CPU.
306 */
307 num_cpu = sysconf(_SC_NPROCESSORS_ONLN);
308 if (num_cpu == -1) {
309 ret_code = LTTNG_ERR_FATAL;
310 goto end;
311 }
312
313 if (num_bytes_requested_per_cpu > UINT64_MAX / (uint64_t) num_cpu) {
314 /* Overflow */
315 ret_code = LTTNG_ERR_OVERFLOW;
316 goto end;
317 }
318
319 num_bytes_requested_total =
320 num_bytes_requested_per_cpu * (uint64_t) num_cpu;
321
322 /*
323 * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
324 * reliable estimate we can get but it is only exposed by the kernel
325 * since 3.14. (See Linux kernel commit:
326 * 34e431b0ae398fc54ea69ff85ec700722c9da773)
327 */
328 ret = utils_get_memory_available(&best_mem_info);
329 if (ret >= 0) {
330 goto success;
331 }
332
333 /*
334 * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This
335 * is a sanity check for obvious user error.
336 */
337 ret = utils_get_memory_total(&best_mem_info);
338 if (ret >= 0) {
339 goto success;
340 }
341
342 /* No valid source of information. */
343 ret_code = LTTNG_ERR_NOMEM;
344 goto end;
345
346 success:
347 if (best_mem_info >= num_bytes_requested_total) {
348 ret_code = LTTNG_OK;
349 } else {
350 ret_code = LTTNG_ERR_NOMEM;
351 }
352 end:
353 return ret_code;
354 }
355
356 /*
357 * Try connect to session daemon with sock_path.
358 *
359 * Return 0 on success, else -1
360 */
361 static int try_connect_sessiond(const char *sock_path)
362 {
363 int ret;
364
365 /* If socket exist, we check if the daemon listens for connect. */
366 ret = access(sock_path, F_OK);
367 if (ret < 0) {
368 /* Not alive */
369 goto error;
370 }
371
372 ret = lttcomm_connect_unix_sock(sock_path);
373 if (ret < 0) {
374 /* Not alive. */
375 goto error;
376 }
377
378 ret = lttcomm_close_unix_sock(ret);
379 if (ret < 0) {
380 PERROR("lttcomm_close_unix_sock");
381 }
382
383 return 0;
384
385 error:
386 return -1;
387 }
388
389 /*
390 * Set sessiond socket path by putting it in the global sessiond_sock_path
391 * variable.
392 *
393 * Returns 0 on success, negative value on failure (the sessiond socket path
394 * is somehow too long or ENOMEM).
395 */
396 static int set_session_daemon_path(void)
397 {
398 int in_tgroup = 0; /* In tracing group. */
399 uid_t uid;
400
401 uid = getuid();
402
403 if (uid != 0) {
404 /* Are we in the tracing group ? */
405 in_tgroup = lttng_check_tracing_group();
406 }
407
408 if ((uid == 0) || in_tgroup == 1) {
409 const int ret = lttng_strncpy(sessiond_sock_path,
410 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK,
411 sizeof(sessiond_sock_path));
412
413 if (ret) {
414 goto error;
415 }
416 }
417
418 if (uid != 0) {
419 int ret;
420
421 if (in_tgroup) {
422 /* Tracing group. */
423 ret = try_connect_sessiond(sessiond_sock_path);
424 if (ret >= 0) {
425 goto end;
426 }
427 /* Global session daemon not available... */
428 }
429 /* ...or not in tracing group (and not root), default */
430
431 /*
432 * With GNU C < 2.1, snprintf returns -1 if the target buffer
433 * is too small;
434 * With GNU C >= 2.1, snprintf returns the required size
435 * (excluding closing null)
436 */
437 ret = snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
438 DEFAULT_HOME_CLIENT_UNIX_SOCK, utils_get_home_dir());
439 if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) {
440 goto error;
441 }
442 }
443 end:
444 return 0;
445
446 error:
447 return -1;
448 }
449
450 /*
451 * Connect to the LTTng session daemon.
452 *
453 * On success, return the socket's file descriptor. On error, return -1.
454 */
455 int connect_sessiond(void)
456 {
457 int ret;
458
459 ret = set_session_daemon_path();
460 if (ret < 0) {
461 goto error;
462 }
463
464 /* Connect to the sesssion daemon. */
465 ret = lttcomm_connect_unix_sock(sessiond_sock_path);
466 if (ret < 0) {
467 goto error;
468 }
469
470 return ret;
471
472 error:
473 return -1;
474 }
475
476 static void reset_global_sessiond_connection_state(void)
477 {
478 sessiond_socket = -1;
479 connected = 0;
480 }
481
482 /*
483 * Clean disconnect from the session daemon.
484 *
485 * On success, return 0. On error, return -1.
486 */
487 static int disconnect_sessiond(void)
488 {
489 int ret = 0;
490
491 if (connected) {
492 ret = lttcomm_close_unix_sock(sessiond_socket);
493 reset_global_sessiond_connection_state();
494 }
495
496 return ret;
497 }
498
499 static int recv_sessiond_optional_data(size_t len, void **user_buf,
500 size_t *user_len)
501 {
502 int ret = 0;
503 void *buf = NULL;
504
505 if (len) {
506 if (!user_len) {
507 ret = -LTTNG_ERR_INVALID;
508 goto end;
509 }
510
511 buf = zmalloc(len);
512 if (!buf) {
513 ret = -ENOMEM;
514 goto end;
515 }
516
517 ret = recv_data_sessiond(buf, len);
518 if (ret < 0) {
519 goto end;
520 }
521
522 if (!user_buf) {
523 ret = -LTTNG_ERR_INVALID;
524 goto end;
525 }
526
527 /* Move ownership of command header buffer to user. */
528 *user_buf = buf;
529 buf = NULL;
530 *user_len = len;
531 } else {
532 /* No command header. */
533 if (user_len) {
534 *user_len = 0;
535 }
536
537 if (user_buf) {
538 *user_buf = NULL;
539 }
540 }
541
542 end:
543 free(buf);
544 return ret;
545 }
546
547 /*
548 * Ask the session daemon a specific command and put the data into buf.
549 * Takes extra var. len. data and file descriptors as input to send to the
550 * session daemon.
551 *
552 * Return size of data (only payload, not header) or a negative error code.
553 */
554 int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg *lsm,
555 const int *fds, size_t nb_fd, const void *vardata,
556 size_t vardata_len, void **user_payload_buf,
557 void **user_cmd_header_buf, size_t *user_cmd_header_len)
558 {
559 int ret;
560 size_t payload_len;
561 struct lttcomm_lttng_msg llm;
562
563 ret = connect_sessiond();
564 if (ret < 0) {
565 ret = -LTTNG_ERR_NO_SESSIOND;
566 goto end;
567 } else {
568 sessiond_socket = ret;
569 connected = 1;
570 }
571
572 ret = send_session_msg(lsm);
573 if (ret < 0) {
574 /* Ret value is a valid lttng error code. */
575 goto end;
576 }
577 /* Send var len data */
578 ret = send_session_varlen(vardata, vardata_len);
579 if (ret < 0) {
580 /* Ret value is a valid lttng error code. */
581 goto end;
582 }
583
584 /* Send fds */
585 ret = send_session_fds(fds, nb_fd);
586 if (ret < 0) {
587 /* Ret value is a valid lttng error code. */
588 goto end;
589 }
590
591 /* Get header from data transmission */
592 ret = recv_data_sessiond(&llm, sizeof(llm));
593 if (ret < 0) {
594 /* Ret value is a valid lttng error code. */
595 goto end;
596 }
597
598 /* Check error code if OK */
599 if (llm.ret_code != LTTNG_OK) {
600 ret = -llm.ret_code;
601 goto end;
602 }
603
604 /* Get command header from data transmission */
605 ret = recv_sessiond_optional_data(llm.cmd_header_size,
606 user_cmd_header_buf, user_cmd_header_len);
607 if (ret < 0) {
608 goto end;
609 }
610
611 /* Get payload from data transmission */
612 ret = recv_sessiond_optional_data(llm.data_size, user_payload_buf,
613 &payload_len);
614 if (ret < 0) {
615 goto end;
616 }
617
618 ret = llm.data_size;
619
620 end:
621 disconnect_sessiond();
622 return ret;
623 }
624
625 int lttng_ctl_ask_sessiond_payload(struct lttng_payload_view *message,
626 struct lttng_payload *reply)
627 {
628 int ret;
629 struct lttcomm_lttng_msg llm;
630 const int fd_count = lttng_payload_view_get_fd_handle_count(message);
631
632 LTTNG_ASSERT(reply->buffer.size == 0);
633 LTTNG_ASSERT(lttng_dynamic_pointer_array_get_count(&reply->_fd_handles) == 0);
634
635 ret = connect_sessiond();
636 if (ret < 0) {
637 ret = -LTTNG_ERR_NO_SESSIOND;
638 goto end;
639 } else {
640 sessiond_socket = ret;
641 connected = 1;
642 }
643
644 /* Send command to session daemon */
645 ret = lttcomm_send_creds_unix_sock(sessiond_socket, message->buffer.data,
646 message->buffer.size);
647 if (ret < 0) {
648 ret = -LTTNG_ERR_FATAL;
649 goto end;
650 }
651
652 if (fd_count > 0) {
653 ret = lttcomm_send_payload_view_fds_unix_sock(sessiond_socket,
654 message);
655 if (ret < 0) {
656 ret = -LTTNG_ERR_FATAL;
657 goto end;
658 }
659 }
660
661 /* Get header from data transmission */
662 ret = recv_payload_sessiond(reply, sizeof(llm));
663 if (ret < 0) {
664 /* Ret value is a valid lttng error code. */
665 goto end;
666 }
667
668 llm = *((typeof(llm) *) reply->buffer.data);
669
670 /* Check error code if OK */
671 if (llm.ret_code != LTTNG_OK) {
672 if (llm.ret_code < LTTNG_OK || llm.ret_code >= LTTNG_ERR_NR) {
673 /* Invalid error code received. */
674 ret = -LTTNG_ERR_UNK;
675 } else {
676 ret = -llm.ret_code;
677 }
678 goto end;
679 }
680
681 if (llm.cmd_header_size > 0) {
682 ret = recv_payload_sessiond(reply, llm.cmd_header_size);
683 if (ret < 0) {
684 goto end;
685 }
686 }
687
688 /* Get command header from data transmission */
689 if (llm.data_size > 0) {
690 ret = recv_payload_sessiond(reply, llm.data_size);
691 if (ret < 0) {
692 goto end;
693 }
694 }
695
696 if (llm.fd_count > 0) {
697 ret = lttcomm_recv_payload_fds_unix_sock(
698 sessiond_socket, llm.fd_count, reply);
699 if (ret < 0) {
700 goto end;
701 }
702 }
703
704 /* Don't return the llm header to the caller. */
705 memmove(reply->buffer.data, reply->buffer.data + sizeof(llm),
706 reply->buffer.size - sizeof(llm));
707 ret = lttng_dynamic_buffer_set_size(
708 &reply->buffer, reply->buffer.size - sizeof(llm));
709 if (ret) {
710 /* Can't happen as size is reduced. */
711 abort();
712 }
713
714 ret = reply->buffer.size;
715
716 end:
717 disconnect_sessiond();
718 return ret;
719 }
720
721 /*
722 * Create lttng handle and return pointer.
723 *
724 * The returned pointer will be NULL in case of malloc() error.
725 */
726 struct lttng_handle *lttng_create_handle(const char *session_name,
727 struct lttng_domain *domain)
728 {
729 int ret;
730 struct lttng_handle *handle = NULL;
731
732 handle = (lttng_handle *) zmalloc(sizeof(struct lttng_handle));
733 if (handle == NULL) {
734 PERROR("malloc handle");
735 goto end;
736 }
737
738 /* Copy session name */
739 ret = lttng_strncpy(handle->session_name, session_name ? : "",
740 sizeof(handle->session_name));
741 if (ret) {
742 goto error;
743 }
744
745 /* Copy lttng domain or leave initialized to 0. */
746 if (domain) {
747 lttng_ctl_copy_lttng_domain(&handle->domain, domain);
748 }
749
750 end:
751 return handle;
752 error:
753 free(handle);
754 return NULL;
755 }
756
757 /*
758 * Destroy handle by free(3) the pointer.
759 */
760 void lttng_destroy_handle(struct lttng_handle *handle)
761 {
762 free(handle);
763 }
764
765 /*
766 * Register an outside consumer.
767 *
768 * Returns size of returned session payload data or a negative error code.
769 */
770 int lttng_register_consumer(struct lttng_handle *handle,
771 const char *socket_path)
772 {
773 int ret;
774 struct lttcomm_session_msg lsm;
775
776 if (handle == NULL || socket_path == NULL) {
777 ret = -LTTNG_ERR_INVALID;
778 goto end;
779 }
780
781 memset(&lsm, 0, sizeof(lsm));
782 lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
783 ret = lttng_strncpy(lsm.session.name, handle->session_name,
784 sizeof(lsm.session.name));
785 if (ret) {
786 ret = -LTTNG_ERR_INVALID;
787 goto end;
788 }
789
790 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
791
792 ret = lttng_strncpy(lsm.u.reg.path, socket_path,
793 sizeof(lsm.u.reg.path));
794 if (ret) {
795 ret = -LTTNG_ERR_INVALID;
796 goto end;
797 }
798
799 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
800 end:
801 return ret;
802 }
803
804 /*
805 * Start tracing for all traces of the session.
806 *
807 * Returns size of returned session payload data or a negative error code.
808 */
809 int lttng_start_tracing(const char *session_name)
810 {
811 int ret;
812 struct lttcomm_session_msg lsm;
813
814 if (session_name == NULL) {
815 ret = -LTTNG_ERR_INVALID;
816 goto end;
817 }
818
819 memset(&lsm, 0, sizeof(lsm));
820 lsm.cmd_type = LTTNG_START_TRACE;
821
822 ret = lttng_strncpy(lsm.session.name, session_name,
823 sizeof(lsm.session.name));
824 if (ret) {
825 ret = -LTTNG_ERR_INVALID;
826 goto end;
827 }
828
829 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
830 end:
831 return ret;
832 }
833
834 /*
835 * Stop tracing for all traces of the session.
836 */
837 static int _lttng_stop_tracing(const char *session_name, int wait)
838 {
839 int ret, data_ret;
840 struct lttcomm_session_msg lsm;
841
842 if (session_name == NULL) {
843 ret = -LTTNG_ERR_INVALID;
844 goto error;
845 }
846
847 memset(&lsm, 0, sizeof(lsm));
848 lsm.cmd_type = LTTNG_STOP_TRACE;
849
850 ret = lttng_strncpy(lsm.session.name, session_name,
851 sizeof(lsm.session.name));
852 if (ret) {
853 ret = -LTTNG_ERR_INVALID;
854 goto error;
855 }
856
857 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
858 if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
859 goto error;
860 }
861
862 if (!wait) {
863 goto end;
864 }
865
866 /* Check for data availability */
867 do {
868 data_ret = lttng_data_pending(session_name);
869 if (data_ret < 0) {
870 /* Return the data available call error. */
871 ret = data_ret;
872 goto error;
873 }
874
875 /*
876 * Data sleep time before retrying (in usec). Don't sleep if the
877 * call returned value indicates availability.
878 */
879 if (data_ret) {
880 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US);
881 }
882 } while (data_ret != 0);
883
884 end:
885 error:
886 return ret;
887 }
888
889 /*
890 * Stop tracing and wait for data availability.
891 */
892 int lttng_stop_tracing(const char *session_name)
893 {
894 return _lttng_stop_tracing(session_name, 1);
895 }
896
897 /*
898 * Stop tracing but _don't_ wait for data availability.
899 */
900 int lttng_stop_tracing_no_wait(const char *session_name)
901 {
902 return _lttng_stop_tracing(session_name, 0);
903 }
904
905 /*
906 * Add context to a channel.
907 *
908 * If the given channel is NULL, add the contexts to all channels.
909 * The event_name param is ignored.
910 *
911 * Returns the size of the returned payload data or a negative error code.
912 */
913 int lttng_add_context(struct lttng_handle *handle,
914 struct lttng_event_context *ctx, const char *event_name,
915 const char *channel_name)
916 {
917 int ret;
918 size_t len = 0;
919 char *buf = NULL;
920 struct lttcomm_session_msg lsm;
921
922 /* Safety check. Both are mandatory. */
923 if (handle == NULL || ctx == NULL) {
924 ret = -LTTNG_ERR_INVALID;
925 goto end;
926 }
927
928 memset(&lsm, 0, sizeof(lsm));
929 lsm.cmd_type = LTTNG_ADD_CONTEXT;
930
931 /* If no channel name, send empty string. */
932 ret = lttng_strncpy(lsm.u.context.channel_name, channel_name ?: "",
933 sizeof(lsm.u.context.channel_name));
934 if (ret) {
935 ret = -LTTNG_ERR_INVALID;
936 goto end;
937 }
938
939 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
940 ret = lttng_strncpy(lsm.session.name, handle->session_name,
941 sizeof(lsm.session.name));
942 if (ret) {
943 ret = -LTTNG_ERR_INVALID;
944 goto end;
945 }
946
947 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
948 size_t provider_len, ctx_len;
949 const char *provider_name = ctx->u.app_ctx.provider_name;
950 const char *ctx_name = ctx->u.app_ctx.ctx_name;
951
952 if (!provider_name || !ctx_name) {
953 ret = -LTTNG_ERR_INVALID;
954 goto end;
955 }
956
957 provider_len = strlen(provider_name);
958 if (provider_len == 0) {
959 ret = -LTTNG_ERR_INVALID;
960 goto end;
961 }
962 lsm.u.context.provider_name_len = provider_len;
963
964 ctx_len = strlen(ctx_name);
965 if (ctx_len == 0) {
966 ret = -LTTNG_ERR_INVALID;
967 goto end;
968 }
969 lsm.u.context.context_name_len = ctx_len;
970
971 len = provider_len + ctx_len;
972 buf = (char *) zmalloc(len);
973 if (!buf) {
974 ret = -LTTNG_ERR_NOMEM;
975 goto end;
976 }
977
978 memcpy(buf, provider_name, provider_len);
979 memcpy(buf + provider_len, ctx_name, ctx_len);
980 }
981 memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context));
982
983 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
984 /*
985 * Don't leak application addresses to the sessiond.
986 * This is only necessary when ctx is for an app ctx otherwise
987 * the values inside the union (type & config) are overwritten.
988 */
989 lsm.u.context.ctx.u.app_ctx.provider_name = NULL;
990 lsm.u.context.ctx.u.app_ctx.ctx_name = NULL;
991 }
992
993 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, buf, len, NULL);
994 end:
995 free(buf);
996 return ret;
997 }
998
999 /*
1000 * Enable event(s) for a channel.
1001 *
1002 * If no event name is specified, all events are enabled.
1003 * If no channel name is specified, the default 'channel0' is used.
1004 *
1005 * Returns size of returned session payload data or a negative error code.
1006 */
1007 int lttng_enable_event(struct lttng_handle *handle,
1008 struct lttng_event *ev, const char *channel_name)
1009 {
1010 return lttng_enable_event_with_exclusions(handle, ev, channel_name,
1011 NULL, 0, NULL);
1012 }
1013
1014 /*
1015 * Create or enable an event with a filter expression.
1016 *
1017 * Return negative error value on error.
1018 * Return size of returned session payload data if OK.
1019 */
1020 int lttng_enable_event_with_filter(struct lttng_handle *handle,
1021 struct lttng_event *event, const char *channel_name,
1022 const char *filter_expression)
1023 {
1024 return lttng_enable_event_with_exclusions(handle, event, channel_name,
1025 filter_expression, 0, NULL);
1026 }
1027
1028 /*
1029 * Depending on the event, return a newly allocated agent filter expression or
1030 * NULL if not applicable.
1031 *
1032 * An event with NO loglevel and the name is * will return NULL.
1033 */
1034 static char *set_agent_filter(const char *filter, struct lttng_event *ev)
1035 {
1036 int err;
1037 char *agent_filter = NULL;
1038
1039 LTTNG_ASSERT(ev);
1040
1041 /* Don't add filter for the '*' event. */
1042 if (strcmp(ev->name, "*") != 0) {
1043 if (filter) {
1044 err = asprintf(&agent_filter, "(%s) && (logger_name == \"%s\")", filter,
1045 ev->name);
1046 } else {
1047 err = asprintf(&agent_filter, "logger_name == \"%s\"", ev->name);
1048 }
1049 if (err < 0) {
1050 PERROR("asprintf");
1051 goto error;
1052 }
1053 }
1054
1055 /* Add loglevel filtering if any for the JUL domain. */
1056 if (ev->loglevel_type != LTTNG_EVENT_LOGLEVEL_ALL) {
1057 const char *op;
1058
1059 if (ev->loglevel_type == LTTNG_EVENT_LOGLEVEL_RANGE) {
1060 op = ">=";
1061 } else {
1062 op = "==";
1063 }
1064
1065 if (filter || agent_filter) {
1066 char *new_filter;
1067
1068 err = asprintf(&new_filter, "(%s) && (int_loglevel %s %d)",
1069 agent_filter ? agent_filter : filter, op,
1070 ev->loglevel);
1071 if (agent_filter) {
1072 free(agent_filter);
1073 }
1074 agent_filter = new_filter;
1075 } else {
1076 err = asprintf(&agent_filter, "int_loglevel %s %d", op,
1077 ev->loglevel);
1078 }
1079 if (err < 0) {
1080 PERROR("asprintf");
1081 goto error;
1082 }
1083 }
1084
1085 return agent_filter;
1086 error:
1087 free(agent_filter);
1088 return NULL;
1089 }
1090
1091 /*
1092 * Enable event(s) for a channel, possibly with exclusions and a filter.
1093 * If no event name is specified, all events are enabled.
1094 * If no channel name is specified, the default name is used.
1095 * If filter expression is not NULL, the filter is set for the event.
1096 * If exclusion count is not zero, the exclusions are set for the event.
1097 * Returns size of returned session payload data or a negative error code.
1098 */
1099 int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
1100 struct lttng_event *ev, const char *channel_name,
1101 const char *original_filter_expression,
1102 int exclusion_count, char **exclusion_list)
1103 {
1104 struct lttcomm_session_msg lsm;
1105 struct lttng_payload payload;
1106 int ret = 0, i;
1107 unsigned int free_filter_expression = 0;
1108 struct filter_parser_ctx *ctx = NULL;
1109
1110 /*
1111 * We have either a filter or some exclusions, so we need to set up
1112 * a variable-length payload from where to send the data.
1113 */
1114 lttng_payload_init(&payload);
1115
1116 /*
1117 * Cast as non-const since we may replace the filter expression
1118 * by a dynamically allocated string. Otherwise, the original
1119 * string is not modified.
1120 */
1121 char *filter_expression = (char *) original_filter_expression;
1122
1123 if (handle == NULL || ev == NULL) {
1124 ret = -LTTNG_ERR_INVALID;
1125 goto error;
1126 }
1127
1128 /*
1129 * Empty filter string will always be rejected by the parser
1130 * anyway, so treat this corner-case early to eliminate
1131 * lttng_fmemopen error for 0-byte allocation.
1132 */
1133 if (filter_expression && filter_expression[0] == '\0') {
1134 ret = -LTTNG_ERR_INVALID;
1135 goto error;
1136 }
1137
1138 memset(&lsm, 0, sizeof(lsm));
1139
1140 /* If no channel name, send empty string. */
1141 ret = lttng_strncpy(lsm.u.enable.channel_name, channel_name ?: "",
1142 sizeof(lsm.u.enable.channel_name));
1143 if (ret) {
1144 ret = -LTTNG_ERR_INVALID;
1145 goto error;
1146 }
1147
1148 lsm.cmd_type = LTTNG_ENABLE_EVENT;
1149 if (ev->name[0] == '\0') {
1150 /* Enable all events. */
1151 ret = lttng_strncpy(ev->name, "*", sizeof(ev->name));
1152 LTTNG_ASSERT(ret == 0);
1153 }
1154
1155 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1156 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
1157
1158 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1159 sizeof(lsm.session.name));
1160 if (ret) {
1161 ret = -LTTNG_ERR_INVALID;
1162 goto error;
1163 }
1164
1165 lsm.u.enable.exclusion_count = exclusion_count;
1166 lsm.u.enable.bytecode_len = 0;
1167
1168 /* Parse filter expression. */
1169 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1170 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1171 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1172 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1173 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1174 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1175 char *agent_filter;
1176
1177 /* Setup JUL filter if needed. */
1178 agent_filter = set_agent_filter(filter_expression, ev);
1179 if (!agent_filter) {
1180 if (!filter_expression) {
1181 /*
1182 * No JUL and no filter, just skip
1183 * everything below.
1184 */
1185 goto ask_sessiond;
1186 }
1187 } else {
1188 /*
1189 * With an agent filter, the original filter has
1190 * been added to it thus replace the filter
1191 * expression.
1192 */
1193 filter_expression = agent_filter;
1194 free_filter_expression = 1;
1195 }
1196 }
1197
1198 ret = filter_parser_ctx_create_from_filter_expression(filter_expression, &ctx);
1199 if (ret) {
1200 goto filter_error;
1201 }
1202
1203 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
1204 + bytecode_get_len(&ctx->bytecode->b);
1205 lsm.u.enable.expression_len = strlen(filter_expression) + 1;
1206 }
1207
1208 ret = lttng_dynamic_buffer_set_capacity(&payload.buffer,
1209 lsm.u.enable.bytecode_len +
1210 lsm.u.enable.expression_len +
1211 LTTNG_SYMBOL_NAME_LEN *
1212 exclusion_count);
1213 if (ret) {
1214 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1215 goto mem_error;
1216 }
1217
1218 /* Put exclusion names first in the data. */
1219 for (i = 0; i < exclusion_count; i++) {
1220 size_t exclusion_len;
1221
1222 exclusion_len = lttng_strnlen(exclusion_list[i],
1223 LTTNG_SYMBOL_NAME_LEN);
1224 if (exclusion_len == LTTNG_SYMBOL_NAME_LEN) {
1225 /* Exclusion is not NULL-terminated. */
1226 ret = -LTTNG_ERR_INVALID;
1227 goto mem_error;
1228 }
1229
1230 ret = lttng_dynamic_buffer_append(&payload.buffer,
1231 exclusion_list[i], exclusion_len);
1232 if (ret) {
1233 goto mem_error;
1234 }
1235
1236 /*
1237 * Padding the rest of the entry with zeros. Every exclusion
1238 * entries take LTTNG_SYMBOL_NAME_LEN bytes in the buffer.
1239 */
1240 ret = lttng_dynamic_buffer_set_size(&payload.buffer,
1241 LTTNG_SYMBOL_NAME_LEN * (i + 1));
1242 if (ret) {
1243 goto mem_error;
1244 }
1245 }
1246
1247 /* Add filter expression next. */
1248 if (filter_expression) {
1249 ret = lttng_dynamic_buffer_append(&payload.buffer,
1250 filter_expression, lsm.u.enable.expression_len);
1251 if (ret) {
1252 goto mem_error;
1253 }
1254 }
1255 /* Add filter bytecode next. */
1256 if (ctx && lsm.u.enable.bytecode_len != 0) {
1257 ret = lttng_dynamic_buffer_append(&payload.buffer,
1258 &ctx->bytecode->b, lsm.u.enable.bytecode_len);
1259 if (ret) {
1260 goto mem_error;
1261 }
1262 }
1263 if (ev->extended.ptr) {
1264 struct lttng_event_extended *ev_ext =
1265 (struct lttng_event_extended *) ev->extended.ptr;
1266
1267 if (ev_ext->probe_location) {
1268 /*
1269 * lttng_userspace_probe_location_serialize returns the
1270 * number of bytes that was appended to the buffer.
1271 */
1272 ret = lttng_userspace_probe_location_serialize(
1273 ev_ext->probe_location, &payload);
1274 if (ret < 0) {
1275 goto mem_error;
1276 }
1277
1278 /*
1279 * Set the size of the userspace probe location element
1280 * of the buffer so that the receiving side knows where
1281 * to split it.
1282 */
1283 lsm.u.enable.userspace_probe_location_len = ret;
1284 }
1285 }
1286
1287 {
1288 struct lttng_payload_view view = lttng_payload_view_from_payload(
1289 &payload, 0, -1);
1290 int fd_count = lttng_payload_view_get_fd_handle_count(&view);
1291 int fd_to_send;
1292
1293 if (fd_count < 0) {
1294 goto mem_error;
1295 }
1296
1297 LTTNG_ASSERT(fd_count == 0 || fd_count == 1);
1298 if (fd_count == 1) {
1299 struct fd_handle *h =
1300 lttng_payload_view_pop_fd_handle(&view);
1301
1302 if (!h) {
1303 goto mem_error;
1304 }
1305
1306 fd_to_send = fd_handle_get_fd(h);
1307 fd_handle_put(h);
1308 }
1309
1310 ret = lttng_ctl_ask_sessiond_fds_varlen(&lsm,
1311 fd_count ? &fd_to_send : NULL, fd_count,
1312 view.buffer.size ? view.buffer.data : NULL,
1313 view.buffer.size, NULL, NULL, 0);
1314 }
1315
1316 mem_error:
1317 if (filter_expression && ctx) {
1318 filter_bytecode_free(ctx);
1319 filter_ir_free(ctx);
1320 filter_parser_ctx_free(ctx);
1321 }
1322 filter_error:
1323 if (free_filter_expression) {
1324 /*
1325 * The filter expression has been replaced and must be freed as
1326 * it is not the original filter expression received as a
1327 * parameter.
1328 */
1329 free(filter_expression);
1330 }
1331 error:
1332 /*
1333 * Return directly to the caller and don't ask the sessiond since
1334 * something went wrong in the parsing of data above.
1335 */
1336 lttng_payload_reset(&payload);
1337 return ret;
1338
1339 ask_sessiond:
1340 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1341 return ret;
1342 }
1343
1344 int lttng_disable_event_ext(struct lttng_handle *handle,
1345 struct lttng_event *ev, const char *channel_name,
1346 const char *original_filter_expression)
1347 {
1348 struct lttcomm_session_msg lsm;
1349 char *varlen_data;
1350 int ret = 0;
1351 unsigned int free_filter_expression = 0;
1352 struct filter_parser_ctx *ctx = NULL;
1353 /*
1354 * Cast as non-const since we may replace the filter expression
1355 * by a dynamically allocated string. Otherwise, the original
1356 * string is not modified.
1357 */
1358 char *filter_expression = (char *) original_filter_expression;
1359
1360 if (handle == NULL || ev == NULL) {
1361 ret = -LTTNG_ERR_INVALID;
1362 goto error;
1363 }
1364
1365 /*
1366 * Empty filter string will always be rejected by the parser
1367 * anyway, so treat this corner-case early to eliminate
1368 * lttng_fmemopen error for 0-byte allocation.
1369 */
1370 if (filter_expression && filter_expression[0] == '\0') {
1371 ret = -LTTNG_ERR_INVALID;
1372 goto error;
1373 }
1374
1375 memset(&lsm, 0, sizeof(lsm));
1376
1377 /* If no channel name, send empty string. */
1378 ret = lttng_strncpy(lsm.u.disable.channel_name, channel_name ?: "",
1379 sizeof(lsm.u.disable.channel_name));
1380 if (ret) {
1381 ret = -LTTNG_ERR_INVALID;
1382 goto error;
1383 }
1384
1385 lsm.cmd_type = LTTNG_DISABLE_EVENT;
1386
1387 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1388 memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event));
1389
1390 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1391 sizeof(lsm.session.name));
1392 if (ret) {
1393 ret = -LTTNG_ERR_INVALID;
1394 goto error;
1395 }
1396
1397 lsm.u.disable.bytecode_len = 0;
1398
1399 /*
1400 * For the JUL domain, a filter is enforced except for the
1401 * disable all event. This is done to avoid having the event in
1402 * all sessions thus filtering by logger name.
1403 */
1404 if (filter_expression == NULL &&
1405 (handle->domain.type != LTTNG_DOMAIN_JUL &&
1406 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
1407 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
1408 goto ask_sessiond;
1409 }
1410
1411 /*
1412 * We have a filter, so we need to set up a variable-length
1413 * memory block from where to send the data.
1414 */
1415
1416 /* Parse filter expression */
1417 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1418 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1419 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1420 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1421 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1422 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1423 char *agent_filter;
1424
1425 /* Setup JUL filter if needed. */
1426 agent_filter = set_agent_filter(filter_expression, ev);
1427 if (!agent_filter) {
1428 if (!filter_expression) {
1429 /*
1430 * No JUL and no filter, just skip
1431 * everything below.
1432 */
1433 goto ask_sessiond;
1434 }
1435 } else {
1436 /*
1437 * With a JUL filter, the original filter has
1438 * been added to it thus replace the filter
1439 * expression.
1440 */
1441 filter_expression = agent_filter;
1442 free_filter_expression = 1;
1443 }
1444 }
1445
1446 ret = filter_parser_ctx_create_from_filter_expression(filter_expression, &ctx);
1447 if (ret) {
1448 goto filter_error;
1449 }
1450
1451 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
1452 + bytecode_get_len(&ctx->bytecode->b);
1453 lsm.u.enable.expression_len = strlen(filter_expression) + 1;
1454 }
1455
1456 varlen_data = (char *) zmalloc(lsm.u.disable.bytecode_len
1457 + lsm.u.disable.expression_len);
1458 if (!varlen_data) {
1459 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1460 goto mem_error;
1461 }
1462
1463 /* Add filter expression. */
1464 if (lsm.u.disable.expression_len != 0) {
1465 memcpy(varlen_data,
1466 filter_expression,
1467 lsm.u.disable.expression_len);
1468 }
1469 /* Add filter bytecode next. */
1470 if (ctx && lsm.u.disable.bytecode_len != 0) {
1471 memcpy(varlen_data
1472 + lsm.u.disable.expression_len,
1473 &ctx->bytecode->b,
1474 lsm.u.disable.bytecode_len);
1475 }
1476
1477 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, varlen_data,
1478 lsm.u.disable.bytecode_len + lsm.u.disable.expression_len, NULL);
1479 free(varlen_data);
1480
1481 mem_error:
1482 if (filter_expression && ctx) {
1483 filter_bytecode_free(ctx);
1484 filter_ir_free(ctx);
1485 filter_parser_ctx_free(ctx);
1486 }
1487 filter_error:
1488 if (free_filter_expression) {
1489 /*
1490 * The filter expression has been replaced and must be freed as
1491 * it is not the original filter expression received as a
1492 * parameter.
1493 */
1494 free(filter_expression);
1495 }
1496 error:
1497 /*
1498 * Return directly to the caller and don't ask the sessiond since
1499 * something went wrong in the parsing of data above.
1500 */
1501 return ret;
1502
1503 ask_sessiond:
1504 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1505 return ret;
1506 }
1507
1508 /*
1509 * Disable event(s) of a channel and domain.
1510 * If no event name is specified, all events are disabled.
1511 * If no channel name is specified, the default 'channel0' is used.
1512 * Returns size of returned session payload data or a negative error code.
1513 */
1514 int lttng_disable_event(struct lttng_handle *handle, const char *name,
1515 const char *channel_name)
1516 {
1517 int ret;
1518 struct lttng_event ev;
1519
1520 memset(&ev, 0, sizeof(ev));
1521 ev.loglevel = -1;
1522 ev.type = LTTNG_EVENT_ALL;
1523 ret = lttng_strncpy(ev.name, name ?: "", sizeof(ev.name));
1524 if (ret) {
1525 ret = -LTTNG_ERR_INVALID;
1526 goto end;
1527 }
1528
1529 ret = lttng_disable_event_ext(handle, &ev, channel_name, NULL);
1530 end:
1531 return ret;
1532 }
1533
1534 struct lttng_channel *lttng_channel_create(struct lttng_domain *domain)
1535 {
1536 struct lttng_channel *channel = NULL;
1537 struct lttng_channel_extended *extended = NULL;
1538
1539 if (!domain) {
1540 goto error;
1541 }
1542
1543 /* Validate domain. */
1544 switch (domain->type) {
1545 case LTTNG_DOMAIN_UST:
1546 switch (domain->buf_type) {
1547 case LTTNG_BUFFER_PER_UID:
1548 case LTTNG_BUFFER_PER_PID:
1549 break;
1550 default:
1551 goto error;
1552 }
1553 break;
1554 case LTTNG_DOMAIN_KERNEL:
1555 if (domain->buf_type != LTTNG_BUFFER_GLOBAL) {
1556 goto error;
1557 }
1558 break;
1559 default:
1560 goto error;
1561 }
1562
1563 channel = (lttng_channel *) zmalloc(sizeof(*channel));
1564 if (!channel) {
1565 goto error;
1566 }
1567
1568 extended = (lttng_channel_extended *) zmalloc(sizeof(*extended));
1569 if (!extended) {
1570 goto error;
1571 }
1572
1573 channel->attr.extended.ptr = extended;
1574
1575 lttng_channel_set_default_attr(domain, &channel->attr);
1576 return channel;
1577 error:
1578 free(channel);
1579 free(extended);
1580 return NULL;
1581 }
1582
1583 void lttng_channel_destroy(struct lttng_channel *channel)
1584 {
1585 if (!channel) {
1586 return;
1587 }
1588
1589 if (channel->attr.extended.ptr) {
1590 free(channel->attr.extended.ptr);
1591 }
1592 free(channel);
1593 }
1594
1595 /*
1596 * Enable channel per domain
1597 * Returns size of returned session payload data or a negative error code.
1598 */
1599 int lttng_enable_channel(struct lttng_handle *handle,
1600 struct lttng_channel *in_chan)
1601 {
1602 enum lttng_error_code ret_code;
1603 int ret;
1604 struct lttcomm_session_msg lsm;
1605 uint64_t total_buffer_size_needed_per_cpu = 0;
1606
1607 /* NULL arguments are forbidden. No default values. */
1608 if (handle == NULL || in_chan == NULL) {
1609 return -LTTNG_ERR_INVALID;
1610 }
1611
1612 memset(&lsm, 0, sizeof(lsm));
1613 memcpy(&lsm.u.channel.chan, in_chan, sizeof(lsm.u.channel.chan));
1614 lsm.u.channel.chan.attr.extended.ptr = NULL;
1615
1616 if (!in_chan->attr.extended.ptr) {
1617 struct lttng_channel *channel;
1618 struct lttng_channel_extended *extended;
1619
1620 channel = lttng_channel_create(&handle->domain);
1621 if (!channel) {
1622 return -LTTNG_ERR_NOMEM;
1623 }
1624
1625 /*
1626 * Create a new channel in order to use default extended
1627 * attribute values.
1628 */
1629 extended = (struct lttng_channel_extended *)
1630 channel->attr.extended.ptr;
1631 memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
1632 lttng_channel_destroy(channel);
1633 } else {
1634 struct lttng_channel_extended *extended;
1635
1636 extended = (struct lttng_channel_extended *)
1637 in_chan->attr.extended.ptr;
1638 memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
1639 }
1640
1641 /*
1642 * Verify that the amount of memory required to create the requested
1643 * buffer is available on the system at the moment.
1644 */
1645 if (lsm.u.channel.chan.attr.num_subbuf >
1646 UINT64_MAX / lsm.u.channel.chan.attr.subbuf_size) {
1647 /* Overflow */
1648 ret = -LTTNG_ERR_OVERFLOW;
1649 goto end;
1650 }
1651
1652 total_buffer_size_needed_per_cpu = lsm.u.channel.chan.attr.num_subbuf *
1653 lsm.u.channel.chan.attr.subbuf_size;
1654 ret_code = check_enough_available_memory(
1655 total_buffer_size_needed_per_cpu);
1656 if (ret_code != LTTNG_OK) {
1657 ret = -ret_code;
1658 goto end;
1659 }
1660
1661 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
1662 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1663
1664 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1665 sizeof(lsm.session.name));
1666 if (ret) {
1667 ret = -LTTNG_ERR_INVALID;
1668 goto end;
1669 }
1670
1671 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1672 end:
1673 return ret;
1674 }
1675
1676 /*
1677 * All tracing will be stopped for registered events of the channel.
1678 * Returns size of returned session payload data or a negative error code.
1679 */
1680 int lttng_disable_channel(struct lttng_handle *handle, const char *name)
1681 {
1682 int ret;
1683 struct lttcomm_session_msg lsm;
1684
1685 /* Safety check. Both are mandatory. */
1686 if (handle == NULL || name == NULL) {
1687 return -LTTNG_ERR_INVALID;
1688 }
1689
1690 memset(&lsm, 0, sizeof(lsm));
1691
1692 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1693
1694 ret = lttng_strncpy(lsm.u.disable.channel_name, name,
1695 sizeof(lsm.u.disable.channel_name));
1696 if (ret) {
1697 ret = -LTTNG_ERR_INVALID;
1698 goto end;
1699 }
1700
1701 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1702
1703 ret = lttng_strncpy(lsm.session.name, handle->session_name,
1704 sizeof(lsm.session.name));
1705 if (ret) {
1706 ret = -LTTNG_ERR_INVALID;
1707 goto end;
1708 }
1709
1710 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1711 end:
1712 return ret;
1713 }
1714
1715 /*
1716 * Lists all available tracepoints of domain.
1717 * Sets the contents of the events array.
1718 * Returns the number of lttng_event entries in events;
1719 * on error, returns a negative value.
1720 */
1721 int lttng_list_tracepoints(struct lttng_handle *handle,
1722 struct lttng_event **events)
1723 {
1724 int ret;
1725 struct lttcomm_session_msg lsm;
1726
1727 if (handle == NULL) {
1728 return -LTTNG_ERR_INVALID;
1729 }
1730
1731 memset(&lsm, 0, sizeof(lsm));
1732 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
1733 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1734
1735 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1736 if (ret < 0) {
1737 return ret;
1738 }
1739
1740 return ret / sizeof(struct lttng_event);
1741 }
1742
1743 /*
1744 * Lists all available tracepoint fields of domain.
1745 * Sets the contents of the event field array.
1746 * Returns the number of lttng_event_field entries in events;
1747 * on error, returns a negative value.
1748 */
1749 int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1750 struct lttng_event_field **fields)
1751 {
1752 int ret;
1753 struct lttcomm_session_msg lsm;
1754
1755 if (handle == NULL) {
1756 return -LTTNG_ERR_INVALID;
1757 }
1758
1759 memset(&lsm, 0, sizeof(lsm));
1760 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
1761 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
1762
1763 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
1764 if (ret < 0) {
1765 return ret;
1766 }
1767
1768 return ret / sizeof(struct lttng_event_field);
1769 }
1770
1771 /*
1772 * Lists all available kernel system calls. Allocates and sets the contents of
1773 * the events array.
1774 *
1775 * Returns the number of lttng_event entries in events; on error, returns a
1776 * negative value.
1777 */
1778 int lttng_list_syscalls(struct lttng_event **events)
1779 {
1780 int ret;
1781 struct lttcomm_session_msg lsm;
1782
1783 if (!events) {
1784 return -LTTNG_ERR_INVALID;
1785 }
1786
1787 memset(&lsm, 0, sizeof(lsm));
1788 lsm.cmd_type = LTTNG_LIST_SYSCALLS;
1789 /* Force kernel domain for system calls. */
1790 lsm.domain.type = LTTNG_DOMAIN_KERNEL;
1791
1792 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1793 if (ret < 0) {
1794 return ret;
1795 }
1796
1797 return ret / sizeof(struct lttng_event);
1798 }
1799
1800 /*
1801 * Returns a human readable string describing
1802 * the error code (positive or negative value).
1803 */
1804 const char *lttng_strerror(int code)
1805 {
1806 if (code > 0) {
1807 code = -code;
1808 }
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 = (lttng_error_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((const char *) 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 LTTNG_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 = (lttng_session_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 char *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 = ((char *) *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 char *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 = lttng_align_ceil(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 lttng_align_ceil(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 int ret = 0;
2657 char *new_group;
2658
2659 if (name == NULL) {
2660 ret = -LTTNG_ERR_INVALID;
2661 goto end;
2662 }
2663
2664 new_group = strdup(name);
2665 if (!new_group) {
2666 ret = -LTTNG_ERR_FATAL;
2667 goto end;
2668 }
2669
2670 free(tracing_group);
2671 tracing_group = new_group;
2672 new_group = NULL;
2673
2674 end:
2675 return ret;
2676 }
2677
2678 int lttng_calibrate(struct lttng_handle *handle,
2679 struct lttng_calibrate *calibrate)
2680 {
2681 /*
2682 * This command was removed in LTTng 2.9.
2683 */
2684 return -LTTNG_ERR_UND;
2685 }
2686
2687 /*
2688 * Set default channel attributes.
2689 * If either or both of the arguments are null, attr content is zeroe'd.
2690 */
2691 void lttng_channel_set_default_attr(struct lttng_domain *domain,
2692 struct lttng_channel_attr *attr)
2693 {
2694 struct lttng_channel_extended *extended;
2695
2696 /* Safety check */
2697 if (attr == NULL || domain == NULL) {
2698 return;
2699 }
2700
2701 extended = (struct lttng_channel_extended *) attr->extended.ptr;
2702 memset(attr, 0, sizeof(struct lttng_channel_attr));
2703
2704 /* Same for all domains. */
2705 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
2706 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
2707 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
2708
2709 switch (domain->type) {
2710 case LTTNG_DOMAIN_KERNEL:
2711 attr->switch_timer_interval =
2712 DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
2713 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
2714 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
2715 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
2716 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
2717 if (extended) {
2718 extended->monitor_timer_interval =
2719 DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER;
2720 extended->blocking_timeout =
2721 DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT;
2722 }
2723 break;
2724 case LTTNG_DOMAIN_UST:
2725 switch (domain->buf_type) {
2726 case LTTNG_BUFFER_PER_UID:
2727 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
2728 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
2729 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
2730 attr->switch_timer_interval =
2731 DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
2732 attr->read_timer_interval =
2733 DEFAULT_UST_UID_CHANNEL_READ_TIMER;
2734 if (extended) {
2735 extended->monitor_timer_interval =
2736 DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER;
2737 extended->blocking_timeout =
2738 DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT;
2739 }
2740 break;
2741 case LTTNG_BUFFER_PER_PID:
2742 default:
2743 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
2744 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
2745 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
2746 attr->switch_timer_interval =
2747 DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
2748 attr->read_timer_interval =
2749 DEFAULT_UST_PID_CHANNEL_READ_TIMER;
2750 if (extended) {
2751 extended->monitor_timer_interval =
2752 DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER;
2753 extended->blocking_timeout =
2754 DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT;
2755 }
2756 break;
2757 }
2758 default:
2759 /* Default behavior: leave set to 0. */
2760 break;
2761 }
2762
2763 attr->extended.ptr = extended;
2764 }
2765
2766 int lttng_channel_get_discarded_event_count(struct lttng_channel *channel,
2767 uint64_t *discarded_events)
2768 {
2769 int ret = 0;
2770 struct lttng_channel_extended *chan_ext;
2771
2772 if (!channel || !discarded_events) {
2773 ret = -LTTNG_ERR_INVALID;
2774 goto end;
2775 }
2776
2777 chan_ext = (lttng_channel_extended *) channel->attr.extended.ptr;
2778 if (!chan_ext) {
2779 /*
2780 * This can happen since the lttng_channel structure is
2781 * used for other tasks where this pointer is never set.
2782 */
2783 *discarded_events = 0;
2784 goto end;
2785 }
2786
2787 *discarded_events = chan_ext->discarded_events;
2788 end:
2789 return ret;
2790 }
2791
2792 int lttng_channel_get_lost_packet_count(struct lttng_channel *channel,
2793 uint64_t *lost_packets)
2794 {
2795 int ret = 0;
2796 struct lttng_channel_extended *chan_ext;
2797
2798 if (!channel || !lost_packets) {
2799 ret = -LTTNG_ERR_INVALID;
2800 goto end;
2801 }
2802
2803 chan_ext = (lttng_channel_extended *) channel->attr.extended.ptr;
2804 if (!chan_ext) {
2805 /*
2806 * This can happen since the lttng_channel structure is
2807 * used for other tasks where this pointer is never set.
2808 */
2809 *lost_packets = 0;
2810 goto end;
2811 }
2812
2813 *lost_packets = chan_ext->lost_packets;
2814 end:
2815 return ret;
2816 }
2817
2818 int lttng_channel_get_monitor_timer_interval(struct lttng_channel *chan,
2819 uint64_t *monitor_timer_interval)
2820 {
2821 int ret = 0;
2822
2823 if (!chan || !monitor_timer_interval) {
2824 ret = -LTTNG_ERR_INVALID;
2825 goto end;
2826 }
2827
2828 if (!chan->attr.extended.ptr) {
2829 ret = -LTTNG_ERR_INVALID;
2830 goto end;
2831 }
2832
2833 *monitor_timer_interval = ((struct lttng_channel_extended *)
2834 chan->attr.extended.ptr)->monitor_timer_interval;
2835 end:
2836 return ret;
2837 }
2838
2839 int lttng_channel_set_monitor_timer_interval(struct lttng_channel *chan,
2840 uint64_t monitor_timer_interval)
2841 {
2842 int ret = 0;
2843
2844 if (!chan || !chan->attr.extended.ptr) {
2845 ret = -LTTNG_ERR_INVALID;
2846 goto end;
2847 }
2848
2849 ((struct lttng_channel_extended *)
2850 chan->attr.extended.ptr)->monitor_timer_interval =
2851 monitor_timer_interval;
2852 end:
2853 return ret;
2854 }
2855
2856 int lttng_channel_get_blocking_timeout(struct lttng_channel *chan,
2857 int64_t *blocking_timeout)
2858 {
2859 int ret = 0;
2860
2861 if (!chan || !blocking_timeout) {
2862 ret = -LTTNG_ERR_INVALID;
2863 goto end;
2864 }
2865
2866 if (!chan->attr.extended.ptr) {
2867 ret = -LTTNG_ERR_INVALID;
2868 goto end;
2869 }
2870
2871 *blocking_timeout = ((struct lttng_channel_extended *)
2872 chan->attr.extended.ptr)->blocking_timeout;
2873 end:
2874 return ret;
2875 }
2876
2877 int lttng_channel_set_blocking_timeout(struct lttng_channel *chan,
2878 int64_t blocking_timeout)
2879 {
2880 int ret = 0;
2881 int64_t msec_timeout;
2882
2883 if (!chan || !chan->attr.extended.ptr) {
2884 ret = -LTTNG_ERR_INVALID;
2885 goto end;
2886 }
2887
2888 if (blocking_timeout < 0 && blocking_timeout != -1) {
2889 ret = -LTTNG_ERR_INVALID;
2890 goto end;
2891 }
2892
2893 /*
2894 * LTTng-ust's use of poll() to implement this timeout mechanism forces
2895 * us to accept a narrower range of values (msecs expressed as a signed
2896 * 32-bit integer).
2897 */
2898 msec_timeout = blocking_timeout / 1000;
2899 if (msec_timeout != (int32_t) msec_timeout) {
2900 ret = -LTTNG_ERR_INVALID;
2901 goto end;
2902 }
2903
2904 ((struct lttng_channel_extended *)
2905 chan->attr.extended.ptr)->blocking_timeout =
2906 blocking_timeout;
2907 end:
2908 return ret;
2909 }
2910
2911 /*
2912 * Check if session daemon is alive.
2913 *
2914 * Return 1 if alive or 0 if not.
2915 * On error returns a negative value.
2916 */
2917 int lttng_session_daemon_alive(void)
2918 {
2919 int ret;
2920
2921 ret = set_session_daemon_path();
2922 if (ret < 0) {
2923 /* Error. */
2924 return ret;
2925 }
2926
2927 if (*sessiond_sock_path == '\0') {
2928 /*
2929 * No socket path set. Weird error which means the constructor
2930 * was not called.
2931 */
2932 abort();
2933 }
2934
2935 ret = try_connect_sessiond(sessiond_sock_path);
2936 if (ret < 0) {
2937 /* Not alive. */
2938 return 0;
2939 }
2940
2941 /* Is alive. */
2942 return 1;
2943 }
2944
2945 /*
2946 * Set URL for a consumer for a session and domain.
2947 *
2948 * Return 0 on success, else a negative value.
2949 */
2950 int lttng_set_consumer_url(struct lttng_handle *handle,
2951 const char *control_url, const char *data_url)
2952 {
2953 int ret;
2954 ssize_t size;
2955 struct lttcomm_session_msg lsm;
2956 struct lttng_uri *uris = NULL;
2957
2958 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
2959 ret = -LTTNG_ERR_INVALID;
2960 goto error;
2961 }
2962
2963 memset(&lsm, 0, sizeof(lsm));
2964
2965 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
2966
2967 ret = lttng_strncpy(lsm.session.name, handle->session_name,
2968 sizeof(lsm.session.name));
2969 if (ret) {
2970 ret = -LTTNG_ERR_INVALID;
2971 goto error;
2972 }
2973
2974 COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
2975
2976 size = uri_parse_str_urls(control_url, data_url, &uris);
2977 if (size < 0) {
2978 ret = -LTTNG_ERR_INVALID;
2979 goto error;
2980 }
2981
2982 lsm.u.uri.size = size;
2983
2984 ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris,
2985 sizeof(struct lttng_uri) * size, NULL);
2986
2987 free(uris);
2988 error:
2989 return ret;
2990 }
2991
2992 /*
2993 * [OBSOLETE]
2994 */
2995 extern "C"
2996 LTTNG_EXPORT int lttng_enable_consumer(struct lttng_handle *handle);
2997 int lttng_enable_consumer(struct lttng_handle *handle)
2998 {
2999 return -ENOSYS;
3000 }
3001
3002 /*
3003 * [OBSOLETE]
3004 */
3005 extern "C"
3006 LTTNG_EXPORT int lttng_disable_consumer(struct lttng_handle *handle);
3007 int lttng_disable_consumer(struct lttng_handle *handle)
3008 {
3009 return -ENOSYS;
3010 }
3011
3012 /*
3013 * [OBSOLETE]
3014 */
3015 extern "C"
3016 LTTNG_EXPORT int _lttng_create_session_ext(const char *name, const char *url,
3017 const char *datetime);
3018 int _lttng_create_session_ext(const char *name, const char *url,
3019 const char *datetime)
3020 {
3021 return -ENOSYS;
3022 }
3023
3024 /*
3025 * For a given session name, this call checks if the data is ready to be read
3026 * or is still being extracted by the consumer(s) hence not ready to be used by
3027 * any readers.
3028 */
3029 int lttng_data_pending(const char *session_name)
3030 {
3031 int ret;
3032 struct lttcomm_session_msg lsm;
3033 uint8_t *pending = NULL;
3034
3035 if (session_name == NULL) {
3036 return -LTTNG_ERR_INVALID;
3037 }
3038
3039 memset(&lsm, 0, sizeof(lsm));
3040 lsm.cmd_type = LTTNG_DATA_PENDING;
3041
3042 ret = lttng_strncpy(lsm.session.name, session_name,
3043 sizeof(lsm.session.name));
3044 if (ret) {
3045 ret = -LTTNG_ERR_INVALID;
3046 goto end;
3047 }
3048
3049 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending);
3050 if (ret < 0) {
3051 goto end;
3052 } else if (ret != 1) {
3053 /* Unexpected payload size */
3054 ret = -LTTNG_ERR_INVALID;
3055 goto end;
3056 } else if (!pending) {
3057 /* Internal error. */
3058 ret = -LTTNG_ERR_UNK;
3059 goto end;
3060 }
3061
3062 ret = (int) *pending;
3063 end:
3064 free(pending);
3065 return ret;
3066 }
3067
3068 /*
3069 * Regenerate the metadata for a session.
3070 * Return 0 on success, a negative error code on error.
3071 */
3072 int lttng_regenerate_metadata(const char *session_name)
3073 {
3074 int ret;
3075 struct lttcomm_session_msg lsm;
3076
3077 if (!session_name) {
3078 ret = -LTTNG_ERR_INVALID;
3079 goto end;
3080 }
3081
3082 memset(&lsm, 0, sizeof(lsm));
3083 lsm.cmd_type = LTTNG_REGENERATE_METADATA;
3084
3085 ret = lttng_strncpy(lsm.session.name, session_name,
3086 sizeof(lsm.session.name));
3087 if (ret) {
3088 ret = -LTTNG_ERR_INVALID;
3089 goto end;
3090 }
3091
3092 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
3093 if (ret < 0) {
3094 goto end;
3095 }
3096
3097 ret = 0;
3098 end:
3099 return ret;
3100 }
3101
3102 /*
3103 * Deprecated, replaced by lttng_regenerate_metadata.
3104 */
3105 int lttng_metadata_regenerate(const char *session_name)
3106 {
3107 return lttng_regenerate_metadata(session_name);
3108 }
3109
3110 /*
3111 * Regenerate the statedump of a session.
3112 * Return 0 on success, a negative error code on error.
3113 */
3114 int lttng_regenerate_statedump(const char *session_name)
3115 {
3116 int ret;
3117 struct lttcomm_session_msg lsm;
3118
3119 if (!session_name) {
3120 ret = -LTTNG_ERR_INVALID;
3121 goto end;
3122 }
3123
3124 memset(&lsm, 0, sizeof(lsm));
3125 lsm.cmd_type = LTTNG_REGENERATE_STATEDUMP;
3126
3127 ret = lttng_strncpy(lsm.session.name, session_name,
3128 sizeof(lsm.session.name));
3129 if (ret) {
3130 ret = -LTTNG_ERR_INVALID;
3131 goto end;
3132 }
3133
3134 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
3135 if (ret < 0) {
3136 goto end;
3137 }
3138
3139 ret = 0;
3140 end:
3141 return ret;
3142 }
3143
3144 static
3145 int _lttng_register_trigger(struct lttng_trigger *trigger, const char *name,
3146 bool generate_name)
3147 {
3148 int ret;
3149 struct lttcomm_session_msg lsm = {
3150 .cmd_type = LTTNG_REGISTER_TRIGGER,
3151 };
3152 lsm.u.trigger.is_trigger_anonymous = !name && !generate_name;
3153 struct lttcomm_session_msg *message_lsm;
3154 struct lttng_payload message;
3155 struct lttng_payload reply;
3156 struct lttng_trigger *reply_trigger = NULL;
3157 enum lttng_domain_type domain_type;
3158 const struct lttng_credentials user_creds = {
3159 .uid = LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3160 .gid = LTTNG_OPTIONAL_INIT_UNSET,
3161 };
3162 const char *unused_trigger_name = NULL;
3163 enum lttng_trigger_status trigger_status;
3164
3165 lttng_payload_init(&message);
3166 lttng_payload_init(&reply);
3167
3168 if (!trigger) {
3169 ret = -LTTNG_ERR_INVALID;
3170 goto end;
3171 }
3172
3173 trigger_status = lttng_trigger_get_name(trigger, &unused_trigger_name);
3174 if (trigger_status != LTTNG_TRIGGER_STATUS_UNSET) {
3175 /* Re-using already registered trigger. */
3176 ret = -LTTNG_ERR_INVALID;
3177 goto end;
3178 }
3179
3180 if (name) {
3181 trigger_status = lttng_trigger_set_name(trigger, name);
3182 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
3183 ret = -LTTNG_ERR_NOMEM;
3184 goto end;
3185 }
3186 }
3187
3188 if (!trigger->creds.uid.is_set) {
3189 /* Use the client's credentials as the trigger credentials. */
3190 lttng_trigger_set_credentials(trigger, &user_creds);
3191 } else {
3192 /*
3193 * Validate that either the current trigger credentials and the
3194 * client credentials are identical or that the current user is
3195 * root. The root user can register, unregister triggers for
3196 * himself and other users.
3197 *
3198 * This check is also present on the sessiond side, using the
3199 * credentials passed on the socket. These check are all
3200 * "safety" checks.
3201 */
3202 const struct lttng_credentials *trigger_creds =
3203 lttng_trigger_get_credentials(trigger);
3204
3205 if (!lttng_credentials_is_equal_uid(trigger_creds, &user_creds)) {
3206 if (lttng_credentials_get_uid(&user_creds) != 0) {
3207 ret = -LTTNG_ERR_EPERM;
3208 goto end_unset_name;
3209 }
3210 }
3211 }
3212
3213 if (!lttng_trigger_validate(trigger)) {
3214 ret = -LTTNG_ERR_INVALID_TRIGGER;
3215 goto end_unset_name;
3216 }
3217
3218 domain_type = lttng_trigger_get_underlying_domain_type_restriction(
3219 trigger);
3220
3221 lsm.domain.type = domain_type;
3222
3223 ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
3224 if (ret) {
3225 ret = -LTTNG_ERR_NOMEM;
3226 goto end_unset_name;
3227 }
3228
3229 ret = lttng_trigger_serialize(trigger, &message);
3230 if (ret < 0) {
3231 ret = -LTTNG_ERR_UNK;
3232 goto end_unset_name;
3233 }
3234
3235 /*
3236 * This is needed to populate the trigger object size for the command
3237 * header.
3238 */
3239 message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
3240
3241 message_lsm->u.trigger.length = (uint32_t) message.buffer.size - sizeof(lsm);
3242
3243 {
3244 struct lttng_payload_view message_view =
3245 lttng_payload_view_from_payload(
3246 &message, 0, -1);
3247
3248 message_lsm->fd_count = lttng_payload_view_get_fd_handle_count(
3249 &message_view);
3250 ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
3251 if (ret < 0) {
3252 goto end_unset_name;
3253 }
3254 }
3255
3256 {
3257 struct lttng_payload_view reply_view =
3258 lttng_payload_view_from_payload(
3259 &reply, 0, reply.buffer.size);
3260
3261 ret = lttng_trigger_create_from_payload(
3262 &reply_view, &reply_trigger);
3263 if (ret < 0) {
3264 ret = -LTTNG_ERR_INVALID_PROTOCOL;
3265 goto end_unset_name;
3266 }
3267 }
3268
3269 if (name || generate_name) {
3270 ret = lttng_trigger_assign_name(trigger, reply_trigger);
3271 if (ret < 0) {
3272 ret = -LTTNG_ERR_NOMEM;
3273 goto end;
3274 }
3275 }
3276
3277 ret = 0;
3278 goto end;
3279
3280 end_unset_name:
3281 trigger_status = lttng_trigger_set_name(trigger, NULL);
3282 if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
3283 ret = -LTTNG_ERR_UNK;
3284 }
3285 end:
3286 lttng_payload_reset(&message);
3287 lttng_payload_reset(&reply);
3288 lttng_trigger_destroy(reply_trigger);
3289 return ret;
3290 }
3291
3292 int lttng_register_trigger(struct lttng_trigger *trigger)
3293 {
3294 /* Register an anonymous trigger. */
3295 return _lttng_register_trigger(trigger, NULL, false);
3296 }
3297
3298 enum lttng_error_code lttng_register_trigger_with_name(
3299 struct lttng_trigger *trigger, const char *name)
3300 {
3301 const int ret = _lttng_register_trigger(trigger, name, false);
3302
3303 return ret == 0 ? LTTNG_OK : (enum lttng_error_code) -ret;
3304 }
3305
3306 enum lttng_error_code lttng_register_trigger_with_automatic_name(
3307 struct lttng_trigger *trigger)
3308 {
3309 const int ret = _lttng_register_trigger(trigger, nullptr, true);
3310
3311 return ret == 0 ? LTTNG_OK : (enum lttng_error_code) -ret;
3312 }
3313
3314 enum lttng_error_code lttng_error_query_execute(
3315 const struct lttng_error_query *query,
3316 const struct lttng_endpoint *endpoint,
3317 struct lttng_error_query_results **results)
3318 {
3319 int ret;
3320 enum lttng_error_code ret_code;
3321 struct lttcomm_session_msg lsm = {
3322 .cmd_type = LTTNG_EXECUTE_ERROR_QUERY,
3323 };
3324 struct lttng_payload message;
3325 struct lttng_payload reply;
3326 struct lttcomm_session_msg *message_lsm;
3327
3328 lttng_payload_init(&message);
3329 lttng_payload_init(&reply);
3330
3331 if (!query || !results) {
3332 ret_code = LTTNG_ERR_INVALID;
3333 goto end;
3334 }
3335
3336 if (endpoint != lttng_session_daemon_command_endpoint) {
3337 ret_code = LTTNG_ERR_INVALID_ERROR_QUERY_TARGET;
3338 goto end;
3339 }
3340
3341 ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
3342 if (ret) {
3343 ret_code = LTTNG_ERR_NOMEM;
3344 goto end;
3345 }
3346
3347 ret = lttng_error_query_serialize(query, &message);
3348 if (ret) {
3349 ret_code = LTTNG_ERR_UNK;
3350 goto end;
3351 }
3352
3353 message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
3354 message_lsm->u.error_query.length =
3355 (uint32_t) message.buffer.size - sizeof(lsm);
3356
3357 {
3358 struct lttng_payload_view message_view =
3359 lttng_payload_view_from_payload(
3360 &message, 0, -1);
3361
3362 message_lsm->fd_count = lttng_payload_view_get_fd_handle_count(
3363 &message_view);
3364 ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
3365 if (ret < 0) {
3366 ret_code =(lttng_error_code) -ret;
3367 goto end;
3368 }
3369 }
3370
3371 {
3372 ssize_t reply_create_ret;
3373 struct lttng_payload_view reply_view =
3374 lttng_payload_view_from_payload(
3375 &reply, 0, reply.buffer.size);
3376
3377 reply_create_ret = lttng_error_query_results_create_from_payload(
3378 &reply_view, results);
3379 if (reply_create_ret < 0) {
3380 ret_code = LTTNG_ERR_INVALID_PROTOCOL;
3381 goto end;
3382 }
3383 }
3384
3385 ret_code = LTTNG_OK;
3386 end:
3387 lttng_payload_reset(&message);
3388 lttng_payload_reset(&reply);
3389 return ret_code;
3390 }
3391
3392 int lttng_unregister_trigger(const struct lttng_trigger *trigger)
3393 {
3394 int ret;
3395 struct lttcomm_session_msg lsm;
3396 struct lttcomm_session_msg *message_lsm;
3397 struct lttng_payload message;
3398 struct lttng_payload reply;
3399 struct lttng_trigger *copy = NULL;
3400 const struct lttng_credentials user_creds = {
3401 .uid = LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
3402 .gid = LTTNG_OPTIONAL_INIT_UNSET,
3403 };
3404
3405 lttng_payload_init(&message);
3406 lttng_payload_init(&reply);
3407
3408 if (!trigger) {
3409 ret = -LTTNG_ERR_INVALID;
3410 goto end;
3411 }
3412
3413 copy = lttng_trigger_copy(trigger);
3414 if (!copy) {
3415 ret = -LTTNG_ERR_UNK;
3416 goto end;
3417 }
3418
3419 if (!copy->creds.uid.is_set) {
3420 /* Use the client credentials as the trigger credentials */
3421 lttng_trigger_set_credentials(copy, &user_creds);
3422 } else {
3423 /*
3424 * Validate that either the current trigger credentials and the
3425 * client credentials are identical or that the current user is
3426 * root. The root user can register, unregister triggers for
3427 * himself and other users.
3428 *
3429 * This check is also present on the sessiond side, using the
3430 * credentials passed on the socket. These check are all
3431 * "safety" checks.
3432 */
3433 const struct lttng_credentials *trigger_creds =
3434 lttng_trigger_get_credentials(copy);
3435 if (!lttng_credentials_is_equal_uid(trigger_creds, &user_creds)) {
3436 if (lttng_credentials_get_uid(&user_creds) != 0) {
3437 ret = -LTTNG_ERR_EPERM;
3438 goto end;
3439 }
3440 }
3441 }
3442
3443 if (!lttng_trigger_validate(copy)) {
3444 ret = -LTTNG_ERR_INVALID_TRIGGER;
3445 goto end;
3446 }
3447
3448 memset(&lsm, 0, sizeof(lsm));
3449 lsm.cmd_type = LTTNG_UNREGISTER_TRIGGER;
3450
3451 ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
3452 if (ret) {
3453 ret = -LTTNG_ERR_NOMEM;
3454 goto end;
3455 }
3456
3457 ret = lttng_trigger_serialize(copy, &message);
3458 if (ret < 0) {
3459 ret = -LTTNG_ERR_UNK;
3460 goto end;
3461 }
3462
3463 /*
3464 * This is needed to populate the trigger object size for the command
3465 * header and number of fds sent.
3466 */
3467 message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
3468
3469 message_lsm->u.trigger.length = (uint32_t) message.buffer.size - sizeof(lsm);
3470
3471 {
3472 struct lttng_payload_view message_view =
3473 lttng_payload_view_from_payload(
3474 &message, 0, -1);
3475
3476 /*
3477 * Update the message header with the number of fd that will be
3478 * sent.
3479 */
3480 message_lsm->fd_count = lttng_payload_view_get_fd_handle_count(
3481 &message_view);
3482
3483 ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
3484 if (ret < 0) {
3485 goto end;
3486 }
3487 }
3488
3489 ret = 0;
3490 end:
3491 lttng_trigger_destroy(copy);
3492 lttng_payload_reset(&message);
3493 lttng_payload_reset(&reply);
3494 return ret;
3495 }
3496
3497 /*
3498 * Ask the session daemon for all registered triggers for the current user.
3499 *
3500 * Allocates and return an lttng_triggers set.
3501 * On error, returns a suitable lttng_error_code.
3502 */
3503 enum lttng_error_code lttng_list_triggers(struct lttng_triggers **triggers)
3504 {
3505 int ret;
3506 enum lttng_error_code ret_code = LTTNG_OK;
3507 struct lttcomm_session_msg lsm = { .cmd_type = LTTNG_LIST_TRIGGERS };
3508 struct lttng_triggers *local_triggers = NULL;
3509 struct lttng_payload reply;
3510 struct lttng_payload_view lsm_view =
3511 lttng_payload_view_init_from_buffer(
3512 (const char *) &lsm, 0, sizeof(lsm));
3513
3514 lttng_payload_init(&reply);
3515
3516 ret = lttng_ctl_ask_sessiond_payload(&lsm_view, &reply);
3517 if (ret < 0) {
3518 ret_code = (enum lttng_error_code) -ret;
3519 goto end;
3520 }
3521
3522 {
3523 struct lttng_payload_view reply_view =
3524 lttng_payload_view_from_payload(
3525 &reply, 0, reply.buffer.size);
3526
3527 ret = lttng_triggers_create_from_payload(
3528 &reply_view, &local_triggers);
3529 if (ret < 0) {
3530 ret_code = LTTNG_ERR_FATAL;
3531 goto end;
3532 }
3533 }
3534
3535 *triggers = local_triggers;
3536 local_triggers = NULL;
3537 end:
3538 lttng_payload_reset(&reply);
3539 lttng_triggers_destroy(local_triggers);
3540 return ret_code;
3541 }
3542
3543 /*
3544 * lib constructor.
3545 */
3546 static void __attribute__((constructor)) init(void)
3547 {
3548 /* Set default session group */
3549 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
3550 }
3551
3552 /*
3553 * lib destructor.
3554 */
3555 static void __attribute__((destructor)) lttng_ctl_exit(void)
3556 {
3557 free(tracing_group);
3558 }
This page took 0.139471 seconds and 3 git commands to generate.