X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=9e2d4d129894878631d38452f05bc5ffc25c946a;hp=0c32d941af6e17e859a41857c0d800d7be0cb5c2;hb=178191b3899f114001f000c2e7f46909969f9c6f;hpb=fceb65dfca20fb1e2071a44ada9fe61384d2b890 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index 0c32d941a..9e2d4d129 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -19,25 +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 -#include #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. */ #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. @@ -125,67 +125,21 @@ 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, }; -/* 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; +/* 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, }; /* @@ -307,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; }; /* @@ -411,18 +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. - */ -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. + * 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_uri(const char *name, - struct lttng_uri *ctrl_uri, struct lttng_uri *data_uri, - unsigned int enable_consumer); +extern int lttng_create_session(const char *name, const char *url); /* * Destroy a tracing session. @@ -524,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). * @@ -552,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. @@ -600,14 +559,16 @@ 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. + * Set URL 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. + * 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_uri(struct lttng_handle *handle, - struct lttng_uri *uri); +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. @@ -619,4 +580,32 @@ extern int lttng_enable_consumer(struct lttng_handle *handle); */ extern int lttng_disable_consumer(struct lttng_handle *handle); -#endif /* _LTTNG_H */ +/* + * 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); + +/* + * 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 */