X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Flib%2Flttng-ctl%2Flttng-ctl.c;h=03b74c0b74771a9d0be8158f152a617123799c47;hp=edaebf59c8654515ac7872d0888e4a84dd6ab0ad;hb=2001793c1141e89b34e70efb28b27ec0cc8e6d47;hpb=2f70b271351fe2b7befc4e327503f7c13a57dcd5 diff --git a/src/lib/lttng-ctl/lttng-ctl.c b/src/lib/lttng-ctl/lttng-ctl.c index edaebf59c..03b74c0b7 100644 --- a/src/lib/lttng-ctl/lttng-ctl.c +++ b/src/lib/lttng-ctl/lttng-ctl.c @@ -4,6 +4,7 @@ * Linux Trace Toolkit Control Library * * Copyright (C) 2011 David Goulet + * Copyright (C) 2016 - Jérémie Galarneau * * 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, @@ -19,7 +20,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#define _GNU_SOURCE +#define _LGPL_SOURCE #include #include #include @@ -32,12 +33,15 @@ #include #include #include +#include #include +#include #include "filter/filter-ast.h" #include "filter/filter-parser.h" #include "filter/filter-bytecode.h" #include "filter/memstream.h" +#include "lttng-ctl-helper.h" #ifdef DEBUG static const int print_xml = 1; @@ -57,7 +61,6 @@ do { \ /* 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; @@ -69,144 +72,16 @@ static int connected; * 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; - -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; -} +int lttng_opt_mi; /* * Copy string from src to dst and enforce null terminated byte. */ -static void copy_string(char *dst, const char *src, size_t len) +LTTNG_HIDDEN +void lttng_ctl_copy_string(char *dst, const char *src, size_t len) { if (src && dst) { strncpy(dst, src, len); @@ -222,17 +97,17 @@ static void copy_string(char *dst, const char *src, size_t len) * * If domain is unknown, default domain will be the kernel. */ -static void copy_lttng_domain(struct lttng_domain *dst, struct lttng_domain *src) +LTTNG_HIDDEN +void lttng_ctl_copy_lttng_domain(struct lttng_domain *dst, + struct lttng_domain *src) { 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: - */ + case LTTNG_DOMAIN_JUL: + case LTTNG_DOMAIN_LOG4J: + case LTTNG_DOMAIN_PYTHON: memcpy(dst, src, sizeof(struct lttng_domain)); break; default: @@ -323,16 +198,18 @@ end: } /* - * Check if we are in the specified group. + * Check if we are in the specified group. * - * If yes return 1, else return -1. + * If yes return 1, else return -1. */ -static int check_tracing_group(const char *grp_name) +LTTNG_HIDDEN +int lttng_check_tracing_group(void) { struct group *grp_tracing; /* no free(). See getgrnam(3) */ gid_t *grp_list; int grp_list_size, grp_id, i; int ret = -1; + const char *grp_name = tracing_group; /* Get GID of group 'tracing' */ grp_tracing = getgrnam(grp_name); @@ -344,19 +221,19 @@ static int check_tracing_group(const char *grp_name) /* Get number of supplementary group IDs */ grp_list_size = getgroups(0, NULL); if (grp_list_size < 0) { - perror("getgroups"); + PERROR("getgroups"); goto end; } /* Alloc group list of the right size */ - grp_list = malloc(grp_list_size * sizeof(gid_t)); + grp_list = zmalloc(grp_list_size * sizeof(gid_t)); if (!grp_list) { - perror("malloc"); + PERROR("malloc"); goto end; } grp_id = getgroups(grp_list_size, grp_list); if (grp_id < 0) { - perror("getgroups"); + PERROR("getgroups"); goto free_list; } @@ -392,13 +269,13 @@ static int try_connect_sessiond(const char *sock_path) ret = lttcomm_connect_unix_sock(sock_path); if (ret < 0) { - /* Not alive */ + /* Not alive. */ goto error; } ret = lttcomm_close_unix_sock(ret); if (ret < 0) { - perror("lttcomm_close_unix_sock"); + PERROR("lttcomm_close_unix_sock"); } return 0; @@ -416,25 +293,26 @@ error: */ static int set_session_daemon_path(void) { - int ret; - int in_tgroup = 0; /* In tracing group */ + int in_tgroup = 0; /* In tracing group. */ uid_t uid; uid = getuid(); if (uid != 0) { /* Are we in the tracing group ? */ - in_tgroup = check_tracing_group(tracing_group); + in_tgroup = lttng_check_tracing_group(); } if ((uid == 0) || in_tgroup) { - copy_string(sessiond_sock_path, DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, - sizeof(sessiond_sock_path)); + lttng_ctl_copy_string(sessiond_sock_path, + DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, sizeof(sessiond_sock_path)); } if (uid != 0) { + int ret; + if (in_tgroup) { - /* Tracing group */ + /* Tracing group. */ ret = try_connect_sessiond(sessiond_sock_path); if (ret >= 0) { goto end; @@ -444,11 +322,13 @@ static int set_session_daemon_path(void) /* ...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) + * 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")); + DEFAULT_HOME_CLIENT_UNIX_SOCK, utils_get_home_dir()); if ((ret < 0) || (ret >= sizeof(sessiond_sock_path))) { goto error; } @@ -461,20 +341,25 @@ error: } /* - * Connect to the LTTng session daemon. + * Connect to the LTTng session daemon. * - * On success, return 0. On error, return -1. + * On success, return 0. On error, return -1. */ static int connect_sessiond(void) { int ret; + /* Don't try to connect if already connected. */ + if (connected) { + return 0; + } + ret = set_session_daemon_path(); if (ret < 0) { goto error; } - /* Connect to the sesssion daemon */ + /* Connect to the sesssion daemon. */ ret = lttcomm_connect_unix_sock(sessiond_sock_path); if (ret < 0) { goto error; @@ -491,6 +376,7 @@ error: /* * Clean disconnect from the session daemon. + * * On success, return 0. On error, return -1. */ static int disconnect_sessiond(void) @@ -512,7 +398,8 @@ static int disconnect_sessiond(void) * * Return size of data (only payload, not header) or a negative error code. */ -static int ask_sessiond_varlen(struct lttcomm_session_msg *lsm, +LTTNG_HIDDEN +int lttng_ctl_ask_sessiond_varlen(struct lttcomm_session_msg *lsm, void *vardata, size_t varlen, void **buf) { int ret; @@ -562,7 +449,11 @@ static int ask_sessiond_varlen(struct lttcomm_session_msg *lsm, goto end; } - data = (void*) malloc(size); + data = zmalloc(size); + if (!data) { + ret = -ENOMEM; + goto end; + } /* Get payload data */ ret = recv_data_sessiond(data, size); @@ -589,18 +480,9 @@ 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, @@ -612,18 +494,18 @@ struct lttng_handle *lttng_create_handle(const char *session_name, goto end; } - handle = malloc(sizeof(struct lttng_handle)); + handle = zmalloc(sizeof(struct lttng_handle)); if (handle == NULL) { PERROR("malloc handle"); goto end; } /* Copy session name */ - copy_string(handle->session_name, session_name, + lttng_ctl_copy_string(handle->session_name, session_name, sizeof(handle->session_name)); /* Copy lttng domain */ - copy_lttng_domain(&handle->domain, domain); + lttng_ctl_copy_lttng_domain(&handle->domain, domain); end: return handle; @@ -634,13 +516,12 @@ end: */ void lttng_destroy_handle(struct lttng_handle *handle) { - if (handle) { - free(handle); - } + free(handle); } /* * Register an outside consumer. + * * Returns size of returned session payload data or a negative error code. */ int lttng_register_consumer(struct lttng_handle *handle, @@ -652,19 +533,22 @@ int lttng_register_consumer(struct lttng_handle *handle, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_REGISTER_CONSUMER; - copy_string(lsm.session.name, handle->session_name, + lttng_ctl_copy_string(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - copy_string(lsm.u.reg.path, socket_path, sizeof(lsm.u.reg.path)); + lttng_ctl_copy_string(lsm.u.reg.path, socket_path, + sizeof(lsm.u.reg.path)); - return ask_sessiond(&lsm, NULL); + return lttng_ctl_ask_sessiond(&lsm, NULL); } /* - * Start tracing for all traces of the session. - * Returns size of returned session payload data or a negative error code. + * 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) { @@ -674,37 +558,86 @@ int lttng_start_tracing(const char *session_name) return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_START_TRACE; - copy_string(lsm.session.name, session_name, sizeof(lsm.session.name)); + lttng_ctl_copy_string(lsm.session.name, session_name, + sizeof(lsm.session.name)); - return ask_sessiond(&lsm, NULL); + return lttng_ctl_ask_sessiond(&lsm, NULL); } /* - * 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 -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_STOP_TRACE; - copy_string(lsm.session.name, session_name, sizeof(lsm.session.name)); + lttng_ctl_copy_string(lsm.session.name, session_name, + sizeof(lsm.session.name)); + + ret = lttng_ctl_ask_sessiond(&lsm, NULL); + if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) { + goto error; + } + + if (!wait) { + goto end; + } + + /* 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); + } + } while (data_ret != 0); + +end: +error: + return ret; +} + +/* + * Stop tracing and wait for data availability. + */ +int lttng_stop_tracing(const char *session_name) +{ + return _lttng_stop_tracing(session_name, 1); +} - return ask_sessiond(&lsm, NULL); +/* + * 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 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. + * 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. */ @@ -712,114 +645,204 @@ int lttng_add_context(struct lttng_handle *handle, struct lttng_event_context *ctx, const char *event_name, const char *channel_name) { + int ret; + size_t len = 0; + char *buf = NULL; struct lttcomm_session_msg lsm; - /* Safety check. Both are mandatory */ + /* Safety check. Both are mandatory. */ if (handle == NULL || ctx == NULL) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto end; } 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)); + /* If no channel name, send empty string. */ + if (channel_name == NULL) { + lttng_ctl_copy_string(lsm.u.context.channel_name, "", + sizeof(lsm.u.context.channel_name)); + } else { + lttng_ctl_copy_string(lsm.u.context.channel_name, channel_name, + sizeof(lsm.u.context.channel_name)); + } + + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_string(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) { + size_t provider_len, ctx_len; + const char *provider_name = ctx->u.app_ctx.provider_name; + const char *ctx_name = ctx->u.app_ctx.ctx_name; - memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context)); + if (!provider_name || !ctx_name) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); + provider_len = strlen(provider_name); + if (provider_len == 0) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + lsm.u.context.provider_name_len = provider_len; + + ctx_len = strlen(ctx_name); + if (ctx_len == 0) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + lsm.u.context.context_name_len = ctx_len; + + len = provider_len + ctx_len; + buf = zmalloc(len); + if (!buf) { + ret = -LTTNG_ERR_NOMEM; + goto end; + } + + memcpy(buf, provider_name, provider_len); + memcpy(buf + provider_len, ctx_name, ctx_len); + } + memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context)); + /* Don't leak application addresses to the sessiond. */ + lsm.u.context.ctx.u.app_ctx.provider_name = NULL; + lsm.u.context.ctx.u.app_ctx.ctx_name = NULL; - return ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond_varlen(&lsm, buf, len, NULL); +end: + free(buf); + return ret; } /* - * 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. + * 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; + return lttng_enable_event_with_exclusions(handle, ev, channel_name, + NULL, 0, NULL); +} - if (handle == NULL || ev == NULL) { - return -LTTNG_ERR_INVALID; +/* + * 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_enable_event_with_filter(struct lttng_handle *handle, + struct lttng_event *event, const char *channel_name, + const char *filter_expression) +{ + return lttng_enable_event_with_exclusions(handle, event, channel_name, + filter_expression, 0, NULL); +} + +/* + * Depending on the event, return a newly allocated agent filter expression or + * NULL if not applicable. + * + * An event with NO loglevel and the name is * will return NULL. + */ +static char *set_agent_filter(const char *filter, struct lttng_event *ev) +{ + int err; + char *agent_filter = NULL; + + assert(ev); + + /* Don't add filter for the '*' event. */ + if (ev->name[0] != '*') { + if (filter) { + err = asprintf(&agent_filter, "(%s) && (logger_name == \"%s\")", filter, + ev->name); + } else { + err = asprintf(&agent_filter, "logger_name == \"%s\"", ev->name); + } + if (err < 0) { + PERROR("asprintf"); + goto error; + } } - memset(&lsm, 0, sizeof(lsm)); + /* Add loglevel filtering if any for the JUL domain. */ + if (ev->loglevel_type != LTTNG_EVENT_LOGLEVEL_ALL) { + char *op; - /* If no channel name, we put the default name */ - if (channel_name == NULL) { - copy_string(lsm.u.enable.channel_name, DEFAULT_CHANNEL_NAME, - sizeof(lsm.u.enable.channel_name)); - } else { - copy_string(lsm.u.enable.channel_name, channel_name, - sizeof(lsm.u.enable.channel_name)); - } + if (ev->loglevel_type == LTTNG_EVENT_LOGLEVEL_RANGE) { + op = ">="; + } else { + op = "=="; + } - copy_lttng_domain(&lsm.domain, &handle->domain); + if (filter || agent_filter) { + char *new_filter; - if (ev->name[0] != '\0') { - lsm.cmd_type = LTTNG_ENABLE_EVENT; - } else { - lsm.cmd_type = LTTNG_ENABLE_ALL_EVENT; + err = asprintf(&new_filter, "(%s) && (int_loglevel %s %d)", + agent_filter ? agent_filter : filter, op, + ev->loglevel); + if (agent_filter) { + free(agent_filter); + } + agent_filter = new_filter; + } else { + err = asprintf(&agent_filter, "int_loglevel %s %d", op, + ev->loglevel); + } + if (err < 0) { + PERROR("asprintf"); + goto error; + } } - memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event)); - - copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); - return ask_sessiond(&lsm, NULL); + return agent_filter; +error: + free(agent_filter); + return NULL; } /* - * set filter for an event - * Return negative error value on error. - * Return size of returned session payload data if OK. + * Generate the filter bytecode from a given filter expression string. Put the + * newly allocated parser context in ctxp and populate the lsm object with the + * expression len. + * + * Return 0 on success else a LTTNG_ERR_* code and ctxp is untouched. */ - -int lttng_set_event_filter(struct lttng_handle *handle, - const char *event_name, const char *channel_name, - const char *filter_expression) +static int generate_filter(char *filter_expression, + struct lttcomm_session_msg *lsm, struct filter_parser_ctx **ctxp) { - struct lttcomm_session_msg lsm; - struct filter_parser_ctx *ctx; - FILE *fmem; - int ret = 0; - - /* Safety check. */ - if (handle == NULL) { - return -LTTNG_ERR_INVALID; - } + int ret; + struct filter_parser_ctx *ctx = NULL; + FILE *fmem = NULL; - if (!filter_expression) { - return 0; - } + assert(filter_expression); + assert(lsm); + assert(ctxp); /* - * casting const to non-const, as the underlying function will - * use it in read-only mode. + * 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; + ret = -LTTNG_ERR_FILTER_NOMEM; + goto error; } ctx = filter_parser_ctx_alloc(fmem); if (!ctx) { fprintf(stderr, "Error allocating parser\n"); ret = -LTTNG_ERR_FILTER_NOMEM; - goto alloc_error; + goto filter_alloc_error; } ret = filter_parser_ctx_append_ast(ctx); if (ret) { @@ -860,6 +883,12 @@ int lttng_set_event_filter(struct lttng_handle *handle, ret = -LTTNG_ERR_FILTER_INVAL; goto parse_error; } + /* Validate strings used as literals in the expression. */ + ret = filter_visitor_ir_validate_string(ctx); + if (ret) { + ret = -LTTNG_ERR_FILTER_INVAL; + goto parse_error; + } dbg_printf("done\n"); dbg_printf("Generating bytecode... "); @@ -872,127 +901,425 @@ int lttng_set_event_filter(struct lttng_handle *handle, } 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; + bytecode_get_len(&ctx->bytecode->b)); - /* Copy channel name */ - copy_string(lsm.u.filter.channel_name, channel_name, - sizeof(lsm.u.filter.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) - + bytecode_get_len(&ctx->bytecode->b); + lsm->u.enable.bytecode_len = sizeof(ctx->bytecode->b) + + bytecode_get_len(&ctx->bytecode->b); + lsm->u.enable.expression_len = strlen(filter_expression) + 1; - 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); + /* No need to keep the memory stream. */ if (fclose(fmem) != 0) { - perror("fclose"); + PERROR("fclose"); } - return ret; + + *ctxp = ctx; + return 0; parse_error: - filter_bytecode_free(ctx); filter_ir_free(ctx); filter_parser_ctx_free(ctx); -alloc_error: +filter_alloc_error: if (fclose(fmem) != 0) { - perror("fclose"); + PERROR("fclose"); } +error: 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. + * Enable event(s) for a channel, possibly with exclusions and a filter. + * If no event name is specified, all events are enabled. + * If no channel name is specified, the default name is used. + * If filter expression is not NULL, the filter is set for the event. + * If exclusion count is not zero, the exclusions are set for the event. + * 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) +int lttng_enable_event_with_exclusions(struct lttng_handle *handle, + struct lttng_event *ev, const char *channel_name, + const char *original_filter_expression, + int exclusion_count, char **exclusion_list) { struct lttcomm_session_msg lsm; + char *varlen_data; + int ret = 0; + unsigned int free_filter_expression = 0; + struct filter_parser_ctx *ctx = NULL; + /* + * Cast as non-const since we may replace the filter expression + * by a dynamically allocated string. Otherwise, the original + * string is not modified. + */ + char *filter_expression = (char *) original_filter_expression; - if (handle == NULL) { - return -LTTNG_ERR_INVALID; + if (handle == NULL || ev == NULL) { + ret = -LTTNG_ERR_INVALID; + goto error; } - memset(&lsm, 0, sizeof(lsm)); - - if (channel_name) { - copy_string(lsm.u.disable.channel_name, channel_name, - sizeof(lsm.u.disable.channel_name)); - } else { - copy_string(lsm.u.disable.channel_name, DEFAULT_CHANNEL_NAME, - sizeof(lsm.u.disable.channel_name)); + /* + * 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 (filter_expression && filter_expression[0] == '\0') { + ret = -LTTNG_ERR_INVALID; + goto error; } - copy_lttng_domain(&lsm.domain, &handle->domain); + memset(&lsm, 0, sizeof(lsm)); - if (name != NULL) { - copy_string(lsm.u.disable.name, name, sizeof(lsm.u.disable.name)); - lsm.cmd_type = LTTNG_DISABLE_EVENT; + /* If no channel name, send empty string. */ + if (channel_name == NULL) { + lttng_ctl_copy_string(lsm.u.enable.channel_name, "", + sizeof(lsm.u.enable.channel_name)); } else { - lsm.cmd_type = LTTNG_DISABLE_ALL_EVENT; + lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name, + sizeof(lsm.u.enable.channel_name)); } - copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); + lsm.cmd_type = LTTNG_ENABLE_EVENT; + if (ev->name[0] == '\0') { + /* Enable all events */ + lttng_ctl_copy_string(ev->name, "*", sizeof(ev->name)); + } - return ask_sessiond(&lsm, NULL); -} + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + /* FIXME: copying non-packed struct to packed struct. */ + memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event)); -/* - * 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) -{ - struct lttcomm_session_msg lsm; + lttng_ctl_copy_string(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + lsm.u.enable.exclusion_count = exclusion_count; + lsm.u.enable.bytecode_len = 0; /* - * NULL arguments are forbidden. No default values. + * For the JUL domain, a filter is enforced except for the enable all + * event. This is done to avoid having the event in all sessions thus + * filtering by logger name. */ - if (handle == NULL || chan == NULL) { - return -LTTNG_ERR_INVALID; + if (exclusion_count == 0 && filter_expression == NULL && + (handle->domain.type != LTTNG_DOMAIN_JUL && + handle->domain.type != LTTNG_DOMAIN_LOG4J && + handle->domain.type != LTTNG_DOMAIN_PYTHON)) { + goto ask_sessiond; } - memset(&lsm, 0, sizeof(lsm)); + /* + * We have either a filter or some exclusions, so we need to set up + * a variable-length memory block from where to send the data. + */ - memcpy(&lsm.u.channel.chan, chan, sizeof(lsm.u.channel.chan)); + /* Parse filter expression. */ + if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL + || handle->domain.type == LTTNG_DOMAIN_LOG4J + || handle->domain.type == LTTNG_DOMAIN_PYTHON) { + if (handle->domain.type == LTTNG_DOMAIN_JUL || + handle->domain.type == LTTNG_DOMAIN_LOG4J || + handle->domain.type == LTTNG_DOMAIN_PYTHON) { + char *agent_filter; + + /* Setup JUL filter if needed. */ + agent_filter = set_agent_filter(filter_expression, ev); + if (!agent_filter) { + if (!filter_expression) { + /* + * No JUL and no filter, just skip + * everything below. + */ + goto ask_sessiond; + } + } else { + /* + * With an agent filter, the original filter has + * been added to it thus replace the filter + * expression. + */ + filter_expression = agent_filter; + free_filter_expression = 1; + } + } + + ret = generate_filter(filter_expression, &lsm, &ctx); + if (ret) { + goto filter_error; + } + } + + varlen_data = zmalloc(lsm.u.enable.bytecode_len + + lsm.u.enable.expression_len + + LTTNG_SYMBOL_NAME_LEN * exclusion_count); + if (!varlen_data) { + ret = -LTTNG_ERR_EXCLUSION_NOMEM; + goto mem_error; + } + + /* Put exclusion names first in the data. */ + while (exclusion_count--) { + strncpy(varlen_data + LTTNG_SYMBOL_NAME_LEN * exclusion_count, + *(exclusion_list + exclusion_count), + LTTNG_SYMBOL_NAME_LEN - 1); + } + /* Add filter expression next. */ + if (lsm.u.enable.expression_len != 0) { + memcpy(varlen_data + + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count, + filter_expression, + lsm.u.enable.expression_len); + } + /* Add filter bytecode next. */ + if (ctx && lsm.u.enable.bytecode_len != 0) { + memcpy(varlen_data + + LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count + + lsm.u.enable.expression_len, + &ctx->bytecode->b, + lsm.u.enable.bytecode_len); + } + + ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data, + (LTTNG_SYMBOL_NAME_LEN * lsm.u.enable.exclusion_count) + + lsm.u.enable.bytecode_len + lsm.u.enable.expression_len, + NULL); + free(varlen_data); + +mem_error: + if (filter_expression && ctx) { + filter_bytecode_free(ctx); + filter_ir_free(ctx); + filter_parser_ctx_free(ctx); + } +filter_error: + if (free_filter_expression) { + /* + * The filter expression has been replaced and must be freed as + * it is not the original filter expression received as a + * parameter. + */ + free(filter_expression); + } +error: + /* + * Return directly to the caller and don't ask the sessiond since + * something went wrong in the parsing of data above. + */ + return ret; + +ask_sessiond: + ret = lttng_ctl_ask_sessiond(&lsm, NULL); + return ret; +} + +int lttng_disable_event_ext(struct lttng_handle *handle, + struct lttng_event *ev, const char *channel_name, + const char *original_filter_expression) +{ + struct lttcomm_session_msg lsm; + char *varlen_data; + int ret = 0; + unsigned int free_filter_expression = 0; + struct filter_parser_ctx *ctx = NULL; + /* + * Cast as non-const since we may replace the filter expression + * by a dynamically allocated string. Otherwise, the original + * string is not modified. + */ + char *filter_expression = (char *) original_filter_expression; + + if (handle == NULL || ev == NULL) { + ret = -LTTNG_ERR_INVALID; + goto error; + } + + /* + * 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 (filter_expression && filter_expression[0] == '\0') { + ret = -LTTNG_ERR_INVALID; + goto error; + } + + memset(&lsm, 0, sizeof(lsm)); + + /* If no channel name, send empty string. */ + if (channel_name == NULL) { + lttng_ctl_copy_string(lsm.u.disable.channel_name, "", + sizeof(lsm.u.disable.channel_name)); + } else { + lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name, + sizeof(lsm.u.disable.channel_name)); + } + + lsm.cmd_type = LTTNG_DISABLE_EVENT; + + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + /* FIXME: copying non-packed struct to packed struct. */ + memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event)); + + lttng_ctl_copy_string(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + lsm.u.disable.bytecode_len = 0; + + /* + * For the JUL domain, a filter is enforced except for the + * disable all event. This is done to avoid having the event in + * all sessions thus filtering by logger name. + */ + if (filter_expression == NULL && + (handle->domain.type != LTTNG_DOMAIN_JUL && + handle->domain.type != LTTNG_DOMAIN_LOG4J && + handle->domain.type != LTTNG_DOMAIN_PYTHON)) { + goto ask_sessiond; + } + + /* + * We have a filter, so we need to set up a variable-length + * memory block from where to send the data. + */ + + /* Parse filter expression */ + if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL + || handle->domain.type == LTTNG_DOMAIN_LOG4J + || handle->domain.type == LTTNG_DOMAIN_PYTHON) { + if (handle->domain.type == LTTNG_DOMAIN_JUL || + handle->domain.type == LTTNG_DOMAIN_LOG4J || + handle->domain.type == LTTNG_DOMAIN_PYTHON) { + char *agent_filter; + + /* Setup JUL filter if needed. */ + agent_filter = set_agent_filter(filter_expression, ev); + if (!agent_filter) { + if (!filter_expression) { + /* + * No JUL and no filter, just skip + * everything below. + */ + goto ask_sessiond; + } + } else { + /* + * With a JUL filter, the original filter has + * been added to it thus replace the filter + * expression. + */ + filter_expression = agent_filter; + free_filter_expression = 1; + } + } + + ret = generate_filter(filter_expression, &lsm, &ctx); + if (ret) { + goto filter_error; + } + } + + varlen_data = zmalloc(lsm.u.disable.bytecode_len + + lsm.u.disable.expression_len); + if (!varlen_data) { + ret = -LTTNG_ERR_EXCLUSION_NOMEM; + goto mem_error; + } + + /* Add filter expression. */ + if (lsm.u.disable.expression_len != 0) { + memcpy(varlen_data, + filter_expression, + lsm.u.disable.expression_len); + } + /* Add filter bytecode next. */ + if (ctx && lsm.u.disable.bytecode_len != 0) { + memcpy(varlen_data + + lsm.u.disable.expression_len, + &ctx->bytecode->b, + lsm.u.disable.bytecode_len); + } + + ret = lttng_ctl_ask_sessiond_varlen(&lsm, varlen_data, + lsm.u.disable.bytecode_len + lsm.u.disable.expression_len, NULL); + free(varlen_data); + +mem_error: + if (filter_expression && ctx) { + filter_bytecode_free(ctx); + filter_ir_free(ctx); + filter_parser_ctx_free(ctx); + } +filter_error: + if (free_filter_expression) { + /* + * The filter expression has been replaced and must be freed as + * it is not the original filter expression received as a + * parameter. + */ + free(filter_expression); + } +error: + /* + * Return directly to the caller and don't ask the sessiond since + * something went wrong in the parsing of data above. + */ + return ret; + +ask_sessiond: + ret = lttng_ctl_ask_sessiond(&lsm, NULL); + 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 lttng_event ev; + + memset(&ev, 0, sizeof(ev)); + ev.loglevel = -1; + ev.type = LTTNG_EVENT_ALL; + lttng_ctl_copy_string(ev.name, name, sizeof(ev.name)); + return lttng_disable_event_ext(handle, &ev, channel_name, NULL); +} + +/* + * 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) +{ + struct lttcomm_session_msg lsm; + + /* NULL arguments are forbidden. No default values. */ + if (handle == NULL || chan == NULL) { + 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; - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - copy_string(lsm.session.name, handle->session_name, + lttng_ctl_copy_string(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - return ask_sessiond(&lsm, NULL); + return lttng_ctl_ask_sessiond(&lsm, NULL); } /* - * All tracing will be stopped for registered events of the channel. - * Returns size of returned session payload data or a negative error code. + * 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) { struct lttcomm_session_msg lsm; - /* Safety check. Both are mandatory */ + /* Safety check. Both are mandatory. */ if (handle == NULL || name == NULL) { return -LTTNG_ERR_INVALID; } @@ -1001,22 +1328,74 @@ int lttng_disable_channel(struct lttng_handle *handle, const char *name) lsm.cmd_type = LTTNG_DISABLE_CHANNEL; - copy_string(lsm.u.disable.channel_name, name, + lttng_ctl_copy_string(lsm.u.disable.channel_name, name, sizeof(lsm.u.disable.channel_name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - copy_string(lsm.session.name, handle->session_name, + lttng_ctl_copy_string(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - return ask_sessiond(&lsm, NULL); + return lttng_ctl_ask_sessiond(&lsm, NULL); } /* - * 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. + * Add PID to session tracker. + * Return 0 on success else a negative LTTng error code. + */ +int lttng_track_pid(struct lttng_handle *handle, int pid) +{ + struct lttcomm_session_msg lsm; + + /* NULL arguments are forbidden. No default values. */ + if (handle == NULL) { + return -LTTNG_ERR_INVALID; + } + + memset(&lsm, 0, sizeof(lsm)); + + lsm.cmd_type = LTTNG_TRACK_PID; + lsm.u.pid_tracker.pid = pid; + + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + + lttng_ctl_copy_string(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + + return lttng_ctl_ask_sessiond(&lsm, NULL); +} + +/* + * Remove PID from session tracker. + * Return 0 on success else a negative LTTng error code. + */ +int lttng_untrack_pid(struct lttng_handle *handle, int pid) +{ + struct lttcomm_session_msg lsm; + + /* NULL arguments are forbidden. No default values. */ + if (handle == NULL) { + return -LTTNG_ERR_INVALID; + } + + memset(&lsm, 0, sizeof(lsm)); + + lsm.cmd_type = LTTNG_UNTRACK_PID; + lsm.u.pid_tracker.pid = pid; + + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + + lttng_ctl_copy_string(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + + return lttng_ctl_ask_sessiond(&lsm, NULL); +} + +/* + * 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) @@ -1028,10 +1407,11 @@ int lttng_list_tracepoints(struct lttng_handle *handle, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_TRACEPOINTS; - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - ret = ask_sessiond(&lsm, (void **) events); + ret = lttng_ctl_ask_sessiond(&lsm, (void **) events); if (ret < 0) { return ret; } @@ -1040,10 +1420,10 @@ int lttng_list_tracepoints(struct lttng_handle *handle, } /* - * 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. + * 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. */ int lttng_list_tracepoint_fields(struct lttng_handle *handle, struct lttng_event_field **fields) @@ -1055,10 +1435,11 @@ int lttng_list_tracepoint_fields(struct lttng_handle *handle, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS; - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - ret = ask_sessiond(&lsm, (void **) fields); + ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields); if (ret < 0) { return ret; } @@ -1067,8 +1448,37 @@ int lttng_list_tracepoint_fields(struct lttng_handle *handle, } /* - * Returns a human readable string describing - * the error code (a negative value). + * Lists all available kernel system calls. Allocates and 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_syscalls(struct lttng_event **events) +{ + int ret; + struct lttcomm_session_msg lsm; + + if (!events) { + return -LTTNG_ERR_INVALID; + } + + memset(&lsm, 0, sizeof(lsm)); + lsm.cmd_type = LTTNG_LIST_SYSCALLS; + /* Force kernel domain for system calls. */ + lsm.domain.type = LTTNG_DOMAIN_KERNEL; + + ret = lttng_ctl_ask_sessiond(&lsm, (void **) events); + if (ret < 0) { + return ret; + } + + return ret / sizeof(struct lttng_event); +} + +/* + * Returns a human readable string describing + * the error code (a negative value). */ const char *lttng_strerror(int code) { @@ -1082,6 +1492,7 @@ const char *lttng_strerror(int code) */ int lttng_create_session(const char *name, const char *url) { + int ret; ssize_t size; struct lttcomm_session_msg lsm; struct lttng_uri *uris = NULL; @@ -1093,23 +1504,26 @@ int lttng_create_session(const char *name, const char *url) memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_CREATE_SESSION; - copy_string(lsm.session.name, name, sizeof(lsm.session.name)); + lttng_ctl_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); + size = uri_parse_str_urls(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); + ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris, + sizeof(struct lttng_uri) * size, NULL); + + free(uris); + return ret; } /* - * Destroy session using name. - * Returns size of returned session payload data or a negative error code. + * Destroy session using name. + * Returns size of returned session payload data or a negative error code. */ int lttng_destroy_session(const char *session_name) { @@ -1119,26 +1533,29 @@ int lttng_destroy_session(const char *session_name) return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_DESTROY_SESSION; - copy_string(lsm.session.name, session_name, sizeof(lsm.session.name)); + lttng_ctl_copy_string(lsm.session.name, session_name, + sizeof(lsm.session.name)); - return ask_sessiond(&lsm, NULL); + return lttng_ctl_ask_sessiond(&lsm, NULL); } /* - * Ask the session daemon for all available sessions. - * Sets the contents of the sessions array. - * Returns the number of lttng_session entries in sessions; - * on error, returns a negative value. + * Ask the session daemon for all available sessions. + * 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) { int ret; struct lttcomm_session_msg lsm; + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_SESSIONS; - ret = ask_sessiond(&lsm, (void**) sessions); + ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions); if (ret < 0) { return ret; } @@ -1146,11 +1563,31 @@ int lttng_list_sessions(struct lttng_session **sessions) return ret / sizeof(struct lttng_session); } +int lttng_set_session_shm_path(const char *session_name, + const char *shm_path) +{ + struct lttcomm_session_msg lsm; + + if (session_name == NULL) { + return -LTTNG_ERR_INVALID; + } + + memset(&lsm, 0, sizeof(lsm)); + lsm.cmd_type = LTTNG_SET_SESSION_SHM_PATH; + + lttng_ctl_copy_string(lsm.session.name, session_name, + sizeof(lsm.session.name)); + lttng_ctl_copy_string(lsm.u.set_shm_path.shm_path, shm_path, + sizeof(lsm.u.set_shm_path.shm_path)); + + return lttng_ctl_ask_sessiond(&lsm, NULL); +} + /* - * 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. + * 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) @@ -1162,11 +1599,13 @@ int lttng_list_domains(const char *session_name, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_DOMAINS; - copy_string(lsm.session.name, session_name, sizeof(lsm.session.name)); + lttng_ctl_copy_string(lsm.session.name, session_name, + sizeof(lsm.session.name)); - ret = ask_sessiond(&lsm, (void**) domains); + ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains); if (ret < 0) { return ret; } @@ -1175,10 +1614,10 @@ int lttng_list_domains(const char *session_name, } /* - * 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. + * 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) @@ -1190,13 +1629,14 @@ int lttng_list_channels(struct lttng_handle *handle, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_CHANNELS; - copy_string(lsm.session.name, handle->session_name, + lttng_ctl_copy_string(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - ret = ask_sessiond(&lsm, (void**) channels); + ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels); if (ret < 0) { return ret; } @@ -1205,10 +1645,10 @@ int lttng_list_channels(struct lttng_handle *handle, } /* - * 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. + * 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) @@ -1221,15 +1661,16 @@ int lttng_list_events(struct lttng_handle *handle, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_EVENTS; - copy_string(lsm.session.name, handle->session_name, + lttng_ctl_copy_string(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - copy_string(lsm.u.list.channel_name, channel_name, + lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name, sizeof(lsm.u.list.channel_name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - ret = ask_sessiond(&lsm, (void**) events); + ret = lttng_ctl_ask_sessiond(&lsm, (void**) events); if (ret < 0) { return ret; } @@ -1268,12 +1709,13 @@ int lttng_calibrate(struct lttng_handle *handle, return -LTTNG_ERR_INVALID; } + memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_CALIBRATE; - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); memcpy(&lsm.u.calibrate, calibrate, sizeof(lsm.u.calibrate)); - return ask_sessiond(&lsm, NULL); + return lttng_ctl_ask_sessiond(&lsm, NULL); } /* @@ -1290,30 +1732,42 @@ void lttng_channel_set_default_attr(struct lttng_domain *domain, memset(attr, 0, sizeof(struct lttng_channel_attr)); + /* Same for all domains. */ + attr->overwrite = DEFAULT_CHANNEL_OVERWRITE; + attr->tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE; + attr->tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT; + 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->switch_timer_interval = + DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER; + attr->read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER; + 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->num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM; - attr->output = DEFAULT_UST_CHANNEL_OUTPUT; - break; + switch (domain->buf_type) { + case LTTNG_BUFFER_PER_UID: + attr->subbuf_size = default_get_ust_uid_channel_subbuf_size(); + attr->num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM; + attr->output = DEFAULT_UST_UID_CHANNEL_OUTPUT; + attr->switch_timer_interval = + DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER; + attr->read_timer_interval = + DEFAULT_UST_UID_CHANNEL_READ_TIMER; + break; + case LTTNG_BUFFER_PER_PID: + default: + attr->subbuf_size = default_get_ust_pid_channel_subbuf_size(); + attr->num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM; + attr->output = DEFAULT_UST_PID_CHANNEL_OUTPUT; + attr->switch_timer_interval = + DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER; + attr->read_timer_interval = + DEFAULT_UST_PID_CHANNEL_READ_TIMER; + break; + } default: /* Default behavior: leave set to 0. */ break; @@ -1332,25 +1786,25 @@ int lttng_session_daemon_alive(void) ret = set_session_daemon_path(); if (ret < 0) { - /* Error */ + /* Error. */ return ret; } - if (strlen(sessiond_sock_path) == 0) { + if (*sessiond_sock_path == '\0') { /* - * No socket path set. Weird error which means the constructor was not - * called. + * No socket path set. Weird error which means the constructor + * was not called. */ assert(0); } ret = try_connect_sessiond(sessiond_sock_path); if (ret < 0) { - /* Not alive */ + /* Not alive. */ return 0; } - /* Is alive */ + /* Is alive. */ return 1; } @@ -1362,6 +1816,7 @@ int lttng_session_daemon_alive(void) int lttng_set_consumer_url(struct lttng_handle *handle, const char *control_url, const char *data_url) { + int ret; ssize_t size; struct lttcomm_session_msg lsm; struct lttng_uri *uris = NULL; @@ -1374,229 +1829,287 @@ int lttng_set_consumer_url(struct lttng_handle *handle, lsm.cmd_type = LTTNG_SET_CONSUMER_URI; - copy_string(lsm.session.name, handle->session_name, + lttng_ctl_copy_string(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - size = parse_str_urls_to_uri(control_url, data_url, &uris); + size = uri_parse_str_urls(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); + ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris, + sizeof(struct lttng_uri) * size, NULL); + + free(uris); + return ret; } /* - * Enable consumer for a session and domain. - * - * Return 0 on success, else a negative value. + * [OBSOLETE] */ 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 -ENOSYS; +} - return ask_sessiond(&lsm, NULL); +/* + * [OBSOLETE] + */ +int lttng_disable_consumer(struct lttng_handle *handle) +{ + return -ENOSYS; } /* - * Disable consumer for a session and domain. + * 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. * - * Return 0 on success, else a negative value. + * 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_disable_consumer(struct lttng_handle *handle) +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 (handle == NULL) { + if (name == NULL || datetime == NULL) { return -LTTNG_ERR_INVALID; } - lsm.cmd_type = LTTNG_DISABLE_CONSUMER; + memset(&lsm, 0, sizeof(lsm)); - copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); - copy_lttng_domain(&lsm.domain, &handle->domain); + lsm.cmd_type = LTTNG_CREATE_SESSION; + lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); + + /* There should never be a data URL. */ + size = uri_parse_str_urls(url, NULL, &uris); + if (size < 0) { + ret = -LTTNG_ERR_INVALID; + goto error; + } - return ask_sessiond(&lsm, NULL); + lsm.u.uri.size = size; + + if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) { + /* Don't append datetime if the name was automatically created. */ + if (strncmp(name, DEFAULT_SESSION_NAME "-", + strlen(DEFAULT_SESSION_NAME) + 1)) { + ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s", + name, datetime); + } else { + ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name); + } + if (ret < 0) { + PERROR("snprintf uri subdir"); + ret = -LTTNG_ERR_FATAL; + goto error; + } + } + + ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris, + sizeof(struct lttng_uri) * size, NULL); + +error: + free(uris); + return ret; } /* - * Set health socket path by putting it in the global health_sock_path - * variable. - * - * Returns 0 on success or assert(0) on ENOMEM. + * 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. */ -static int set_health_socket_path(void) +int lttng_data_pending(const char *session_name) { int ret; - int in_tgroup = 0; /* In tracing group */ - uid_t uid; - const char *home; - - uid = getuid(); + struct lttcomm_session_msg lsm; + uint8_t *pending = NULL; - if (uid != 0) { - /* Are we in the tracing group ? */ - in_tgroup = check_tracing_group(tracing_group); + if (session_name == NULL) { + return -LTTNG_ERR_INVALID; } - if ((uid == 0) || in_tgroup) { - copy_string(health_sock_path, DEFAULT_GLOBAL_HEALTH_UNIX_SOCK, - sizeof(health_sock_path)); - } + memset(&lsm, 0, sizeof(lsm)); + lsm.cmd_type = LTTNG_DATA_PENDING; - 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"; - } + lttng_ctl_copy_string(lsm.session.name, session_name, + sizeof(lsm.session.name)); - 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); - } + ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending); + if (ret < 0) { + goto end; + } else if (ret != 1) { + /* Unexpected payload size */ + ret = -LTTNG_ERR_INVALID; + goto end; } - return 0; + ret = (int) *pending; +end: + free(pending); + return ret; } /* - * Check session daemon health for a specific health component. + * Create a session exclusively used for snapshot. * - * 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(). + * Returns LTTNG_OK on success or a negative error code. */ -int lttng_health_check(enum lttng_health_component c) +int lttng_create_session_snapshot(const char *name, const char *snapshot_url) { - int sock, ret; - struct lttcomm_health_msg msg; - struct lttcomm_health_data reply; + int ret; + ssize_t size; + struct lttcomm_session_msg lsm; + struct lttng_uri *uris = NULL; - /* Connect to the sesssion daemon */ - sock = lttcomm_connect_unix_sock(health_sock_path); - if (sock < 0) { - ret = -LTTNG_ERR_NO_SESSIOND; - goto error; + if (name == NULL) { + return -LTTNG_ERR_INVALID; } - msg.cmd = LTTNG_HEALTH_CHECK; - msg.component = c; + memset(&lsm, 0, sizeof(lsm)); - ret = lttcomm_send_unix_sock(sock, (void *)&msg, sizeof(msg)); - if (ret < 0) { - ret = -LTTNG_ERR_FATAL; - goto close_error; - } + lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT; + lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); - ret = lttcomm_recv_unix_sock(sock, (void *)&reply, sizeof(reply)); - if (ret < 0) { - ret = -LTTNG_ERR_FATAL; - goto close_error; + size = uri_parse_str_urls(snapshot_url, NULL, &uris); + if (size < 0) { + return -LTTNG_ERR_INVALID; } - ret = reply.ret_code; + lsm.u.uri.size = size; -close_error: - close(sock); + ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris, + sizeof(struct lttng_uri) * size, NULL); -error: + free(uris); 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. + * Create a session exclusively used for live. * - * 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. + * Returns LTTNG_OK on success or a negative error code. */ -int _lttng_create_session_ext(const char *name, const char *url, - const char *datetime) +int lttng_create_session_live(const char *name, const char *url, + unsigned int timer_interval) { int ret; ssize_t size; struct lttcomm_session_msg lsm; struct lttng_uri *uris = NULL; - if (name == NULL || datetime == NULL) { + if (name == NULL || timer_interval == 0) { 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 -LTTNG_ERR_FATAL; + lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE; + lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); + + if (url) { + size = uri_parse_str_urls(url, NULL, &uris); + if (size <= 0) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + /* file:// is not accepted for live session. */ + if (uris[0].dtype == LTTNG_DST_PATH) { + ret = -LTTNG_ERR_INVALID; + goto end; } } else { - copy_string(lsm.session.name, name, sizeof(lsm.session.name)); + size = 0; } - /* There should never be a data URL */ - size = parse_str_urls_to_uri(url, NULL, &uris); - if (size < 0) { + lsm.u.session_live.nb_uri = size; + lsm.u.session_live.timer_interval = timer_interval; + + ret = lttng_ctl_ask_sessiond_varlen(&lsm, uris, + sizeof(struct lttng_uri) * size, NULL); + +end: + free(uris); + return ret; +} + +/* + * List PIDs in the tracker. + * + * enabled is set to whether the PID tracker is enabled. + * pids is set to an allocated array of PIDs currently tracked. On + * success, pids must be freed by the caller. + * nr_pids is set to the number of entries contained by the pids array. + * + * Returns 0 on success, else a negative LTTng error code. + */ +int lttng_list_tracker_pids(struct lttng_handle *handle, + int *_enabled, int32_t **_pids, size_t *_nr_pids) +{ + int ret; + int enabled = 1; + struct lttcomm_session_msg lsm; + size_t nr_pids; + int32_t *pids; + + if (handle == NULL) { return -LTTNG_ERR_INVALID; } - lsm.u.uri.size = size; + memset(&lsm, 0, sizeof(lsm)); + lsm.cmd_type = LTTNG_LIST_TRACKER_PIDS; + lttng_ctl_copy_string(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - if (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; - } + ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pids); + if (ret < 0) { + return ret; } - - return ask_sessiond_varlen(&lsm, uris, sizeof(struct lttng_uri) * size, - NULL); + nr_pids = ret / sizeof(int32_t); + if (nr_pids == 1 && pids[0] == -1) { + free(pids); + pids = NULL; + enabled = 0; + nr_pids = 0; + } + *_enabled = enabled; + *_pids = pids; + *_nr_pids = nr_pids; + return 0; } /* - * lib constructor + * lib constructor. */ static void __attribute__((constructor)) init() { /* Set default session 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); }