Truncate exclusion names to have a terminal '\0'
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.c
1 /*
2 * liblttngctl.c
3 *
4 * Linux Trace Toolkit Control Library
5 *
6 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
7 *
8 * This library is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License, version 2.1 only,
10 * as published by the Free Software Foundation.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this library; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22 #define _LGPL_SOURCE
23 #include <assert.h>
24 #include <grp.h>
25 #include <errno.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30
31 #include <common/common.h>
32 #include <common/defaults.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
34 #include <common/uri.h>
35 #include <common/utils.h>
36 #include <lttng/lttng.h>
37 #include <lttng/health-internal.h>
38
39 #include "filter/filter-ast.h"
40 #include "filter/filter-parser.h"
41 #include "filter/filter-bytecode.h"
42 #include "filter/memstream.h"
43 #include "lttng-ctl-helper.h"
44
45 #ifdef DEBUG
46 static const int print_xml = 1;
47 #define dbg_printf(fmt, args...) \
48 printf("[debug liblttng-ctl] " fmt, ## args)
49 #else
50 static const int print_xml = 0;
51 #define dbg_printf(fmt, args...) \
52 do { \
53 /* do nothing but check printf format */ \
54 if (0) \
55 printf("[debug liblttnctl] " fmt, ## args); \
56 } while (0)
57 #endif
58
59
60 /* Socket to session daemon for communication */
61 static int sessiond_socket;
62 static char sessiond_sock_path[PATH_MAX];
63
64 /* Variables */
65 static char *tracing_group;
66 static int connected;
67
68 /* Global */
69
70 /*
71 * Those two variables are used by error.h to silent or control the verbosity of
72 * error message. They are global to the library so application linking with it
73 * are able to compile correctly and also control verbosity of the library.
74 */
75 int lttng_opt_quiet;
76 int lttng_opt_verbose;
77 int lttng_opt_mi;
78
79 /*
80 * Copy string from src to dst and enforce null terminated byte.
81 */
82 LTTNG_HIDDEN
83 void lttng_ctl_copy_string(char *dst, const char *src, size_t len)
84 {
85 if (src && dst) {
86 strncpy(dst, src, len);
87 /* Enforce the NULL terminated byte */
88 dst[len - 1] = '\0';
89 } else if (dst) {
90 dst[0] = '\0';
91 }
92 }
93
94 /*
95 * Copy domain to lttcomm_session_msg domain.
96 *
97 * If domain is unknown, default domain will be the kernel.
98 */
99 LTTNG_HIDDEN
100 void lttng_ctl_copy_lttng_domain(struct lttng_domain *dst,
101 struct lttng_domain *src)
102 {
103 if (src && dst) {
104 switch (src->type) {
105 case LTTNG_DOMAIN_KERNEL:
106 case LTTNG_DOMAIN_UST:
107 case LTTNG_DOMAIN_JUL:
108 case LTTNG_DOMAIN_LOG4J:
109 case LTTNG_DOMAIN_PYTHON:
110 memcpy(dst, src, sizeof(struct lttng_domain));
111 break;
112 default:
113 memset(dst, 0, sizeof(struct lttng_domain));
114 break;
115 }
116 }
117 }
118
119 /*
120 * Send lttcomm_session_msg to the session daemon.
121 *
122 * On success, returns the number of bytes sent (>=0)
123 * On error, returns -1
124 */
125 static int send_session_msg(struct lttcomm_session_msg *lsm)
126 {
127 int ret;
128
129 if (!connected) {
130 ret = -LTTNG_ERR_NO_SESSIOND;
131 goto end;
132 }
133
134 DBG("LSM cmd type : %d", lsm->cmd_type);
135
136 ret = lttcomm_send_creds_unix_sock(sessiond_socket, lsm,
137 sizeof(struct lttcomm_session_msg));
138 if (ret < 0) {
139 ret = -LTTNG_ERR_FATAL;
140 }
141
142 end:
143 return ret;
144 }
145
146 /*
147 * Send var len data to the session daemon.
148 *
149 * On success, returns the number of bytes sent (>=0)
150 * On error, returns -1
151 */
152 static int send_session_varlen(void *data, size_t len)
153 {
154 int ret;
155
156 if (!connected) {
157 ret = -LTTNG_ERR_NO_SESSIOND;
158 goto end;
159 }
160
161 if (!data || !len) {
162 ret = 0;
163 goto end;
164 }
165
166 ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
167 if (ret < 0) {
168 ret = -LTTNG_ERR_FATAL;
169 }
170
171 end:
172 return ret;
173 }
174
175 /*
176 * Receive data from the sessiond socket.
177 *
178 * On success, returns the number of bytes received (>=0)
179 * On error, returns -1 (recvmsg() error) or -ENOTCONN
180 */
181 static int recv_data_sessiond(void *buf, size_t len)
182 {
183 int ret;
184
185 if (!connected) {
186 ret = -LTTNG_ERR_NO_SESSIOND;
187 goto end;
188 }
189
190 ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len);
191 if (ret < 0) {
192 ret = -LTTNG_ERR_FATAL;
193 }
194
195 end:
196 return ret;
197 }
198
199 /*
200 * Check if we are in the specified group.
201 *
202 * If yes return 1, else return -1.
203 */
204 LTTNG_HIDDEN
205 int lttng_check_tracing_group(void)
206 {
207 struct group *grp_tracing; /* no free(). See getgrnam(3) */
208 gid_t *grp_list;
209 int grp_list_size, grp_id, i;
210 int ret = -1;
211 const char *grp_name = tracing_group;
212
213 /* Get GID of group 'tracing' */
214 grp_tracing = getgrnam(grp_name);
215 if (!grp_tracing) {
216 /* If grp_tracing is NULL, the group does not exist. */
217 goto end;
218 }
219
220 /* Get number of supplementary group IDs */
221 grp_list_size = getgroups(0, NULL);
222 if (grp_list_size < 0) {
223 PERROR("getgroups");
224 goto end;
225 }
226
227 /* Alloc group list of the right size */
228 grp_list = zmalloc(grp_list_size * sizeof(gid_t));
229 if (!grp_list) {
230 PERROR("malloc");
231 goto end;
232 }
233 grp_id = getgroups(grp_list_size, grp_list);
234 if (grp_id < 0) {
235 PERROR("getgroups");
236 goto free_list;
237 }
238
239 for (i = 0; i < grp_list_size; i++) {
240 if (grp_list[i] == grp_tracing->gr_gid) {
241 ret = 1;
242 break;
243 }
244 }
245
246 free_list:
247 free(grp_list);
248
249 end:
250 return ret;
251 }
252
253 /*
254 * Try connect to session daemon with sock_path.
255 *
256 * Return 0 on success, else -1
257 */
258 static int try_connect_sessiond(const char *sock_path)
259 {
260 int ret;
261
262 /* If socket exist, we check if the daemon listens for connect. */
263 ret = access(sock_path, F_OK);
264 if (ret < 0) {
265 /* Not alive */
266 goto error;
267 }
268
269 ret = lttcomm_connect_unix_sock(sock_path);
270 if (ret < 0) {
271 /* Not alive */
272 goto error;
273 }
274
275 ret = lttcomm_close_unix_sock(ret);
276 if (ret < 0) {
277 PERROR("lttcomm_close_unix_sock");
278 }
279
280 return 0;
281
282 error:
283 return -1;
284 }
285
286 /*
287 * Set sessiond socket path by putting it in the global sessiond_sock_path
288 * variable.
289 *
290 * Returns 0 on success, negative value on failure (the sessiond socket path
291 * is somehow too long or ENOMEM).
292 */
293 static int set_session_daemon_path(void)
294 {
295 int in_tgroup = 0; /* In tracing group */
296 uid_t uid;
297
298 uid = getuid();
299
300 if (uid != 0) {
301 /* Are we in the tracing group ? */
302 in_tgroup = lttng_check_tracing_group();
303 }
304
305 if ((uid == 0) || in_tgroup) {
306 lttng_ctl_copy_string(sessiond_sock_path,
307 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, sizeof(sessiond_sock_path));
308 }
309
310 if (uid != 0) {
311 int ret;
312
313 if (in_tgroup) {
314 /* Tracing group */
315 ret = try_connect_sessiond(sessiond_sock_path);
316 if (ret >= 0) {
317 goto end;
318 }
319 /* Global session daemon not available... */
320 }
321 /* ...or not in tracing group (and not root), default */
322
323 /*
324 * With GNU C < 2.1, snprintf returns -1 if the target buffer is too small;
325 * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
326 */
327 ret = snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
328 DEFAULT_HOME_CLIENT_UNIX_SOCK, utils_get_home_dir());
329 if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) {
330 goto error;
331 }
332 }
333 end:
334 return 0;
335
336 error:
337 return -1;
338 }
339
340 /*
341 * Connect to the LTTng session daemon.
342 *
343 * On success, return 0. On error, return -1.
344 */
345 static int connect_sessiond(void)
346 {
347 int ret;
348
349 /* Don't try to connect if already connected. */
350 if (connected) {
351 return 0;
352 }
353
354 ret = set_session_daemon_path();
355 if (ret < 0) {
356 goto error;
357 }
358
359 /* Connect to the sesssion daemon */
360 ret = lttcomm_connect_unix_sock(sessiond_sock_path);
361 if (ret < 0) {
362 goto error;
363 }
364
365 sessiond_socket = ret;
366 connected = 1;
367
368 return 0;
369
370 error:
371 return -1;
372 }
373
374 /*
375 * Clean disconnect from the session daemon.
376 * On success, return 0. On error, return -1.
377 */
378 static int disconnect_sessiond(void)
379 {
380 int ret = 0;
381
382 if (connected) {
383 ret = lttcomm_close_unix_sock(sessiond_socket);
384 sessiond_socket = 0;
385 connected = 0;
386 }
387
388 return ret;
389 }
390
391 /*
392 * Ask the session daemon a specific command and put the data into buf.
393 * Takes extra var. len. data as input to send to the session daemon.
394 *
395 * Return size of data (only payload, not header) or a negative error code.
396 */
397 LTTNG_HIDDEN
398 int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg *lsm,
399 void *vardata, size_t varlen, void **buf)
400 {
401 int ret;
402 size_t size;
403 void *data = NULL;
404 struct lttcomm_lttng_msg llm;
405
406 ret = connect_sessiond();
407 if (ret < 0) {
408 ret = -LTTNG_ERR_NO_SESSIOND;
409 goto end;
410 }
411
412 /* Send command to session daemon */
413 ret = send_session_msg(lsm);
414 if (ret < 0) {
415 /* Ret value is a valid lttng error code. */
416 goto end;
417 }
418 /* Send var len data */
419 ret = send_session_varlen(vardata, varlen);
420 if (ret < 0) {
421 /* Ret value is a valid lttng error code. */
422 goto end;
423 }
424
425 /* Get header from data transmission */
426 ret = recv_data_sessiond(&llm, sizeof(llm));
427 if (ret < 0) {
428 /* Ret value is a valid lttng error code. */
429 goto end;
430 }
431
432 /* Check error code if OK */
433 if (llm.ret_code != LTTNG_OK) {
434 ret = -llm.ret_code;
435 goto end;
436 }
437
438 size = llm.data_size;
439 if (size == 0) {
440 /* If client free with size 0 */
441 if (buf != NULL) {
442 *buf = NULL;
443 }
444 ret = 0;
445 goto end;
446 }
447
448 data = zmalloc(size);
449 if (!data) {
450 ret = -ENOMEM;
451 goto end;
452 }
453
454 /* Get payload data */
455 ret = recv_data_sessiond(data, size);
456 if (ret < 0) {
457 free(data);
458 goto end;
459 }
460
461 /*
462 * Extra protection not to dereference a NULL pointer. If buf is NULL at
463 * this point, an error is returned and data is freed.
464 */
465 if (buf == NULL) {
466 ret = -LTTNG_ERR_INVALID;
467 free(data);
468 goto end;
469 }
470
471 *buf = data;
472 ret = size;
473
474 end:
475 disconnect_sessiond();
476 return ret;
477 }
478
479 /*
480 * Create lttng handle and return pointer.
481 * The returned pointer will be NULL in case of malloc() error.
482 */
483 struct lttng_handle *lttng_create_handle(const char *session_name,
484 struct lttng_domain *domain)
485 {
486 struct lttng_handle *handle = NULL;
487
488 if (domain == NULL) {
489 goto end;
490 }
491
492 handle = zmalloc(sizeof(struct lttng_handle));
493 if (handle == NULL) {
494 PERROR("malloc handle");
495 goto end;
496 }
497
498 /* Copy session name */
499 lttng_ctl_copy_string(handle->session_name, session_name,
500 sizeof(handle->session_name));
501
502 /* Copy lttng domain */
503 lttng_ctl_copy_lttng_domain(&handle->domain, domain);
504
505 end:
506 return handle;
507 }
508
509 /*
510 * Destroy handle by free(3) the pointer.
511 */
512 void lttng_destroy_handle(struct lttng_handle *handle)
513 {
514 free(handle);
515 }
516
517 /*
518 * Register an outside consumer.
519 * Returns size of returned session payload data or a negative error code.
520 */
521 int lttng_register_consumer(struct lttng_handle *handle,
522 const char *socket_path)
523 {
524 struct lttcomm_session_msg lsm;
525
526 if (handle == NULL || socket_path == NULL) {
527 return -LTTNG_ERR_INVALID;
528 }
529
530 memset(&lsm, 0, sizeof(lsm));
531 lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
532 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
533 sizeof(lsm.session.name));
534 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
535
536 lttng_ctl_copy_string(lsm.u.reg.path, socket_path, sizeof(lsm.u.reg.path));
537
538 return lttng_ctl_ask_sessiond(&lsm, NULL);
539 }
540
541 /*
542 * Start tracing for all traces of the session.
543 * Returns size of returned session payload data or a negative error code.
544 */
545 int lttng_start_tracing(const char *session_name)
546 {
547 struct lttcomm_session_msg lsm;
548
549 if (session_name == NULL) {
550 return -LTTNG_ERR_INVALID;
551 }
552
553 memset(&lsm, 0, sizeof(lsm));
554 lsm.cmd_type = LTTNG_START_TRACE;
555
556 lttng_ctl_copy_string(lsm.session.name, session_name,
557 sizeof(lsm.session.name));
558
559 return lttng_ctl_ask_sessiond(&lsm, NULL);
560 }
561
562 /*
563 * Stop tracing for all traces of the session.
564 */
565 static int _lttng_stop_tracing(const char *session_name, int wait)
566 {
567 int ret, data_ret;
568 struct lttcomm_session_msg lsm;
569
570 if (session_name == NULL) {
571 return -LTTNG_ERR_INVALID;
572 }
573
574 memset(&lsm, 0, sizeof(lsm));
575 lsm.cmd_type = LTTNG_STOP_TRACE;
576
577 lttng_ctl_copy_string(lsm.session.name, session_name,
578 sizeof(lsm.session.name));
579
580 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
581 if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
582 goto error;
583 }
584
585 if (!wait) {
586 goto end;
587 }
588
589 /* Check for data availability */
590 do {
591 data_ret = lttng_data_pending(session_name);
592 if (data_ret < 0) {
593 /* Return the data available call error. */
594 ret = data_ret;
595 goto error;
596 }
597
598 /*
599 * Data sleep time before retrying (in usec). Don't sleep if the call
600 * returned value indicates availability.
601 */
602 if (data_ret) {
603 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME);
604 }
605 } while (data_ret != 0);
606
607 end:
608 error:
609 return ret;
610 }
611
612 /*
613 * Stop tracing and wait for data availability.
614 */
615 int lttng_stop_tracing(const char *session_name)
616 {
617 return _lttng_stop_tracing(session_name, 1);
618 }
619
620 /*
621 * Stop tracing but _don't_ wait for data availability.
622 */
623 int lttng_stop_tracing_no_wait(const char *session_name)
624 {
625 return _lttng_stop_tracing(session_name, 0);
626 }
627
628 /*
629 * Add context to a channel.
630 *
631 * If the given channel is NULL, add the contexts to all channels.
632 * The event_name param is ignored.
633 *
634 * Returns the size of the returned payload data or a negative error code.
635 */
636 int lttng_add_context(struct lttng_handle *handle,
637 struct lttng_event_context *ctx, const char *event_name,
638 const char *channel_name)
639 {
640 struct lttcomm_session_msg lsm;
641
642 /* Safety check. Both are mandatory */
643 if (handle == NULL || ctx == NULL) {
644 return -LTTNG_ERR_INVALID;
645 }
646
647 memset(&lsm, 0, sizeof(lsm));
648
649 lsm.cmd_type = LTTNG_ADD_CONTEXT;
650
651 /* If no channel name, send empty string. */
652 if (channel_name == NULL) {
653 lttng_ctl_copy_string(lsm.u.context.channel_name, "",
654 sizeof(lsm.u.context.channel_name));
655 } else {
656 lttng_ctl_copy_string(lsm.u.context.channel_name, channel_name,
657 sizeof(lsm.u.context.channel_name));
658 }
659
660 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
661
662 memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context));
663
664 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
665 sizeof(lsm.session.name));
666
667 return lttng_ctl_ask_sessiond(&lsm, NULL);
668 }
669
670 /*
671 * Enable event(s) for a channel.
672 * If no event name is specified, all events are enabled.
673 * If no channel name is specified, the default 'channel0' is used.
674 * Returns size of returned session payload data or a negative error code.
675 */
676 int lttng_enable_event(struct lttng_handle *handle,
677 struct lttng_event *ev, const char *channel_name)
678 {
679 return lttng_enable_event_with_exclusions(handle, ev, channel_name,
680 NULL, 0, NULL);
681 }
682
683 /*
684 * Create or enable an event with a filter expression.
685 *
686 * Return negative error value on error.
687 * Return size of returned session payload data if OK.
688 */
689 int lttng_enable_event_with_filter(struct lttng_handle *handle,
690 struct lttng_event *event, const char *channel_name,
691 const char *filter_expression)
692 {
693 return lttng_enable_event_with_exclusions(handle, event, channel_name,
694 filter_expression, 0, NULL);
695 }
696
697 /*
698 * Depending on the event, return a newly allocated agent filter expression or
699 * NULL if not applicable.
700 *
701 * An event with NO loglevel and the name is * will return NULL.
702 */
703 static char *set_agent_filter(const char *filter, struct lttng_event *ev)
704 {
705 int err;
706 char *agent_filter = NULL;
707
708 assert(ev);
709
710 /* Don't add filter for the '*' event. */
711 if (ev->name[0] != '*') {
712 if (filter) {
713 err = asprintf(&agent_filter, "(%s) && (logger_name == \"%s\")", filter,
714 ev->name);
715 } else {
716 err = asprintf(&agent_filter, "logger_name == \"%s\"", ev->name);
717 }
718 if (err < 0) {
719 PERROR("asprintf");
720 goto error;
721 }
722 }
723
724 /* Add loglevel filtering if any for the JUL domain. */
725 if (ev->loglevel_type != LTTNG_EVENT_LOGLEVEL_ALL) {
726 char *op;
727
728 if (ev->loglevel_type == LTTNG_EVENT_LOGLEVEL_RANGE) {
729 op = ">=";
730 } else {
731 op = "==";
732 }
733
734 if (filter || agent_filter) {
735 char *new_filter;
736
737 err = asprintf(&new_filter, "(%s) && (int_loglevel %s %d)",
738 agent_filter ? agent_filter : filter, op,
739 ev->loglevel);
740 if (agent_filter) {
741 free(agent_filter);
742 }
743 agent_filter = new_filter;
744 } else {
745 err = asprintf(&agent_filter, "int_loglevel %s %d", op,
746 ev->loglevel);
747 }
748 if (err < 0) {
749 PERROR("asprintf");
750 goto error;
751 }
752 }
753
754 return agent_filter;
755 error:
756 free(agent_filter);
757 return NULL;
758 }
759
760 /*
761 * Generate the filter bytecode from a given filter expression string. Put the
762 * newly allocated parser context in ctxp and populate the lsm object with the
763 * expression len.
764 *
765 * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched.
766 */
767 static int generate_filter(char *filter_expression,
768 struct lttcomm_session_msg *lsm, struct filter_parser_ctx **ctxp)
769 {
770 int ret;
771 struct filter_parser_ctx *ctx = NULL;
772 FILE *fmem = NULL;
773
774 assert(filter_expression);
775 assert(lsm);
776 assert(ctxp);
777
778 /*
779 * Casting const to non-const, as the underlying function will use it in
780 * read-only mode.
781 */
782 fmem = lttng_fmemopen((void *) filter_expression,
783 strlen(filter_expression), "r");
784 if (!fmem) {
785 fprintf(stderr, "Error opening memory as stream\n");
786 ret = -LTTNG_ERR_FILTER_NOMEM;
787 goto error;
788 }
789 ctx = filter_parser_ctx_alloc(fmem);
790 if (!ctx) {
791 fprintf(stderr, "Error allocating parser\n");
792 ret = -LTTNG_ERR_FILTER_NOMEM;
793 goto filter_alloc_error;
794 }
795 ret = filter_parser_ctx_append_ast(ctx);
796 if (ret) {
797 fprintf(stderr, "Parse error\n");
798 ret = -LTTNG_ERR_FILTER_INVAL;
799 goto parse_error;
800 }
801 ret = filter_visitor_set_parent(ctx);
802 if (ret) {
803 fprintf(stderr, "Set parent error\n");
804 ret = -LTTNG_ERR_FILTER_INVAL;
805 goto parse_error;
806 }
807 if (print_xml) {
808 ret = filter_visitor_print_xml(ctx, stdout, 0);
809 if (ret) {
810 fflush(stdout);
811 fprintf(stderr, "XML print error\n");
812 ret = -LTTNG_ERR_FILTER_INVAL;
813 goto parse_error;
814 }
815 }
816
817 dbg_printf("Generating IR... ");
818 fflush(stdout);
819 ret = filter_visitor_ir_generate(ctx);
820 if (ret) {
821 fprintf(stderr, "Generate IR error\n");
822 ret = -LTTNG_ERR_FILTER_INVAL;
823 goto parse_error;
824 }
825 dbg_printf("done\n");
826
827 dbg_printf("Validating IR... ");
828 fflush(stdout);
829 ret = filter_visitor_ir_check_binary_op_nesting(ctx);
830 if (ret) {
831 ret = -LTTNG_ERR_FILTER_INVAL;
832 goto parse_error;
833 }
834 /* Validate strings used as literals in the expression */
835 ret = filter_visitor_ir_validate_string(ctx);
836 if (ret) {
837 ret = -LTTNG_ERR_FILTER_INVAL;
838 goto parse_error;
839 }
840 dbg_printf("done\n");
841
842 dbg_printf("Generating bytecode... ");
843 fflush(stdout);
844 ret = filter_visitor_bytecode_generate(ctx);
845 if (ret) {
846 fprintf(stderr, "Generate bytecode error\n");
847 ret = -LTTNG_ERR_FILTER_INVAL;
848 goto parse_error;
849 }
850 dbg_printf("done\n");
851 dbg_printf("Size of bytecode generated: %u bytes.\n",
852 bytecode_get_len(&ctx->bytecode->b));
853
854 lsm->u.enable.bytecode_len = sizeof(ctx->bytecode->b)
855 + bytecode_get_len(&ctx->bytecode->b);
856 lsm->u.enable.expression_len = strlen(filter_expression) + 1;
857
858 /* No need to keep the memory stream. */
859 if (fclose(fmem) != 0) {
860 PERROR("fclose");
861 }
862
863 *ctxp = ctx;
864 return 0;
865
866 parse_error:
867 filter_ir_free(ctx);
868 filter_parser_ctx_free(ctx);
869 filter_alloc_error:
870 if (fclose(fmem) != 0) {
871 PERROR("fclose");
872 }
873 error:
874 return ret;
875 }
876
877 /*
878 * Enable event(s) for a channel, possibly with exclusions and a filter.
879 * If no event name is specified, all events are enabled.
880 * If no channel name is specified, the default name is used.
881 * If filter expression is not NULL, the filter is set for the event.
882 * If exclusion count is not zero, the exclusions are set for the event.
883 * Returns size of returned session payload data or a negative error code.
884 */
885 int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
886 struct lttng_event *ev, const char *channel_name,
887 const char *original_filter_expression,
888 int exclusion_count, char **exclusion_list)
889 {
890 struct lttcomm_session_msg lsm;
891 char *varlen_data;
892 int ret = 0;
893 unsigned int free_filter_expression = 0;
894 struct filter_parser_ctx *ctx = NULL;
895 /*
896 * Cast as non-const since we may replace the filter expression
897 * by a dynamically allocated string. Otherwise, the original
898 * string is not modified.
899 */
900 char *filter_expression = (char *) original_filter_expression;
901
902 if (handle == NULL || ev == NULL) {
903 ret = -LTTNG_ERR_INVALID;
904 goto error;
905 }
906
907 /* Empty filter string will always be rejected by the parser
908 * anyway, so treat this corner-case early to eliminate
909 * lttng_fmemopen error for 0-byte allocation.
910 */
911 if (filter_expression && filter_expression[0] == '\0') {
912 ret = -LTTNG_ERR_INVALID;
913 goto error;
914 }
915
916 memset(&lsm, 0, sizeof(lsm));
917
918 /* If no channel name, send empty string. */
919 if (channel_name == NULL) {
920 lttng_ctl_copy_string(lsm.u.enable.channel_name, "",
921 sizeof(lsm.u.enable.channel_name));
922 } else {
923 lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name,
924 sizeof(lsm.u.enable.channel_name));
925 }
926
927 lsm.cmd_type = LTTNG_ENABLE_EVENT;
928 if (ev->name[0] == '\0') {
929 /* Enable all events */
930 lttng_ctl_copy_string(ev->name, "*", sizeof(ev->name));
931 }
932
933 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
934 /* FIXME: copying non-packed struct to packed struct. */
935 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
936
937 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
938 sizeof(lsm.session.name));
939 lsm.u.enable.exclusion_count = exclusion_count;
940 lsm.u.enable.bytecode_len = 0;
941
942 /*
943 * For the JUL domain, a filter is enforced except for the enable all
944 * event. This is done to avoid having the event in all sessions thus
945 * filtering by logger name.
946 */
947 if (exclusion_count == 0 && filter_expression == NULL &&
948 (handle->domain.type != LTTNG_DOMAIN_JUL &&
949 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
950 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
951 goto ask_sessiond;
952 }
953
954 /*
955 * We have either a filter or some exclusions, so we need to set up
956 * a variable-length memory block from where to send the data
957 */
958
959 /* Parse filter expression */
960 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
961 || handle->domain.type == LTTNG_DOMAIN_LOG4J
962 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
963 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
964 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
965 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
966 char *agent_filter;
967
968 /* Setup JUL filter if needed. */
969 agent_filter = set_agent_filter(filter_expression, ev);
970 if (!agent_filter) {
971 if (!filter_expression) {
972 /* No JUL and no filter, just skip everything below. */
973 goto ask_sessiond;
974 }
975 } else {
976 /*
977 * With an agent filter, the original filter has been added to
978 * it thus replace the filter expression.
979 */
980 filter_expression = agent_filter;
981 free_filter_expression = 1;
982 }
983 }
984
985 ret = generate_filter(filter_expression, &lsm, &ctx);
986 if (ret) {
987 goto filter_error;
988 }
989 }
990
991 varlen_data = zmalloc(lsm.u.enable.bytecode_len
992 + lsm.u.enable.expression_len
993 + LTTNG_SYMBOL_NAME_LEN * exclusion_count);
994 if (!varlen_data) {
995 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
996 goto mem_error;
997 }
998
999 /* Put exclusion names first in the data */
1000 while (exclusion_count--) {
1001 strncpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * exclusion_count,
1002 *(exclusion_list + exclusion_count),
1003 LTTNG_SYMBOL_NAME_LEN - 1);
1004 }
1005 /* Add filter expression next */
1006 if (lsm.u.enable.expression_len != 0) {
1007 memcpy(varlen_data
1008 + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count,
1009 filter_expression,
1010 lsm.u.enable.expression_len);
1011 }
1012 /* Add filter bytecode next */
1013 if (ctx && lsm.u.enable.bytecode_len != 0) {
1014 memcpy(varlen_data
1015 + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count
1016 + lsm.u.enable.expression_len,
1017 &ctx->bytecode->b,
1018 lsm.u.enable.bytecode_len);
1019 }
1020
1021 ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data,
1022 (LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count) +
1023 lsm.u.enable.bytecode_len + lsm.u.enable.expression_len, NULL);
1024 free(varlen_data);
1025
1026 mem_error:
1027 if (filter_expression && ctx) {
1028 filter_bytecode_free(ctx);
1029 filter_ir_free(ctx);
1030 filter_parser_ctx_free(ctx);
1031 }
1032 filter_error:
1033 if (free_filter_expression) {
1034 /*
1035 * The filter expression has been replaced and must be freed as it is
1036 * not the original filter expression received as a parameter.
1037 */
1038 free(filter_expression);
1039 }
1040 error:
1041 /*
1042 * Return directly to the caller and don't ask the sessiond since something
1043 * went wrong in the parsing of data above.
1044 */
1045 return ret;
1046
1047 ask_sessiond:
1048 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1049 return ret;
1050 }
1051
1052 int lttng_disable_event_ext(struct lttng_handle *handle,
1053 struct lttng_event *ev, const char *channel_name,
1054 const char *original_filter_expression)
1055 {
1056 struct lttcomm_session_msg lsm;
1057 char *varlen_data;
1058 int ret = 0;
1059 unsigned int free_filter_expression = 0;
1060 struct filter_parser_ctx *ctx = NULL;
1061 /*
1062 * Cast as non-const since we may replace the filter expression
1063 * by a dynamically allocated string. Otherwise, the original
1064 * string is not modified.
1065 */
1066 char *filter_expression = (char *) original_filter_expression;
1067
1068 if (handle == NULL || ev == NULL) {
1069 ret = -LTTNG_ERR_INVALID;
1070 goto error;
1071 }
1072
1073 /* Empty filter string will always be rejected by the parser
1074 * anyway, so treat this corner-case early to eliminate
1075 * lttng_fmemopen error for 0-byte allocation.
1076 */
1077 if (filter_expression && filter_expression[0] == '\0') {
1078 ret = -LTTNG_ERR_INVALID;
1079 goto error;
1080 }
1081
1082 memset(&lsm, 0, sizeof(lsm));
1083
1084 /* If no channel name, send empty string. */
1085 if (channel_name == NULL) {
1086 lttng_ctl_copy_string(lsm.u.disable.channel_name, "",
1087 sizeof(lsm.u.disable.channel_name));
1088 } else {
1089 lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name,
1090 sizeof(lsm.u.disable.channel_name));
1091 }
1092
1093 lsm.cmd_type = LTTNG_DISABLE_EVENT;
1094
1095 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1096 /* FIXME: copying non-packed struct to packed struct. */
1097 memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event));
1098
1099 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1100 sizeof(lsm.session.name));
1101 lsm.u.disable.bytecode_len = 0;
1102
1103 /*
1104 * For the JUL domain, a filter is enforced except for the
1105 * disable all event. This is done to avoid having the event in
1106 * all sessions thus filtering by logger name.
1107 */
1108 if (filter_expression == NULL &&
1109 (handle->domain.type != LTTNG_DOMAIN_JUL &&
1110 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
1111 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
1112 goto ask_sessiond;
1113 }
1114
1115 /*
1116 * We have a filter, so we need to set up a variable-length
1117 * memory block from where to send the data.
1118 */
1119
1120 /* Parse filter expression */
1121 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1122 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1123 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1124 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1125 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1126 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1127 char *agent_filter;
1128
1129 /* Setup JUL filter if needed. */
1130 agent_filter = set_agent_filter(filter_expression, ev);
1131 if (!agent_filter) {
1132 if (!filter_expression) {
1133 /* No JUL and no filter, just skip everything below. */
1134 goto ask_sessiond;
1135 }
1136 } else {
1137 /*
1138 * With a JUL filter, the original filter has been added to it
1139 * thus replace the filter expression.
1140 */
1141 filter_expression = agent_filter;
1142 free_filter_expression = 1;
1143 }
1144 }
1145
1146 ret = generate_filter(filter_expression, &lsm, &ctx);
1147 if (ret) {
1148 goto filter_error;
1149 }
1150 }
1151
1152 varlen_data = zmalloc(lsm.u.disable.bytecode_len
1153 + lsm.u.disable.expression_len);
1154 if (!varlen_data) {
1155 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1156 goto mem_error;
1157 }
1158
1159 /* Add filter expression */
1160 if (lsm.u.disable.expression_len != 0) {
1161 memcpy(varlen_data,
1162 filter_expression,
1163 lsm.u.disable.expression_len);
1164 }
1165 /* Add filter bytecode next */
1166 if (ctx && lsm.u.disable.bytecode_len != 0) {
1167 memcpy(varlen_data
1168 + lsm.u.disable.expression_len,
1169 &ctx->bytecode->b,
1170 lsm.u.disable.bytecode_len);
1171 }
1172
1173 ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data,
1174 lsm.u.disable.bytecode_len + lsm.u.disable.expression_len, NULL);
1175 free(varlen_data);
1176
1177 mem_error:
1178 if (filter_expression && ctx) {
1179 filter_bytecode_free(ctx);
1180 filter_ir_free(ctx);
1181 filter_parser_ctx_free(ctx);
1182 }
1183 filter_error:
1184 if (free_filter_expression) {
1185 /*
1186 * The filter expression has been replaced and must be freed as it is
1187 * not the original filter expression received as a parameter.
1188 */
1189 free(filter_expression);
1190 }
1191 error:
1192 /*
1193 * Return directly to the caller and don't ask the sessiond since something
1194 * went wrong in the parsing of data above.
1195 */
1196 return ret;
1197
1198 ask_sessiond:
1199 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1200 return ret;
1201 }
1202
1203 /*
1204 * Disable event(s) of a channel and domain.
1205 * If no event name is specified, all events are disabled.
1206 * If no channel name is specified, the default 'channel0' is used.
1207 * Returns size of returned session payload data or a negative error code.
1208 */
1209 int lttng_disable_event(struct lttng_handle *handle, const char *name,
1210 const char *channel_name)
1211 {
1212 struct lttng_event ev;
1213
1214 memset(&ev, 0, sizeof(ev));
1215 ev.loglevel = -1;
1216 ev.type = LTTNG_EVENT_ALL;
1217 lttng_ctl_copy_string(ev.name, name, sizeof(ev.name));
1218 return lttng_disable_event_ext(handle, &ev, channel_name, NULL);
1219 }
1220
1221 /*
1222 * Enable channel per domain
1223 * Returns size of returned session payload data or a negative error code.
1224 */
1225 int lttng_enable_channel(struct lttng_handle *handle,
1226 struct lttng_channel *chan)
1227 {
1228 struct lttcomm_session_msg lsm;
1229
1230 /*
1231 * NULL arguments are forbidden. No default values.
1232 */
1233 if (handle == NULL || chan == NULL) {
1234 return -LTTNG_ERR_INVALID;
1235 }
1236
1237 memset(&lsm, 0, sizeof(lsm));
1238
1239 memcpy(&lsm.u.channel.chan, chan, sizeof(lsm.u.channel.chan));
1240
1241 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
1242
1243 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1244
1245 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1246 sizeof(lsm.session.name));
1247
1248 return lttng_ctl_ask_sessiond(&lsm, NULL);
1249 }
1250
1251 /*
1252 * All tracing will be stopped for registered events of the channel.
1253 * Returns size of returned session payload data or a negative error code.
1254 */
1255 int lttng_disable_channel(struct lttng_handle *handle, const char *name)
1256 {
1257 struct lttcomm_session_msg lsm;
1258
1259 /* Safety check. Both are mandatory */
1260 if (handle == NULL || name == NULL) {
1261 return -LTTNG_ERR_INVALID;
1262 }
1263
1264 memset(&lsm, 0, sizeof(lsm));
1265
1266 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1267
1268 lttng_ctl_copy_string(lsm.u.disable.channel_name, name,
1269 sizeof(lsm.u.disable.channel_name));
1270
1271 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1272
1273 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1274 sizeof(lsm.session.name));
1275
1276 return lttng_ctl_ask_sessiond(&lsm, NULL);
1277 }
1278
1279 /*
1280 * Add PID to session tracker.
1281 * Return 0 on success else a negative LTTng error code.
1282 */
1283 int lttng_track_pid(struct lttng_handle *handle, int pid)
1284 {
1285 struct lttcomm_session_msg lsm;
1286
1287 /*
1288 * NULL arguments are forbidden. No default values.
1289 */
1290 if (handle == NULL) {
1291 return -LTTNG_ERR_INVALID;
1292 }
1293
1294 memset(&lsm, 0, sizeof(lsm));
1295
1296 lsm.cmd_type = LTTNG_TRACK_PID;
1297 lsm.u.pid_tracker.pid = pid;
1298
1299 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1300
1301 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1302 sizeof(lsm.session.name));
1303
1304 return lttng_ctl_ask_sessiond(&lsm, NULL);
1305 }
1306
1307 /*
1308 * Remove PID from session tracker.
1309 * Return 0 on success else a negative LTTng error code.
1310 */
1311 int lttng_untrack_pid(struct lttng_handle *handle, int pid)
1312 {
1313 struct lttcomm_session_msg lsm;
1314
1315 /*
1316 * NULL arguments are forbidden. No default values.
1317 */
1318 if (handle == NULL) {
1319 return -LTTNG_ERR_INVALID;
1320 }
1321
1322 memset(&lsm, 0, sizeof(lsm));
1323
1324 lsm.cmd_type = LTTNG_UNTRACK_PID;
1325 lsm.u.pid_tracker.pid = pid;
1326
1327 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1328
1329 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1330 sizeof(lsm.session.name));
1331
1332 return lttng_ctl_ask_sessiond(&lsm, NULL);
1333 }
1334
1335 /*
1336 * Lists all available tracepoints of domain.
1337 * Sets the contents of the events array.
1338 * Returns the number of lttng_event entries in events;
1339 * on error, returns a negative value.
1340 */
1341 int lttng_list_tracepoints(struct lttng_handle *handle,
1342 struct lttng_event **events)
1343 {
1344 int ret;
1345 struct lttcomm_session_msg lsm;
1346
1347 if (handle == NULL) {
1348 return -LTTNG_ERR_INVALID;
1349 }
1350
1351 memset(&lsm, 0, sizeof(lsm));
1352 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
1353 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1354
1355 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1356 if (ret < 0) {
1357 return ret;
1358 }
1359
1360 return ret / sizeof(struct lttng_event);
1361 }
1362
1363 /*
1364 * Lists all available tracepoint fields of domain.
1365 * Sets the contents of the event field array.
1366 * Returns the number of lttng_event_field entries in events;
1367 * on error, returns a negative value.
1368 */
1369 int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1370 struct lttng_event_field **fields)
1371 {
1372 int ret;
1373 struct lttcomm_session_msg lsm;
1374
1375 if (handle == NULL) {
1376 return -LTTNG_ERR_INVALID;
1377 }
1378
1379 memset(&lsm, 0, sizeof(lsm));
1380 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
1381 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1382
1383 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
1384 if (ret < 0) {
1385 return ret;
1386 }
1387
1388 return ret / sizeof(struct lttng_event_field);
1389 }
1390
1391 /*
1392 * Lists all available kernel system calls. Allocates and sets the contents of
1393 * the events array.
1394 *
1395 * Returns the number of lttng_event entries in events; on error, returns a
1396 * negative value.
1397 */
1398 int lttng_list_syscalls(struct lttng_event **events)
1399 {
1400 int ret;
1401 struct lttcomm_session_msg lsm;
1402
1403 if (!events) {
1404 return -LTTNG_ERR_INVALID;
1405 }
1406
1407 memset(&lsm, 0, sizeof(lsm));
1408 lsm.cmd_type = LTTNG_LIST_SYSCALLS;
1409 /* Force kernel domain for system calls. */
1410 lsm.domain.type = LTTNG_DOMAIN_KERNEL;
1411
1412 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1413 if (ret < 0) {
1414 return ret;
1415 }
1416
1417 return ret / sizeof(struct lttng_event);
1418 }
1419
1420 /*
1421 * Returns a human readable string describing
1422 * the error code (a negative value).
1423 */
1424 const char *lttng_strerror(int code)
1425 {
1426 return error_get_str(code);
1427 }
1428
1429 /*
1430 * Create a brand new session using name and url for destination.
1431 *
1432 * Returns LTTNG_OK on success or a negative error code.
1433 */
1434 int lttng_create_session(const char *name, const char *url)
1435 {
1436 int ret;
1437 ssize_t size;
1438 struct lttcomm_session_msg lsm;
1439 struct lttng_uri *uris = NULL;
1440
1441 if (name == NULL) {
1442 return -LTTNG_ERR_INVALID;
1443 }
1444
1445 memset(&lsm, 0, sizeof(lsm));
1446
1447 lsm.cmd_type = LTTNG_CREATE_SESSION;
1448 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1449
1450 /* There should never be a data URL */
1451 size = uri_parse_str_urls(url, NULL, &uris);
1452 if (size < 0) {
1453 return -LTTNG_ERR_INVALID;
1454 }
1455
1456 lsm.u.uri.size = size;
1457
1458 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1459 sizeof(struct lttng_uri) * size, NULL);
1460
1461 free(uris);
1462 return ret;
1463 }
1464
1465 /*
1466 * Destroy session using name.
1467 * Returns size of returned session payload data or a negative error code.
1468 */
1469 int lttng_destroy_session(const char *session_name)
1470 {
1471 struct lttcomm_session_msg lsm;
1472
1473 if (session_name == NULL) {
1474 return -LTTNG_ERR_INVALID;
1475 }
1476
1477 memset(&lsm, 0, sizeof(lsm));
1478 lsm.cmd_type = LTTNG_DESTROY_SESSION;
1479
1480 lttng_ctl_copy_string(lsm.session.name, session_name,
1481 sizeof(lsm.session.name));
1482
1483 return lttng_ctl_ask_sessiond(&lsm, NULL);
1484 }
1485
1486 /*
1487 * Ask the session daemon for all available sessions.
1488 * Sets the contents of the sessions array.
1489 * Returns the number of lttng_session entries in sessions;
1490 * on error, returns a negative value.
1491 */
1492 int lttng_list_sessions(struct lttng_session **sessions)
1493 {
1494 int ret;
1495 struct lttcomm_session_msg lsm;
1496
1497 memset(&lsm, 0, sizeof(lsm));
1498 lsm.cmd_type = LTTNG_LIST_SESSIONS;
1499 ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions);
1500 if (ret < 0) {
1501 return ret;
1502 }
1503
1504 return ret / sizeof(struct lttng_session);
1505 }
1506
1507 int lttng_set_session_shm_path(const char *session_name,
1508 const char *shm_path)
1509 {
1510 struct lttcomm_session_msg lsm;
1511
1512 if (session_name == NULL) {
1513 return -LTTNG_ERR_INVALID;
1514 }
1515
1516 memset(&lsm, 0, sizeof(lsm));
1517 lsm.cmd_type = LTTNG_SET_SESSION_SHM_PATH;
1518
1519 lttng_ctl_copy_string(lsm.session.name, session_name,
1520 sizeof(lsm.session.name));
1521 lttng_ctl_copy_string(lsm.u.set_shm_path.shm_path, shm_path,
1522 sizeof(lsm.u.set_shm_path.shm_path));
1523
1524 return lttng_ctl_ask_sessiond(&lsm, NULL);
1525 }
1526
1527 /*
1528 * Ask the session daemon for all available domains of a session.
1529 * Sets the contents of the domains array.
1530 * Returns the number of lttng_domain entries in domains;
1531 * on error, returns a negative value.
1532 */
1533 int lttng_list_domains(const char *session_name,
1534 struct lttng_domain **domains)
1535 {
1536 int ret;
1537 struct lttcomm_session_msg lsm;
1538
1539 if (session_name == NULL) {
1540 return -LTTNG_ERR_INVALID;
1541 }
1542
1543 memset(&lsm, 0, sizeof(lsm));
1544 lsm.cmd_type = LTTNG_LIST_DOMAINS;
1545
1546 lttng_ctl_copy_string(lsm.session.name, session_name,
1547 sizeof(lsm.session.name));
1548
1549 ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains);
1550 if (ret < 0) {
1551 return ret;
1552 }
1553
1554 return ret / sizeof(struct lttng_domain);
1555 }
1556
1557 /*
1558 * Ask the session daemon for all available channels of a session.
1559 * Sets the contents of the channels array.
1560 * Returns the number of lttng_channel entries in channels;
1561 * on error, returns a negative value.
1562 */
1563 int lttng_list_channels(struct lttng_handle *handle,
1564 struct lttng_channel **channels)
1565 {
1566 int ret;
1567 struct lttcomm_session_msg lsm;
1568
1569 if (handle == NULL) {
1570 return -LTTNG_ERR_INVALID;
1571 }
1572
1573 memset(&lsm, 0, sizeof(lsm));
1574 lsm.cmd_type = LTTNG_LIST_CHANNELS;
1575 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1576 sizeof(lsm.session.name));
1577
1578 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1579
1580 ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
1581 if (ret < 0) {
1582 return ret;
1583 }
1584
1585 return ret / sizeof(struct lttng_channel);
1586 }
1587
1588 /*
1589 * Ask the session daemon for all available events of a session channel.
1590 * Sets the contents of the events array.
1591 * Returns the number of lttng_event entries in events;
1592 * on error, returns a negative value.
1593 */
1594 int lttng_list_events(struct lttng_handle *handle,
1595 const char *channel_name, struct lttng_event **events)
1596 {
1597 int ret;
1598 struct lttcomm_session_msg lsm;
1599
1600 /* Safety check. An handle and channel name are mandatory */
1601 if (handle == NULL || channel_name == NULL) {
1602 return -LTTNG_ERR_INVALID;
1603 }
1604
1605 memset(&lsm, 0, sizeof(lsm));
1606 lsm.cmd_type = LTTNG_LIST_EVENTS;
1607 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1608 sizeof(lsm.session.name));
1609 lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name,
1610 sizeof(lsm.u.list.channel_name));
1611
1612 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1613
1614 ret = lttng_ctl_ask_sessiond(&lsm, (void**) events);
1615 if (ret < 0) {
1616 return ret;
1617 }
1618
1619 return ret / sizeof(struct lttng_event);
1620 }
1621
1622 /*
1623 * Sets the tracing_group variable with name.
1624 * This function allocates memory pointed to by tracing_group.
1625 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1626 */
1627 int lttng_set_tracing_group(const char *name)
1628 {
1629 if (name == NULL) {
1630 return -LTTNG_ERR_INVALID;
1631 }
1632
1633 if (asprintf(&tracing_group, "%s", name) < 0) {
1634 return -LTTNG_ERR_FATAL;
1635 }
1636
1637 return 0;
1638 }
1639
1640 /*
1641 * Returns size of returned session payload data or a negative error code.
1642 */
1643 int lttng_calibrate(struct lttng_handle *handle,
1644 struct lttng_calibrate *calibrate)
1645 {
1646 struct lttcomm_session_msg lsm;
1647
1648 /* Safety check. NULL pointer are forbidden */
1649 if (handle == NULL || calibrate == NULL) {
1650 return -LTTNG_ERR_INVALID;
1651 }
1652
1653 memset(&lsm, 0, sizeof(lsm));
1654 lsm.cmd_type = LTTNG_CALIBRATE;
1655 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1656
1657 memcpy(&lsm.u.calibrate, calibrate, sizeof(lsm.u.calibrate));
1658
1659 return lttng_ctl_ask_sessiond(&lsm, NULL);
1660 }
1661
1662 /*
1663 * Set default channel attributes.
1664 * If either or both of the arguments are null, attr content is zeroe'd.
1665 */
1666 void lttng_channel_set_default_attr(struct lttng_domain *domain,
1667 struct lttng_channel_attr *attr)
1668 {
1669 /* Safety check */
1670 if (attr == NULL || domain == NULL) {
1671 return;
1672 }
1673
1674 memset(attr, 0, sizeof(struct lttng_channel_attr));
1675
1676 /* Same for all domains. */
1677 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
1678 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
1679 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
1680
1681 switch (domain->type) {
1682 case LTTNG_DOMAIN_KERNEL:
1683 attr->switch_timer_interval = DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
1684 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
1685 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
1686 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
1687 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
1688 break;
1689 case LTTNG_DOMAIN_UST:
1690 switch (domain->buf_type) {
1691 case LTTNG_BUFFER_PER_UID:
1692 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
1693 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
1694 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
1695 attr->switch_timer_interval = DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
1696 attr->read_timer_interval = DEFAULT_UST_UID_CHANNEL_READ_TIMER;
1697 break;
1698 case LTTNG_BUFFER_PER_PID:
1699 default:
1700 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
1701 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
1702 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
1703 attr->switch_timer_interval = DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
1704 attr->read_timer_interval = DEFAULT_UST_PID_CHANNEL_READ_TIMER;
1705 break;
1706 }
1707 default:
1708 /* Default behavior: leave set to 0. */
1709 break;
1710 }
1711 }
1712
1713 /*
1714 * Check if session daemon is alive.
1715 *
1716 * Return 1 if alive or 0 if not.
1717 * On error returns a negative value.
1718 */
1719 int lttng_session_daemon_alive(void)
1720 {
1721 int ret;
1722
1723 ret = set_session_daemon_path();
1724 if (ret < 0) {
1725 /* Error */
1726 return ret;
1727 }
1728
1729 if (*sessiond_sock_path == '\0') {
1730 /*
1731 * No socket path set. Weird error which means the constructor was not
1732 * called.
1733 */
1734 assert(0);
1735 }
1736
1737 ret = try_connect_sessiond(sessiond_sock_path);
1738 if (ret < 0) {
1739 /* Not alive */
1740 return 0;
1741 }
1742
1743 /* Is alive */
1744 return 1;
1745 }
1746
1747 /*
1748 * Set URL for a consumer for a session and domain.
1749 *
1750 * Return 0 on success, else a negative value.
1751 */
1752 int lttng_set_consumer_url(struct lttng_handle *handle,
1753 const char *control_url, const char *data_url)
1754 {
1755 int ret;
1756 ssize_t size;
1757 struct lttcomm_session_msg lsm;
1758 struct lttng_uri *uris = NULL;
1759
1760 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
1761 return -LTTNG_ERR_INVALID;
1762 }
1763
1764 memset(&lsm, 0, sizeof(lsm));
1765
1766 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
1767
1768 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1769 sizeof(lsm.session.name));
1770 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1771
1772 size = uri_parse_str_urls(control_url, data_url, &uris);
1773 if (size < 0) {
1774 return -LTTNG_ERR_INVALID;
1775 }
1776
1777 lsm.u.uri.size = size;
1778
1779 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1780 sizeof(struct lttng_uri) * size, NULL);
1781
1782 free(uris);
1783 return ret;
1784 }
1785
1786 /*
1787 * [OBSOLETE]
1788 */
1789 int lttng_enable_consumer(struct lttng_handle *handle)
1790 {
1791 return -ENOSYS;
1792 }
1793
1794 /*
1795 * [OBSOLETE]
1796 */
1797 int lttng_disable_consumer(struct lttng_handle *handle)
1798 {
1799 return -ENOSYS;
1800 }
1801
1802 /*
1803 * This is an extension of create session that is ONLY and SHOULD only be used
1804 * by the lttng command line program. It exists to avoid using URI parsing in
1805 * the lttng client.
1806 *
1807 * We need the date and time for the trace path subdirectory for the case where
1808 * the user does NOT define one using either -o or -U. Using the normal
1809 * lttng_create_session API call, we have no clue on the session daemon side if
1810 * the URL was generated automatically by the client or define by the user.
1811 *
1812 * So this function "wrapper" is hidden from the public API, takes the datetime
1813 * string and appends it if necessary to the URI subdirectory before sending it
1814 * to the session daemon.
1815 *
1816 * With this extra function, the lttng_create_session call behavior is not
1817 * changed and the timestamp is appended to the URI on the session daemon side
1818 * if necessary.
1819 */
1820 int _lttng_create_session_ext(const char *name, const char *url,
1821 const char *datetime)
1822 {
1823 int ret;
1824 ssize_t size;
1825 struct lttcomm_session_msg lsm;
1826 struct lttng_uri *uris = NULL;
1827
1828 if (name == NULL || datetime == NULL) {
1829 return -LTTNG_ERR_INVALID;
1830 }
1831
1832 memset(&lsm, 0, sizeof(lsm));
1833
1834 lsm.cmd_type = LTTNG_CREATE_SESSION;
1835 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1836
1837 /* There should never be a data URL */
1838 size = uri_parse_str_urls(url, NULL, &uris);
1839 if (size < 0) {
1840 ret = -LTTNG_ERR_INVALID;
1841 goto error;
1842 }
1843
1844 lsm.u.uri.size = size;
1845
1846 if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
1847 /* Don't append datetime if the name was automatically created. */
1848 if (strncmp(name, DEFAULT_SESSION_NAME "-",
1849 strlen(DEFAULT_SESSION_NAME) + 1)) {
1850 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s",
1851 name, datetime);
1852 } else {
1853 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name);
1854 }
1855 if (ret < 0) {
1856 PERROR("snprintf uri subdir");
1857 ret = -LTTNG_ERR_FATAL;
1858 goto error;
1859 }
1860 }
1861
1862 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1863 sizeof(struct lttng_uri) * size, NULL);
1864
1865 error:
1866 free(uris);
1867 return ret;
1868 }
1869
1870 /*
1871 * For a given session name, this call checks if the data is ready to be read
1872 * or is still being extracted by the consumer(s) hence not ready to be used by
1873 * any readers.
1874 */
1875 int lttng_data_pending(const char *session_name)
1876 {
1877 int ret;
1878 struct lttcomm_session_msg lsm;
1879 uint8_t *pending = NULL;
1880
1881 if (session_name == NULL) {
1882 return -LTTNG_ERR_INVALID;
1883 }
1884
1885 memset(&lsm, 0, sizeof(lsm));
1886 lsm.cmd_type = LTTNG_DATA_PENDING;
1887
1888 lttng_ctl_copy_string(lsm.session.name, session_name,
1889 sizeof(lsm.session.name));
1890
1891 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending);
1892 if (ret < 0) {
1893 goto end;
1894 } else if (ret != 1) {
1895 /* Unexpected payload size */
1896 ret = -LTTNG_ERR_INVALID;
1897 goto end;
1898 }
1899
1900 ret = (int) *pending;
1901 end:
1902 free(pending);
1903 return ret;
1904 }
1905
1906 /*
1907 * Create a session exclusively used for snapshot.
1908 *
1909 * Returns LTTNG_OK on success or a negative error code.
1910 */
1911 int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
1912 {
1913 int ret;
1914 ssize_t size;
1915 struct lttcomm_session_msg lsm;
1916 struct lttng_uri *uris = NULL;
1917
1918 if (name == NULL) {
1919 return -LTTNG_ERR_INVALID;
1920 }
1921
1922 memset(&lsm, 0, sizeof(lsm));
1923
1924 lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT;
1925 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1926
1927 size = uri_parse_str_urls(snapshot_url, NULL, &uris);
1928 if (size < 0) {
1929 return -LTTNG_ERR_INVALID;
1930 }
1931
1932 lsm.u.uri.size = size;
1933
1934 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1935 sizeof(struct lttng_uri) * size, NULL);
1936
1937 free(uris);
1938 return ret;
1939 }
1940
1941 /*
1942 * Create a session exclusively used for live.
1943 *
1944 * Returns LTTNG_OK on success or a negative error code.
1945 */
1946 int lttng_create_session_live(const char *name, const char *url,
1947 unsigned int timer_interval)
1948 {
1949 int ret;
1950 ssize_t size;
1951 struct lttcomm_session_msg lsm;
1952 struct lttng_uri *uris = NULL;
1953
1954 if (name == NULL || timer_interval == 0) {
1955 return -LTTNG_ERR_INVALID;
1956 }
1957
1958 memset(&lsm, 0, sizeof(lsm));
1959
1960 lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE;
1961 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1962
1963 if (url) {
1964 size = uri_parse_str_urls(url, NULL, &uris);
1965 if (size <= 0) {
1966 ret = -LTTNG_ERR_INVALID;
1967 goto end;
1968 }
1969
1970 /* file:// is not accepted for live session. */
1971 if (uris[0].dtype == LTTNG_DST_PATH) {
1972 ret = -LTTNG_ERR_INVALID;
1973 goto end;
1974 }
1975 } else {
1976 size = 0;
1977 }
1978
1979 lsm.u.session_live.nb_uri = size;
1980 lsm.u.session_live.timer_interval = timer_interval;
1981
1982 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1983 sizeof(struct lttng_uri) * size, NULL);
1984
1985 end:
1986 free(uris);
1987 return ret;
1988 }
1989
1990 /*
1991 * List PIDs in the tracker.
1992 *
1993 * enabled is set to whether the PID tracker is enabled.
1994 * pids is set to an allocated array of PIDs currently tracked. On
1995 * success, pids must be freed by the caller.
1996 * nr_pids is set to the number of entries contained by the pids array.
1997 *
1998 * Returns 0 on success, else a negative LTTng error code.
1999 */
2000 int lttng_list_tracker_pids(struct lttng_handle *handle,
2001 int *_enabled, int32_t **_pids, size_t *_nr_pids)
2002 {
2003 int ret;
2004 int enabled = 1;
2005 struct lttcomm_session_msg lsm;
2006 size_t nr_pids;
2007 int32_t *pids;
2008
2009 if (handle == NULL) {
2010 return -LTTNG_ERR_INVALID;
2011 }
2012
2013 memset(&lsm, 0, sizeof(lsm));
2014 lsm.cmd_type = LTTNG_LIST_TRACKER_PIDS;
2015 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
2016 sizeof(lsm.session.name));
2017 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
2018
2019 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pids);
2020 if (ret < 0) {
2021 return ret;
2022 }
2023 nr_pids = ret / sizeof(int32_t);
2024 if (nr_pids == 1 && pids[0] == -1) {
2025 free(pids);
2026 pids = NULL;
2027 enabled = 0;
2028 nr_pids = 0;
2029 }
2030 *_enabled = enabled;
2031 *_pids = pids;
2032 *_nr_pids = nr_pids;
2033 return 0;
2034 }
2035
2036 /*
2037 * lib constructor
2038 */
2039 static void __attribute__((constructor)) init()
2040 {
2041 /* Set default session group */
2042 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
2043 }
2044
2045 /*
2046 * lib destructor
2047 */
2048 static void __attribute__((destructor)) lttng_ctl_exit()
2049 {
2050 free(tracing_group);
2051 }
This page took 0.125008 seconds and 4 git commands to generate.