Fix: add missing VALGRIND ifdef checks and documentation
[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 */
225 grp_list = malloc(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
445 data = (void*) malloc(size);
446
447 /* Get payload data */
448 ret = recv_data_sessiond(data, size);
449 if (ret < 0) {
450 free(data);
451 goto end;
452 }
453
83009e5e
DG
454 /*
455 * Extra protection not to dereference a NULL pointer. If buf is NULL at
456 * this point, an error is returned and data is freed.
457 */
458 if (buf == NULL) {
2f70b271 459 ret = -LTTNG_ERR_INVALID;
83009e5e
DG
460 free(data);
461 goto end;
462 }
463
65beb5ff
DG
464 *buf = data;
465 ret = size;
466
467end:
468 disconnect_sessiond();
469 return ret;
470}
471
9f19cc17 472/*
cd80958d 473 * Create lttng handle and return pointer.
1c8d13c8 474 * The returned pointer will be NULL in case of malloc() error.
9f19cc17 475 */
cd80958d
DG
476struct lttng_handle *lttng_create_handle(const char *session_name,
477 struct lttng_domain *domain)
9f19cc17 478{
2f70b271
DG
479 struct lttng_handle *handle = NULL;
480
481 if (domain == NULL) {
482 goto end;
483 }
cd80958d
DG
484
485 handle = malloc(sizeof(struct lttng_handle));
486 if (handle == NULL) {
2f70b271 487 PERROR("malloc handle");
cd80958d
DG
488 goto end;
489 }
490
491 /* Copy session name */
cac3069d 492 lttng_ctl_copy_string(handle->session_name, session_name,
cd80958d
DG
493 sizeof(handle->session_name));
494
495 /* Copy lttng domain */
cac3069d 496 lttng_ctl_copy_lttng_domain(&handle->domain, domain);
cd80958d
DG
497
498end:
499 return handle;
500}
501
502/*
503 * Destroy handle by free(3) the pointer.
504 */
505void lttng_destroy_handle(struct lttng_handle *handle)
506{
0e428499 507 free(handle);
eb354453
DG
508}
509
d9800920
DG
510/*
511 * Register an outside consumer.
1c8d13c8 512 * Returns size of returned session payload data or a negative error code.
d9800920
DG
513 */
514int lttng_register_consumer(struct lttng_handle *handle,
515 const char *socket_path)
516{
517 struct lttcomm_session_msg lsm;
518
2f70b271
DG
519 if (handle == NULL || socket_path == NULL) {
520 return -LTTNG_ERR_INVALID;
521 }
522
d9800920 523 lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
cac3069d 524 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
d9800920 525 sizeof(lsm.session.name));
cac3069d 526 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
d9800920 527
cac3069d 528 lttng_ctl_copy_string(lsm.u.reg.path, socket_path, sizeof(lsm.u.reg.path));
d9800920 529
cac3069d 530 return lttng_ctl_ask_sessiond(&lsm, NULL);
d9800920
DG
531}
532
1df4dedd 533/*
1c8d13c8
TD
534 * Start tracing for all traces of the session.
535 * Returns size of returned session payload data or a negative error code.
1df4dedd 536 */
6a4f824d 537int lttng_start_tracing(const char *session_name)
f3ed775e 538{
cd80958d
DG
539 struct lttcomm_session_msg lsm;
540
6a4f824d 541 if (session_name == NULL) {
2f70b271 542 return -LTTNG_ERR_INVALID;
cd80958d
DG
543 }
544
545 lsm.cmd_type = LTTNG_START_TRACE;
6a4f824d 546
cac3069d
DG
547 lttng_ctl_copy_string(lsm.session.name, session_name,
548 sizeof(lsm.session.name));
cd80958d 549
cac3069d 550 return lttng_ctl_ask_sessiond(&lsm, NULL);
f3ed775e 551}
1df4dedd
DG
552
553/*
38ee087f 554 * Stop tracing for all traces of the session.
f3ed775e 555 */
38ee087f 556static int _lttng_stop_tracing(const char *session_name, int wait)
f3ed775e 557{
38ee087f 558 int ret, data_ret;
cd80958d
DG
559 struct lttcomm_session_msg lsm;
560
6a4f824d 561 if (session_name == NULL) {
2f70b271 562 return -LTTNG_ERR_INVALID;
6a4f824d
DG
563 }
564
cd80958d 565 lsm.cmd_type = LTTNG_STOP_TRACE;
6a4f824d 566
cac3069d
DG
567 lttng_ctl_copy_string(lsm.session.name, session_name,
568 sizeof(lsm.session.name));
cd80958d 569
cac3069d 570 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
38ee087f
DG
571 if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
572 goto error;
573 }
574
575 if (!wait) {
576 goto end;
577 }
578
579 _MSG("Waiting for data availability");
b7a81c24 580 fflush(stdout);
38ee087f
DG
581
582 /* Check for data availability */
583 do {
6d805429 584 data_ret = lttng_data_pending(session_name);
38ee087f
DG
585 if (data_ret < 0) {
586 /* Return the data available call error. */
587 ret = data_ret;
588 goto error;
589 }
590
591 /*
592 * Data sleep time before retrying (in usec). Don't sleep if the call
593 * returned value indicates availability.
594 */
6d805429 595 if (data_ret) {
38ee087f
DG
596 usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME);
597 _MSG(".");
b7a81c24 598 fflush(stdout);
38ee087f 599 }
6d805429 600 } while (data_ret != 0);
38ee087f
DG
601
602 MSG("");
603
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
93deb080
JI
694/*
695 * Enable event(s) for a channel, possibly with exclusions and a filter.
696 * If no event name is specified, all events are enabled.
697 * If no channel name is specified, the default name is used.
698 * If filter expression is not NULL, the filter is set for the event.
699 * If exclusion count is not zero, the exclusions are set for the event.
700 * Returns size of returned session payload data or a negative error code.
701 */
702int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
703 struct lttng_event *ev, const char *channel_name,
704 const char *filter_expression,
705 int exclusion_count, char **exclusion_list)
706{
707 struct lttcomm_session_msg lsm;
708 char *varlen_data;
709 int ret = 0;
710 struct filter_parser_ctx *ctx = NULL;
711 FILE *fmem = NULL;
712
713 if (handle == NULL || ev == NULL) {
714 return -LTTNG_ERR_INVALID;
715 }
716
717 /* Empty filter string will always be rejected by the parser
718 * anyway, so treat this corner-case early to eliminate
719 * lttng_fmemopen error for 0-byte allocation.
720 */
721 if (filter_expression && filter_expression[0] == '\0') {
722 return -LTTNG_ERR_INVALID;
723 }
724
725 memset(&lsm, 0, sizeof(lsm));
726
727 /* If no channel name, send empty string. */
728 if (channel_name == NULL) {
729 lttng_ctl_copy_string(lsm.u.enable.channel_name, "",
730 sizeof(lsm.u.enable.channel_name));
731 } else {
732 lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name,
733 sizeof(lsm.u.enable.channel_name));
734 }
735
6565421f
DG
736 if (ev->name[0] != '\0') {
737 lsm.cmd_type = LTTNG_ENABLE_EVENT;
738 } else {
739 lsm.cmd_type = LTTNG_ENABLE_ALL_EVENT;
740 }
93deb080 741
6565421f 742 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
93deb080
JI
743 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
744
745 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
746 sizeof(lsm.session.name));
747 lsm.u.enable.exclusion_count = exclusion_count;
748 lsm.u.enable.bytecode_len = 0;
749
750 if (exclusion_count == 0 && filter_expression == NULL) {
751 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
752 return ret;
753 }
754
755 /*
756 * We have either a filter or some exclusions, so we need to set up
757 * a variable-length memory block from where to send the data
758 */
759
760 /* Parse filter expression */
761 if (filter_expression != NULL) {
762
763 /*
764 * casting const to non-const, as the underlying function will
765 * use it in read-only mode.
766 */
767 fmem = lttng_fmemopen((void *) filter_expression,
768 strlen(filter_expression), "r");
769 if (!fmem) {
770 fprintf(stderr, "Error opening memory as stream\n");
771 return -LTTNG_ERR_FILTER_NOMEM;
772 }
773 ctx = filter_parser_ctx_alloc(fmem);
774 if (!ctx) {
775 fprintf(stderr, "Error allocating parser\n");
776 ret = -LTTNG_ERR_FILTER_NOMEM;
777 goto filter_alloc_error;
778 }
779 ret = filter_parser_ctx_append_ast(ctx);
780 if (ret) {
781 fprintf(stderr, "Parse error\n");
782 ret = -LTTNG_ERR_FILTER_INVAL;
783 goto parse_error;
784 }
785 ret = filter_visitor_set_parent(ctx);
786 if (ret) {
787 fprintf(stderr, "Set parent error\n");
788 ret = -LTTNG_ERR_FILTER_INVAL;
789 goto parse_error;
790 }
791 if (print_xml) {
792 ret = filter_visitor_print_xml(ctx, stdout, 0);
793 if (ret) {
794 fflush(stdout);
795 fprintf(stderr, "XML print error\n");
796 ret = -LTTNG_ERR_FILTER_INVAL;
797 goto parse_error;
798 }
799 }
800
801 dbg_printf("Generating IR... ");
802 fflush(stdout);
803 ret = filter_visitor_ir_generate(ctx);
804 if (ret) {
805 fprintf(stderr, "Generate IR error\n");
806 ret = -LTTNG_ERR_FILTER_INVAL;
807 goto parse_error;
808 }
809 dbg_printf("done\n");
810
811 dbg_printf("Validating IR... ");
812 fflush(stdout);
813 ret = filter_visitor_ir_check_binary_op_nesting(ctx);
814 if (ret) {
815 ret = -LTTNG_ERR_FILTER_INVAL;
816 goto parse_error;
817 }
818 dbg_printf("done\n");
819
820 dbg_printf("Generating bytecode... ");
821 fflush(stdout);
822 ret = filter_visitor_bytecode_generate(ctx);
823 if (ret) {
824 fprintf(stderr, "Generate bytecode error\n");
825 ret = -LTTNG_ERR_FILTER_INVAL;
826 goto parse_error;
827 }
828 dbg_printf("done\n");
829 dbg_printf("Size of bytecode generated: %u bytes.\n",
830 bytecode_get_len(&ctx->bytecode->b));
831
832 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
833 + bytecode_get_len(&ctx->bytecode->b);
834 }
835
836 /* Allocate variable length data */
837 if (lsm.u.enable.exclusion_count != 0) {
838 varlen_data = zmalloc(lsm.u.enable.bytecode_len
839 + LTTNG_SYMBOL_NAME_LEN * exclusion_count);
840 if (!varlen_data) {
841 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
842 goto varlen_alloc_error;
843 }
844 /* Put exclusion names first in the data */
845 while (exclusion_count--) {
846 strncpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * exclusion_count,
847 *(exclusion_list + exclusion_count),
848 LTTNG_SYMBOL_NAME_LEN);
849 }
850 /* Add filter bytecode next */
851 if (lsm.u.enable.bytecode_len != 0) {
852 memcpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count,
853 &ctx->bytecode->b,
854 lsm.u.enable.bytecode_len);
855 }
856 } else {
857 /* no exclusions - use the already allocated filter bytecode */
858 varlen_data = (char *)(&ctx->bytecode->b);
859 }
860
861 ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data,
67676bd8
DG
862 (LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count) +
863 lsm.u.enable.bytecode_len, NULL);
93deb080
JI
864
865 if (lsm.u.enable.exclusion_count != 0) {
866 free(varlen_data);
867 }
868
869varlen_alloc_error:
870 if (filter_expression) {
871 filter_bytecode_free(ctx);
872 filter_ir_free(ctx);
873 filter_parser_ctx_free(ctx);
874 if (fclose(fmem) != 0) {
875 perror("fclose");
876 }
877 }
878 return ret;
879
880parse_error:
881 filter_bytecode_free(ctx);
882 filter_ir_free(ctx);
883 filter_parser_ctx_free(ctx);
884filter_alloc_error:
885 if (fclose(fmem) != 0) {
886 perror("fclose");
887 }
888 return ret;
889}
890
1df4dedd 891/*
1c8d13c8
TD
892 * Disable event(s) of a channel and domain.
893 * If no event name is specified, all events are disabled.
894 * If no channel name is specified, the default 'channel0' is used.
895 * Returns size of returned session payload data or a negative error code.
1df4dedd 896 */
cd80958d 897int lttng_disable_event(struct lttng_handle *handle, const char *name,
38057ed1 898 const char *channel_name)
1df4dedd 899{
cd80958d 900 struct lttcomm_session_msg lsm;
1df4dedd 901
9d697d3d 902 if (handle == NULL) {
2f70b271 903 return -LTTNG_ERR_INVALID;
cd80958d
DG
904 }
905
441c16a7
MD
906 memset(&lsm, 0, sizeof(lsm));
907
85076754
MD
908 /* If no channel name, send empty string. */
909 if (channel_name == NULL) {
910 lttng_ctl_copy_string(lsm.u.disable.channel_name, "",
cd80958d 911 sizeof(lsm.u.disable.channel_name));
f3ed775e 912 } else {
85076754 913 lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name,
cd80958d 914 sizeof(lsm.u.disable.channel_name));
eb354453
DG
915 }
916
cac3069d 917 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
f5177a38 918
f84efadf 919 if (name != NULL) {
cac3069d
DG
920 lttng_ctl_copy_string(lsm.u.disable.name, name,
921 sizeof(lsm.u.disable.name));
cd80958d 922 lsm.cmd_type = LTTNG_DISABLE_EVENT;
f5177a38 923 } else {
cd80958d 924 lsm.cmd_type = LTTNG_DISABLE_ALL_EVENT;
f3ed775e
DG
925 }
926
cac3069d 927 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d
DG
928 sizeof(lsm.session.name));
929
cac3069d 930 return lttng_ctl_ask_sessiond(&lsm, NULL);
1df4dedd
DG
931}
932
933/*
1c8d13c8
TD
934 * Enable channel per domain
935 * Returns size of returned session payload data or a negative error code.
a5c5a2bd 936 */
cd80958d 937int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 938 struct lttng_channel *chan)
a5c5a2bd 939{
cd80958d
DG
940 struct lttcomm_session_msg lsm;
941
5117eeec
DG
942 /*
943 * NULL arguments are forbidden. No default values.
944 */
945 if (handle == NULL || chan == NULL) {
2f70b271 946 return -LTTNG_ERR_INVALID;
cd80958d
DG
947 }
948
441c16a7
MD
949 memset(&lsm, 0, sizeof(lsm));
950
5117eeec 951 memcpy(&lsm.u.channel.chan, chan, sizeof(lsm.u.channel.chan));
7d29a247 952
cd80958d
DG
953 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
954
cac3069d 955 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
7d29a247 956
cac3069d 957 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d
DG
958 sizeof(lsm.session.name));
959
cac3069d 960 return lttng_ctl_ask_sessiond(&lsm, NULL);
8c0faa1d 961}
1df4dedd 962
2ef84c95 963/*
1c8d13c8
TD
964 * All tracing will be stopped for registered events of the channel.
965 * Returns size of returned session payload data or a negative error code.
2ef84c95 966 */
cd80958d 967int lttng_disable_channel(struct lttng_handle *handle, const char *name)
2ef84c95 968{
cd80958d
DG
969 struct lttcomm_session_msg lsm;
970
9d697d3d
DG
971 /* Safety check. Both are mandatory */
972 if (handle == NULL || name == NULL) {
2f70b271 973 return -LTTNG_ERR_INVALID;
cd80958d
DG
974 }
975
441c16a7
MD
976 memset(&lsm, 0, sizeof(lsm));
977
cd80958d 978 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1df4dedd 979
cac3069d 980 lttng_ctl_copy_string(lsm.u.disable.channel_name, name,
9d697d3d
DG
981 sizeof(lsm.u.disable.channel_name));
982
cac3069d 983 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
cd80958d 984
cac3069d 985 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d
DG
986 sizeof(lsm.session.name));
987
cac3069d 988 return lttng_ctl_ask_sessiond(&lsm, NULL);
ca95a216
DG
989}
990
fac6795d 991/*
1c8d13c8
TD
992 * Lists all available tracepoints of domain.
993 * Sets the contents of the events array.
994 * Returns the number of lttng_event entries in events;
995 * on error, returns a negative value.
fac6795d 996 */
cd80958d 997int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 998 struct lttng_event **events)
fac6795d 999{
052da939 1000 int ret;
cd80958d
DG
1001 struct lttcomm_session_msg lsm;
1002
9d697d3d 1003 if (handle == NULL) {
2f70b271 1004 return -LTTNG_ERR_INVALID;
cd80958d 1005 }
fac6795d 1006
cd80958d 1007 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
cac3069d 1008 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
2a71efd5 1009
cac3069d 1010 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
052da939
DG
1011 if (ret < 0) {
1012 return ret;
eb354453 1013 }
fac6795d 1014
9f19cc17 1015 return ret / sizeof(struct lttng_event);
fac6795d
DG
1016}
1017
f37d259d
MD
1018/*
1019 * Lists all available tracepoint fields of domain.
1020 * Sets the contents of the event field array.
1021 * Returns the number of lttng_event_field entries in events;
1022 * on error, returns a negative value.
1023 */
1024int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1025 struct lttng_event_field **fields)
1026{
1027 int ret;
1028 struct lttcomm_session_msg lsm;
1029
1030 if (handle == NULL) {
2f70b271 1031 return -LTTNG_ERR_INVALID;
f37d259d
MD
1032 }
1033
1034 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
cac3069d 1035 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
f37d259d 1036
cac3069d 1037 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
f37d259d
MD
1038 if (ret < 0) {
1039 return ret;
1040 }
1041
1042 return ret / sizeof(struct lttng_event_field);
1043}
1044
1657e9bb 1045/*
1c8d13c8
TD
1046 * Returns a human readable string describing
1047 * the error code (a negative value).
1657e9bb 1048 */
9a745bc7 1049const char *lttng_strerror(int code)
1657e9bb 1050{
f73fabfd 1051 return error_get_str(code);
1657e9bb
DG
1052}
1053
aaf97519 1054/*
a4b92340
DG
1055 * Create a brand new session using name and url for destination.
1056 *
f73fabfd 1057 * Returns LTTNG_OK on success or a negative error code.
00e2e675 1058 */
a4b92340 1059int lttng_create_session(const char *name, const char *url)
00e2e675 1060{
3dd05a85 1061 int ret;
a4b92340 1062 ssize_t size;
00e2e675 1063 struct lttcomm_session_msg lsm;
a4b92340 1064 struct lttng_uri *uris = NULL;
00e2e675 1065
a4b92340 1066 if (name == NULL) {
2f70b271 1067 return -LTTNG_ERR_INVALID;
00e2e675
DG
1068 }
1069
a4b92340 1070 memset(&lsm, 0, sizeof(lsm));
00e2e675 1071
a4b92340 1072 lsm.cmd_type = LTTNG_CREATE_SESSION;
cac3069d 1073 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
a4b92340
DG
1074
1075 /* There should never be a data URL */
bc894455 1076 size = uri_parse_str_urls(url, NULL, &uris);
a4b92340 1077 if (size < 0) {
2f70b271 1078 return -LTTNG_ERR_INVALID;
00e2e675
DG
1079 }
1080
a4b92340
DG
1081 lsm.u.uri.size = size;
1082
cac3069d
DG
1083 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1084 sizeof(struct lttng_uri) * size, NULL);
3dd05a85
DG
1085
1086 free(uris);
1087 return ret;
00e2e675
DG
1088}
1089
8028d920 1090/*
8028d920 1091 * Destroy session using name.
1c8d13c8 1092 * Returns size of returned session payload data or a negative error code.
8028d920 1093 */
843f5df9 1094int lttng_destroy_session(const char *session_name)
8028d920 1095{
cd80958d
DG
1096 struct lttcomm_session_msg lsm;
1097
843f5df9 1098 if (session_name == NULL) {
2f70b271 1099 return -LTTNG_ERR_INVALID;
cd80958d
DG
1100 }
1101
1102 lsm.cmd_type = LTTNG_DESTROY_SESSION;
843f5df9 1103
cac3069d
DG
1104 lttng_ctl_copy_string(lsm.session.name, session_name,
1105 sizeof(lsm.session.name));
cd80958d 1106
cac3069d 1107 return lttng_ctl_ask_sessiond(&lsm, NULL);
aaf97519
DG
1108}
1109
57167058 1110/*
57167058 1111 * Ask the session daemon for all available sessions.
1c8d13c8
TD
1112 * Sets the contents of the sessions array.
1113 * Returns the number of lttng_session entries in sessions;
1114 * on error, returns a negative value.
57167058 1115 */
ca95a216 1116int lttng_list_sessions(struct lttng_session **sessions)
57167058 1117{
ca95a216 1118 int ret;
cd80958d 1119 struct lttcomm_session_msg lsm;
57167058 1120
cd80958d 1121 lsm.cmd_type = LTTNG_LIST_SESSIONS;
cac3069d 1122 ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions);
57167058 1123 if (ret < 0) {
ca95a216 1124 return ret;
57167058
DG
1125 }
1126
ca95a216 1127 return ret / sizeof(struct lttng_session);
57167058
DG
1128}
1129
9f19cc17 1130/*
1c8d13c8
TD
1131 * Ask the session daemon for all available domains of a session.
1132 * Sets the contents of the domains array.
1133 * Returns the number of lttng_domain entries in domains;
1134 * on error, returns a negative value.
9f19cc17 1135 */
330be774 1136int lttng_list_domains(const char *session_name,
cd80958d 1137 struct lttng_domain **domains)
9f19cc17
DG
1138{
1139 int ret;
cd80958d
DG
1140 struct lttcomm_session_msg lsm;
1141
330be774 1142 if (session_name == NULL) {
2f70b271 1143 return -LTTNG_ERR_INVALID;
cd80958d 1144 }
9f19cc17 1145
cd80958d
DG
1146 lsm.cmd_type = LTTNG_LIST_DOMAINS;
1147
cac3069d
DG
1148 lttng_ctl_copy_string(lsm.session.name, session_name,
1149 sizeof(lsm.session.name));
cd80958d 1150
cac3069d 1151 ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains);
9f19cc17
DG
1152 if (ret < 0) {
1153 return ret;
1154 }
1155
1156 return ret / sizeof(struct lttng_domain);
1157}
1158
1159/*
1c8d13c8
TD
1160 * Ask the session daemon for all available channels of a session.
1161 * Sets the contents of the channels array.
1162 * Returns the number of lttng_channel entries in channels;
1163 * on error, returns a negative value.
9f19cc17 1164 */
cd80958d
DG
1165int lttng_list_channels(struct lttng_handle *handle,
1166 struct lttng_channel **channels)
9f19cc17
DG
1167{
1168 int ret;
cd80958d
DG
1169 struct lttcomm_session_msg lsm;
1170
9d697d3d 1171 if (handle == NULL) {
2f70b271 1172 return -LTTNG_ERR_INVALID;
cd80958d
DG
1173 }
1174
1175 lsm.cmd_type = LTTNG_LIST_CHANNELS;
cac3069d 1176 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d 1177 sizeof(lsm.session.name));
9f19cc17 1178
cac3069d 1179 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
9f19cc17 1180
cac3069d 1181 ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
9f19cc17
DG
1182 if (ret < 0) {
1183 return ret;
1184 }
1185
1186 return ret / sizeof(struct lttng_channel);
1187}
1188
1189/*
1c8d13c8
TD
1190 * Ask the session daemon for all available events of a session channel.
1191 * Sets the contents of the events array.
1192 * Returns the number of lttng_event entries in events;
1193 * on error, returns a negative value.
9f19cc17 1194 */
cd80958d
DG
1195int lttng_list_events(struct lttng_handle *handle,
1196 const char *channel_name, struct lttng_event **events)
9f19cc17
DG
1197{
1198 int ret;
cd80958d 1199 struct lttcomm_session_msg lsm;
9f19cc17 1200
9d697d3d
DG
1201 /* Safety check. An handle and channel name are mandatory */
1202 if (handle == NULL || channel_name == NULL) {
2f70b271 1203 return -LTTNG_ERR_INVALID;
cd80958d
DG
1204 }
1205
1206 lsm.cmd_type = LTTNG_LIST_EVENTS;
cac3069d 1207 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d 1208 sizeof(lsm.session.name));
cac3069d 1209 lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name,
cd80958d
DG
1210 sizeof(lsm.u.list.channel_name));
1211
cac3069d 1212 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
9f19cc17 1213
cac3069d 1214 ret = lttng_ctl_ask_sessiond(&lsm, (void**) events);
9f19cc17
DG
1215 if (ret < 0) {
1216 return ret;
1217 }
1218
1219 return ret / sizeof(struct lttng_event);
1220}
1221
fac6795d 1222/*
1c8d13c8
TD
1223 * Sets the tracing_group variable with name.
1224 * This function allocates memory pointed to by tracing_group.
1225 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
fac6795d
DG
1226 */
1227int lttng_set_tracing_group(const char *name)
1228{
9d697d3d 1229 if (name == NULL) {
2f70b271 1230 return -LTTNG_ERR_INVALID;
9d697d3d
DG
1231 }
1232
fac6795d 1233 if (asprintf(&tracing_group, "%s", name) < 0) {
2f70b271 1234 return -LTTNG_ERR_FATAL;
fac6795d
DG
1235 }
1236
1237 return 0;
1238}
1239
d0254c7c 1240/*
af87c45a 1241 * Returns size of returned session payload data or a negative error code.
d0254c7c 1242 */
cd80958d 1243int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
1244 struct lttng_calibrate *calibrate)
1245{
cd80958d 1246 struct lttcomm_session_msg lsm;
d0254c7c 1247
9d697d3d
DG
1248 /* Safety check. NULL pointer are forbidden */
1249 if (handle == NULL || calibrate == NULL) {
2f70b271 1250 return -LTTNG_ERR_INVALID;
cd80958d 1251 }
d0254c7c 1252
cd80958d 1253 lsm.cmd_type = LTTNG_CALIBRATE;
cac3069d 1254 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
d0254c7c 1255
cd80958d
DG
1256 memcpy(&lsm.u.calibrate, calibrate, sizeof(lsm.u.calibrate));
1257
cac3069d 1258 return lttng_ctl_ask_sessiond(&lsm, NULL);
d0254c7c
MD
1259}
1260
5edd7e09
DG
1261/*
1262 * Set default channel attributes.
441c16a7 1263 * If either or both of the arguments are null, attr content is zeroe'd.
5edd7e09
DG
1264 */
1265void lttng_channel_set_default_attr(struct lttng_domain *domain,
1266 struct lttng_channel_attr *attr)
1267{
1268 /* Safety check */
1269 if (attr == NULL || domain == NULL) {
1270 return;
1271 }
1272
eacaa7a6
DS
1273 memset(attr, 0, sizeof(struct lttng_channel_attr));
1274
0a9c6494
DG
1275 /* Same for all domains. */
1276 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
1277 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
1278 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
1279
5edd7e09
DG
1280 switch (domain->type) {
1281 case LTTNG_DOMAIN_KERNEL:
d92ff3ef
DG
1282 attr->switch_timer_interval = DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
1283 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
3e230f92 1284 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
5edd7e09
DG
1285 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
1286 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
1287 break;
1288 case LTTNG_DOMAIN_UST:
0a9c6494
DG
1289 switch (domain->buf_type) {
1290 case LTTNG_BUFFER_PER_UID:
1291 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
1292 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
1293 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
1294 attr->switch_timer_interval = DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
1295 attr->read_timer_interval = DEFAULT_UST_UID_CHANNEL_READ_TIMER;
1296 break;
1297 case LTTNG_BUFFER_PER_PID:
1298 default:
1299 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
1300 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
1301 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
1302 attr->switch_timer_interval = DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
1303 attr->read_timer_interval = DEFAULT_UST_PID_CHANNEL_READ_TIMER;
1304 break;
1305 }
5edd7e09 1306 default:
441c16a7 1307 /* Default behavior: leave set to 0. */
5edd7e09
DG
1308 break;
1309 }
1310}
1311
fac6795d 1312/*
2269e89e 1313 * Check if session daemon is alive.
fac6795d 1314 *
2269e89e 1315 * Return 1 if alive or 0 if not.
1c8d13c8 1316 * On error returns a negative value.
fac6795d 1317 */
947308c4 1318int lttng_session_daemon_alive(void)
fac6795d
DG
1319{
1320 int ret;
1321
1322 ret = set_session_daemon_path();
1323 if (ret < 0) {
947308c4 1324 /* Error */
fac6795d
DG
1325 return ret;
1326 }
1327
9d035200 1328 if (*sessiond_sock_path == '\0') {
2f70b271
DG
1329 /*
1330 * No socket path set. Weird error which means the constructor was not
1331 * called.
1332 */
1333 assert(0);
fac6795d
DG
1334 }
1335
2269e89e 1336 ret = try_connect_sessiond(sessiond_sock_path);
7d8234d9
MD
1337 if (ret < 0) {
1338 /* Not alive */
1339 return 0;
1340 }
7d8234d9 1341
947308c4
DG
1342 /* Is alive */
1343 return 1;
fac6795d
DG
1344}
1345
00e2e675 1346/*
a4b92340 1347 * Set URL for a consumer for a session and domain.
00e2e675
DG
1348 *
1349 * Return 0 on success, else a negative value.
1350 */
a4b92340
DG
1351int lttng_set_consumer_url(struct lttng_handle *handle,
1352 const char *control_url, const char *data_url)
00e2e675 1353{
3dd05a85 1354 int ret;
a4b92340 1355 ssize_t size;
00e2e675 1356 struct lttcomm_session_msg lsm;
a4b92340 1357 struct lttng_uri *uris = NULL;
00e2e675 1358
a4b92340 1359 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
2f70b271 1360 return -LTTNG_ERR_INVALID;
00e2e675
DG
1361 }
1362
a4b92340
DG
1363 memset(&lsm, 0, sizeof(lsm));
1364
00e2e675
DG
1365 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
1366
cac3069d 1367 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
00e2e675 1368 sizeof(lsm.session.name));
cac3069d 1369 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
00e2e675 1370
bc894455 1371 size = uri_parse_str_urls(control_url, data_url, &uris);
a4b92340 1372 if (size < 0) {
2f70b271 1373 return -LTTNG_ERR_INVALID;
a4b92340
DG
1374 }
1375
1376 lsm.u.uri.size = size;
00e2e675 1377
cac3069d
DG
1378 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1379 sizeof(struct lttng_uri) * size, NULL);
3dd05a85
DG
1380
1381 free(uris);
1382 return ret;
00e2e675
DG
1383}
1384
1385/*
9c6bda17 1386 * [OBSOLETE]
00e2e675
DG
1387 */
1388int lttng_enable_consumer(struct lttng_handle *handle)
1389{
785d2d0d 1390 return -ENOSYS;
00e2e675
DG
1391}
1392
1393/*
9c6bda17 1394 * [OBSOLETE]
00e2e675
DG
1395 */
1396int lttng_disable_consumer(struct lttng_handle *handle)
1397{
785d2d0d 1398 return -ENOSYS;
00e2e675
DG
1399}
1400
07424f16
DG
1401/*
1402 * This is an extension of create session that is ONLY and SHOULD only be used
1403 * by the lttng command line program. It exists to avoid using URI parsing in
1404 * the lttng client.
1405 *
1406 * We need the date and time for the trace path subdirectory for the case where
1407 * the user does NOT define one using either -o or -U. Using the normal
1408 * lttng_create_session API call, we have no clue on the session daemon side if
1409 * the URL was generated automatically by the client or define by the user.
1410 *
1411 * So this function "wrapper" is hidden from the public API, takes the datetime
1412 * string and appends it if necessary to the URI subdirectory before sending it
1413 * to the session daemon.
1414 *
1415 * With this extra function, the lttng_create_session call behavior is not
1416 * changed and the timestamp is appended to the URI on the session daemon side
1417 * if necessary.
1418 */
1419int _lttng_create_session_ext(const char *name, const char *url,
1420 const char *datetime)
1421{
3dd05a85 1422 int ret;
07424f16
DG
1423 ssize_t size;
1424 struct lttcomm_session_msg lsm;
1425 struct lttng_uri *uris = NULL;
1426
2bba9e53 1427 if (name == NULL || datetime == NULL) {
2f70b271 1428 return -LTTNG_ERR_INVALID;
07424f16
DG
1429 }
1430
1431 memset(&lsm, 0, sizeof(lsm));
1432
1433 lsm.cmd_type = LTTNG_CREATE_SESSION;
cac3069d 1434 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
07424f16
DG
1435
1436 /* There should never be a data URL */
bc894455 1437 size = uri_parse_str_urls(url, NULL, &uris);
07424f16 1438 if (size < 0) {
3dd05a85
DG
1439 ret = -LTTNG_ERR_INVALID;
1440 goto error;
07424f16
DG
1441 }
1442
1443 lsm.u.uri.size = size;
1444
4b35a6b3 1445 if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
da4aa2b8
DG
1446 /* Don't append datetime if the name was automatically created. */
1447 if (strncmp(name, DEFAULT_SESSION_NAME "-",
1448 strlen(DEFAULT_SESSION_NAME) + 1)) {
1449 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s",
1450 name, datetime);
1451 } else {
1452 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name);
1453 }
07424f16
DG
1454 if (ret < 0) {
1455 PERROR("snprintf uri subdir");
3dd05a85
DG
1456 ret = -LTTNG_ERR_FATAL;
1457 goto error;
07424f16
DG
1458 }
1459 }
1460
cac3069d
DG
1461 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1462 sizeof(struct lttng_uri) * size, NULL);
3dd05a85
DG
1463
1464error:
1465 free(uris);
1466 return ret;
07424f16
DG
1467}
1468
806e2684
DG
1469/*
1470 * For a given session name, this call checks if the data is ready to be read
1471 * or is still being extracted by the consumer(s) hence not ready to be used by
1472 * any readers.
1473 */
6d805429 1474int lttng_data_pending(const char *session_name)
806e2684
DG
1475{
1476 int ret;
1477 struct lttcomm_session_msg lsm;
1478
1479 if (session_name == NULL) {
1480 return -LTTNG_ERR_INVALID;
1481 }
1482
6d805429 1483 lsm.cmd_type = LTTNG_DATA_PENDING;
806e2684 1484
cac3069d
DG
1485 lttng_ctl_copy_string(lsm.session.name, session_name,
1486 sizeof(lsm.session.name));
806e2684 1487
cac3069d 1488 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
806e2684
DG
1489
1490 /*
cac3069d
DG
1491 * The lttng_ctl_ask_sessiond function negate the return code if it's not
1492 * LTTNG_OK so getting -1 means that the reply ret_code was 1 thus meaning
1493 * that the data is available. Yes it is hackish but for now this is the
1494 * only way.
806e2684
DG
1495 */
1496 if (ret == -1) {
1497 ret = 1;
1498 }
1499
1500 return ret;
1501}
1502
27babd3a
DG
1503/*
1504 * Create a session exclusively used for snapshot.
1505 *
1506 * Returns LTTNG_OK on success or a negative error code.
1507 */
1508int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
1509{
1510 int ret;
1511 ssize_t size;
1512 struct lttcomm_session_msg lsm;
1513 struct lttng_uri *uris = NULL;
1514
1515 if (name == NULL) {
1516 return -LTTNG_ERR_INVALID;
1517 }
1518
1519 memset(&lsm, 0, sizeof(lsm));
1520
1521 lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT;
1522 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1523
1524 size = uri_parse_str_urls(snapshot_url, NULL, &uris);
1525 if (size < 0) {
1526 return -LTTNG_ERR_INVALID;
1527 }
1528
1529 lsm.u.uri.size = size;
1530
1531 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1532 sizeof(struct lttng_uri) * size, NULL);
1533
1534 free(uris);
1535 return ret;
1536}
1537
ecc48a90
JD
1538/*
1539 * Create a session exclusively used for live.
1540 *
1541 * Returns LTTNG_OK on success or a negative error code.
1542 */
1543int lttng_create_session_live(const char *name, const char *url,
1544 unsigned int timer_interval)
1545{
1546 int ret;
1547 ssize_t size;
1548 struct lttcomm_session_msg lsm;
1549 struct lttng_uri *uris = NULL;
1550
1551 if (name == NULL) {
1552 return -LTTNG_ERR_INVALID;
1553 }
1554
1555 memset(&lsm, 0, sizeof(lsm));
1556
1557 lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE;
1558 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1559
1560 size = uri_parse_str_urls(url, NULL, &uris);
903055ea 1561 if (size <= 0) {
ecc48a90
JD
1562 ret = -LTTNG_ERR_INVALID;
1563 goto end;
1564 }
1565
1566 /* file:// is not accepted for live session. */
1567 if (uris[0].dtype == LTTNG_DST_PATH) {
1568 ret = -LTTNG_ERR_INVALID;
1569 goto end;
1570 }
1571
1572 lsm.u.session_live.nb_uri = size;
1573 lsm.u.session_live.timer_interval = timer_interval;
1574
1575 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1576 sizeof(struct lttng_uri) * size, NULL);
1577
1578end:
1579 free(uris);
1580 return ret;
1581}
1582
fac6795d
DG
1583/*
1584 * lib constructor
1585 */
1586static void __attribute__((constructor)) init()
1587{
1588 /* Set default session group */
bbccc3d2 1589 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
fac6795d 1590}
49cca668
DG
1591
1592/*
1593 * lib destructor
1594 */
1595static void __attribute__((destructor)) lttng_ctl_exit()
1596{
1597 free(tracing_group);
1598}
This page took 0.213251 seconds and 4 git commands to generate.