X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=5a826aad78bd3262063de1f14011c5d06f01a5c4;hp=3b1be61974bd8f60558ae34b948ef41751e1e34e;hb=321d0ee36e3c7f9d38647cb171f5760f4278c784;hpb=f37d259d342af1ff8855d9eaa578cb7a3cfcc4f2 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index 3b1be6197..5a826aad7 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -19,13 +19,24 @@ * 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 + +#ifndef LTTNG_PACKED +#define LTTNG_PACKED __attribute__((__packed__)) +#endif + /* * Event symbol length. Copied from LTTng kernel ABI. */ @@ -80,21 +91,21 @@ enum lttng_loglevel_type { * 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, }; /* @@ -118,12 +129,23 @@ 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, }; +/* 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, +}; + /* * The structures should be initialized to zero before use. */ @@ -138,7 +160,7 @@ struct lttng_domain { char exec_name[NAME_MAX]; char padding[LTTNG_DOMAIN_PADDING2]; } attr; -}; +} LTTNG_PACKED; /* * Perf counter attributes @@ -152,7 +174,7 @@ struct lttng_event_perf_counter_ctx { char name[LTTNG_SYMBOL_NAME_LEN]; char padding[LTTNG_PERF_EVENT_PADDING1]; -}; +} LTTNG_PACKED; /* * Event/channel context @@ -169,7 +191,7 @@ struct lttng_event_context { struct lttng_event_perf_counter_ctx perf_counter; char padding[LTTNG_EVENT_CONTEXT_PADDING2]; } u; -}; +} LTTNG_PACKED; /* * Event probe. @@ -186,7 +208,7 @@ struct lttng_event_probe_attr { char symbol_name[LTTNG_SYMBOL_NAME_LEN]; char padding[LTTNG_EVENT_PROBE_PADDING1]; -}; +} LTTNG_PACKED; /* * Function tracer @@ -198,14 +220,14 @@ struct lttng_event_function_attr { 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; @@ -214,8 +236,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]; @@ -226,7 +249,7 @@ struct lttng_event { char padding[LTTNG_EVENT_PADDING2]; } attr; -}; +} LTTNG_PACKED; enum lttng_event_field_type { LTTNG_EVENT_FIELD_OTHER = 0, @@ -242,7 +265,8 @@ struct lttng_event_field { 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. @@ -259,7 +283,7 @@ struct lttng_channel_attr { enum lttng_event_output output; /* splice, mmap */ char padding[LTTNG_CHANNEL_ATTR_PADDING1]; -}; +} LTTNG_PACKED; /* * Channel information structure. For both kernel and user-space. @@ -273,14 +297,14 @@ struct lttng_channel { 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. @@ -299,7 +323,7 @@ struct lttng_session { uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ char padding[LTTNG_SESSION_PADDING1]; -}; +} LTTNG_PACKED; /* * Handle used as a context for commands. @@ -312,7 +336,7 @@ struct lttng_handle { struct lttng_domain domain; char padding[LTTNG_HANDLE_PADDING1]; -}; +} LTTNG_PACKED; /* * Public LTTng control API @@ -340,22 +364,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); @@ -422,7 +452,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); @@ -451,15 +482,30 @@ 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, @@ -470,15 +516,32 @@ extern int lttng_add_context(struct lttng_handle *handle, * * 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 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 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); @@ -486,7 +549,7 @@ extern int lttng_enable_channel(struct lttng_handle *handle, /* * 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, @@ -495,13 +558,14 @@ 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); @@ -510,9 +574,61 @@ 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 int lttng_enable_consumer(struct lttng_handle *handle); + +/* + * Disable consumer for a session and domain. + */ +extern 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 */