#include <common/uri.h>
#include <lttng/lttng.h>
-#include "filter-ast.h"
-#include "filter-parser.h"
-#include "filter-bytecode.h"
-#include "memstream.h"
+#include "filter/filter-ast.h"
+#include "filter/filter-parser.h"
+#include "filter/filter-bytecode.h"
+#include "filter/memstream.h"
#ifdef DEBUG
-const int print_xml = 1;
+static const int print_xml = 1;
#define dbg_printf(fmt, args...) \
printf("[debug liblttng-ctl] " fmt, ## args)
#else
-const int print_xml = 0;
+static const int print_xml = 0;
#define dbg_printf(fmt, args...) \
do { \
/* do nothing but check printf format */ \
* 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.
- *
- * Note that it is *not* possible to silent ERR() and PERROR() macros.
*/
int lttng_opt_quiet;
int lttng_opt_verbose;
int ret;
if (!connected) {
- ret = -ENOTCONN;
+ ret = -LTTNG_ERR_NO_SESSIOND;
goto end;
}
ret = lttcomm_send_creds_unix_sock(sessiond_socket, lsm,
sizeof(struct lttcomm_session_msg));
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ }
end:
return ret;
int ret;
if (!connected) {
- ret = -ENOTCONN;
+ ret = -LTTNG_ERR_NO_SESSIOND;
goto end;
}
}
ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
+ if (ret < 0) {
+ ret = -LTTNG_ERR_FATAL;
+ }
end:
return ret;
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;
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,
- * -ENOMEM on failure (the sessiond socket path is somehow too long)
+ * 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)
{
ret = snprintf(sessiond_sock_path, sizeof(sessiond_sock_path),
DEFAULT_HOME_CLIENT_UNIX_SOCK, getenv("HOME"));
if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) {
- return -ENOMEM;
+ goto error;
}
}
end:
return 0;
+
+error:
+ return -1;
}
/*
ret = set_session_daemon_path();
if (ret < 0) {
- return -1; /* set_session_daemon_path() returns -ENOMEM */
+ 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;
}
/*
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;
}
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;
}
{
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));
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 traces of the session.
- * Returns size of returned session payload data or a negative error code.
+ * 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 and/or channel.
- * If event_name is NULL, the context is applied to all events of the channel.
- * If channel_name is NULL, a lookup of the event's channel is done.
- * If both are NULL, the context is applied to all events of all channels.
+ * 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.
*/
/* Safety check. Both are mandatory */
if (handle == NULL || ctx == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
/* 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);
struct lttcomm_session_msg lsm;
if (handle == NULL || ev == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
}
/*
- * set filter for an event
+ * Create or enable an event with a filter expression.
+ *
* Return negative error value on error.
* Return size of returned session payload data if OK.
*/
-
-int lttng_set_event_filter(struct lttng_handle *handle,
- const char *event_name, const char *channel_name,
+int lttng_enable_event_with_filter(struct lttng_handle *handle,
+ struct lttng_event *event, const char *channel_name,
const char *filter_expression)
{
struct lttcomm_session_msg lsm;
FILE *fmem;
int ret = 0;
- /* Safety check. */
- if (handle == NULL) {
- return -1;
+ if (!filter_expression) {
+ /*
+ * Fall back to normal event enabling if no filter
+ * specified.
+ */
+ return lttng_enable_event(handle, event, channel_name);
}
- if (!filter_expression) {
- return 0;
+ /*
+ * Empty filter string will always be rejected by the parser
+ * anyway, so treat this corner-case early to eliminate
+ * lttng_fmemopen error for 0-byte allocation.
+ */
+ if (handle == NULL || filter_expression[0] == '\0') {
+ return -LTTNG_ERR_INVALID;
}
/*
strlen(filter_expression), "r");
if (!fmem) {
fprintf(stderr, "Error opening memory as stream\n");
- return -ENOMEM;
+ return -LTTNG_ERR_FILTER_NOMEM;
}
ctx = filter_parser_ctx_alloc(fmem);
if (!ctx) {
fprintf(stderr, "Error allocating parser\n");
- ret = -ENOMEM;
+ ret = -LTTNG_ERR_FILTER_NOMEM;
goto alloc_error;
}
ret = filter_parser_ctx_append_ast(ctx);
if (ret) {
fprintf(stderr, "Parse error\n");
- ret = -EINVAL;
+ ret = -LTTNG_ERR_FILTER_INVAL;
goto parse_error;
}
ret = filter_visitor_set_parent(ctx);
if (ret) {
fprintf(stderr, "Set parent error\n");
- ret = -EINVAL;
+ ret = -LTTNG_ERR_FILTER_INVAL;
goto parse_error;
}
if (print_xml) {
if (ret) {
fflush(stdout);
fprintf(stderr, "XML print error\n");
- ret = -EINVAL;
+ ret = -LTTNG_ERR_FILTER_INVAL;
goto parse_error;
}
}
ret = filter_visitor_ir_generate(ctx);
if (ret) {
fprintf(stderr, "Generate IR error\n");
- ret = -EINVAL;
+ ret = -LTTNG_ERR_FILTER_INVAL;
goto parse_error;
}
dbg_printf("done\n");
fflush(stdout);
ret = filter_visitor_ir_check_binary_op_nesting(ctx);
if (ret) {
- ret = -EINVAL;
+ ret = -LTTNG_ERR_FILTER_INVAL;
goto parse_error;
}
dbg_printf("done\n");
ret = filter_visitor_bytecode_generate(ctx);
if (ret) {
fprintf(stderr, "Generate bytecode error\n");
- ret = -EINVAL;
+ ret = -LTTNG_ERR_FILTER_INVAL;
goto parse_error;
}
dbg_printf("done\n");
memset(&lsm, 0, sizeof(lsm));
- lsm.cmd_type = LTTNG_SET_FILTER;
+ lsm.cmd_type = LTTNG_ENABLE_EVENT_WITH_FILTER;
/* Copy channel name */
- copy_string(lsm.u.filter.channel_name, channel_name,
- sizeof(lsm.u.filter.channel_name));
+ copy_string(lsm.u.enable.channel_name, channel_name,
+ sizeof(lsm.u.enable.channel_name));
/* Copy event name */
- copy_string(lsm.u.filter.event_name, event_name,
- sizeof(lsm.u.filter.event_name));
- lsm.u.filter.bytecode_len = sizeof(ctx->bytecode->b)
+ if (event) {
+ memcpy(&lsm.u.enable.event, event, sizeof(lsm.u.enable.event));
+ }
+
+ lsm.u.enable.bytecode_len = sizeof(ctx->bytecode->b)
+ bytecode_get_len(&ctx->bytecode->b);
copy_lttng_domain(&lsm.domain, &handle->domain);
sizeof(lsm.session.name));
ret = ask_sessiond_varlen(&lsm, &ctx->bytecode->b,
- lsm.u.filter.bytecode_len, NULL);
+ lsm.u.enable.bytecode_len, NULL);
filter_bytecode_free(ctx);
filter_ir_free(ctx);
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
* NULL arguments are forbidden. No default values.
*/
if (handle == NULL || chan == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
/* Safety check. Both are mandatory */
if (handle == NULL || name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
*/
const char *lttng_strerror(int code)
{
- /* lttcomm error codes range from -LTTCOMM_OK down to -LTTCOMM_NR */
- if (code > -LTTCOMM_OK) {
- return "Ended with errors";
- }
-
- return lttcomm_get_readable_code(code);
+ return error_get_str(code);
}
/*
* Create a brand new session using name and url for destination.
*
- * Returns LTTCOMM_OK on success or a negative error code.
+ * Returns LTTNG_OK on success or a negative error code.
*/
int lttng_create_session(const char *name, const char *url)
{
struct lttng_uri *uris = NULL;
if (name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
/* There should never be a data URL */
size = parse_str_urls_to_uri(url, NULL, &uris);
if (size < 0) {
- return LTTCOMM_INVALID;
+ return -LTTNG_ERR_INVALID;
}
lsm.u.uri.size = size;
struct lttcomm_session_msg lsm;
if (session_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_DESTROY_SESSION;
struct lttcomm_session_msg lsm;
if (session_name == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_DOMAINS;
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_LIST_CHANNELS;
/* 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;
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;
/* Safety check. NULL pointer are forbidden */
if (handle == NULL || calibrate == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_CALIBRATE;
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;
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;
}
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);
struct lttng_uri *uris = NULL;
if (handle == NULL || (control_url == NULL && data_url == NULL)) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
size = parse_str_urls_to_uri(control_url, data_url, &uris);
if (size < 0) {
- return LTTCOMM_INVALID;
+ return -LTTNG_ERR_INVALID;
}
lsm.u.uri.size = size;
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_ENABLE_CONSUMER;
struct lttcomm_session_msg lsm;
if (handle == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
lsm.cmd_type = LTTNG_DISABLE_CONSUMER;
/*
* Check session daemon health for a specific health component.
*
- * Return 0 if health is OK or else 1 if BAD. A return value of -1 indicate
- * that the control library was not able to connect to the session daemon
- * health socket.
+ * Return 0 if health is OK or else 1 if BAD.
*
- * Any other positive value is an lttcomm error which can be translate with
+ * 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)
/* Connect to the sesssion daemon */
sock = lttcomm_connect_unix_sock(health_sock_path);
if (sock < 0) {
- ret = -1;
+ ret = -LTTNG_ERR_NO_SESSIOND;
goto error;
}
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;
}
struct lttng_uri *uris = NULL;
if (name == NULL || datetime == NULL) {
- return -1;
+ return -LTTNG_ERR_INVALID;
}
memset(&lsm, 0, sizeof(lsm));
lsm.cmd_type = LTTNG_CREATE_SESSION;
- if (!strncmp(name, DEFAULT_SESSION_NAME, strlen(DEFAULT_SESSION_NAME))) {
- ret = snprintf(lsm.session.name, sizeof(lsm.session.name), "%s-%s",
- name, datetime);
- if (ret < 0) {
- PERROR("snprintf session name datetime");
- return -1;
- }
- } else {
- copy_string(lsm.session.name, name, sizeof(lsm.session.name));
- }
+ 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 LTTCOMM_INVALID;
+ return -LTTNG_ERR_INVALID;
}
lsm.u.uri.size = size;
- if (uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) {
+ 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 -1;
+ return -LTTNG_ERR_FATAL;
}
}
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
*/
/* Set socket for health check */
(void) set_health_socket_path();
}
+
+/*
+ * lib destructor
+ */
+static void __attribute__((destructor)) lttng_ctl_exit()
+{
+ free(tracing_group);
+}