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