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