Send enable-event commands with exclusion data
[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{
cd80958d
DG
676 struct lttcomm_session_msg lsm;
677
5117eeec 678 if (handle == NULL || ev == NULL) {
2f70b271 679 return -LTTNG_ERR_INVALID;
cd80958d 680 }
33a2b854 681
441c16a7
MD
682 memset(&lsm, 0, sizeof(lsm));
683
85076754 684 /* If no channel name, send empty string. */
94cf3c47 685 if (channel_name == NULL) {
85076754 686 lttng_ctl_copy_string(lsm.u.enable.channel_name, "",
cd80958d 687 sizeof(lsm.u.enable.channel_name));
33a2b854 688 } else {
cac3069d 689 lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name,
cd80958d 690 sizeof(lsm.u.enable.channel_name));
eb354453
DG
691 }
692
cac3069d 693 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
0d0c377a 694
8c9ae521 695 if (ev->name[0] != '\0') {
cd80958d 696 lsm.cmd_type = LTTNG_ENABLE_EVENT;
0d0c377a 697 } else {
cd80958d 698 lsm.cmd_type = LTTNG_ENABLE_ALL_EVENT;
f3ed775e 699 }
8c9ae521 700 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
f3ed775e 701
cac3069d 702 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d
DG
703 sizeof(lsm.session.name));
704
cac3069d 705 return lttng_ctl_ask_sessiond(&lsm, NULL);
1df4dedd
DG
706}
707
53a80697 708/*
025faf73 709 * Create or enable an event with a filter expression.
178191b3 710 *
53a80697
MD
711 * Return negative error value on error.
712 * Return size of returned session payload data if OK.
713 */
025faf73 714int lttng_enable_event_with_filter(struct lttng_handle *handle,
178191b3 715 struct lttng_event *event, const char *channel_name,
53a80697
MD
716 const char *filter_expression)
717{
718 struct lttcomm_session_msg lsm;
719 struct filter_parser_ctx *ctx;
720 FILE *fmem;
721 int ret = 0;
722
52df2401
MD
723 if (!filter_expression) {
724 /*
725 * Fall back to normal event enabling if no filter
726 * specified.
727 */
728 return lttng_enable_event(handle, event, channel_name);
729 }
730
731 /*
732 * Empty filter string will always be rejected by the parser
733 * anyway, so treat this corner-case early to eliminate
734 * lttng_fmemopen error for 0-byte allocation.
735 */
736 if (handle == NULL || filter_expression[0] == '\0') {
2f70b271 737 return -LTTNG_ERR_INVALID;
53a80697
MD
738 }
739
53a80697
MD
740 /*
741 * casting const to non-const, as the underlying function will
742 * use it in read-only mode.
743 */
744 fmem = lttng_fmemopen((void *) filter_expression,
745 strlen(filter_expression), "r");
746 if (!fmem) {
747 fprintf(stderr, "Error opening memory as stream\n");
ff7ef7b8 748 return -LTTNG_ERR_FILTER_NOMEM;
53a80697
MD
749 }
750 ctx = filter_parser_ctx_alloc(fmem);
751 if (!ctx) {
752 fprintf(stderr, "Error allocating parser\n");
ff7ef7b8 753 ret = -LTTNG_ERR_FILTER_NOMEM;
53a80697
MD
754 goto alloc_error;
755 }
756 ret = filter_parser_ctx_append_ast(ctx);
757 if (ret) {
758 fprintf(stderr, "Parse error\n");
ff7ef7b8 759 ret = -LTTNG_ERR_FILTER_INVAL;
53a80697
MD
760 goto parse_error;
761 }
762 ret = filter_visitor_set_parent(ctx);
763 if (ret) {
764 fprintf(stderr, "Set parent error\n");
ff7ef7b8 765 ret = -LTTNG_ERR_FILTER_INVAL;
53a80697
MD
766 goto parse_error;
767 }
768 if (print_xml) {
769 ret = filter_visitor_print_xml(ctx, stdout, 0);
770 if (ret) {
771 fflush(stdout);
772 fprintf(stderr, "XML print error\n");
ff7ef7b8 773 ret = -LTTNG_ERR_FILTER_INVAL;
53a80697
MD
774 goto parse_error;
775 }
776 }
777
778 dbg_printf("Generating IR... ");
779 fflush(stdout);
780 ret = filter_visitor_ir_generate(ctx);
781 if (ret) {
782 fprintf(stderr, "Generate IR error\n");
ff7ef7b8 783 ret = -LTTNG_ERR_FILTER_INVAL;
53a80697
MD
784 goto parse_error;
785 }
786 dbg_printf("done\n");
787
788 dbg_printf("Validating IR... ");
789 fflush(stdout);
790 ret = filter_visitor_ir_check_binary_op_nesting(ctx);
791 if (ret) {
ff7ef7b8 792 ret = -LTTNG_ERR_FILTER_INVAL;
53a80697
MD
793 goto parse_error;
794 }
795 dbg_printf("done\n");
796
797 dbg_printf("Generating bytecode... ");
798 fflush(stdout);
799 ret = filter_visitor_bytecode_generate(ctx);
800 if (ret) {
801 fprintf(stderr, "Generate bytecode error\n");
ff7ef7b8 802 ret = -LTTNG_ERR_FILTER_INVAL;
53a80697
MD
803 goto parse_error;
804 }
805 dbg_printf("done\n");
806 dbg_printf("Size of bytecode generated: %u bytes.\n",
807 bytecode_get_len(&ctx->bytecode->b));
808
809 memset(&lsm, 0, sizeof(lsm));
810
025faf73 811 lsm.cmd_type = LTTNG_ENABLE_EVENT_WITH_FILTER;
53a80697 812
85076754
MD
813 /* If no channel name, send empty string. */
814 if (channel_name == NULL) {
815 lttng_ctl_copy_string(lsm.u.enable.channel_name, "",
816 sizeof(lsm.u.enable.channel_name));
817 } else {
818 lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name,
819 sizeof(lsm.u.enable.channel_name));
820 }
821
53a80697 822 /* Copy event name */
178191b3
DG
823 if (event) {
824 memcpy(&lsm.u.enable.event, event, sizeof(lsm.u.enable.event));
825 }
826
025faf73 827 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
53a80697
MD
828 + bytecode_get_len(&ctx->bytecode->b);
829
cac3069d 830 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
53a80697 831
cac3069d 832 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
53a80697
MD
833 sizeof(lsm.session.name));
834
cac3069d 835 ret = lttng_ctl_ask_sessiond_varlen(&lsm, &ctx->bytecode->b,
025faf73 836 lsm.u.enable.bytecode_len, NULL);
53a80697
MD
837
838 filter_bytecode_free(ctx);
839 filter_ir_free(ctx);
840 filter_parser_ctx_free(ctx);
841 if (fclose(fmem) != 0) {
842 perror("fclose");
843 }
844 return ret;
845
846parse_error:
847 filter_bytecode_free(ctx);
848 filter_ir_free(ctx);
849 filter_parser_ctx_free(ctx);
850alloc_error:
851 if (fclose(fmem) != 0) {
852 perror("fclose");
853 }
854 return ret;
855}
856
93deb080
JI
857/*
858 * Enable event(s) for a channel, possibly with exclusions and a filter.
859 * If no event name is specified, all events are enabled.
860 * If no channel name is specified, the default name is used.
861 * If filter expression is not NULL, the filter is set for the event.
862 * If exclusion count is not zero, the exclusions are set for the event.
863 * Returns size of returned session payload data or a negative error code.
864 */
865int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
866 struct lttng_event *ev, const char *channel_name,
867 const char *filter_expression,
868 int exclusion_count, char **exclusion_list)
869{
870 struct lttcomm_session_msg lsm;
871 char *varlen_data;
872 int ret = 0;
873 struct filter_parser_ctx *ctx = NULL;
874 FILE *fmem = NULL;
875
876 if (handle == NULL || ev == NULL) {
877 return -LTTNG_ERR_INVALID;
878 }
879
880 /* Empty filter string will always be rejected by the parser
881 * anyway, so treat this corner-case early to eliminate
882 * lttng_fmemopen error for 0-byte allocation.
883 */
884 if (filter_expression && filter_expression[0] == '\0') {
885 return -LTTNG_ERR_INVALID;
886 }
887
888 memset(&lsm, 0, sizeof(lsm));
889
890 /* If no channel name, send empty string. */
891 if (channel_name == NULL) {
892 lttng_ctl_copy_string(lsm.u.enable.channel_name, "",
893 sizeof(lsm.u.enable.channel_name));
894 } else {
895 lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name,
896 sizeof(lsm.u.enable.channel_name));
897 }
898
899 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
900
901 /* figure out correct command type, based on if we have a filter or exclusions */
902 if (exclusion_count == 0) {
903 if (filter_expression == NULL) {
904 if (ev->name[0] != '\0') {
905 lsm.cmd_type = LTTNG_ENABLE_EVENT;
906 } else {
907 lsm.cmd_type = LTTNG_ENABLE_ALL_EVENT;
908 }
909 } else {
910 lsm.cmd_type = LTTNG_ENABLE_EVENT_WITH_FILTER;
911 }
912 } else {
913 lsm.cmd_type = LTTNG_ENABLE_EVENT_WITH_EXCLUSION;
914 }
915
916 memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
917
918 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
919 sizeof(lsm.session.name));
920 lsm.u.enable.exclusion_count = exclusion_count;
921 lsm.u.enable.bytecode_len = 0;
922
923 if (exclusion_count == 0 && filter_expression == NULL) {
924 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
925 return ret;
926 }
927
928 /*
929 * We have either a filter or some exclusions, so we need to set up
930 * a variable-length memory block from where to send the data
931 */
932
933 /* Parse filter expression */
934 if (filter_expression != NULL) {
935
936 /*
937 * casting const to non-const, as the underlying function will
938 * use it in read-only mode.
939 */
940 fmem = lttng_fmemopen((void *) filter_expression,
941 strlen(filter_expression), "r");
942 if (!fmem) {
943 fprintf(stderr, "Error opening memory as stream\n");
944 return -LTTNG_ERR_FILTER_NOMEM;
945 }
946 ctx = filter_parser_ctx_alloc(fmem);
947 if (!ctx) {
948 fprintf(stderr, "Error allocating parser\n");
949 ret = -LTTNG_ERR_FILTER_NOMEM;
950 goto filter_alloc_error;
951 }
952 ret = filter_parser_ctx_append_ast(ctx);
953 if (ret) {
954 fprintf(stderr, "Parse error\n");
955 ret = -LTTNG_ERR_FILTER_INVAL;
956 goto parse_error;
957 }
958 ret = filter_visitor_set_parent(ctx);
959 if (ret) {
960 fprintf(stderr, "Set parent error\n");
961 ret = -LTTNG_ERR_FILTER_INVAL;
962 goto parse_error;
963 }
964 if (print_xml) {
965 ret = filter_visitor_print_xml(ctx, stdout, 0);
966 if (ret) {
967 fflush(stdout);
968 fprintf(stderr, "XML print error\n");
969 ret = -LTTNG_ERR_FILTER_INVAL;
970 goto parse_error;
971 }
972 }
973
974 dbg_printf("Generating IR... ");
975 fflush(stdout);
976 ret = filter_visitor_ir_generate(ctx);
977 if (ret) {
978 fprintf(stderr, "Generate IR error\n");
979 ret = -LTTNG_ERR_FILTER_INVAL;
980 goto parse_error;
981 }
982 dbg_printf("done\n");
983
984 dbg_printf("Validating IR... ");
985 fflush(stdout);
986 ret = filter_visitor_ir_check_binary_op_nesting(ctx);
987 if (ret) {
988 ret = -LTTNG_ERR_FILTER_INVAL;
989 goto parse_error;
990 }
991 dbg_printf("done\n");
992
993 dbg_printf("Generating bytecode... ");
994 fflush(stdout);
995 ret = filter_visitor_bytecode_generate(ctx);
996 if (ret) {
997 fprintf(stderr, "Generate bytecode error\n");
998 ret = -LTTNG_ERR_FILTER_INVAL;
999 goto parse_error;
1000 }
1001 dbg_printf("done\n");
1002 dbg_printf("Size of bytecode generated: %u bytes.\n",
1003 bytecode_get_len(&ctx->bytecode->b));
1004
1005 lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
1006 + bytecode_get_len(&ctx->bytecode->b);
1007 }
1008
1009 /* Allocate variable length data */
1010 if (lsm.u.enable.exclusion_count != 0) {
1011 varlen_data = zmalloc(lsm.u.enable.bytecode_len
1012 + LTTNG_SYMBOL_NAME_LEN * exclusion_count);
1013 if (!varlen_data) {
1014 ret = -LTTNG_ERR_EXCLUSION_NOMEM;
1015 goto varlen_alloc_error;
1016 }
1017 /* Put exclusion names first in the data */
1018 while (exclusion_count--) {
1019 strncpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * exclusion_count,
1020 *(exclusion_list + exclusion_count),
1021 LTTNG_SYMBOL_NAME_LEN);
1022 }
1023 /* Add filter bytecode next */
1024 if (lsm.u.enable.bytecode_len != 0) {
1025 memcpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count,
1026 &ctx->bytecode->b,
1027 lsm.u.enable.bytecode_len);
1028 }
1029 } else {
1030 /* no exclusions - use the already allocated filter bytecode */
1031 varlen_data = (char *)(&ctx->bytecode->b);
1032 }
1033
1034 ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data,
1035 LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count
1036 + lsm.u.enable.bytecode_len,
1037 NULL);
1038
1039 if (lsm.u.enable.exclusion_count != 0) {
1040 free(varlen_data);
1041 }
1042
1043varlen_alloc_error:
1044 if (filter_expression) {
1045 filter_bytecode_free(ctx);
1046 filter_ir_free(ctx);
1047 filter_parser_ctx_free(ctx);
1048 if (fclose(fmem) != 0) {
1049 perror("fclose");
1050 }
1051 }
1052 return ret;
1053
1054parse_error:
1055 filter_bytecode_free(ctx);
1056 filter_ir_free(ctx);
1057 filter_parser_ctx_free(ctx);
1058filter_alloc_error:
1059 if (fclose(fmem) != 0) {
1060 perror("fclose");
1061 }
1062 return ret;
1063}
1064
1df4dedd 1065/*
1c8d13c8
TD
1066 * Disable event(s) of a channel and domain.
1067 * If no event name is specified, all events are disabled.
1068 * If no channel name is specified, the default 'channel0' is used.
1069 * Returns size of returned session payload data or a negative error code.
1df4dedd 1070 */
cd80958d 1071int lttng_disable_event(struct lttng_handle *handle, const char *name,
38057ed1 1072 const char *channel_name)
1df4dedd 1073{
cd80958d 1074 struct lttcomm_session_msg lsm;
1df4dedd 1075
9d697d3d 1076 if (handle == NULL) {
2f70b271 1077 return -LTTNG_ERR_INVALID;
cd80958d
DG
1078 }
1079
441c16a7
MD
1080 memset(&lsm, 0, sizeof(lsm));
1081
85076754
MD
1082 /* If no channel name, send empty string. */
1083 if (channel_name == NULL) {
1084 lttng_ctl_copy_string(lsm.u.disable.channel_name, "",
cd80958d 1085 sizeof(lsm.u.disable.channel_name));
f3ed775e 1086 } else {
85076754 1087 lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name,
cd80958d 1088 sizeof(lsm.u.disable.channel_name));
eb354453
DG
1089 }
1090
cac3069d 1091 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
f5177a38 1092
f84efadf 1093 if (name != NULL) {
cac3069d
DG
1094 lttng_ctl_copy_string(lsm.u.disable.name, name,
1095 sizeof(lsm.u.disable.name));
cd80958d 1096 lsm.cmd_type = LTTNG_DISABLE_EVENT;
f5177a38 1097 } else {
cd80958d 1098 lsm.cmd_type = LTTNG_DISABLE_ALL_EVENT;
f3ed775e
DG
1099 }
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);
1df4dedd
DG
1105}
1106
1107/*
1c8d13c8
TD
1108 * Enable channel per domain
1109 * Returns size of returned session payload data or a negative error code.
a5c5a2bd 1110 */
cd80958d 1111int lttng_enable_channel(struct lttng_handle *handle,
38057ed1 1112 struct lttng_channel *chan)
a5c5a2bd 1113{
cd80958d
DG
1114 struct lttcomm_session_msg lsm;
1115
5117eeec
DG
1116 /*
1117 * NULL arguments are forbidden. No default values.
1118 */
1119 if (handle == NULL || chan == NULL) {
2f70b271 1120 return -LTTNG_ERR_INVALID;
cd80958d
DG
1121 }
1122
441c16a7
MD
1123 memset(&lsm, 0, sizeof(lsm));
1124
5117eeec 1125 memcpy(&lsm.u.channel.chan, chan, sizeof(lsm.u.channel.chan));
7d29a247 1126
cd80958d
DG
1127 lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
1128
cac3069d 1129 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
7d29a247 1130
cac3069d 1131 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d
DG
1132 sizeof(lsm.session.name));
1133
cac3069d 1134 return lttng_ctl_ask_sessiond(&lsm, NULL);
8c0faa1d 1135}
1df4dedd 1136
2ef84c95 1137/*
1c8d13c8
TD
1138 * All tracing will be stopped for registered events of the channel.
1139 * Returns size of returned session payload data or a negative error code.
2ef84c95 1140 */
cd80958d 1141int lttng_disable_channel(struct lttng_handle *handle, const char *name)
2ef84c95 1142{
cd80958d
DG
1143 struct lttcomm_session_msg lsm;
1144
9d697d3d
DG
1145 /* Safety check. Both are mandatory */
1146 if (handle == NULL || name == NULL) {
2f70b271 1147 return -LTTNG_ERR_INVALID;
cd80958d
DG
1148 }
1149
441c16a7
MD
1150 memset(&lsm, 0, sizeof(lsm));
1151
cd80958d 1152 lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
1df4dedd 1153
cac3069d 1154 lttng_ctl_copy_string(lsm.u.disable.channel_name, name,
9d697d3d
DG
1155 sizeof(lsm.u.disable.channel_name));
1156
cac3069d 1157 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
cd80958d 1158
cac3069d 1159 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d
DG
1160 sizeof(lsm.session.name));
1161
cac3069d 1162 return lttng_ctl_ask_sessiond(&lsm, NULL);
ca95a216
DG
1163}
1164
fac6795d 1165/*
1c8d13c8
TD
1166 * Lists all available tracepoints of domain.
1167 * Sets the contents of the events array.
1168 * Returns the number of lttng_event entries in events;
1169 * on error, returns a negative value.
fac6795d 1170 */
cd80958d 1171int lttng_list_tracepoints(struct lttng_handle *handle,
2a71efd5 1172 struct lttng_event **events)
fac6795d 1173{
052da939 1174 int ret;
cd80958d
DG
1175 struct lttcomm_session_msg lsm;
1176
9d697d3d 1177 if (handle == NULL) {
2f70b271 1178 return -LTTNG_ERR_INVALID;
cd80958d 1179 }
fac6795d 1180
cd80958d 1181 lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
cac3069d 1182 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
2a71efd5 1183
cac3069d 1184 ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
052da939
DG
1185 if (ret < 0) {
1186 return ret;
eb354453 1187 }
fac6795d 1188
9f19cc17 1189 return ret / sizeof(struct lttng_event);
fac6795d
DG
1190}
1191
f37d259d
MD
1192/*
1193 * Lists all available tracepoint fields of domain.
1194 * Sets the contents of the event field array.
1195 * Returns the number of lttng_event_field entries in events;
1196 * on error, returns a negative value.
1197 */
1198int lttng_list_tracepoint_fields(struct lttng_handle *handle,
1199 struct lttng_event_field **fields)
1200{
1201 int ret;
1202 struct lttcomm_session_msg lsm;
1203
1204 if (handle == NULL) {
2f70b271 1205 return -LTTNG_ERR_INVALID;
f37d259d
MD
1206 }
1207
1208 lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
cac3069d 1209 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
f37d259d 1210
cac3069d 1211 ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
f37d259d
MD
1212 if (ret < 0) {
1213 return ret;
1214 }
1215
1216 return ret / sizeof(struct lttng_event_field);
1217}
1218
1657e9bb 1219/*
1c8d13c8
TD
1220 * Returns a human readable string describing
1221 * the error code (a negative value).
1657e9bb 1222 */
9a745bc7 1223const char *lttng_strerror(int code)
1657e9bb 1224{
f73fabfd 1225 return error_get_str(code);
1657e9bb
DG
1226}
1227
aaf97519 1228/*
a4b92340
DG
1229 * Create a brand new session using name and url for destination.
1230 *
f73fabfd 1231 * Returns LTTNG_OK on success or a negative error code.
00e2e675 1232 */
a4b92340 1233int lttng_create_session(const char *name, const char *url)
00e2e675 1234{
3dd05a85 1235 int ret;
a4b92340 1236 ssize_t size;
00e2e675 1237 struct lttcomm_session_msg lsm;
a4b92340 1238 struct lttng_uri *uris = NULL;
00e2e675 1239
a4b92340 1240 if (name == NULL) {
2f70b271 1241 return -LTTNG_ERR_INVALID;
00e2e675
DG
1242 }
1243
a4b92340 1244 memset(&lsm, 0, sizeof(lsm));
00e2e675 1245
a4b92340 1246 lsm.cmd_type = LTTNG_CREATE_SESSION;
cac3069d 1247 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
a4b92340
DG
1248
1249 /* There should never be a data URL */
bc894455 1250 size = uri_parse_str_urls(url, NULL, &uris);
a4b92340 1251 if (size < 0) {
2f70b271 1252 return -LTTNG_ERR_INVALID;
00e2e675
DG
1253 }
1254
a4b92340
DG
1255 lsm.u.uri.size = size;
1256
cac3069d
DG
1257 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1258 sizeof(struct lttng_uri) * size, NULL);
3dd05a85
DG
1259
1260 free(uris);
1261 return ret;
00e2e675
DG
1262}
1263
8028d920 1264/*
8028d920 1265 * Destroy session using name.
1c8d13c8 1266 * Returns size of returned session payload data or a negative error code.
8028d920 1267 */
843f5df9 1268int lttng_destroy_session(const char *session_name)
8028d920 1269{
cd80958d
DG
1270 struct lttcomm_session_msg lsm;
1271
843f5df9 1272 if (session_name == NULL) {
2f70b271 1273 return -LTTNG_ERR_INVALID;
cd80958d
DG
1274 }
1275
1276 lsm.cmd_type = LTTNG_DESTROY_SESSION;
843f5df9 1277
cac3069d
DG
1278 lttng_ctl_copy_string(lsm.session.name, session_name,
1279 sizeof(lsm.session.name));
cd80958d 1280
cac3069d 1281 return lttng_ctl_ask_sessiond(&lsm, NULL);
aaf97519
DG
1282}
1283
57167058 1284/*
57167058 1285 * Ask the session daemon for all available sessions.
1c8d13c8
TD
1286 * Sets the contents of the sessions array.
1287 * Returns the number of lttng_session entries in sessions;
1288 * on error, returns a negative value.
57167058 1289 */
ca95a216 1290int lttng_list_sessions(struct lttng_session **sessions)
57167058 1291{
ca95a216 1292 int ret;
cd80958d 1293 struct lttcomm_session_msg lsm;
57167058 1294
cd80958d 1295 lsm.cmd_type = LTTNG_LIST_SESSIONS;
cac3069d 1296 ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions);
57167058 1297 if (ret < 0) {
ca95a216 1298 return ret;
57167058
DG
1299 }
1300
ca95a216 1301 return ret / sizeof(struct lttng_session);
57167058
DG
1302}
1303
9f19cc17 1304/*
1c8d13c8
TD
1305 * Ask the session daemon for all available domains of a session.
1306 * Sets the contents of the domains array.
1307 * Returns the number of lttng_domain entries in domains;
1308 * on error, returns a negative value.
9f19cc17 1309 */
330be774 1310int lttng_list_domains(const char *session_name,
cd80958d 1311 struct lttng_domain **domains)
9f19cc17
DG
1312{
1313 int ret;
cd80958d
DG
1314 struct lttcomm_session_msg lsm;
1315
330be774 1316 if (session_name == NULL) {
2f70b271 1317 return -LTTNG_ERR_INVALID;
cd80958d 1318 }
9f19cc17 1319
cd80958d
DG
1320 lsm.cmd_type = LTTNG_LIST_DOMAINS;
1321
cac3069d
DG
1322 lttng_ctl_copy_string(lsm.session.name, session_name,
1323 sizeof(lsm.session.name));
cd80958d 1324
cac3069d 1325 ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains);
9f19cc17
DG
1326 if (ret < 0) {
1327 return ret;
1328 }
1329
1330 return ret / sizeof(struct lttng_domain);
1331}
1332
1333/*
1c8d13c8
TD
1334 * Ask the session daemon for all available channels of a session.
1335 * Sets the contents of the channels array.
1336 * Returns the number of lttng_channel entries in channels;
1337 * on error, returns a negative value.
9f19cc17 1338 */
cd80958d
DG
1339int lttng_list_channels(struct lttng_handle *handle,
1340 struct lttng_channel **channels)
9f19cc17
DG
1341{
1342 int ret;
cd80958d
DG
1343 struct lttcomm_session_msg lsm;
1344
9d697d3d 1345 if (handle == NULL) {
2f70b271 1346 return -LTTNG_ERR_INVALID;
cd80958d
DG
1347 }
1348
1349 lsm.cmd_type = LTTNG_LIST_CHANNELS;
cac3069d 1350 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d 1351 sizeof(lsm.session.name));
9f19cc17 1352
cac3069d 1353 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
9f19cc17 1354
cac3069d 1355 ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
9f19cc17
DG
1356 if (ret < 0) {
1357 return ret;
1358 }
1359
1360 return ret / sizeof(struct lttng_channel);
1361}
1362
1363/*
1c8d13c8
TD
1364 * Ask the session daemon for all available events of a session channel.
1365 * Sets the contents of the events array.
1366 * Returns the number of lttng_event entries in events;
1367 * on error, returns a negative value.
9f19cc17 1368 */
cd80958d
DG
1369int lttng_list_events(struct lttng_handle *handle,
1370 const char *channel_name, struct lttng_event **events)
9f19cc17
DG
1371{
1372 int ret;
cd80958d 1373 struct lttcomm_session_msg lsm;
9f19cc17 1374
9d697d3d
DG
1375 /* Safety check. An handle and channel name are mandatory */
1376 if (handle == NULL || channel_name == NULL) {
2f70b271 1377 return -LTTNG_ERR_INVALID;
cd80958d
DG
1378 }
1379
1380 lsm.cmd_type = LTTNG_LIST_EVENTS;
cac3069d 1381 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
cd80958d 1382 sizeof(lsm.session.name));
cac3069d 1383 lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name,
cd80958d
DG
1384 sizeof(lsm.u.list.channel_name));
1385
cac3069d 1386 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
9f19cc17 1387
cac3069d 1388 ret = lttng_ctl_ask_sessiond(&lsm, (void**) events);
9f19cc17
DG
1389 if (ret < 0) {
1390 return ret;
1391 }
1392
1393 return ret / sizeof(struct lttng_event);
1394}
1395
fac6795d 1396/*
1c8d13c8
TD
1397 * Sets the tracing_group variable with name.
1398 * This function allocates memory pointed to by tracing_group.
1399 * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
fac6795d
DG
1400 */
1401int lttng_set_tracing_group(const char *name)
1402{
9d697d3d 1403 if (name == NULL) {
2f70b271 1404 return -LTTNG_ERR_INVALID;
9d697d3d
DG
1405 }
1406
fac6795d 1407 if (asprintf(&tracing_group, "%s", name) < 0) {
2f70b271 1408 return -LTTNG_ERR_FATAL;
fac6795d
DG
1409 }
1410
1411 return 0;
1412}
1413
d0254c7c 1414/*
af87c45a 1415 * Returns size of returned session payload data or a negative error code.
d0254c7c 1416 */
cd80958d 1417int lttng_calibrate(struct lttng_handle *handle,
d0254c7c
MD
1418 struct lttng_calibrate *calibrate)
1419{
cd80958d 1420 struct lttcomm_session_msg lsm;
d0254c7c 1421
9d697d3d
DG
1422 /* Safety check. NULL pointer are forbidden */
1423 if (handle == NULL || calibrate == NULL) {
2f70b271 1424 return -LTTNG_ERR_INVALID;
cd80958d 1425 }
d0254c7c 1426
cd80958d 1427 lsm.cmd_type = LTTNG_CALIBRATE;
cac3069d 1428 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
d0254c7c 1429
cd80958d
DG
1430 memcpy(&lsm.u.calibrate, calibrate, sizeof(lsm.u.calibrate));
1431
cac3069d 1432 return lttng_ctl_ask_sessiond(&lsm, NULL);
d0254c7c
MD
1433}
1434
5edd7e09
DG
1435/*
1436 * Set default channel attributes.
441c16a7 1437 * If either or both of the arguments are null, attr content is zeroe'd.
5edd7e09
DG
1438 */
1439void lttng_channel_set_default_attr(struct lttng_domain *domain,
1440 struct lttng_channel_attr *attr)
1441{
1442 /* Safety check */
1443 if (attr == NULL || domain == NULL) {
1444 return;
1445 }
1446
eacaa7a6
DS
1447 memset(attr, 0, sizeof(struct lttng_channel_attr));
1448
0a9c6494
DG
1449 /* Same for all domains. */
1450 attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
1451 attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE;
1452 attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT;
1453
5edd7e09
DG
1454 switch (domain->type) {
1455 case LTTNG_DOMAIN_KERNEL:
d92ff3ef
DG
1456 attr->switch_timer_interval = DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER;
1457 attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER;
3e230f92 1458 attr->subbuf_size = default_get_kernel_channel_subbuf_size();
5edd7e09
DG
1459 attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
1460 attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
1461 break;
1462 case LTTNG_DOMAIN_UST:
0a9c6494
DG
1463 switch (domain->buf_type) {
1464 case LTTNG_BUFFER_PER_UID:
1465 attr->subbuf_size = default_get_ust_uid_channel_subbuf_size();
1466 attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM;
1467 attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT;
1468 attr->switch_timer_interval = DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
1469 attr->read_timer_interval = DEFAULT_UST_UID_CHANNEL_READ_TIMER;
1470 break;
1471 case LTTNG_BUFFER_PER_PID:
1472 default:
1473 attr->subbuf_size = default_get_ust_pid_channel_subbuf_size();
1474 attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM;
1475 attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT;
1476 attr->switch_timer_interval = DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
1477 attr->read_timer_interval = DEFAULT_UST_PID_CHANNEL_READ_TIMER;
1478 break;
1479 }
5edd7e09 1480 default:
441c16a7 1481 /* Default behavior: leave set to 0. */
5edd7e09
DG
1482 break;
1483 }
1484}
1485
fac6795d 1486/*
2269e89e 1487 * Check if session daemon is alive.
fac6795d 1488 *
2269e89e 1489 * Return 1 if alive or 0 if not.
1c8d13c8 1490 * On error returns a negative value.
fac6795d 1491 */
947308c4 1492int lttng_session_daemon_alive(void)
fac6795d
DG
1493{
1494 int ret;
1495
1496 ret = set_session_daemon_path();
1497 if (ret < 0) {
947308c4 1498 /* Error */
fac6795d
DG
1499 return ret;
1500 }
1501
9d035200 1502 if (*sessiond_sock_path == '\0') {
2f70b271
DG
1503 /*
1504 * No socket path set. Weird error which means the constructor was not
1505 * called.
1506 */
1507 assert(0);
fac6795d
DG
1508 }
1509
2269e89e 1510 ret = try_connect_sessiond(sessiond_sock_path);
7d8234d9
MD
1511 if (ret < 0) {
1512 /* Not alive */
1513 return 0;
1514 }
7d8234d9 1515
947308c4
DG
1516 /* Is alive */
1517 return 1;
fac6795d
DG
1518}
1519
00e2e675 1520/*
a4b92340 1521 * Set URL for a consumer for a session and domain.
00e2e675
DG
1522 *
1523 * Return 0 on success, else a negative value.
1524 */
a4b92340
DG
1525int lttng_set_consumer_url(struct lttng_handle *handle,
1526 const char *control_url, const char *data_url)
00e2e675 1527{
3dd05a85 1528 int ret;
a4b92340 1529 ssize_t size;
00e2e675 1530 struct lttcomm_session_msg lsm;
a4b92340 1531 struct lttng_uri *uris = NULL;
00e2e675 1532
a4b92340 1533 if (handle == NULL || (control_url == NULL && data_url == NULL)) {
2f70b271 1534 return -LTTNG_ERR_INVALID;
00e2e675
DG
1535 }
1536
a4b92340
DG
1537 memset(&lsm, 0, sizeof(lsm));
1538
00e2e675
DG
1539 lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
1540
cac3069d 1541 lttng_ctl_copy_string(lsm.session.name, handle->session_name,
00e2e675 1542 sizeof(lsm.session.name));
cac3069d 1543 lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
00e2e675 1544
bc894455 1545 size = uri_parse_str_urls(control_url, data_url, &uris);
a4b92340 1546 if (size < 0) {
2f70b271 1547 return -LTTNG_ERR_INVALID;
a4b92340
DG
1548 }
1549
1550 lsm.u.uri.size = size;
00e2e675 1551
cac3069d
DG
1552 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1553 sizeof(struct lttng_uri) * size, NULL);
3dd05a85
DG
1554
1555 free(uris);
1556 return ret;
00e2e675
DG
1557}
1558
1559/*
9c6bda17 1560 * [OBSOLETE]
00e2e675
DG
1561 */
1562int lttng_enable_consumer(struct lttng_handle *handle)
1563{
785d2d0d 1564 return -ENOSYS;
00e2e675
DG
1565}
1566
1567/*
9c6bda17 1568 * [OBSOLETE]
00e2e675
DG
1569 */
1570int lttng_disable_consumer(struct lttng_handle *handle)
1571{
785d2d0d 1572 return -ENOSYS;
00e2e675
DG
1573}
1574
07424f16
DG
1575/*
1576 * This is an extension of create session that is ONLY and SHOULD only be used
1577 * by the lttng command line program. It exists to avoid using URI parsing in
1578 * the lttng client.
1579 *
1580 * We need the date and time for the trace path subdirectory for the case where
1581 * the user does NOT define one using either -o or -U. Using the normal
1582 * lttng_create_session API call, we have no clue on the session daemon side if
1583 * the URL was generated automatically by the client or define by the user.
1584 *
1585 * So this function "wrapper" is hidden from the public API, takes the datetime
1586 * string and appends it if necessary to the URI subdirectory before sending it
1587 * to the session daemon.
1588 *
1589 * With this extra function, the lttng_create_session call behavior is not
1590 * changed and the timestamp is appended to the URI on the session daemon side
1591 * if necessary.
1592 */
1593int _lttng_create_session_ext(const char *name, const char *url,
1594 const char *datetime)
1595{
3dd05a85 1596 int ret;
07424f16
DG
1597 ssize_t size;
1598 struct lttcomm_session_msg lsm;
1599 struct lttng_uri *uris = NULL;
1600
2bba9e53 1601 if (name == NULL || datetime == NULL) {
2f70b271 1602 return -LTTNG_ERR_INVALID;
07424f16
DG
1603 }
1604
1605 memset(&lsm, 0, sizeof(lsm));
1606
1607 lsm.cmd_type = LTTNG_CREATE_SESSION;
cac3069d 1608 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
07424f16
DG
1609
1610 /* There should never be a data URL */
bc894455 1611 size = uri_parse_str_urls(url, NULL, &uris);
07424f16 1612 if (size < 0) {
3dd05a85
DG
1613 ret = -LTTNG_ERR_INVALID;
1614 goto error;
07424f16
DG
1615 }
1616
1617 lsm.u.uri.size = size;
1618
4b35a6b3 1619 if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
da4aa2b8
DG
1620 /* Don't append datetime if the name was automatically created. */
1621 if (strncmp(name, DEFAULT_SESSION_NAME "-",
1622 strlen(DEFAULT_SESSION_NAME) + 1)) {
1623 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s",
1624 name, datetime);
1625 } else {
1626 ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name);
1627 }
07424f16
DG
1628 if (ret < 0) {
1629 PERROR("snprintf uri subdir");
3dd05a85
DG
1630 ret = -LTTNG_ERR_FATAL;
1631 goto error;
07424f16
DG
1632 }
1633 }
1634
cac3069d
DG
1635 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1636 sizeof(struct lttng_uri) * size, NULL);
3dd05a85
DG
1637
1638error:
1639 free(uris);
1640 return ret;
07424f16
DG
1641}
1642
806e2684
DG
1643/*
1644 * For a given session name, this call checks if the data is ready to be read
1645 * or is still being extracted by the consumer(s) hence not ready to be used by
1646 * any readers.
1647 */
6d805429 1648int lttng_data_pending(const char *session_name)
806e2684
DG
1649{
1650 int ret;
1651 struct lttcomm_session_msg lsm;
1652
1653 if (session_name == NULL) {
1654 return -LTTNG_ERR_INVALID;
1655 }
1656
6d805429 1657 lsm.cmd_type = LTTNG_DATA_PENDING;
806e2684 1658
cac3069d
DG
1659 lttng_ctl_copy_string(lsm.session.name, session_name,
1660 sizeof(lsm.session.name));
806e2684 1661
cac3069d 1662 ret = lttng_ctl_ask_sessiond(&lsm, NULL);
806e2684
DG
1663
1664 /*
cac3069d
DG
1665 * The lttng_ctl_ask_sessiond function negate the return code if it's not
1666 * LTTNG_OK so getting -1 means that the reply ret_code was 1 thus meaning
1667 * that the data is available. Yes it is hackish but for now this is the
1668 * only way.
806e2684
DG
1669 */
1670 if (ret == -1) {
1671 ret = 1;
1672 }
1673
1674 return ret;
1675}
1676
27babd3a
DG
1677/*
1678 * Create a session exclusively used for snapshot.
1679 *
1680 * Returns LTTNG_OK on success or a negative error code.
1681 */
1682int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
1683{
1684 int ret;
1685 ssize_t size;
1686 struct lttcomm_session_msg lsm;
1687 struct lttng_uri *uris = NULL;
1688
1689 if (name == NULL) {
1690 return -LTTNG_ERR_INVALID;
1691 }
1692
1693 memset(&lsm, 0, sizeof(lsm));
1694
1695 lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT;
1696 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1697
1698 size = uri_parse_str_urls(snapshot_url, NULL, &uris);
1699 if (size < 0) {
1700 return -LTTNG_ERR_INVALID;
1701 }
1702
1703 lsm.u.uri.size = size;
1704
1705 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1706 sizeof(struct lttng_uri) * size, NULL);
1707
1708 free(uris);
1709 return ret;
1710}
1711
ecc48a90
JD
1712/*
1713 * Create a session exclusively used for live.
1714 *
1715 * Returns LTTNG_OK on success or a negative error code.
1716 */
1717int lttng_create_session_live(const char *name, const char *url,
1718 unsigned int timer_interval)
1719{
1720 int ret;
1721 ssize_t size;
1722 struct lttcomm_session_msg lsm;
1723 struct lttng_uri *uris = NULL;
1724
1725 if (name == NULL) {
1726 return -LTTNG_ERR_INVALID;
1727 }
1728
1729 memset(&lsm, 0, sizeof(lsm));
1730
1731 lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE;
1732 lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name));
1733
1734 size = uri_parse_str_urls(url, NULL, &uris);
1735 if (size < 0) {
1736 ret = -LTTNG_ERR_INVALID;
1737 goto end;
1738 }
1739
1740 /* file:// is not accepted for live session. */
1741 if (uris[0].dtype == LTTNG_DST_PATH) {
1742 ret = -LTTNG_ERR_INVALID;
1743 goto end;
1744 }
1745
1746 lsm.u.session_live.nb_uri = size;
1747 lsm.u.session_live.timer_interval = timer_interval;
1748
1749 ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris,
1750 sizeof(struct lttng_uri) * size, NULL);
1751
1752end:
1753 free(uris);
1754 return ret;
1755}
1756
fac6795d
DG
1757/*
1758 * lib constructor
1759 */
1760static void __attribute__((constructor)) init()
1761{
1762 /* Set default session group */
bbccc3d2 1763 lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
fac6795d 1764}
49cca668
DG
1765
1766/*
1767 * lib destructor
1768 */
1769static void __attribute__((destructor)) lttng_ctl_exit()
1770{
1771 free(tracing_group);
1772}
This page took 0.129469 seconds and 4 git commands to generate.