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