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