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