* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
*
* 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
* 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>
+/*
+ * 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 <stdint.h>
+#undef __STDC_LIMIT_MACROS
+#else /* #ifndef __STDC_LIMIT_MACROS */
#include <stdint.h>
+#endif /* #else #ifndef __STDC_LIMIT_MACROS */
#include <sys/types.h>
+/* Error codes that can be returned by API calls */
+#include <lttng/lttng-error.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
/*
* Event symbol length. Copied from LTTng kernel ABI.
*/
* 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. */
};
/*
* 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,
+ 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,
};
/*
/* 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,
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 {
} 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;
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 {
* 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 {
/*
* Function tracer
+ *
+ * The structures should be initialized to zero before use.
*/
#define LTTNG_EVENT_FUNCTION_PADDING1 16
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;
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];
} 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 */
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 {
* 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 {
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.
+ * 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(const char *name, const char *path);
+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.
+ *
+ * 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.
+ *
+ * Name can't be NULL.
+ */
+extern int lttng_create_session_snapshot(const char *name,
+ const char *snapshot_url);
+
+/*
+ * 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.
+ *
+ * Returns LTTNG_OK on success or a negative error code.
+ */
+extern int lttng_create_session_live(const char *name, const char *url,
+ unsigned int timer_interval);
/*
* 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);
extern int lttng_list_tracepoints(struct lttng_handle *handle,
struct lttng_event **events);
+/*
+ * List the available tracepoints fields of a specific lttng domain.
+ *
+ * Return the size (number of entries) of the "lttng_event_field" array.
+ * Caller must free(3).
+ */
+extern int lttng_list_tracepoint_fields(struct lttng_handle *handle,
+ struct lttng_event_field **fields);
+
/*
* Check if a session daemon is alive.
*
/*
* 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,
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).
+ *
+ * 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);
/*
- * 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.
+ */
+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.
+ */
+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.
*/
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).
*/
extern int lttng_disable_event(struct lttng_handle *handle,
const char *name, const char *channel_name);
/*
- * Disable kernel channel.
+ * 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);
-#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.
+ */
+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 */
projects / lttng-tools.git / blobdiff