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