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