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