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