*
* Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
*
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation; only
- * version 2.1 of the License.
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License, version 2.1 only,
+ * as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this library; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#define _GNU_SOURCE
+#include <assert.h>
#include <grp.h>
#include <errno.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
+#include <common/common.h>
+#include <common/defaults.h>
#include <common/sessiond-comm/sessiond-comm.h>
-#include <common/lttng-share.h>
-#include <common/lttngerr.h>
+#include <common/uri.h>
#include <lttng/lttng.h>
+#include "filter/filter-ast.h"
+#include "filter/filter-parser.h"
+#include "filter/filter-bytecode.h"
+#include "filter/memstream.h"
+
+#ifdef DEBUG
+static const int print_xml = 1;
+#define dbg_printf(fmt, args...) \
+ printf("[debug liblttng-ctl] " fmt, ## args)
+#else
+static const int print_xml = 0;
+#define dbg_printf(fmt, args...) \
+do { \
+ /* do nothing but check printf format */ \
+ if (0) \
+ printf("[debug liblttnctl] " fmt, ## args); \
+} while (0)
+#endif
+
+
/* Socket to session daemon for communication */
static int sessiond_socket;
static char sessiond_sock_path[PATH_MAX];
+static char health_sock_path[PATH_MAX];
/* Variables */
static char *tracing_group;
static int connected;
+/* Global */
+
+/*
+ * Those two variables are used by error.h to silent or control the verbosity of
+ * error message. They are global to the library so application linking with it
+ * are able to compile correctly and also control verbosity of the library.
+ */
+int lttng_opt_quiet;
+int lttng_opt_verbose;
+
+static void set_default_url_attr(struct lttng_uri *uri,
+ enum lttng_stream_type stype)
+{
+ uri->stype = stype;
+ if (uri->dtype != LTTNG_DST_PATH && uri->port == 0) {
+ uri->port = (stype == LTTNG_STREAM_CONTROL) ?
+ DEFAULT_NETWORK_CONTROL_PORT : DEFAULT_NETWORK_DATA_PORT;
+ }
+}
+
+/*
+ * Parse a string URL and creates URI(s) returning the size of the populated
+ * array.
+ */
+static ssize_t parse_str_urls_to_uri(const char *ctrl_url, const char *data_url,
+ struct lttng_uri **uris)
+{
+ int ret;
+ unsigned int equal = 1, idx = 0;
+ /* Add the "file://" size to the URL maximum size */
+ char url[PATH_MAX + 7];
+ ssize_t size_ctrl = 0, size_data = 0, size;
+ struct lttng_uri *ctrl_uris = NULL, *data_uris = NULL;
+ struct lttng_uri *tmp_uris = NULL;
+
+ /* No URL(s) is allowed. This means that the consumer will be disabled. */
+ if (ctrl_url == NULL && data_url == NULL) {
+ return 0;
+ }
+
+ /* Check if URLs are equal and if so, only use the control URL */
+ if (ctrl_url && data_url) {
+ equal = !strcmp(ctrl_url, data_url);
+ }
+
+ /*
+ * Since we allow the str_url to be a full local filesystem path, we are
+ * going to create a valid file:// URL if it's the case.
+ *
+ * Check if first character is a '/' or else reject the URL.
+ */
+ if (ctrl_url && ctrl_url[0] == '/') {
+ ret = snprintf(url, sizeof(url), "file://%s", ctrl_url);
+ if (ret < 0) {
+ PERROR("snprintf file url");
+ goto parse_error;
+ }
+ ctrl_url = url;
+ }
+
+ /* Parse the control URL if there is one */
+ if (ctrl_url) {
+ size_ctrl = uri_parse(ctrl_url, &ctrl_uris);
+ if (size_ctrl < 1) {
+ ERR("Unable to parse the URL %s", ctrl_url);
+ goto parse_error;
+ }
+
+ /* At this point, we know there is at least one URI in the array */
+ set_default_url_attr(&ctrl_uris[0], LTTNG_STREAM_CONTROL);
+
+ if (ctrl_uris[0].dtype == LTTNG_DST_PATH && data_url) {
+ ERR("Can not have a data URL when destination is file://");
+ goto error;
+ }
+
+ /* URL are not equal but the control URL uses a net:// protocol */
+ if (size_ctrl == 2) {
+ if (!equal) {
+ ERR("Control URL uses the net:// protocol and the data URL is "
+ "different. Not allowed.");
+ goto error;
+ } else {
+ set_default_url_attr(&ctrl_uris[1], LTTNG_STREAM_DATA);
+ /*
+ * The data_url and ctrl_url are equal and the ctrl_url
+ * contains a net:// protocol so we just skip the data part.
+ */
+ data_url = NULL;
+ }
+ }
+ }
+
+ if (data_url) {
+ /* We have to parse the data URL in this case */
+ size_data = uri_parse(data_url, &data_uris);
+ if (size_data < 1) {
+ ERR("Unable to parse the URL %s", data_url);
+ goto error;
+ } else if (size_data == 2) {
+ ERR("Data URL can not be set with the net[4|6]:// protocol");
+ goto error;
+ }
+
+ set_default_url_attr(&data_uris[0], LTTNG_STREAM_DATA);
+ }
+
+ /* Compute total size */
+ size = size_ctrl + size_data;
+
+ tmp_uris = zmalloc(sizeof(struct lttng_uri) * size);
+ if (tmp_uris == NULL) {
+ PERROR("zmalloc uris");
+ goto error;
+ }
+
+ if (ctrl_uris) {
+ /* It's possible the control URIs array contains more than one URI */
+ memcpy(tmp_uris, ctrl_uris, sizeof(struct lttng_uri) * size_ctrl);
+ ++idx;
+ }
+
+ if (data_uris) {
+ memcpy(&tmp_uris[idx], data_uris, sizeof(struct lttng_uri));
+ }
+
+ *uris = tmp_uris;
+
+ return size;
+
+error:
+ free(ctrl_uris);
+ free(data_uris);
+ free(tmp_uris);
+parse_error:
+ return -1;
+}
+
/*
* Copy string from src to dst and enforce null terminated byte.
*/
{
if (src && dst) {
switch (src->type) {
- case LTTNG_DOMAIN_KERNEL:
- case LTTNG_DOMAIN_UST:
- case LTTNG_DOMAIN_UST_EXEC_NAME:
- case LTTNG_DOMAIN_UST_PID:
- case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
- memcpy(dst, src, sizeof(struct lttng_domain));
- break;
- default:
- dst->type = LTTNG_DOMAIN_KERNEL;
- break;
+ case LTTNG_DOMAIN_KERNEL:
+ case LTTNG_DOMAIN_UST:
+ /*
+ case LTTNG_DOMAIN_UST_EXEC_NAME:
+ case LTTNG_DOMAIN_UST_PID:
+ case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
+ */
+ memcpy(dst, src, sizeof(struct lttng_domain));
+ break;
+ default:
+ memset(dst, 0, sizeof(struct lttng_domain));
+ break;
}
}
}
/*
* Send lttcomm_session_msg to the session daemon.
*
- * On success, return 0
- * On error, return error code
+ * On success, returns the number of bytes sent (>=0)
+ * On error, returns -1
*/
static int send_session_msg(struct lttcomm_session_msg *lsm)
{
int ret;
if (!connected) {
- ret = -ENOTCONN;
+ ret = -LTTNG_ERR_NO_SESSIOND;
goto end;
}
+ DBG("LSM cmd type : %d", lsm->cmd_type);
+
ret = lttcomm_send_creds_unix_sock(sessiond_socket, lsm,
sizeof(struct lttcomm_session_msg));
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ }
+
+end:
+ return ret;
+}
+
+/*
+ * Send var len data to the session daemon.
+ *
+ * On success, returns the number of bytes sent (>=0)
+ * On error, returns -1
+ */
+static int send_session_varlen(void *data, size_t len)
+{
+ int ret;
+
+ if (!connected) {
+ ret = -LTTNG_ERR_NO_SESSIOND;
+ goto end;
+ }
+
+ if (!data || !len) {
+ ret = 0;
+ goto end;
+ }
+
+ ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ }
end:
return ret;
/*
* Receive data from the sessiond socket.
*
- * On success, return 0
- * On error, return recv() error code
+ * On success, returns the number of bytes received (>=0)
+ * On error, returns -1 (recvmsg() error) or -ENOTCONN
*/
static int recv_data_sessiond(void *buf, size_t len)
{
int ret;
if (!connected) {
- ret = -ENOTCONN;
+ ret = -LTTNG_ERR_NO_SESSIOND;
goto end;
}
ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len);
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ }
end:
return ret;
}
/*
- * Check if the specified group name exist.
+ * Check if we are in the specified group.
*
* If yes return 1, else return -1.
*/
/* Get GID of group 'tracing' */
grp_tracing = getgrnam(grp_name);
- if (grp_tracing == NULL) {
- /* NULL means not found also. getgrnam(3) */
- if (errno != 0) {
- perror("getgrnam");
- }
+ if (!grp_tracing) {
+ /* If grp_tracing is NULL, the group does not exist. */
goto end;
}
/* Alloc group list of the right size */
grp_list = malloc(grp_list_size * sizeof(gid_t));
if (!grp_list) {
- ret = -1;
+ perror("malloc");
goto end;
}
grp_id = getgroups(grp_list_size, grp_list);
- if (grp_id < -1) {
+ if (grp_id < 0) {
perror("getgroups");
goto free_list;
}
ret = access(sock_path, F_OK);
if (ret < 0) {
/* Not alive */
- return -1;
+ goto error;
}
ret = lttcomm_connect_unix_sock(sock_path);
if (ret < 0) {
/* Not alive */
- return -1;
+ goto error;
}
ret = lttcomm_close_unix_sock(ret);
}
return 0;
+
+error:
+ return -1;
}
/*
* Set sessiond socket path by putting it in the global sessiond_sock_path
* variable.
+ *
+ * Returns 0 on success, negative value on failure (the sessiond socket path
+ * is somehow too long or ENOMEM).
*/
static int set_session_daemon_path(void)
{
in_tgroup = check_tracing_group(tracing_group);
}
- if (uid == 0) {
- /* Root */
- copy_string(sessiond_sock_path,
- DEFAULT_GLOBAL_CLIENT_UNIX_SOCK,
- sizeof(sessiond_sock_path));
- } else if (in_tgroup) {
- /* Tracing group */
- copy_string(sessiond_sock_path,
- DEFAULT_GLOBAL_CLIENT_UNIX_SOCK,
+ if ((uid == 0) || in_tgroup) {
+ copy_string(sessiond_sock_path, DEFAULT_GLOBAL_CLIENT_UNIX_SOCK,
sizeof(sessiond_sock_path));
+ }
- ret = try_connect_sessiond(sessiond_sock_path);
- if (ret < 0) {
- /* Global session daemon not available */
- if (snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
- DEFAULT_HOME_CLIENT_UNIX_SOCK,
- getenv("HOME")) < 0) {
- return -ENOMEM;
+ if (uid != 0) {
+ if (in_tgroup) {
+ /* Tracing group */
+ ret = try_connect_sessiond(sessiond_sock_path);
+ if (ret >= 0) {
+ goto end;
}
+ /* Global session daemon not available... */
}
- } else {
- /* Not in tracing group and not root, default */
- if (snprintf(sessiond_sock_path, PATH_MAX,
- DEFAULT_HOME_CLIENT_UNIX_SOCK,
- getenv("HOME")) < 0) {
- return -ENOMEM;
+ /* ...or not in tracing group (and not root), default */
+
+ /*
+ * With GNU C < 2.1, snprintf returns -1 if the target buffer is too small;
+ * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
+ */
+ ret = snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
+ DEFAULT_HOME_CLIENT_UNIX_SOCK, getenv("HOME"));
+ if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) {
+ goto error;
}
}
-
+end:
return 0;
+
+error:
+ return -1;
}
/*
ret = set_session_daemon_path();
if (ret < 0) {
- return ret;
+ goto error;
}
/* Connect to the sesssion daemon */
ret = lttcomm_connect_unix_sock(sessiond_sock_path);
if (ret < 0) {
- return ret;
+ goto error;
}
sessiond_socket = ret;
connected = 1;
return 0;
+
+error:
+ return -1;
}
/*
- * Clean disconnect the session daemon.
+ * Clean disconnect from the session daemon.
+ * On success, return 0. On error, return -1.
*/
static int disconnect_sessiond(void)
{
/*
* Ask the session daemon a specific command and put the data into buf.
+ * Takes extra var. len. data as input to send to the session daemon.
*
- * Return size of data (only payload, not header).
+ * Return size of data (only payload, not header) or a negative error code.
*/
-static int ask_sessiond(struct lttcomm_session_msg *lsm, void **buf)
+static int ask_sessiond_varlen(struct lttcomm_session_msg *lsm,
+ void *vardata, size_t varlen, void **buf)
{
int ret;
size_t size;
ret = connect_sessiond();
if (ret < 0) {
+ ret = -LTTNG_ERR_NO_SESSIOND;
goto end;
}
/* Send command to session daemon */
ret = send_session_msg(lsm);
if (ret < 0) {
+ /* Ret value is a valid lttng error code. */
+ goto end;
+ }
+ /* Send var len data */
+ ret = send_session_varlen(vardata, varlen);
+ if (ret < 0) {
+ /* Ret value is a valid lttng error code. */
goto end;
}
/* Get header from data transmission */
ret = recv_data_sessiond(&llm, sizeof(llm));
if (ret < 0) {
+ /* Ret value is a valid lttng error code. */
goto end;
}
/* Check error code if OK */
- if (llm.ret_code != LTTCOMM_OK) {
+ if (llm.ret_code != LTTNG_OK) {
ret = -llm.ret_code;
goto end;
}
* this point, an error is returned and data is freed.
*/
if (buf == NULL) {
- ret = -1;
+ ret = -LTTNG_ERR_INVALID;
free(data);
goto end;
}
return ret;
}
+/*
+ * Ask the session daemon a specific command and put the data into buf.
+ *
+ * Return size of data (only payload, not header) or a negative error code.
+ */
+static int ask_sessiond(struct lttcomm_session_msg *lsm, void **buf)
+{
+ return ask_sessiond_varlen(lsm, NULL, 0, buf);
+}
+
/*
* Create lttng handle and return pointer.
+ * The returned pointer will be NULL in case of malloc() error.
*/
struct lttng_handle *lttng_create_handle(const char *session_name,
struct lttng_domain *domain)
{
- struct lttng_handle *handle;
+ struct lttng_handle *handle = NULL;
+
+ if (domain == NULL) {
+ goto end;
+ }
handle = malloc(sizeof(struct lttng_handle));
if (handle == NULL) {
- perror("malloc handle");
+ PERROR("malloc handle");
goto end;
}
/*
* Register an outside consumer.
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_register_consumer(struct lttng_handle *handle,
const char *socket_path)
{
struct lttcomm_session_msg lsm;
+ if (handle == NULL || socket_path == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
copy_string(lsm.session.name, handle->session_name,
sizeof(lsm.session.name));
}
/*
- * Start tracing for all trace of the session.
+ * Start tracing for all traces of the session.
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_start_tracing(const char *session_name)
{
struct lttcomm_session_msg lsm;
if (session_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_START_TRACE;
}
/*
- * Stop tracing for all trace of the session.
+ * Stop tracing for all traces of the session.
*/
-int lttng_stop_tracing(const char *session_name)
+static int _lttng_stop_tracing(const char *session_name, int wait)
{
+ int ret, data_ret;
struct lttcomm_session_msg lsm;
if (session_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_STOP_TRACE;
copy_string(lsm.session.name, session_name, sizeof(lsm.session.name));
- return ask_sessiond(&lsm, NULL);
+ ret = ask_sessiond(&lsm, NULL);
+ if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
+ goto error;
+ }
+
+ if (!wait) {
+ goto end;
+ }
+
+ _MSG("Waiting for data availability");
+
+ /* Check for data availability */
+ do {
+ data_ret = lttng_data_pending(session_name);
+ if (data_ret < 0) {
+ /* Return the data available call error. */
+ ret = data_ret;
+ goto error;
+ }
+
+ /*
+ * Data sleep time before retrying (in usec). Don't sleep if the call
+ * returned value indicates availability.
+ */
+ if (data_ret) {
+ usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME);
+ _MSG(".");
+ }
+ } while (data_ret != 0);
+
+ MSG("");
+
+end:
+error:
+ return ret;
}
/*
- * Add context to event or/and channel.
+ * Stop tracing and wait for data availability.
+ */
+int lttng_stop_tracing(const char *session_name)
+{
+ return _lttng_stop_tracing(session_name, 1);
+}
+
+/*
+ * Stop tracing but _don't_ wait for data availability.
+ */
+int lttng_stop_tracing_no_wait(const char *session_name)
+{
+ return _lttng_stop_tracing(session_name, 0);
+}
+
+/*
+ * Add context to a channel.
+ *
+ * If the given channel is NULL, add the contexts to all channels.
+ * The event_name param is ignored.
+ *
+ * Returns the size of the returned payload data or a negative error code.
*/
int lttng_add_context(struct lttng_handle *handle,
struct lttng_event_context *ctx, const char *event_name,
/* Safety check. Both are mandatory */
if (handle == NULL || ctx == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
+ memset(&lsm, 0, sizeof(lsm));
+
lsm.cmd_type = LTTNG_ADD_CONTEXT;
/* Copy channel name */
copy_string(lsm.u.context.channel_name, channel_name,
sizeof(lsm.u.context.channel_name));
- /* Copy event name */
- copy_string(lsm.u.context.event_name, event_name,
- sizeof(lsm.u.context.event_name));
copy_lttng_domain(&lsm.domain, &handle->domain);
}
/*
- * Enable event
+ * Enable event(s) for a channel.
+ * If no event name is specified, all events are enabled.
+ * If no channel name is specified, the default 'channel0' is used.
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_enable_event(struct lttng_handle *handle,
struct lttng_event *ev, const char *channel_name)
struct lttcomm_session_msg lsm;
if (handle == NULL || ev == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
+ memset(&lsm, 0, sizeof(lsm));
+
/* If no channel name, we put the default name */
if (channel_name == NULL) {
copy_string(lsm.u.enable.channel_name, DEFAULT_CHANNEL_NAME,
}
/*
- * Disable event of a channel and domain.
+ * Set filter for an event
+ *
+ * Return negative error value on error.
+ * Return size of returned session payload data if OK.
+ */
+int lttng_set_event_filter(struct lttng_handle *handle,
+ struct lttng_event *event, const char *channel_name,
+ const char *filter_expression)
+{
+ struct lttcomm_session_msg lsm;
+ struct filter_parser_ctx *ctx;
+ FILE *fmem;
+ int ret = 0;
+
+ /* Safety check. */
+ if (handle == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ if (!filter_expression) {
+ return 0;
+ }
+
+ /*
+ * casting const to non-const, as the underlying function will
+ * use it in read-only mode.
+ */
+ fmem = lttng_fmemopen((void *) filter_expression,
+ strlen(filter_expression), "r");
+ if (!fmem) {
+ fprintf(stderr, "Error opening memory as stream\n");
+ return -LTTNG_ERR_FILTER_NOMEM;
+ }
+ ctx = filter_parser_ctx_alloc(fmem);
+ if (!ctx) {
+ fprintf(stderr, "Error allocating parser\n");
+ ret = -LTTNG_ERR_FILTER_NOMEM;
+ goto alloc_error;
+ }
+ ret = filter_parser_ctx_append_ast(ctx);
+ if (ret) {
+ fprintf(stderr, "Parse error\n");
+ ret = -LTTNG_ERR_FILTER_INVAL;
+ goto parse_error;
+ }
+ ret = filter_visitor_set_parent(ctx);
+ if (ret) {
+ fprintf(stderr, "Set parent error\n");
+ ret = -LTTNG_ERR_FILTER_INVAL;
+ goto parse_error;
+ }
+ if (print_xml) {
+ ret = filter_visitor_print_xml(ctx, stdout, 0);
+ if (ret) {
+ fflush(stdout);
+ fprintf(stderr, "XML print error\n");
+ ret = -LTTNG_ERR_FILTER_INVAL;
+ goto parse_error;
+ }
+ }
+
+ dbg_printf("Generating IR... ");
+ fflush(stdout);
+ ret = filter_visitor_ir_generate(ctx);
+ if (ret) {
+ fprintf(stderr, "Generate IR error\n");
+ ret = -LTTNG_ERR_FILTER_INVAL;
+ goto parse_error;
+ }
+ dbg_printf("done\n");
+
+ dbg_printf("Validating IR... ");
+ fflush(stdout);
+ ret = filter_visitor_ir_check_binary_op_nesting(ctx);
+ if (ret) {
+ ret = -LTTNG_ERR_FILTER_INVAL;
+ goto parse_error;
+ }
+ dbg_printf("done\n");
+
+ dbg_printf("Generating bytecode... ");
+ fflush(stdout);
+ ret = filter_visitor_bytecode_generate(ctx);
+ if (ret) {
+ fprintf(stderr, "Generate bytecode error\n");
+ ret = -LTTNG_ERR_FILTER_INVAL;
+ goto parse_error;
+ }
+ dbg_printf("done\n");
+ dbg_printf("Size of bytecode generated: %u bytes.\n",
+ bytecode_get_len(&ctx->bytecode->b));
+
+ memset(&lsm, 0, sizeof(lsm));
+
+ lsm.cmd_type = LTTNG_SET_FILTER;
+
+ /* Copy channel name */
+ copy_string(lsm.u.filter.channel_name, channel_name,
+ sizeof(lsm.u.filter.channel_name));
+ /* Copy event name */
+ if (event) {
+ memcpy(&lsm.u.enable.event, event, sizeof(lsm.u.enable.event));
+ }
+
+ lsm.u.filter.bytecode_len = sizeof(ctx->bytecode->b)
+ + bytecode_get_len(&ctx->bytecode->b);
+
+ copy_lttng_domain(&lsm.domain, &handle->domain);
+
+ copy_string(lsm.session.name, handle->session_name,
+ sizeof(lsm.session.name));
+
+ ret = ask_sessiond_varlen(&lsm, &ctx->bytecode->b,
+ lsm.u.filter.bytecode_len, NULL);
+
+ filter_bytecode_free(ctx);
+ filter_ir_free(ctx);
+ filter_parser_ctx_free(ctx);
+ if (fclose(fmem) != 0) {
+ perror("fclose");
+ }
+ return ret;
+
+parse_error:
+ filter_bytecode_free(ctx);
+ filter_ir_free(ctx);
+ filter_parser_ctx_free(ctx);
+alloc_error:
+ if (fclose(fmem) != 0) {
+ perror("fclose");
+ }
+ return ret;
+}
+
+/*
+ * Disable event(s) of a channel and domain.
+ * If no event name is specified, all events are disabled.
+ * If no channel name is specified, the default 'channel0' is used.
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_disable_event(struct lttng_handle *handle, const char *name,
const char *channel_name)
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
+ memset(&lsm, 0, sizeof(lsm));
+
if (channel_name) {
copy_string(lsm.u.disable.channel_name, channel_name,
sizeof(lsm.u.disable.channel_name));
}
/*
- * Enable channel per domain
+ * Enable channel per domain
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_enable_channel(struct lttng_handle *handle,
struct lttng_channel *chan)
* NULL arguments are forbidden. No default values.
*/
if (handle == NULL || chan == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
+ memset(&lsm, 0, sizeof(lsm));
+
memcpy(&lsm.u.channel.chan, chan, sizeof(lsm.u.channel.chan));
lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
}
/*
- * All tracing will be stopped for registered events of the channel.
+ * All tracing will be stopped for registered events of the channel.
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_disable_channel(struct lttng_handle *handle, const char *name)
{
/* Safety check. Both are mandatory */
if (handle == NULL || name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
+ memset(&lsm, 0, sizeof(lsm));
+
lsm.cmd_type = LTTNG_DISABLE_CHANNEL;
copy_string(lsm.u.disable.channel_name, name,
}
/*
- * List all available tracepoints of domain.
- *
- * Return the size (bytes) of the list and set the events array.
- * On error, return negative value.
+ * Lists all available tracepoints of domain.
+ * Sets the contents of the events array.
+ * Returns the number of lttng_event entries in events;
+ * on error, returns a negative value.
*/
int lttng_list_tracepoints(struct lttng_handle *handle,
struct lttng_event **events)
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
}
/*
- * Return a human readable string of code
+ * Lists all available tracepoint fields of domain.
+ * Sets the contents of the event field array.
+ * Returns the number of lttng_event_field entries in events;
+ * on error, returns a negative value.
*/
-const char *lttng_strerror(int code)
+int lttng_list_tracepoint_fields(struct lttng_handle *handle,
+ struct lttng_event_field **fields)
{
- if (code > -LTTCOMM_OK) {
- return "Ended with errors";
+ int ret;
+ struct lttcomm_session_msg lsm;
+
+ if (handle == NULL) {
+ return -LTTNG_ERR_INVALID;
}
- return lttcomm_get_readable_code(code);
+ lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
+ copy_lttng_domain(&lsm.domain, &handle->domain);
+
+ ret = ask_sessiond(&lsm, (void **) fields);
+ if (ret < 0) {
+ return ret;
+ }
+
+ return ret / sizeof(struct lttng_event_field);
+}
+
+/*
+ * Returns a human readable string describing
+ * the error code (a negative value).
+ */
+const char *lttng_strerror(int code)
+{
+ return error_get_str(code);
}
/*
- * Create a brand new session using name.
+ * Create a brand new session using name and url for destination.
+ *
+ * Returns LTTNG_OK on success or a negative error code.
*/
-int lttng_create_session(const char *name, const char *path)
+int lttng_create_session(const char *name, const char *url)
{
+ ssize_t size;
struct lttcomm_session_msg lsm;
+ struct lttng_uri *uris = NULL;
+
+ if (name == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ memset(&lsm, 0, sizeof(lsm));
lsm.cmd_type = LTTNG_CREATE_SESSION;
copy_string(lsm.session.name, name, sizeof(lsm.session.name));
- copy_string(lsm.session.path, path, sizeof(lsm.session.path));
- return ask_sessiond(&lsm, NULL);
+ /* There should never be a data URL */
+ size = parse_str_urls_to_uri(url, NULL, &uris);
+ if (size < 0) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ lsm.u.uri.size = size;
+
+ return ask_sessiond_varlen(&lsm, uris, sizeof(struct lttng_uri) * size,
+ NULL);
}
/*
* Destroy session using name.
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_destroy_session(const char *session_name)
{
struct lttcomm_session_msg lsm;
if (session_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_DESTROY_SESSION;
/*
* Ask the session daemon for all available sessions.
- *
- * Return number of session.
- * On error, return negative value.
+ * Sets the contents of the sessions array.
+ * Returns the number of lttng_session entries in sessions;
+ * on error, returns a negative value.
*/
int lttng_list_sessions(struct lttng_session **sessions)
{
}
/*
- * List domain of a session.
+ * Ask the session daemon for all available domains of a session.
+ * Sets the contents of the domains array.
+ * Returns the number of lttng_domain entries in domains;
+ * on error, returns a negative value.
*/
int lttng_list_domains(const char *session_name,
struct lttng_domain **domains)
struct lttcomm_session_msg lsm;
if (session_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_DOMAINS;
}
/*
- * List channels of a session
+ * Ask the session daemon for all available channels of a session.
+ * Sets the contents of the channels array.
+ * Returns the number of lttng_channel entries in channels;
+ * on error, returns a negative value.
*/
int lttng_list_channels(struct lttng_handle *handle,
struct lttng_channel **channels)
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_CHANNELS;
}
/*
- * List events of a session channel.
+ * Ask the session daemon for all available events of a session channel.
+ * Sets the contents of the events array.
+ * Returns the number of lttng_event entries in events;
+ * on error, returns a negative value.
*/
int lttng_list_events(struct lttng_handle *handle,
const char *channel_name, struct lttng_event **events)
/* Safety check. An handle and channel name are mandatory */
if (handle == NULL || channel_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_EVENTS;
}
/*
- * Set tracing group variable with name. This function allocate memory pointed
- * by tracing_group.
+ * Sets the tracing_group variable with name.
+ * This function allocates memory pointed to by tracing_group.
+ * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
*/
int lttng_set_tracing_group(const char *name)
{
if (name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
if (asprintf(&tracing_group, "%s", name) < 0) {
- return -ENOMEM;
+ return -LTTNG_ERR_FATAL;
}
return 0;
}
/*
- * lttng_calibrate
+ * Returns size of returned session payload data or a negative error code.
*/
int lttng_calibrate(struct lttng_handle *handle,
struct lttng_calibrate *calibrate)
/* Safety check. NULL pointer are forbidden */
if (handle == NULL || calibrate == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_CALIBRATE;
/*
* Set default channel attributes.
+ * If either or both of the arguments are null, attr content is zeroe'd.
*/
void lttng_channel_set_default_attr(struct lttng_domain *domain,
struct lttng_channel_attr *attr)
return;
}
+ memset(attr, 0, sizeof(struct lttng_channel_attr));
+
switch (domain->type) {
case LTTNG_DOMAIN_KERNEL:
attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
attr->switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
attr->read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
- attr->subbuf_size = DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE;
+ attr->subbuf_size = default_get_kernel_channel_subbuf_size();
attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
break;
case LTTNG_DOMAIN_UST:
+#if 0
case LTTNG_DOMAIN_UST_EXEC_NAME:
case LTTNG_DOMAIN_UST_PID:
case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN:
+#endif
attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
attr->switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
attr->read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
- attr->subbuf_size = DEFAULT_UST_CHANNEL_SUBBUF_SIZE;
+ attr->subbuf_size = default_get_ust_channel_subbuf_size();
attr->num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM;
attr->output = DEFAULT_UST_CHANNEL_OUTPUT;
break;
default:
- /* Default behavior */
- memset(attr, 0, sizeof(struct lttng_channel_attr));
+ /* Default behavior: leave set to 0. */
break;
}
}
* Check if session daemon is alive.
*
* Return 1 if alive or 0 if not.
- * On error return -1
+ * On error returns a negative value.
*/
int lttng_session_daemon_alive(void)
{
}
if (strlen(sessiond_sock_path) == 0) {
- /* No socket path set. Weird error */
- return -1;
+ /*
+ * No socket path set. Weird error which means the constructor was not
+ * called.
+ */
+ assert(0);
}
ret = try_connect_sessiond(sessiond_sock_path);
return 1;
}
+/*
+ * Set URL for a consumer for a session and domain.
+ *
+ * Return 0 on success, else a negative value.
+ */
+int lttng_set_consumer_url(struct lttng_handle *handle,
+ const char *control_url, const char *data_url)
+{
+ ssize_t size;
+ struct lttcomm_session_msg lsm;
+ struct lttng_uri *uris = NULL;
+
+ if (handle == NULL || (control_url == NULL && data_url == NULL)) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ memset(&lsm, 0, sizeof(lsm));
+
+ lsm.cmd_type = LTTNG_SET_CONSUMER_URI;
+
+ copy_string(lsm.session.name, handle->session_name,
+ sizeof(lsm.session.name));
+ copy_lttng_domain(&lsm.domain, &handle->domain);
+
+ size = parse_str_urls_to_uri(control_url, data_url, &uris);
+ if (size < 0) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ lsm.u.uri.size = size;
+
+ return ask_sessiond_varlen(&lsm, uris, sizeof(struct lttng_uri) * size,
+ NULL);
+}
+
+/*
+ * Enable consumer for a session and domain.
+ *
+ * Return 0 on success, else a negative value.
+ */
+int lttng_enable_consumer(struct lttng_handle *handle)
+{
+ struct lttcomm_session_msg lsm;
+
+ if (handle == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ lsm.cmd_type = LTTNG_ENABLE_CONSUMER;
+
+ copy_string(lsm.session.name, handle->session_name,
+ sizeof(lsm.session.name));
+ copy_lttng_domain(&lsm.domain, &handle->domain);
+
+ return ask_sessiond(&lsm, NULL);
+}
+
+/*
+ * Disable consumer for a session and domain.
+ *
+ * Return 0 on success, else a negative value.
+ */
+int lttng_disable_consumer(struct lttng_handle *handle)
+{
+ struct lttcomm_session_msg lsm;
+
+ if (handle == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ lsm.cmd_type = LTTNG_DISABLE_CONSUMER;
+
+ copy_string(lsm.session.name, handle->session_name,
+ sizeof(lsm.session.name));
+ copy_lttng_domain(&lsm.domain, &handle->domain);
+
+ return ask_sessiond(&lsm, NULL);
+}
+
+/*
+ * Set health socket path by putting it in the global health_sock_path
+ * variable.
+ *
+ * Returns 0 on success or assert(0) on ENOMEM.
+ */
+static int set_health_socket_path(void)
+{
+ int ret;
+ int in_tgroup = 0; /* In tracing group */
+ uid_t uid;
+ const char *home;
+
+ uid = getuid();
+
+ if (uid != 0) {
+ /* Are we in the tracing group ? */
+ in_tgroup = check_tracing_group(tracing_group);
+ }
+
+ if ((uid == 0) || in_tgroup) {
+ copy_string(health_sock_path, DEFAULT_GLOBAL_HEALTH_UNIX_SOCK,
+ sizeof(health_sock_path));
+ }
+
+ if (uid != 0) {
+ /*
+ * With GNU C < 2.1, snprintf returns -1 if the target buffer is too small;
+ * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
+ */
+ home = getenv("HOME");
+ if (home == NULL) {
+ /* Fallback in /tmp .. */
+ home = "/tmp";
+ }
+
+ ret = snprintf(health_sock_path, sizeof(health_sock_path),
+ DEFAULT_HOME_HEALTH_UNIX_SOCK, home);
+ if ((ret < 0) || (ret >= sizeof(health_sock_path))) {
+ /* ENOMEM at this point... just kill the control lib. */
+ assert(0);
+ }
+ }
+
+ return 0;
+}
+
+/*
+ * Check session daemon health for a specific health component.
+ *
+ * Return 0 if health is OK or else 1 if BAD.
+ *
+ * Any other negative value is a lttng error code which can be translated with
+ * lttng_strerror().
+ */
+int lttng_health_check(enum lttng_health_component c)
+{
+ int sock, ret;
+ struct lttcomm_health_msg msg;
+ struct lttcomm_health_data reply;
+
+ /* Connect to the sesssion daemon */
+ sock = lttcomm_connect_unix_sock(health_sock_path);
+ if (sock < 0) {
+ ret = -LTTNG_ERR_NO_SESSIOND;
+ goto error;
+ }
+
+ msg.cmd = LTTNG_HEALTH_CHECK;
+ msg.component = c;
+
+ ret = lttcomm_send_unix_sock(sock, (void *)&msg, sizeof(msg));
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ goto close_error;
+ }
+
+ ret = lttcomm_recv_unix_sock(sock, (void *)&reply, sizeof(reply));
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ goto close_error;
+ }
+
+ ret = reply.ret_code;
+
+close_error:
+ close(sock);
+
+error:
+ return ret;
+}
+
+/*
+ * This is an extension of create session that is ONLY and SHOULD only be used
+ * by the lttng command line program. It exists to avoid using URI parsing in
+ * the lttng client.
+ *
+ * We need the date and time for the trace path subdirectory for the case where
+ * the user does NOT define one using either -o or -U. Using the normal
+ * lttng_create_session API call, we have no clue on the session daemon side if
+ * the URL was generated automatically by the client or define by the user.
+ *
+ * So this function "wrapper" is hidden from the public API, takes the datetime
+ * string and appends it if necessary to the URI subdirectory before sending it
+ * to the session daemon.
+ *
+ * With this extra function, the lttng_create_session call behavior is not
+ * changed and the timestamp is appended to the URI on the session daemon side
+ * if necessary.
+ */
+int _lttng_create_session_ext(const char *name, const char *url,
+ const char *datetime)
+{
+ int ret;
+ ssize_t size;
+ struct lttcomm_session_msg lsm;
+ struct lttng_uri *uris = NULL;
+
+ if (name == NULL || datetime == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ memset(&lsm, 0, sizeof(lsm));
+
+ lsm.cmd_type = LTTNG_CREATE_SESSION;
+ copy_string(lsm.session.name, name, sizeof(lsm.session.name));
+
+ /* There should never be a data URL */
+ size = parse_str_urls_to_uri(url, NULL, &uris);
+ if (size < 0) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ lsm.u.uri.size = size;
+
+ if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
+ ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s", name,
+ datetime);
+ if (ret < 0) {
+ PERROR("snprintf uri subdir");
+ return -LTTNG_ERR_FATAL;
+ }
+ }
+
+ return ask_sessiond_varlen(&lsm, uris, sizeof(struct lttng_uri) * size,
+ NULL);
+}
+
+/*
+ * For a given session name, this call checks if the data is ready to be read
+ * or is still being extracted by the consumer(s) hence not ready to be used by
+ * any readers.
+ */
+int lttng_data_pending(const char *session_name)
+{
+ int ret;
+ struct lttcomm_session_msg lsm;
+
+ if (session_name == NULL) {
+ return -LTTNG_ERR_INVALID;
+ }
+
+ lsm.cmd_type = LTTNG_DATA_PENDING;
+
+ copy_string(lsm.session.name, session_name, sizeof(lsm.session.name));
+
+ ret = ask_sessiond(&lsm, NULL);
+
+ /*
+ * The ask_sessiond function negate the return code if it's not LTTNG_OK so
+ * getting -1 means that the reply ret_code was 1 thus meaning that the
+ * data is available. Yes it is hackish but for now this is the only way.
+ */
+ if (ret == -1) {
+ ret = 1;
+ }
+
+ return ret;
+}
+
/*
* lib constructor
*/
static void __attribute__((constructor)) init()
{
/* Set default session group */
- lttng_set_tracing_group(LTTNG_DEFAULT_TRACING_GROUP);
+ lttng_set_tracing_group(DEFAULT_TRACING_GROUP);
+ /* Set socket for health check */
+ (void) set_health_socket_path();
+}
+
+/*
+ * lib destructor
+ */
+static void __attribute__((destructor)) lttng_ctl_exit()
+{
+ free(tracing_group);
}
projects / lttng-tools.git / blobdiff