X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=bcccdb47733722420a6997c506df00d06913c60e;hp=0a12d9be75e4b97be6728bad11727105f4e68b8c;hb=0b2dc8df2a6d7b3341a72a04767dd6328907c97c;hpb=38ee087f699718e57d1bc5614c2f79c3c30ccca9

diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h
index 0a12d9be7..bcccdb477 100644
--- a/include/lttng/lttng.h
+++ b/include/lttng/lttng.h
@@ -139,16 +139,25 @@ enum lttng_health_component {
 	LTTNG_HEALTH_APP_REG,
 	LTTNG_HEALTH_KERNEL,
 	LTTNG_HEALTH_CONSUMER,
+	LTTNG_HEALTH_HT_CLEANUP,
 	LTTNG_HEALTH_ALL,
 };
 
+/* Buffer type for a specific domain. */
+enum lttng_buffer_type {
+	LTTNG_BUFFER_PER_PID,	/* Only supported by UST being the default. */
+	LTTNG_BUFFER_PER_UID,	/* Only supported by UST. */
+	LTTNG_BUFFER_GLOBAL,	/* Only supported by the Kernel. */
+};
+
 /*
  * The structures should be initialized to zero before use.
  */
-#define LTTNG_DOMAIN_PADDING1              16
+#define LTTNG_DOMAIN_PADDING1              12
 #define LTTNG_DOMAIN_PADDING2              LTTNG_SYMBOL_NAME_LEN + 32
 struct lttng_domain {
 	enum lttng_domain_type type;
+	enum lttng_buffer_type buf_type;
 	char padding[LTTNG_DOMAIN_PADDING1];
 
 	union {
@@ -269,7 +278,7 @@ struct lttng_event_field {
  *
  * The structures should be initialized to zero before use.
  */
-#define LTTNG_CHANNEL_ATTR_PADDING1        LTTNG_SYMBOL_NAME_LEN + 32
+#define LTTNG_CHANNEL_ATTR_PADDING1        LTTNG_SYMBOL_NAME_LEN + 16
 struct lttng_channel_attr {
 	int overwrite;                      /* 1: overwrite, 0: discard */
 	uint64_t subbuf_size;               /* bytes */
@@ -277,6 +286,9 @@ struct lttng_channel_attr {
 	unsigned int switch_timer_interval; /* usec */
 	unsigned int read_timer_interval;   /* usec */
 	enum lttng_event_output output;     /* splice, mmap */
+	/* LTTng 2.1 padding limit */
+	uint64_t tracefile_size;            /* bytes */
+	uint64_t tracefile_count;           /* number of tracefiles */
 
 	char padding[LTTNG_CHANNEL_ATTR_PADDING1];
 };
@@ -360,15 +372,18 @@ extern struct lttng_handle *lttng_create_handle(const char *session_name,
 		struct lttng_domain *domain);
 
 /*
- * Destroy a handle. This will simply free(3) the data pointer returned by
- * lttng_create_handle(), rendering it unusable.
+ * Destroy an handle.
+ *
+ * It free(3) the data pointer returned by lttng_create_handle(), rendering it
+ * unusable.
  */
 extern void lttng_destroy_handle(struct lttng_handle *handle);
 
 /*
  * Create a tracing session using a name and an optional URL.
  *
- * If _url_ is NULL, no consumer is created for the session.
+ * If _url_ is NULL, no consumer is created for the session. The name can't be
+ * NULL here.
  */
 extern int lttng_create_session(const char *name, const char *url);
 
@@ -377,6 +392,8 @@ extern int lttng_create_session(const char *name, const char *url);
  *
  * The session will not be usable anymore, tracing will be stopped for all
  * registered traces, and the tracing buffers will be flushed.
+ *
+ * The name can't be NULL here.
  */
 extern int lttng_destroy_session(const char *name);
 
@@ -443,7 +460,8 @@ extern int lttng_session_daemon_alive(void);
 /*
  * Set the tracing group for the *current* flow of execution.
  *
- * On success, returns 0, on error, returns -1 (null name) or -ENOMEM.
+ * On success, returns 0 else a negative value on error being a lttng error
+ * code found in lttng-error.h
  */
 extern int lttng_set_tracing_group(const char *name);
 
@@ -477,6 +495,8 @@ extern int lttng_start_tracing(const char *session_name);
  * 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.
+ *
+ * The session_name can't be NULL.
  */
 extern int lttng_stop_tracing(const char *session_name);
 
@@ -489,9 +509,11 @@ extern int lttng_stop_tracing_no_wait(const char *session_name);
 /*
  * Add context to event(s) for a specific channel (or for all).
  *
- * 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.
+ * 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.
+ *
+ * Note that whatever event_name value is, a context can not be added to an
+ * event, so we just ignore it for now.
  */
 extern int lttng_add_context(struct lttng_handle *handle,
 		struct lttng_event_context *ctx, const char *event_name,
@@ -502,26 +524,32 @@ extern int lttng_add_context(struct lttng_handle *handle,
  *
  * If the event you are trying to enable does not exist, it will be created,
  * else it is enabled.
- * If event_name is NULL, all events are enabled.
  * If channel_name is NULL, the default channel is used (channel0).
+ *
+ * The handle and ev params can not be NULL.
  */
 extern int lttng_enable_event(struct lttng_handle *handle,
 		struct lttng_event *ev, const char *channel_name);
 
 /*
- * Apply a filter expression to an event.
+ * Create or enable an event with a specific filter.
  *
- * 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,
+ * If the event you are trying to enable does not exist, it will be created,
+ * else it is enabled.
+ * If ev is NULL, all events are enabled with that filter.
+ * If channel_name is NULL, the default channel is used (channel0) and created
+ * if not found.
+ * If filter_expression is NULL, an event without associated filter is
+ * created.
+ */
+extern int lttng_enable_event_with_filter(struct lttng_handle *handle,
+		struct lttng_event *event, const char *channel_name,
 		const char *filter_expression);
+
 /*
  * Create or enable a channel.
- * The channel name cannot be NULL.
+ *
+ * The chan and handle params can not be NULL.
  */
 extern int lttng_enable_channel(struct lttng_handle *handle,
 		struct lttng_channel *chan);
@@ -529,7 +557,7 @@ extern int lttng_enable_channel(struct lttng_handle *handle,
 /*
  * Disable event(s) of a channel and domain.
  *
- * If event_name is NULL, all events are disabled.
+ * If name is NULL, all events are disabled.
  * If channel_name is NULL, the default channel is used (channel0).
  */
 extern int lttng_disable_event(struct lttng_handle *handle,
@@ -538,13 +566,14 @@ extern int lttng_disable_event(struct lttng_handle *handle,
 /*
  * Disable channel.
  *
- * The channel name cannot be NULL.
  */
 extern int lttng_disable_channel(struct lttng_handle *handle,
 		const char *name);
 
 /*
  * Calibrate LTTng overhead.
+ *
+ * The chan and handle params can not be NULL.
  */
 extern int lttng_calibrate(struct lttng_handle *handle,
 		struct lttng_calibrate *calibrate);
@@ -553,7 +582,7 @@ extern int lttng_calibrate(struct lttng_handle *handle,
  * Set the default channel attributes for a specific domain and an allocated
  * lttng_channel_attr pointer.
  *
- * If either or both of the arguments are NULL, nothing happens.
+ * If one or both arguments are NULL, nothing happens.
  */
 extern void lttng_channel_set_default_attr(struct lttng_domain *domain,
 		struct lttng_channel_attr *attr);
@@ -573,12 +602,14 @@ extern int lttng_set_consumer_url(struct lttng_handle *handle,
 /*
  * Enable the consumer for a session and domain.
  */
-extern int lttng_enable_consumer(struct lttng_handle *handle);
+extern LTTNG_DEPRECATED("This call is now obsolete.")
+int lttng_enable_consumer(struct lttng_handle *handle);
 
 /*
  * Disable consumer for a session and domain.
  */
-extern int lttng_disable_consumer(struct lttng_handle *handle);
+extern LTTNG_DEPRECATED("This call is now obsolete.")
+int lttng_disable_consumer(struct lttng_handle *handle);
 
 /*
  * Check session daemon health for a specific component.
@@ -589,18 +620,22 @@ extern int lttng_disable_consumer(struct lttng_handle *handle);
  *
  * Any other positive value is an lttcomm error which can be translate with
  * lttng_strerror().
+ *
+ * Please see lttng-health-check(3) man page for more information.
  */
 extern int lttng_health_check(enum lttng_health_component c);
 
 /*
  * 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.
+ * or is still being extracted by the consumer(s) (pending) hence not ready to
+ * be used by any readers.
  *
- * Return 0 if the data is _NOT_ available else 1 if the data is ready. On
- * error, a negative value is returned and readable by lttng_strerror().
+ * 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_available(const char *session_name);
+extern int lttng_data_pending(const char *session_name);
 
 #ifdef __cplusplus
 }