Pass lttng_event struct to the set_filter API call

[lttng-tools.git] / include / lttng / lttng.h

diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h
index d421ca518987fb506916fd02359ba9eef06bf63e..9e2d4d129894878631d38452f05bc5ffc25c946a 100644 (file)
--- a/include/lttng/lttng.h
+++ b/include/lttng/lttng.h
@@ -19,24 +19,25 @@
  * 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.
  */
 #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.
@@ -124,6 +125,7 @@ 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 {
@@ -259,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;
 };
 
 /*
@@ -469,9 +472,20 @@ extern int lttng_start_tracing(const char *session_name);
 
 /*
  * Stop tracing for *all* registered traces (kernel and user-space).
+ *
+ * This call will wait for data availability for each domain of the session so
+ * this can take an abritrary amount of time. However, when returning you have
+ * the guarantee that the data is ready to be read and analyse. Use the
+ * _no_wait call below to avoid this behavior.
  */
 extern int lttng_stop_tracing(const char *session_name);
 
+/*
+ * Behave exactly like lttng_stop_tracing but does not wait for data
+ * availability.
+ */
+extern int lttng_stop_tracing_no_wait(const char *session_name);
+
 /*
  * Add context to event(s) for a specific channel (or for all).
  *
@@ -497,14 +511,14 @@ extern int lttng_enable_event(struct lttng_handle *handle,
 /*
  * Apply a filter expression to an event.
  *
- * If event_name is NULL, the filter is applied to all events of the channel.
+ * If event 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,
+               struct lttng_event *event, const char *channel_name,
                const char *filter_expression);
+
 /*
  * Create or enable a channel.
  * The channel name cannot be NULL.
@@ -578,4 +592,20 @@ extern int lttng_disable_consumer(struct lttng_handle *handle);
  */
 extern int lttng_health_check(enum lttng_health_component c);
 
-#endif /* _LTTNG_H */
+/*
+ * 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) (pending) hence not ready to
+ * be used by any readers.
+ *
+ * Return 0 if there is _no_ data pending in the buffers thus having a
+ * guarantee that the data can be read safely. Else, return 1 if there is still
+ * traced data is pending. On error, a negative value is returned and readable
+ * by lttng_strerror().
+ */
+extern int lttng_data_pending(const char *session_name);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LTTNG_H */