Ignore exclusion names order when matching events
[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), LTTNG_SYMBOL_NAME_LEN);
1003 }
1004 /* Add filter expression next */
1005 if (lsm.u.enable.expression_len != 0) {
1006 memcpy(varlen_data
1007 + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count,
1008 filter_expression,
1009 lsm.u.enable.expression_len);
1010 }
1011 /* Add filter bytecode next */
1012 if (ctx && lsm.u.enable.bytecode_len != 0) {
1013 memcpy(varlen_data
1014 + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count
1015 + lsm.u.enable.expression_len,
1016 &ctx->bytecode->b,
1017 lsm.u.enable.bytecode_len);
1018 }
1019
1020 ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data,
1021 (LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count) +
1022 lsm.u.enable.bytecode_len + lsm.u.enable.expression_len, NULL);
1023 free(varlen_data);
1024
1025 mem_error:
1026 if (filter_expression && ctx) {
1027 filter_bytecode_free(ctx);
1028 filter_ir_free(ctx);
1029 filter_parser_ctx_free(ctx);
1030 }
1031 filter_error:
1032 if (free_filter_expression) {
1033 /*
1034 * The filter expression has been replaced and must be freed as it is
1035 * not the original filter expression received as a parameter.
1036 */
1037 free(filter_expression);
1038 }
1039 error:
1040 /*
1041 * Return directly to the caller and don't ask the sessiond since something
1042 * went wrong in the parsing of data above.
1043 */
1044 return ret;
1045
1046 ask_sessiond:
1047 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1048 return ret;
1049 }
1050
1051 int lttng_disable_event_ext(struct lttng_handle *handle,
1052 struct lttng_event *ev, const char *channel_name,
1053 const char *original_filter_expression)
1054 {
1055 struct lttcomm_session_msg lsm;
1056 char *varlen_data;
1057 int ret = 0;
1058 unsigned int free_filter_expression = 0;
1059 struct filter_parser_ctx *ctx = NULL;
1060 /*
1061 * Cast as non-const since we may replace the filter expression
1062 * by a dynamically allocated string. Otherwise, the original
1063 * string is not modified.
1064 */
1065 char *filter_expression = (char *) original_filter_expression;
1066
1067 if (handle == NULL || ev == NULL) {
1068 ret = -LTTNG_ERR_INVALID;
1069 goto error;
1070 }
1071
1072 /* Empty filter string will always be rejected by the parser
1073 * anyway, so treat this corner-case early to eliminate
1074 * lttng_fmemopen error for 0-byte allocation.
1075 */
1076 if (filter_expression && filter_expression[0] == '\0') {
1077 ret = -LTTNG_ERR_INVALID;
1078 goto error;
1079 }
1080
1081 memset(&lsm, 0, sizeof(lsm));
1082
1083 /* If no channel name, send empty string. */
1084 if (channel_name == NULL) {
1085 lttng_ctl_copy_string(lsm.u.disable.channel_name, "",
1086 sizeof(lsm.u.disable.channel_name));
1087 } else {
1088 lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name,
1089 sizeof(lsm.u.disable.channel_name));
1090 }
1091
1092 lsm.cmd_type = LTTNG_DISABLE_EVENT;
1093
1094 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1095 /* FIXME: copying non-packed struct to packed struct. */
1096 memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event));
1097
1098 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1099 sizeof(lsm.session.name));
1100 lsm.u.disable.bytecode_len = 0;
1101
1102 /*
1103 * For the JUL domain, a filter is enforced except for the
1104 * disable all event. This is done to avoid having the event in
1105 * all sessions thus filtering by logger name.
1106 */
1107 if (filter_expression == NULL &&
1108 (handle->domain.type != LTTNG_DOMAIN_JUL &&
1109 handle->domain.type != LTTNG_DOMAIN_LOG4J &&
1110 handle->domain.type != LTTNG_DOMAIN_PYTHON)) {
1111 goto ask_sessiond;
1112 }
1113
1114 /*
1115 * We have a filter, so we need to set up a variable-length
1116 * memory block from where to send the data.
1117 */
1118
1119 /* Parse filter expression */
1120 if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL
1121 || handle->domain.type == LTTNG_DOMAIN_LOG4J
1122 || handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1123 if (handle->domain.type == LTTNG_DOMAIN_JUL ||
1124 handle->domain.type == LTTNG_DOMAIN_LOG4J ||
1125 handle->domain.type == LTTNG_DOMAIN_PYTHON) {
1126 char *agent_filter;
1127
1128 /* Setup JUL filter if needed. */
1129 agent_filter = set_agent_filter(filter_expression, ev);
1130 if (!agent_filter) {
1131 if (!filter_expression) {
1132 /* No JUL and no filter, just skip everything below. */
1133 goto ask_sessiond;
1134 }
1135 } else {
1136 /*
1137 * With a JUL filter, the original filter has been added to it
1138 * thus replace the filter expression.
1139 */
1140 filter_expression = agent_filter;
1141 free_filter_expression = 1;
1142 }
1143 }
1144
1145 ret = generate_filter(filter_expression, &lsm, &ctx);
1146 if (ret) {
1147 goto filter_error;
1148 }
1149 }
1150
1151 varlen_data = zmalloc(lsm.u.disable.bytecode_len
1152 + lsm.u.disable.expression_len);
1153 if (!varlen_data) {
1154 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1155 goto mem_error;
1156 }
1157
1158 /* Add filter expression */
1159 if (lsm.u.disable.expression_len != 0) {
1160 memcpy(varlen_data,
1161 filter_expression,
1162 lsm.u.disable.expression_len);
1163 }
1164 /* Add filter bytecode next */
1165 if (ctx && lsm.u.disable.bytecode_len != 0) {
1166 memcpy(varlen_data
1167 + lsm.u.disable.expression_len,
1168 &ctx->bytecode->b,
1169 lsm.u.disable.bytecode_len);
1170 }
1171
1172 ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data,
1173 lsm.u.disable.bytecode_len + lsm.u.disable.expression_len, NULL);
1174 free(varlen_data);
1175
1176 mem_error:
1177 if (filter_expression && ctx) {
1178 filter_bytecode_free(ctx);
1179 filter_ir_free(ctx);
1180 filter_parser_ctx_free(ctx);
1181 }
1182 filter_error:
1183 if (free_filter_expression) {
1184 /*
1185 * The filter expression has been replaced and must be freed as it is
1186 * not the original filter expression received as a parameter.
1187 */
1188 free(filter_expression);
1189 }
1190 error:
1191 /*
1192 * Return directly to the caller and don't ask the sessiond since something
1193 * went wrong in the parsing of data above.
1194 */
1195 return ret;
1196
1197 ask_sessiond:
1198 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
1199 return ret;
1200 }
1201
1202 /*
1203 * Disable event(s) of a channel and domain.
1204 * If no event name is specified, all events are disabled.
1205 * If no channel name is specified, the default 'channel0' is used.
1206 * Returns size of returned session payload data or a negative error code.
1207 */
1208 int lttng_disable_event(struct lttng_handle *handle, const char *name,
1209 const char *channel_name)
1210 {
1211 struct lttng_event ev;
1212
1213 memset(&ev, 0, sizeof(ev));
1214 ev.loglevel = -1;
1215 ev.type = LTTNG_EVENT_ALL;
1216 lttng_ctl_copy_string(ev.name, name, sizeof(ev.name));
1217 return lttng_disable_event_ext(handle, &ev, channel_name, NULL);
1218 }
1219
1220 /*
1221 * Enable channel per domain
1222 * Returns size of returned session payload data or a negative error code.
1223 */
1224 int lttng_enable_channel(struct lttng_handle *handle,
1225 struct lttng_channel *chan)
1226 {
1227 struct lttcomm_session_msg lsm;
1228
1229 /*
1230 * NULL arguments are forbidden. No default values.
1231 */
1232 if (handle == NULL || chan == NULL) {
1233 return -LTTNG_ERR_INVALID;
1234 }
1235
1236 memset(&lsm, 0, sizeof(lsm));
1237
1238 memcpy(&lsm.u.channel.chan, chan, sizeof(lsm.u.channel.chan));
1239
1240 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
1241
1242 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1243
1244 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1245 sizeof(lsm.session.name));
1246
1247 return lttng_ctl_ask_sessiond(&lsm, NULL);
1248 }
1249
1250 /*
1251 * All tracing will be stopped for registered events of the channel.
1252 * Returns size of returned session payload data or a negative error code.
1253 */
1254 int lttng_disable_channel(struct lttng_handle *handle, const char *name)
1255 {
1256 struct lttcomm_session_msg lsm;
1257
1258 /* Safety check. Both are mandatory */
1259 if (handle == NULL || name == NULL) {
1260 return -LTTNG_ERR_INVALID;
1261 }
1262
1263 memset(&lsm, 0, sizeof(lsm));
1264
1265 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1266
1267 lttng_ctl_copy_string(lsm.u.disable.channel_name, name,
1268 sizeof(lsm.u.disable.channel_name));
1269
1270 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1271
1272 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1273 sizeof(lsm.session.name));
1274
1275 return lttng_ctl_ask_sessiond(&lsm, NULL);
1276 }
1277
1278 /*
1279 * Add PID to session tracker.
1280 * Return 0 on success else a negative LTTng error code.
1281 */
1282 int lttng_track_pid(struct lttng_handle *handle, int pid)
1283 {
1284 struct lttcomm_session_msg lsm;
1285
1286 /*
1287 * NULL arguments are forbidden. No default values.
1288 */
1289 if (handle == NULL) {
1290 return -LTTNG_ERR_INVALID;
1291 }
1292
1293 memset(&lsm, 0, sizeof(lsm));
1294
1295 lsm.cmd_type = LTTNG_TRACK_PID;
1296 lsm.u.pid_tracker.pid = pid;
1297
1298 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1299
1300 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1301 sizeof(lsm.session.name));
1302
1303 return lttng_ctl_ask_sessiond(&lsm, NULL);
1304 }
1305
1306 /*
1307 * Remove PID from session tracker.
1308 * Return 0 on success else a negative LTTng error code.
1309 */
1310 int lttng_untrack_pid(struct lttng_handle *handle, int pid)
1311 {
1312 struct lttcomm_session_msg lsm;
1313
1314 /*
1315 * NULL arguments are forbidden. No default values.
1316 */
1317 if (handle == NULL) {
1318 return -LTTNG_ERR_INVALID;
1319 }
1320
1321 memset(&lsm, 0, sizeof(lsm));
1322
1323 lsm.cmd_type = LTTNG_UNTRACK_PID;
1324 lsm.u.pid_tracker.pid = pid;
1325
1326 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1327
1328 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1329 sizeof(lsm.session.name));
1330
1331 return lttng_ctl_ask_sessiond(&lsm, NULL);
1332 }
1333
1334 /*
1335 * Lists all available tracepoints of domain.
1336 * Sets the contents of the events array.
1337 * Returns the number of lttng_event entries in events;
1338 * on error, returns a negative value.
1339 */
1340 int lttng_list_tracepoints(struct lttng_handle *handle,
1341 struct lttng_event **events)
1342 {
1343 int ret;
1344 struct lttcomm_session_msg lsm;
1345
1346 if (handle == NULL) {
1347 return -LTTNG_ERR_INVALID;
1348 }
1349
1350 memset(&lsm, 0, sizeof(lsm));
1351 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
1352 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1353
1354 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1355 if (ret < 0) {
1356 return ret;
1357 }
1358
1359 return ret / sizeof(struct lttng_event);
1360 }
1361
1362 /*
1363 * Lists all available tracepoint fields of domain.
1364 * Sets the contents of the event field array.
1365 * Returns the number of lttng_event_field entries in events;
1366 * on error, returns a negative value.
1367 */
1368 int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1369 struct lttng_event_field **fields)
1370 {
1371 int ret;
1372 struct lttcomm_session_msg lsm;
1373
1374 if (handle == NULL) {
1375 return -LTTNG_ERR_INVALID;
1376 }
1377
1378 memset(&lsm, 0, sizeof(lsm));
1379 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
1380 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1381
1382 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
1383 if (ret < 0) {
1384 return ret;
1385 }
1386
1387 return ret / sizeof(struct lttng_event_field);
1388 }
1389
1390 /*
1391 * Lists all available kernel system calls. Allocates and sets the contents of
1392 * the events array.
1393 *
1394 * Returns the number of lttng_event entries in events; on error, returns a
1395 * negative value.
1396 */
1397 int lttng_list_syscalls(struct lttng_event **events)
1398 {
1399 int ret;
1400 struct lttcomm_session_msg lsm;
1401
1402 if (!events) {
1403 return -LTTNG_ERR_INVALID;
1404 }
1405
1406 memset(&lsm, 0, sizeof(lsm));
1407 lsm.cmd_type = LTTNG_LIST_SYSCALLS;
1408 /* Force kernel domain for system calls. */
1409 lsm.domain.type = LTTNG_DOMAIN_KERNEL;
1410
1411 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
1412 if (ret < 0) {
1413 return ret;
1414 }
1415
1416 return ret / sizeof(struct lttng_event);
1417 }
1418
1419 /*
1420 * Returns a human readable string describing
1421 * the error code (a negative value).
1422 */
1423 const char *lttng_strerror(int code)
1424 {
1425 return error_get_str(code);
1426 }
1427
1428 /*
1429 * Create a brand new session using name and url for destination.
1430 *
1431 * Returns LTTNG_OK on success or a negative error code.
1432 */
1433 int lttng_create_session(const char *name, const char *url)
1434 {
1435 int ret;
1436 ssize_t size;
1437 struct lttcomm_session_msg lsm;
1438 struct lttng_uri *uris = NULL;
1439
1440 if (name == NULL) {
1441 return -LTTNG_ERR_INVALID;
1442 }
1443
1444 memset(&lsm, 0, sizeof(lsm));
1445
1446 lsm.cmd_type = LTTNG_CREATE_SESSION;
1447 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1448
1449 /* There should never be a data URL */
1450 size = uri_parse_str_urls(url, NULL, &uris);
1451 if (size < 0) {
1452 return -LTTNG_ERR_INVALID;
1453 }
1454
1455 lsm.u.uri.size = size;
1456
1457 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1458 sizeof(struct lttng_uri) * size, NULL);
1459
1460 free(uris);
1461 return ret;
1462 }
1463
1464 /*
1465 * Destroy session using name.
1466 * Returns size of returned session payload data or a negative error code.
1467 */
1468 int lttng_destroy_session(const char *session_name)
1469 {
1470 struct lttcomm_session_msg lsm;
1471
1472 if (session_name == NULL) {
1473 return -LTTNG_ERR_INVALID;
1474 }
1475
1476 memset(&lsm, 0, sizeof(lsm));
1477 lsm.cmd_type = LTTNG_DESTROY_SESSION;
1478
1479 lttng_ctl_copy_string(lsm.session.name, session_name,
1480 sizeof(lsm.session.name));
1481
1482 return lttng_ctl_ask_sessiond(&lsm, NULL);
1483 }
1484
1485 /*
1486 * Ask the session daemon for all available sessions.
1487 * Sets the contents of the sessions array.
1488 * Returns the number of lttng_session entries in sessions;
1489 * on error, returns a negative value.
1490 */
1491 int lttng_list_sessions(struct lttng_session **sessions)
1492 {
1493 int ret;
1494 struct lttcomm_session_msg lsm;
1495
1496 memset(&lsm, 0, sizeof(lsm));
1497 lsm.cmd_type = LTTNG_LIST_SESSIONS;
1498 ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions);
1499 if (ret < 0) {
1500 return ret;
1501 }
1502
1503 return ret / sizeof(struct lttng_session);
1504 }
1505
1506 int lttng_set_session_shm_path(const char *session_name,
1507 const char *shm_path)
1508 {
1509 struct lttcomm_session_msg lsm;
1510
1511 if (session_name == NULL) {
1512 return -LTTNG_ERR_INVALID;
1513 }
1514
1515 memset(&lsm, 0, sizeof(lsm));
1516 lsm.cmd_type = LTTNG_SET_SESSION_SHM_PATH;
1517
1518 lttng_ctl_copy_string(lsm.session.name, session_name,
1519 sizeof(lsm.session.name));
1520 lttng_ctl_copy_string(lsm.u.set_shm_path.shm_path, shm_path,
1521 sizeof(lsm.u.set_shm_path.shm_path));
1522
1523 return lttng_ctl_ask_sessiond(&lsm, NULL);
1524 }
1525
1526 /*
1527 * Ask the session daemon for all available domains of a session.
1528 * Sets the contents of the domains array.
1529 * Returns the number of lttng_domain entries in domains;
1530 * on error, returns a negative value.
1531 */
1532 int lttng_list_domains(const char *session_name,
1533 struct lttng_domain **domains)
1534 {
1535 int ret;
1536 struct lttcomm_session_msg lsm;
1537
1538 if (session_name == NULL) {
1539 return -LTTNG_ERR_INVALID;
1540 }
1541
1542 memset(&lsm, 0, sizeof(lsm));
1543 lsm.cmd_type = LTTNG_LIST_DOMAINS;
1544
1545 lttng_ctl_copy_string(lsm.session.name, session_name,
1546 sizeof(lsm.session.name));
1547
1548 ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains);
1549 if (ret < 0) {
1550 return ret;
1551 }
1552
1553 return ret / sizeof(struct lttng_domain);
1554 }
1555
1556 /*
1557 * Ask the session daemon for all available channels of a session.
1558 * Sets the contents of the channels array.
1559 * Returns the number of lttng_channel entries in channels;
1560 * on error, returns a negative value.
1561 */
1562 int lttng_list_channels(struct lttng_handle *handle,
1563 struct lttng_channel **channels)
1564 {
1565 int ret;
1566 struct lttcomm_session_msg lsm;
1567
1568 if (handle == NULL) {
1569 return -LTTNG_ERR_INVALID;
1570 }
1571
1572 memset(&lsm, 0, sizeof(lsm));
1573 lsm.cmd_type = LTTNG_LIST_CHANNELS;
1574 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1575 sizeof(lsm.session.name));
1576
1577 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1578
1579 ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
1580 if (ret < 0) {
1581 return ret;
1582 }
1583
1584 return ret / sizeof(struct lttng_channel);
1585 }
1586
1587 /*
1588 * Ask the session daemon for all available events of a session channel.
1589 * Sets the contents of the events array.
1590 * Returns the number of lttng_event entries in events;
1591 * on error, returns a negative value.
1592 */
1593 int lttng_list_events(struct lttng_handle *handle,
1594 const char *channel_name, struct lttng_event **events)
1595 {
1596 int ret;
1597 struct lttcomm_session_msg lsm;
1598
1599 /* Safety check. An handle and channel name are mandatory */
1600 if (handle == NULL || channel_name == NULL) {
1601 return -LTTNG_ERR_INVALID;
1602 }
1603
1604 memset(&lsm, 0, sizeof(lsm));
1605 lsm.cmd_type = LTTNG_LIST_EVENTS;
1606 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1607 sizeof(lsm.session.name));
1608 lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name,
1609 sizeof(lsm.u.list.channel_name));
1610
1611 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1612
1613 ret = lttng_ctl_ask_sessiond(&lsm, (void**) events);
1614 if (ret < 0) {
1615 return ret;
1616 }
1617
1618 return ret / sizeof(struct lttng_event);
1619 }
1620
1621 /*
1622 * Sets the tracing_group variable with name.
1623 * This function allocates memory pointed to by tracing_group.
1624 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
1625 */
1626 int lttng_set_tracing_group(const char *name)
1627 {
1628 if (name == NULL) {
1629 return -LTTNG_ERR_INVALID;
1630 }
1631
1632 if (asprintf(&tracing_group, "%s", name) < 0) {
1633 return -LTTNG_ERR_FATAL;
1634 }
1635
1636 return 0;
1637 }
1638
1639 /*
1640 * Returns size of returned session payload data or a negative error code.
1641 */
1642 int lttng_calibrate(struct lttng_handle *handle,
1643 struct lttng_calibrate *calibrate)
1644 {
1645 struct lttcomm_session_msg lsm;
1646
1647 /* Safety check. NULL pointer are forbidden */
1648 if (handle == NULL || calibrate == NULL) {
1649 return -LTTNG_ERR_INVALID;
1650 }
1651
1652 memset(&lsm, 0, sizeof(lsm));
1653 lsm.cmd_type = LTTNG_CALIBRATE;
1654 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1655
1656 memcpy(&lsm.u.calibrate, calibrate, sizeof(lsm.u.calibrate));
1657
1658 return lttng_ctl_ask_sessiond(&lsm, NULL);
1659 }
1660
1661 /*
1662 * Set default channel attributes.
1663 * If either or both of the arguments are null, attr content is zeroe'd.
1664 */
1665 void lttng_channel_set_default_attr(struct lttng_domain *domain,
1666 struct lttng_channel_attr *attr)
1667 {
1668 /* Safety check */
1669 if (attr == NULL || domain == NULL) {
1670 return;
1671 }
1672
1673 memset(attr, 0, sizeof(struct lttng_channel_attr));
1674
1675 /* Same for all domains. */
1676 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
1677 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
1678 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
1679
1680 switch (domain->type) {
1681 case LTTNG_DOMAIN_KERNEL:
1682 attr->switch_timer_interval = DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
1683 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
1684 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
1685 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
1686 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
1687 break;
1688 case LTTNG_DOMAIN_UST:
1689 switch (domain->buf_type) {
1690 case LTTNG_BUFFER_PER_UID:
1691 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
1692 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
1693 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
1694 attr->switch_timer_interval = DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
1695 attr->read_timer_interval = DEFAULT_UST_UID_CHANNEL_READ_TIMER;
1696 break;
1697 case LTTNG_BUFFER_PER_PID:
1698 default:
1699 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
1700 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
1701 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
1702 attr->switch_timer_interval = DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
1703 attr->read_timer_interval = DEFAULT_UST_PID_CHANNEL_READ_TIMER;
1704 break;
1705 }
1706 default:
1707 /* Default behavior: leave set to 0. */
1708 break;
1709 }
1710 }
1711
1712 /*
1713 * Check if session daemon is alive.
1714 *
1715 * Return 1 if alive or 0 if not.
1716 * On error returns a negative value.
1717 */
1718 int lttng_session_daemon_alive(void)
1719 {
1720 int ret;
1721
1722 ret = set_session_daemon_path();
1723 if (ret < 0) {
1724 /* Error */
1725 return ret;
1726 }
1727
1728 if (*sessiond_sock_path == '\0') {
1729 /*
1730 * No socket path set. Weird error which means the constructor was not
1731 * called.
1732 */
1733 assert(0);
1734 }
1735
1736 ret = try_connect_sessiond(sessiond_sock_path);
1737 if (ret < 0) {
1738 /* Not alive */
1739 return 0;
1740 }
1741
1742 /* Is alive */
1743 return 1;
1744 }
1745
1746 /*
1747 * Set URL for a consumer for a session and domain.
1748 *
1749 * Return 0 on success, else a negative value.
1750 */
1751 int lttng_set_consumer_url(struct lttng_handle *handle,
1752 const char *control_url, const char *data_url)
1753 {
1754 int ret;
1755 ssize_t size;
1756 struct lttcomm_session_msg lsm;
1757 struct lttng_uri *uris = NULL;
1758
1759 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
1760 return -LTTNG_ERR_INVALID;
1761 }
1762
1763 memset(&lsm, 0, sizeof(lsm));
1764
1765 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
1766
1767 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
1768 sizeof(lsm.session.name));
1769 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
1770
1771 size = uri_parse_str_urls(control_url, data_url, &uris);
1772 if (size < 0) {
1773 return -LTTNG_ERR_INVALID;
1774 }
1775
1776 lsm.u.uri.size = size;
1777
1778 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1779 sizeof(struct lttng_uri) * size, NULL);
1780
1781 free(uris);
1782 return ret;
1783 }
1784
1785 /*
1786 * [OBSOLETE]
1787 */
1788 int lttng_enable_consumer(struct lttng_handle *handle)
1789 {
1790 return -ENOSYS;
1791 }
1792
1793 /*
1794 * [OBSOLETE]
1795 */
1796 int lttng_disable_consumer(struct lttng_handle *handle)
1797 {
1798 return -ENOSYS;
1799 }
1800
1801 /*
1802 * This is an extension of create session that is ONLY and SHOULD only be used
1803 * by the lttng command line program. It exists to avoid using URI parsing in
1804 * the lttng client.
1805 *
1806 * We need the date and time for the trace path subdirectory for the case where
1807 * the user does NOT define one using either -o or -U. Using the normal
1808 * lttng_create_session API call, we have no clue on the session daemon side if
1809 * the URL was generated automatically by the client or define by the user.
1810 *
1811 * So this function "wrapper" is hidden from the public API, takes the datetime
1812 * string and appends it if necessary to the URI subdirectory before sending it
1813 * to the session daemon.
1814 *
1815 * With this extra function, the lttng_create_session call behavior is not
1816 * changed and the timestamp is appended to the URI on the session daemon side
1817 * if necessary.
1818 */
1819 int _lttng_create_session_ext(const char *name, const char *url,
1820 const char *datetime)
1821 {
1822 int ret;
1823 ssize_t size;
1824 struct lttcomm_session_msg lsm;
1825 struct lttng_uri *uris = NULL;
1826
1827 if (name == NULL || datetime == NULL) {
1828 return -LTTNG_ERR_INVALID;
1829 }
1830
1831 memset(&lsm, 0, sizeof(lsm));
1832
1833 lsm.cmd_type = LTTNG_CREATE_SESSION;
1834 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1835
1836 /* There should never be a data URL */
1837 size = uri_parse_str_urls(url, NULL, &uris);
1838 if (size < 0) {
1839 ret = -LTTNG_ERR_INVALID;
1840 goto error;
1841 }
1842
1843 lsm.u.uri.size = size;
1844
1845 if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
1846 /* Don't append datetime if the name was automatically created. */
1847 if (strncmp(name, DEFAULT_SESSION_NAME "-",
1848 strlen(DEFAULT_SESSION_NAME) + 1)) {
1849 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s",
1850 name, datetime);
1851 } else {
1852 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name);
1853 }
1854 if (ret < 0) {
1855 PERROR("snprintf uri subdir");
1856 ret = -LTTNG_ERR_FATAL;
1857 goto error;
1858 }
1859 }
1860
1861 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1862 sizeof(struct lttng_uri) * size, NULL);
1863
1864 error:
1865 free(uris);
1866 return ret;
1867 }
1868
1869 /*
1870 * For a given session name, this call checks if the data is ready to be read
1871 * or is still being extracted by the consumer(s) hence not ready to be used by
1872 * any readers.
1873 */
1874 int lttng_data_pending(const char *session_name)
1875 {
1876 int ret;
1877 struct lttcomm_session_msg lsm;
1878 uint8_t *pending = NULL;
1879
1880 if (session_name == NULL) {
1881 return -LTTNG_ERR_INVALID;
1882 }
1883
1884 memset(&lsm, 0, sizeof(lsm));
1885 lsm.cmd_type = LTTNG_DATA_PENDING;
1886
1887 lttng_ctl_copy_string(lsm.session.name, session_name,
1888 sizeof(lsm.session.name));
1889
1890 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending);
1891 if (ret < 0) {
1892 goto end;
1893 } else if (ret != 1) {
1894 /* Unexpected payload size */
1895 ret = -LTTNG_ERR_INVALID;
1896 goto end;
1897 }
1898
1899 ret = (int) *pending;
1900 end:
1901 free(pending);
1902 return ret;
1903 }
1904
1905 /*
1906 * Create a session exclusively used for snapshot.
1907 *
1908 * Returns LTTNG_OK on success or a negative error code.
1909 */
1910 int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
1911 {
1912 int ret;
1913 ssize_t size;
1914 struct lttcomm_session_msg lsm;
1915 struct lttng_uri *uris = NULL;
1916
1917 if (name == NULL) {
1918 return -LTTNG_ERR_INVALID;
1919 }
1920
1921 memset(&lsm, 0, sizeof(lsm));
1922
1923 lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT;
1924 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1925
1926 size = uri_parse_str_urls(snapshot_url, NULL, &uris);
1927 if (size < 0) {
1928 return -LTTNG_ERR_INVALID;
1929 }
1930
1931 lsm.u.uri.size = size;
1932
1933 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1934 sizeof(struct lttng_uri) * size, NULL);
1935
1936 free(uris);
1937 return ret;
1938 }
1939
1940 /*
1941 * Create a session exclusively used for live.
1942 *
1943 * Returns LTTNG_OK on success or a negative error code.
1944 */
1945 int lttng_create_session_live(const char *name, const char *url,
1946 unsigned int timer_interval)
1947 {
1948 int ret;
1949 ssize_t size;
1950 struct lttcomm_session_msg lsm;
1951 struct lttng_uri *uris = NULL;
1952
1953 if (name == NULL || timer_interval == 0) {
1954 return -LTTNG_ERR_INVALID;
1955 }
1956
1957 memset(&lsm, 0, sizeof(lsm));
1958
1959 lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE;
1960 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1961
1962 if (url) {
1963 size = uri_parse_str_urls(url, NULL, &uris);
1964 if (size <= 0) {
1965 ret = -LTTNG_ERR_INVALID;
1966 goto end;
1967 }
1968
1969 /* file:// is not accepted for live session. */
1970 if (uris[0].dtype == LTTNG_DST_PATH) {
1971 ret = -LTTNG_ERR_INVALID;
1972 goto end;
1973 }
1974 } else {
1975 size = 0;
1976 }
1977
1978 lsm.u.session_live.nb_uri = size;
1979 lsm.u.session_live.timer_interval = timer_interval;
1980
1981 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1982 sizeof(struct lttng_uri) * size, NULL);
1983
1984 end:
1985 free(uris);
1986 return ret;
1987 }
1988
1989 /*
1990 * List PIDs in the tracker.
1991 *
1992 * enabled is set to whether the PID tracker is enabled.
1993 * pids is set to an allocated array of PIDs currently tracked. On
1994 * success, pids must be freed by the caller.
1995 * nr_pids is set to the number of entries contained by the pids array.
1996 *
1997 * Returns 0 on success, else a negative LTTng error code.
1998 */
1999 int lttng_list_tracker_pids(struct lttng_handle *handle,
2000 int *_enabled, int32_t **_pids, size_t *_nr_pids)
2001 {
2002 int ret;
2003 int enabled = 1;
2004 struct lttcomm_session_msg lsm;
2005 size_t nr_pids;
2006 int32_t *pids;
2007
2008 if (handle == NULL) {
2009 return -LTTNG_ERR_INVALID;
2010 }
2011
2012 memset(&lsm, 0, sizeof(lsm));
2013 lsm.cmd_type = LTTNG_LIST_TRACKER_PIDS;
2014 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
2015 sizeof(lsm.session.name));
2016 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
2017
2018 ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pids);
2019 if (ret < 0) {
2020 return ret;
2021 }
2022 nr_pids = ret / sizeof(int32_t);
2023 if (nr_pids == 1 && pids[0] == -1) {
2024 free(pids);
2025 pids = NULL;
2026 enabled = 0;
2027 nr_pids = 0;
2028 }
2029 *_enabled = enabled;
2030 *_pids = pids;
2031 *_nr_pids = nr_pids;
2032 return 0;
2033 }
2034
2035 /*
2036 * lib constructor
2037 */
2038 static void __attribute__((constructor)) init()
2039 {
2040 /* Set default session group */
2041 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
2042 }
2043
2044 /*
2045 * lib destructor
2046 */
2047 static void __attribute__((destructor)) lttng_ctl_exit()
2048 {
2049 free(tracing_group);
2050 }
This page took 0.124177 seconds and 4 git commands to generate.