* 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 <netinet/in.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
+
+#ifndef LTTNG_PACKED
+#define LTTNG_PACKED __attribute__((__packed__))
+#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.
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,
};
/*
char exec_name[NAME_MAX];
char padding[LTTNG_DOMAIN_PADDING2];
} attr;
-};
+} LTTNG_PACKED;
/*
* Perf counter attributes
char name[LTTNG_SYMBOL_NAME_LEN];
char padding[LTTNG_PERF_EVENT_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Event/channel context
struct lttng_event_perf_counter_ctx perf_counter;
char padding[LTTNG_EVENT_CONTEXT_PADDING2];
} u;
-};
+} LTTNG_PACKED;
/*
* Event probe.
char symbol_name[LTTNG_SYMBOL_NAME_LEN];
char padding[LTTNG_EVENT_PROBE_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Function tracer
char symbol_name[LTTNG_SYMBOL_NAME_LEN];
char padding[LTTNG_EVENT_FUNCTION_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Generic lttng event
*
* The structures should be initialized to zero before use.
*/
-#define LTTNG_EVENT_PADDING1 16
+#define LTTNG_EVENT_PADDING1 15
#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_event {
enum lttng_event_type type;
int32_t enabled; /* Does not apply: -1 */
pid_t pid;
+ unsigned char filter; /* filter enabled ? */
char padding[LTTNG_EVENT_PADDING1];
char padding[LTTNG_EVENT_PADDING2];
} attr;
-};
+} LTTNG_PACKED;
enum lttng_event_field_type {
LTTNG_EVENT_FIELD_OTHER = 0,
enum lttng_event_field_type type;
char padding[LTTNG_EVENT_FIELD_PADDING];
struct lttng_event event;
-};
+ int nowrite;
+} LTTNG_PACKED;
/*
* Tracer channel attributes. For both kernel and user-space.
enum lttng_event_output output; /* splice, mmap */
char padding[LTTNG_CHANNEL_ATTR_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Channel information structure. For both kernel and user-space.
struct lttng_channel_attr attr;
char padding[LTTNG_CHANNEL_PADDING1];
-};
+} LTTNG_PACKED;
#define LTTNG_CALIBRATE_PADDING1 16
struct lttng_calibrate {
enum lttng_calibrate_type type;
char padding[LTTNG_CALIBRATE_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Basic session information.
uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
char padding[LTTNG_SESSION_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Handle used as a context for commands.
struct lttng_domain domain;
char padding[LTTNG_HANDLE_PADDING1];
-};
+} LTTNG_PACKED;
/*
* Public LTTng control API
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 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. The name can't be
+ * NULL here.
*/
-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.
*
* 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);
/*
* 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);
/*
* 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.
+ *
+ * The session_name can't be NULL.
*/
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 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,
*
* 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);
/*
* 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,
/*
* 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);
* 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);
/*
- * 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.
*/
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().
+ *
+ * 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) (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 */
projects / lttng-tools.git / blobdiff