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