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