X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=eda61d6bec30f787f58efa966caa61627ac22c38;hp=bdbf5e93550ea40aa86e1da17e02badf506da3ff;hb=06662f07b04be024dde9d1e3905061997448103a;hpb=8d326ab9f5a306225833ebbfec0a790b7cbc1856 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index bdbf5e935..eda61d6be 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -6,8 +6,8 @@ * Copyright (C) 2011 - David Goulet * * This library is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as published by the - * Free Software Foundation; only version 2.1 of the License. + * under the terms of the GNU Lesser General Public License, version 2.1 only, + * as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or @@ -19,13 +19,30 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -#ifndef _LTTNG_H -#define _LTTNG_H +#ifndef LTTNG_H +#define LTTNG_H #include +/* + * Necessary to include the fixed width type limits on glibc versions older + * than 2.18 when building with a C++ compiler. + */ +#ifndef __STDC_LIMIT_MACROS +#define __STDC_LIMIT_MACROS #include +#undef __STDC_LIMIT_MACROS +#else /* #ifndef __STDC_LIMIT_MACROS */ +#include +#endif /* #else #ifndef __STDC_LIMIT_MACROS */ #include +/* Error codes that can be returned by API calls */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + /* * Event symbol length. Copied from LTTng kernel ABI. */ @@ -40,18 +57,9 @@ * Domain types: the different possible tracers. */ enum lttng_domain_type { - LTTNG_DOMAIN_KERNEL = 1, - LTTNG_DOMAIN_UST = 2, - - /* - * For now, the domains below are not implemented. However, we keep them - * here in order to retain their enum values for future development. Note - * that it is on the roadmap to implement them. - * - LTTNG_DOMAIN_UST_EXEC_NAME = 3, - LTTNG_DOMAIN_UST_PID = 4, - LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5, - */ + LTTNG_DOMAIN_KERNEL = 1, /* Linux Kernel tracer. */ + LTTNG_DOMAIN_UST = 2, /* Global Userspace tracer. */ + LTTNG_DOMAIN_JUL = 3, /* Java Util Logging. */ }; /* @@ -76,6 +84,43 @@ enum lttng_loglevel_type { LTTNG_EVENT_LOGLEVEL_SINGLE = 2, }; +/* + * 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, +}; + +/* + * Available loglevels for the JUL domain. Those are an exact map from the + * class java.util.logging.Level. + */ +enum lttng_loglevel_jul { + LTTNG_LOGLEVEL_JUL_OFF = INT32_MAX, + LTTNG_LOGLEVEL_JUL_SEVERE = 1000, + LTTNG_LOGLEVEL_JUL_WARNING = 900, + LTTNG_LOGLEVEL_JUL_INFO = 800, + LTTNG_LOGLEVEL_JUL_CONFIG = 700, + LTTNG_LOGLEVEL_JUL_FINE = 500, + LTTNG_LOGLEVEL_JUL_FINER = 400, + LTTNG_LOGLEVEL_JUL_FINEST = 300, + LTTNG_LOGLEVEL_JUL_ALL = INT32_MIN, +}; + /* * LTTng consumer mode */ @@ -87,7 +132,7 @@ enum lttng_event_output { /* Event context possible type */ enum lttng_event_context_type { LTTNG_EVENT_CONTEXT_PID = 0, - LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, + LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, /* Backward compat. */ LTTNG_EVENT_CONTEXT_PROCNAME = 2, LTTNG_EVENT_CONTEXT_PRIO = 3, LTTNG_EVENT_CONTEXT_NICE = 4, @@ -97,16 +142,44 @@ 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, + LTTNG_EVENT_CONTEXT_IP = 12, + LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER = 13, + LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER = 14, }; enum lttng_calibrate_type { LTTNG_CALIBRATE_FUNCTION = 0, }; -#define LTTNG_DOMAIN_PADDING1 16 +/* 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_HT_CLEANUP, + LTTNG_HEALTH_APP_MANAGE_NOTIFY, + LTTNG_HEALTH_APP_REG_DISPATCH, + 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 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 { @@ -116,7 +189,11 @@ struct lttng_domain { } attr; }; -/* Perf counter attributes */ +/* + * Perf counter attributes + * + * The structures should be initialized to zero before use. + */ #define LTTNG_PERF_EVENT_PADDING1 16 struct lttng_event_perf_counter_ctx { uint32_t type; @@ -126,7 +203,11 @@ struct lttng_event_perf_counter_ctx { char padding[LTTNG_PERF_EVENT_PADDING1]; }; -/* Event/Channel context */ +/* + * Event/channel context + * + * The structures should be initialized to zero before use. + */ #define LTTNG_EVENT_CONTEXT_PADDING1 16 #define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_event_context { @@ -143,6 +224,8 @@ struct lttng_event_context { * Event probe. * * Either addr is used or symbol_name and offset. + * + * The structures should be initialized to zero before use. */ #define LTTNG_EVENT_PROBE_PADDING1 16 struct lttng_event_probe_attr { @@ -156,6 +239,8 @@ struct lttng_event_probe_attr { /* * Function tracer + * + * The structures should be initialized to zero before use. */ #define LTTNG_EVENT_FUNCTION_PADDING1 16 struct lttng_event_function_attr { @@ -166,8 +251,10 @@ struct lttng_event_function_attr { /* * Generic lttng event + * + * The structures should be initialized to zero before use. */ -#define LTTNG_EVENT_PADDING1 16 +#define LTTNG_EVENT_PADDING1 14 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_event { enum lttng_event_type type; @@ -176,8 +263,10 @@ struct lttng_event { enum lttng_loglevel_type loglevel_type; int loglevel; - uint32_t enabled; + int32_t enabled; /* Does not apply: -1 */ pid_t pid; + unsigned char filter; /* filter enabled ? */ + unsigned char exclusion; /* exclusions added ? */ char padding[LTTNG_EVENT_PADDING1]; @@ -190,10 +279,29 @@ struct lttng_event { } attr; }; +enum lttng_event_field_type { + LTTNG_EVENT_FIELD_OTHER = 0, + LTTNG_EVENT_FIELD_INTEGER = 1, + LTTNG_EVENT_FIELD_ENUM = 2, + LTTNG_EVENT_FIELD_FLOAT = 3, + LTTNG_EVENT_FIELD_STRING = 4, +}; + +#define LTTNG_EVENT_FIELD_PADDING LTTNG_SYMBOL_NAME_LEN + 32 +struct lttng_event_field { + char field_name[LTTNG_SYMBOL_NAME_LEN]; + enum lttng_event_field_type type; + char padding[LTTNG_EVENT_FIELD_PADDING]; + struct lttng_event event; + int nowrite; +}; + /* * Tracer channel attributes. For both kernel and user-space. + * + * 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 + 12 struct lttng_channel_attr { int overwrite; /* 1: overwrite, 0: discard */ uint64_t subbuf_size; /* bytes */ @@ -201,12 +309,19 @@ 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 */ + /* LTTng 2.3 padding limit */ + unsigned int live_timer_interval; /* usec */ char padding[LTTNG_CHANNEL_ATTR_PADDING1]; }; /* * Channel information structure. For both kernel and user-space. + * + * The structures should be initialized to zero before use. */ #define LTTNG_CHANNEL_PADDING1 16 struct lttng_channel { @@ -230,19 +345,25 @@ struct lttng_calibrate { * This is an 'output data' meaning that it only comes *from* the session * daemon *to* the lttng client. It's basically a 'human' representation of * tracing entities (here a session). + * + * The structures should be initialized to zero before use. */ -#define LTTNG_SESSION_PADDING1 16 +#define LTTNG_SESSION_PADDING1 12 struct lttng_session { char name[NAME_MAX]; /* The path where traces are written */ char path[PATH_MAX]; uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ + uint32_t snapshot_mode; + unsigned int live_timer_interval; /* usec */ char padding[LTTNG_SESSION_PADDING1]; }; /* * Handle used as a context for commands. + * + * The structures should be initialized to zero before use. */ #define LTTNG_HANDLE_PADDING1 16 struct lttng_handle { @@ -254,46 +375,78 @@ struct lttng_handle { /* * Public LTTng control API + */ + +/* + * Create a tracing session using a name and an optional URL. * - * For functions having an lttng domain type as parameter, if a bad value is - * given, NO default is applied and an error is returned. + * If _url_ is NULL, no consumer is created for the session. The name can't be + * NULL here. * - * On success, all functions of the API return 0 or the size of the allocated - * array (in bytes). + * Return 0 on success else a negative LTTng error code. + */ +extern int lttng_create_session(const char *name, const char *url); + +/* + * Create a tracing session that will exclusively be used for snapshot meaning + * the session will be in no output mode and every channel enabled for that + * session will be set in overwrite mode and in mmap output since splice is not + * supported. * - * On error, a negative value is returned being a specific lttng-tools error - * code which can be humanly interpreted with lttng_strerror(err). + * Name can't be NULL. If an url is given, it will be used to create a default + * snapshot output using it as a destination. If NULL, no output will be + * defined and an add-output call will be needed. * - * Exceptions to this are noted below. + * Return 0 on success else a negative LTTng error code. */ +extern int lttng_create_session_snapshot(const char *name, + const char *snapshot_url); /* - * Create a handle used as a context for every request made to the library. + * Create a session exclusively used for live reading. + * + * In this mode, the switch-timer parameter is forced for each UST channel, a + * live-switch-timer is enabled for kernel channels, manually setting + * switch-timer is forbidden. Synchronization beacons are sent to the relayd, + * indexes are sent and metadata is checked for each packet. + * + * Name can't be NULL. If no URL is given, the default is to send the data to + * net://127.0.0.1. The timer_interval is in usec and by default set to 1000000 + * (1 second). * - * This handle contains the session name and lttng domain on which the command - * will be executed. - * The returned pointer will be NULL in case of malloc() error. + * Return 0 on success else a negative LTTng error code. */ -extern struct lttng_handle *lttng_create_handle(const char *session_name, - struct lttng_domain *domain); +extern int lttng_create_session_live(const char *name, const char *url, + unsigned int timer_interval); /* - * Destroy a handle. This will simply free(3) the data pointer returned by - * lttng_create_handle(), rendering it unusable. + * Create an handle used as a context for every request made to the library. + * + * This handle contains the session name and domain on which the command will + * be executed. A domain is basically a tracer like the kernel or user space. + * + * Return an newly allocated handle that should be freed using + * lttng_destroy_handle. On error, NULL is returned. */ -extern void lttng_destroy_handle(struct lttng_handle *handle); +extern struct lttng_handle *lttng_create_handle(const char *session_name, + struct lttng_domain *domain); /* - * Create a tracing session using a name and a path where the trace will be - * written. + * Destroy an handle that has been previously created with lttng_create_handle. + * + * It free the given pointer making it unusable. */ -extern int lttng_create_session(const char *name, const char *path); +extern void lttng_destroy_handle(struct lttng_handle *handle); /* * Destroy a tracing session. * - * The session will not be usable anymore, tracing will be stopped for all - * registered traces, and the tracing buffers will be flushed. + * The session will not be usable, tracing will be stopped thus buffers will be + * flushed. + * + * The name can't be NULL here. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_destroy_session(const char *name); @@ -301,15 +454,17 @@ extern int lttng_destroy_session(const char *name); * List all the tracing sessions. * * Return the size (number of entries) of the "lttng_session" array. Caller - * must free(3). + * must free sessions. On error, a negative LTTng error code is returned. */ extern int lttng_list_sessions(struct lttng_session **sessions); /* * List the registered domain(s) of a session. * + * Session name CAN NOT be NULL. + * * Return the size (number of entries) of the "lttng_domain" array. Caller - * must free(3). + * must free domains. On error, a negative LTTng error code is returned. */ extern int lttng_list_domains(const char *session_name, struct lttng_domain **domains); @@ -317,8 +472,10 @@ extern int lttng_list_domains(const char *session_name, /* * List the channel(s) of a session. * + * The handle CAN NOT be NULL. + * * Return the size (number of entries) of the "lttng_channel" array. Caller - * must free(3). + * must free channels. On error, a negative LTTng error code is returned. */ extern int lttng_list_channels(struct lttng_handle *handle, struct lttng_channel **channels); @@ -326,8 +483,10 @@ extern int lttng_list_channels(struct lttng_handle *handle, /* * List the event(s) of a session channel. * - * Return the size (number of entries) of the "lttng_event" array. - * Caller must free(3). + * Both handle and channel_name CAN NOT be NULL. + * + * Return the size (number of entries) of the "lttng_event" array. Caller must + * free events. On error a negative LTTng error code is returned. */ extern int lttng_list_events(struct lttng_handle *handle, const char *channel_name, struct lttng_event **events); @@ -335,28 +494,43 @@ extern int lttng_list_events(struct lttng_handle *handle, /* * List the available tracepoints of a specific lttng domain. * - * Return the size (number of entries) of the "lttng_event" array. - * Caller must free(3). + * The handle CAN NOT be NULL. + * + * Return the size (number of entries) of the "lttng_event" array. Caller must + * free events. On error a negative LTTng error code is returned. */ extern int lttng_list_tracepoints(struct lttng_handle *handle, struct lttng_event **events); +/* + * List the available tracepoints fields of a specific lttng domain. + * + * The handle CAN NOT be NULL. + * + * Return the size (number of entries) of the "lttng_event_field" array. + * Caller must free fields. On error a negative LTTng error code is + * returned. + */ +extern int lttng_list_tracepoint_fields(struct lttng_handle *handle, + struct lttng_event_field **fields); + /* * Check if a session daemon is alive. * - * Return 1 if alive or 0 if not. On error returns a negative value. + * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng + * error code. */ 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 LTTng error code. */ extern int lttng_set_tracing_group(const char *name); /* - * Return a human-readable error message for an lttng-tools error code. + * Return a human-readable error message for a LTTng error code. * * Parameter MUST be a negative value or else you'll get a generic message. */ @@ -367,70 +541,144 @@ extern const char *lttng_strerror(int code); * No consumer will be spawned and all fds/commands will go through the socket * path given (socket_path). * - * NOTE: At the moment, if you use the liblttng-kconsumer, you can only use the - * command socket. The error socket is not supported yet for roaming consumers. + * NOTE that this is not recommended unless you absolutely know what you are + * doing. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_register_consumer(struct lttng_handle *handle, const char *socket_path); /* - * Start tracing for *all* registered traces (kernel and user-space). + * Start tracing for *all* domain(s) in the session. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_start_tracing(const char *session_name); /* - * Stop tracing for *all* registered traces (kernel and user-space). + * Stop tracing for *all* domain(s) in the session. + * + * 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 analyze. Use the + * _no_wait call below to avoid this behavior. + * + * The session_name can't be NULL. + * + * Return 0 on success else a negative LTTng error code. */ 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). * - * 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 the channel_name is NULL and they are no channel for the domain, the + * default channel is created (channel0). The context is then added on ALL + * channels since no name was specified. + * + * The event_name is ignored since adding a context to an event is not possible + * for now. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_add_context(struct lttng_handle *handle, struct lttng_event_context *ctx, const char *event_name, const char *channel_name); /* - * Create or enable a kernel event (or events) for a channel. + * Create or enable an event (or events) for a channel. * * 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). + * else it is enabled. If channel_name is NULL, the default channel is used + * (channel0). + * + * The handle and ev params can not be NULL. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_enable_event(struct lttng_handle *handle, struct lttng_event *ev, const char *channel_name); /* - * Create or enable a kernel channel. - * The channel name cannot be NULL. + * Create or enable an event with a specific filter. + * + * 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. + * + * Return 0 on success else a negative LTTng error code. + */ +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 an event with a filter and/or exclusions. + * + * 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 the filter and exclusion options. + * 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. + * If exclusion count is zero, the event will be created without exclusions. + * + * Return 0 on success else a negative LTTng error code. + */ +extern int lttng_enable_event_with_exclusions(struct lttng_handle *handle, + struct lttng_event *event, const char *channel_name, + const char *filter_expression, + int exclusion_count, char **exclusion_names); + +/* + * Create or enable a channel. + * + * The chan and handle params can not be NULL. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_enable_channel(struct lttng_handle *handle, struct lttng_channel *chan); /* - * Disable kernel event(s) of a channel and domain. + * 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). + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_disable_event(struct lttng_handle *handle, const char *name, const char *channel_name); /* - * Disable kernel channel. + * Disable channel. + * + * Name and handle CAN NOT be NULL. * - * The channel name cannot be NULL. + * Return 0 on success else a negative LTTng error code. */ extern int lttng_disable_channel(struct lttng_handle *handle, const char *name); /* * Calibrate LTTng overhead. + * + * The chan and handle params can not be NULL. + * + * Return 0 on success else a negative LTTng error code. */ extern int lttng_calibrate(struct lttng_handle *handle, struct lttng_calibrate *calibrate); @@ -439,9 +687,79 @@ 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); -#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. + * + * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH] + * + * Possible protocols are: + * > file://... + * Local filesystem full path. + * + * > net[6]://... + * This will use the default network transport layer which is TCP for both + * control (PORT1) and data port (PORT2). + * + * > tcp[6]://... + * TCP only streaming. For this one, both data and control URL must be given. + * + * Return 0 on success else a negative LTTng error code. + */ +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 LTTNG_DEPRECATED("This call is now obsolete.") +int lttng_enable_consumer(struct lttng_handle *handle); + +/* + * Disable consumer for a session and domain. + */ +extern LTTNG_DEPRECATED("This call is now obsolete.") +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(). + * + * Please see lttng-health-check(3) man page for more information. + */ +extern LTTNG_DEPRECATED("This call is now obsolete.") +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 */