X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=515e07c4e9703653c600e633d887ccae6f194957;hp=cb3562ffdf601f66274ffef2bd7252450184e3a2;hb=52df24019c3998b87870fb8371fa20fb33449a0d;hpb=54773d681e44cb32d6923bd2db0dcecd4bd10079 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index cb3562ffd..515e07c4e 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -26,6 +26,13 @@ #include #include +/* Error codes that can be returned by API calls */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + /* * Event symbol length. Copied from LTTng kernel ABI. */ @@ -254,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; }; /* @@ -464,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). * @@ -490,16 +509,20 @@ 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 event_name 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. @@ -573,4 +596,20 @@ extern int lttng_disable_consumer(struct lttng_handle *handle); */ 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) (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 */