Implement filter bytecode support in lttng-session, and parse filter string
[lttng-tools.git] / include / lttng / lttng.h
index c80e2827e585ba626772c0f7506805d819115c99..598abe07777d4b8594219e980ed242795d74b31d 100644 (file)
@@ -23,6 +23,7 @@
 #define _LTTNG_H
 
 #include <limits.h>
+#include <netinet/in.h>
 #include <stdint.h>
 #include <sys/types.h>
 
  */
 #define LTTNG_SYMBOL_NAME_LEN             256
 
+/*
+ * Maximum length of a domain name. This is the limit for the total length of a
+ * domain name specified by the RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt)
+ */
+#define LTTNG_MAX_DNNAME                  255
+
 /*
  * Every lttng_event_* structure both apply to kernel event and user-space
  * event.
@@ -80,21 +87,21 @@ enum lttng_loglevel_type {
  * Available loglevels.
  */
 enum lttng_loglevel {
-        LTTNG_LOGLEVEL_EMERG                  = 0,
-        LTTNG_LOGLEVEL_ALERT                  = 1,
-        LTTNG_LOGLEVEL_CRIT                   = 2,
-        LTTNG_LOGLEVEL_ERR                    = 3,
-        LTTNG_LOGLEVEL_WARNING                = 4,
-        LTTNG_LOGLEVEL_NOTICE                 = 5,
-        LTTNG_LOGLEVEL_INFO                   = 6,
-        LTTNG_LOGLEVEL_DEBUG_SYSTEM           = 7,
-        LTTNG_LOGLEVEL_DEBUG_PROGRAM          = 8,
-        LTTNG_LOGLEVEL_DEBUG_PROCESS          = 9,
-        LTTNG_LOGLEVEL_DEBUG_MODULE           = 10,
-        LTTNG_LOGLEVEL_DEBUG_UNIT             = 11,
-        LTTNG_LOGLEVEL_DEBUG_FUNCTION         = 12,
-        LTTNG_LOGLEVEL_DEBUG_LINE             = 13,
-        LTTNG_LOGLEVEL_DEBUG                  = 14,
+       LTTNG_LOGLEVEL_EMERG                  = 0,
+       LTTNG_LOGLEVEL_ALERT                  = 1,
+       LTTNG_LOGLEVEL_CRIT                   = 2,
+       LTTNG_LOGLEVEL_ERR                    = 3,
+       LTTNG_LOGLEVEL_WARNING                = 4,
+       LTTNG_LOGLEVEL_NOTICE                 = 5,
+       LTTNG_LOGLEVEL_INFO                   = 6,
+       LTTNG_LOGLEVEL_DEBUG_SYSTEM           = 7,
+       LTTNG_LOGLEVEL_DEBUG_PROGRAM          = 8,
+       LTTNG_LOGLEVEL_DEBUG_PROCESS          = 9,
+       LTTNG_LOGLEVEL_DEBUG_MODULE           = 10,
+       LTTNG_LOGLEVEL_DEBUG_UNIT             = 11,
+       LTTNG_LOGLEVEL_DEBUG_FUNCTION         = 12,
+       LTTNG_LOGLEVEL_DEBUG_LINE             = 13,
+       LTTNG_LOGLEVEL_DEBUG                  = 14,
 };
 
 /*
@@ -124,6 +131,63 @@ enum lttng_calibrate_type {
        LTTNG_CALIBRATE_FUNCTION              = 0,
 };
 
+/* Destination type of lttng URI */
+enum lttng_dst_type {
+       LTTNG_DST_IPV4                        = 1,
+       LTTNG_DST_IPV6                        = 2,
+       LTTNG_DST_PATH                        = 3,
+};
+
+/* Type of lttng URI where it is a final destination or a hop */
+enum lttng_uri_type {
+       LTTNG_URI_DST,  /* The URI is a final destination */
+       /*
+        * Hop are not supported yet but planned for a future release.
+        *
+       LTTNG_URI_HOP,
+       */
+};
+
+/* Communication stream type of a lttng URI */
+enum lttng_stream_type {
+       LTTNG_STREAM_CONTROL,
+       LTTNG_STREAM_DATA,
+};
+
+/*
+ * Protocol type of a lttng URI. The value 0 indicate that the proto_type field
+ * should be ignored.
+ */
+enum lttng_proto_type {
+       LTTNG_TCP                             = 1,
+       /*
+        * UDP protocol is not supported for now.
+        *
+       LTTNG_UDP                             = 2,
+       */
+};
+
+/*
+ * Structure representing an URI supported by lttng.
+ */
+#define LTTNG_URI_PADDING1_LEN         16
+#define LTTNG_URI_PADDING2_LEN         LTTNG_SYMBOL_NAME_LEN + 32
+struct lttng_uri {
+       enum lttng_dst_type dtype;
+       enum lttng_uri_type utype;
+       enum lttng_stream_type stype;
+       enum lttng_proto_type proto;
+       in_port_t port;
+       char padding[LTTNG_URI_PADDING1_LEN];
+       char subdir[PATH_MAX];
+       union {
+               char ipv4[INET_ADDRSTRLEN];
+               char ipv6[INET6_ADDRSTRLEN];
+               char path[PATH_MAX];
+               char padding[LTTNG_URI_PADDING2_LEN];
+       } dst;
+};
+
 /*
  * The structures should be initialized to zero before use.
  */
@@ -351,6 +415,14 @@ extern void lttng_destroy_handle(struct lttng_handle *handle);
  */
 extern int lttng_create_session(const char *name, const char *path);
 
+/*
+ * Create a tracing sessioin using a name, URIs and a consumer enable flag.
+ * The control URI is mandatory for consumer local or network.
+ */
+extern int lttng_create_session_uri(const char *name,
+               struct lttng_uri *ctrl_uri, struct lttng_uri *data_uri,
+               unsigned int enable_consumer);
+
 /*
  * Destroy a tracing session.
  *
@@ -476,6 +548,17 @@ extern int lttng_add_context(struct lttng_handle *handle,
 extern int lttng_enable_event(struct lttng_handle *handle,
                struct lttng_event *ev, const char *channel_name);
 
+/*
+ * Apply a filter expression to an event.
+ *
+ * If event_name is NULL, the filter 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 filter is applied to all events of all channels.
+ */
+extern int lttng_set_event_filter(struct lttng_handle *handle,
+               const char *event_name,
+               const char *channel_name,
+               const char *filter_expression);
 /*
  * Create or enable a channel.
  * The channel name cannot be NULL.
@@ -515,4 +598,24 @@ extern int lttng_calibrate(struct lttng_handle *handle,
 extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
                struct lttng_channel_attr *attr);
 
+/*
+ * Set URI for a consumer for a session and domain.
+ *
+ * For network streaming, both data and control stream type MUST be defined
+ * with a specific URIs. Default port are 5342 and 5343 respectively for
+ * control and data which uses the TCP protocol.
+ */
+extern int lttng_set_consumer_uri(struct lttng_handle *handle,
+               struct lttng_uri *uri);
+
+/*
+ * Enable the consumer for a session and domain.
+ */
+extern int lttng_enable_consumer(struct lttng_handle *handle);
+
+/*
+ * Disable consumer for a session and domain.
+ */
+extern int lttng_disable_consumer(struct lttng_handle *handle);
+
 #endif /* _LTTNG_H */
This page took 0.024992 seconds and 4 git commands to generate.