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