Implement filter bytecode support in lttng-session, and parse filter string
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.c
index c5887fe65ead21a41f637aafa3adc10d60e0eb45..780b44dd7cdebba0ed70c69a4459abc42df38658 100644 (file)
@@ -5,19 +5,18 @@
  *
  * 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 <common/sessiond-comm/sessiond-comm.h>
 #include <lttng/lttng.h>
 
+#include "filter-parser.h"
+#include "filter-ast.h"
+#include "filter-bytecode.h"
+#include "memstream.h"
+
+#ifdef DEBUG
+const int print_xml = 1;
+#define dbg_printf(fmt, args...)       \
+       printf("[debug liblttng-ctl] " fmt, ## args)
+#else
+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];
@@ -41,6 +60,18 @@ static char sessiond_sock_path[PATH_MAX];
 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.
+ *
+ * Note that it is *not* possible to silent ERR() and PERROR() macros.
+ */
+int lttng_opt_quiet;
+int lttng_opt_verbose;
+
 /*
  * Copy string from src to dst and enforce null terminated byte.
  */
@@ -64,19 +95,19 @@ static void 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:
-                       */
-                               memcpy(dst, src, sizeof(struct lttng_domain));
-                               break;
-                       default:
-                               memset(dst, 0, sizeof(struct lttng_domain));
-                               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));
+                       dst->type = LTTNG_DOMAIN_KERNEL;
+                       break;
                }
        }
 }
@@ -103,6 +134,31 @@ 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 = -ENOTCONN;
+               goto end;
+       }
+       if (!data || !len) {
+               ret = 0;
+               goto end;
+       }
+
+       ret = lttcomm_send_unix_sock(sessiond_socket, data, len);
+
+end:
+       return ret;
+}
+
 /*
  * Receive data from the sessiond socket.
  *
@@ -300,10 +356,14 @@ 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) 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;
@@ -320,6 +380,11 @@ static int ask_sessiond(struct lttcomm_session_msg *lsm, void **buf)
        if (ret < 0) {
                goto end;
        }
+       /* Send var len data */
+       ret = send_session_varlen(vardata, varlen);
+       if (ret < 0) {
+               goto end;
+       }
 
        /* Get header from data transmission */
        ret = recv_data_sessiond(&llm, sizeof(llm));
@@ -370,6 +435,16 @@ 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.
@@ -544,6 +619,139 @@ int lttng_enable_event(struct lttng_handle *handle,
        return ask_sessiond(&lsm, NULL);
 }
 
+/*
+ * 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,
+               const char *event_name, 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 -1;
+       }
+
+       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 -ENOMEM;
+       }
+       ctx = filter_parser_ctx_alloc(fmem);
+       if (!ctx) {
+               fprintf(stderr, "Error allocating parser\n");
+               ret = -ENOMEM;
+               goto alloc_error;
+       }
+       ret = filter_parser_ctx_append_ast(ctx);
+       if (ret) {
+               fprintf(stderr, "Parse error\n");
+               ret = -EINVAL;
+               goto parse_error;
+       }
+       ret = filter_visitor_set_parent(ctx);
+       if (ret) {
+               fprintf(stderr, "Set parent error\n");
+               ret = -EINVAL;
+               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 = -EINVAL;
+                       goto parse_error;
+               }
+       }
+
+       dbg_printf("Generating IR... ");
+       fflush(stdout);
+       ret = filter_visitor_ir_generate(ctx);
+       if (ret) {
+               fprintf(stderr, "Generate IR error\n");
+               ret = -EINVAL;
+               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 = -EINVAL;
+               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 = -EINVAL;
+               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 */
+       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);
+
+       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.
@@ -669,6 +877,33 @@ int lttng_list_tracepoints(struct lttng_handle *handle,
        return ret / sizeof(struct lttng_event);
 }
 
+/*
+ *  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)
+{
+       int ret;
+       struct lttcomm_session_msg lsm;
+
+       if (handle == NULL) {
+               return -1;
+       }
+
+       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).
@@ -698,6 +933,39 @@ int lttng_create_session(const char *name, const char *path)
        return ask_sessiond(&lsm, NULL);
 }
 
+/*
+ * Create a new tracing session using a name, URIs and a consumer enable flag.
+ */
+int lttng_create_session_uri(const char *name, struct lttng_uri *ctrl_uri,
+               struct lttng_uri *data_uri, unsigned int enable_consumer)
+{
+       struct lttcomm_session_msg lsm;
+
+       /* Name and ctrl_uri are mandatory */
+       if (name == NULL || ctrl_uri == NULL) {
+               return -1;
+       }
+
+       lsm.cmd_type = LTTNG_CREATE_SESSION_URI;
+
+       copy_string(lsm.session.name, name, sizeof(lsm.session.name));
+       /* Anything bigger than zero, the consumer(s) will be enabled */
+       lsm.u.create_uri.enable_consumer = enable_consumer;
+       memcpy(&lsm.u.create_uri.ctrl_uri, ctrl_uri,
+                       sizeof(lsm.u.create_uri.ctrl_uri));
+       if (data_uri) {
+               /*
+                * The only possible scenario where data_uri is NULL is for a local
+                * consumer where the output is at a specified path name on the
+                * filesystem.
+                */
+               memcpy(&lsm.u.create_uri.data_uri, data_uri,
+                               sizeof(lsm.u.create_uri.data_uri));
+       }
+
+       return ask_sessiond(&lsm, NULL);
+}
+
 /*
  *  Destroy session using name.
  *  Returns size of returned session payload data or a negative error code.
@@ -874,13 +1142,13 @@ int lttng_calibrate(struct lttng_handle *handle,
 void lttng_channel_set_default_attr(struct lttng_domain *domain,
                struct lttng_channel_attr *attr)
 {
-       memset(attr, 0, sizeof(struct lttng_channel_attr));
-
        /* Safety check */
        if (attr == NULL || domain == NULL) {
                return;
        }
 
+       memset(attr, 0, sizeof(struct lttng_channel_attr));
+
        switch (domain->type) {
        case LTTNG_DOMAIN_KERNEL:
                attr->overwrite = DEFAULT_CHANNEL_OVERWRITE;
@@ -942,6 +1210,74 @@ int lttng_session_daemon_alive(void)
        return 1;
 }
 
+/*
+ * Set URI for a consumer for a session and domain.
+ *
+ * Return 0 on success, else a negative value.
+ */
+int lttng_set_consumer_uri(struct lttng_handle *handle, struct lttng_uri *uri)
+{
+       struct lttcomm_session_msg lsm;
+
+       if (handle == NULL || uri == NULL) {
+               return -1;
+       }
+
+       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);
+
+       memcpy(&lsm.u.uri, uri, sizeof(lsm.u.uri));
+
+       return ask_sessiond(&lsm, 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 -1;
+       }
+
+       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 -1;
+       }
+
+       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);
+}
+
 /*
  * lib constructor
  */
This page took 0.028373 seconds and 4 git commands to generate.