X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=bcccdb47733722420a6997c506df00d06913c60e;hp=bdbf5e93550ea40aa86e1da17e02badf506da3ff;hb=0b2dc8df2a6d7b3341a72a04767dd6328907c97c;hpb=8d326ab9f5a306225833ebbfec0a790b7cbc1856 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index bdbf5e935..bcccdb477 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,20 @@ * 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 +/* Error codes that can be returned by API calls */ +#include + +#ifdef __cplusplus +extern "C" { +#endif + /* * Event symbol length. Copied from LTTng kernel ABI. */ @@ -76,6 +83,27 @@ 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, +}; + /* * LTTng consumer mode */ @@ -97,16 +125,39 @@ 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, }; -#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_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 +167,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 +181,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 +202,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 +217,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 +229,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 15 #define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_event { enum lttng_event_type type; @@ -176,8 +241,9 @@ 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 ? */ char padding[LTTNG_EVENT_PADDING1]; @@ -190,10 +256,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 + 16 struct lttng_channel_attr { int overwrite; /* 1: overwrite, 0: discard */ uint64_t subbuf_size; /* bytes */ @@ -201,12 +286,17 @@ 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 */ 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,6 +320,8 @@ 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 struct lttng_session { @@ -243,6 +335,8 @@ struct lttng_session { /* * Handle used as a context for commands. + * + * The structures should be initialized to zero before use. */ #define LTTNG_HANDLE_PADDING1 16 struct lttng_handle { @@ -278,22 +372,28 @@ extern struct lttng_handle *lttng_create_handle(const char *session_name, 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); /* * 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); @@ -341,6 +441,15 @@ extern int lttng_list_events(struct lttng_handle *handle, 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. * @@ -351,7 +460,8 @@ 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 value on error being a lttng error + * code found in lttng-error.h */ extern int lttng_set_tracing_group(const char *name); @@ -380,57 +490,90 @@ 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. + * + * 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 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); @@ -439,9 +582,63 @@ 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. + */ +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 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 */