Fix: Mismatch of field name between ust and tools
[lttng-tools.git] / include / lttng / lttng.h
index c80e2827e585ba626772c0f7506805d819115c99..f92ccb6fdb3615266bb86c06dc465accb01ded9b 100644 (file)
  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#ifndef _LTTNG_H
-#define _LTTNG_H
+#ifndef LTTNG_H
+#define LTTNG_H
 
 #include <limits.h>
 #include <stdint.h>
 #include <sys/types.h>
 
+/* Error codes that can be returned by API calls */
+#include <lttng/lttng-error.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 /*
  * Event symbol length. Copied from LTTng kernel ABI.
  */
@@ -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,
 };
 
 /*
@@ -118,12 +125,23 @@ enum lttng_event_context_type {
        LTTNG_EVENT_CONTEXT_PPID              = 8,
        LTTNG_EVENT_CONTEXT_VPPID             = 9,
        LTTNG_EVENT_CONTEXT_PTHREAD_ID        = 10,
+       LTTNG_EVENT_CONTEXT_HOSTNAME          = 11,
 };
 
 enum lttng_calibrate_type {
        LTTNG_CALIBRATE_FUNCTION              = 0,
 };
 
+/* Health component for the health check function. */
+enum lttng_health_component {
+       LTTNG_HEALTH_CMD,
+       LTTNG_HEALTH_APP_MANAGE,
+       LTTNG_HEALTH_APP_REG,
+       LTTNG_HEALTH_KERNEL,
+       LTTNG_HEALTH_CONSUMER,
+       LTTNG_HEALTH_ALL,
+};
+
 /*
  * The structures should be initialized to zero before use.
  */
@@ -205,7 +223,7 @@ struct lttng_event_function_attr {
  *
  * The structures should be initialized to zero before use.
  */
-#define LTTNG_EVENT_PADDING1               16
+#define LTTNG_EVENT_PADDING1               15
 #define LTTNG_EVENT_PADDING2               LTTNG_SYMBOL_NAME_LEN + 32
 struct lttng_event {
        enum lttng_event_type type;
@@ -216,6 +234,7 @@ struct lttng_event {
 
        int32_t enabled;        /* Does not apply: -1 */
        pid_t pid;
+       unsigned char filter;   /* filter enabled ? */
 
        char padding[LTTNG_EVENT_PADDING1];
 
@@ -242,6 +261,7 @@ struct lttng_event_field {
        enum lttng_event_field_type type;
        char padding[LTTNG_EVENT_FIELD_PADDING];
        struct lttng_event event;
+       int nowrite;
 };
 
 /*
@@ -346,10 +366,11 @@ extern struct lttng_handle *lttng_create_handle(const char *session_name,
 extern void lttng_destroy_handle(struct lttng_handle *handle);
 
 /*
- * Create a tracing session using a name and a path where the trace will be
- * written.
+ * Create a tracing session using a name and an optional URL.
+ *
+ * If _url_ is NULL, no consumer is created for the session.
  */
-extern int lttng_create_session(const char *name, const char *path);
+extern int lttng_create_session(const char *name, const char *url);
 
 /*
  * Destroy a tracing session.
@@ -476,6 +497,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 +547,42 @@ extern int lttng_calibrate(struct lttng_handle *handle,
 extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
                struct lttng_channel_attr *attr);
 
-#endif /* _LTTNG_H */
+/*
+ * Set URL for a consumer for a session and domain.
+ *
+ * Both data and control URL must be defined. If both URLs are the same, only
+ * the control URL is used even for network streaming.
+ *
+ * Default port are 5342 and 5343 respectively for control and data which uses
+ * the TCP protocol.
+ */
+extern int lttng_set_consumer_url(struct lttng_handle *handle,
+               const char *control_url, const char *data_url);
+
+/*
+ * 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);
+
+/*
+ * Check session daemon health for a specific component.
+ *
+ * Return 0 if health is OK or 1 if BAD. A returned value of -1 indicate that
+ * the control library was not able to connect to the session daemon health
+ * socket.
+ *
+ * Any other positive value is an lttcomm error which can be translate with
+ * lttng_strerror().
+ */
+extern int lttng_health_check(enum lttng_health_component c);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LTTNG_H */
This page took 0.025361 seconds and 4 git commands to generate.