X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=9e2d4d129894878631d38452f05bc5ffc25c946a;hp=f1c913b66b639f5244bb0282e1b734282df85656;hb=178191b3899f114001f000c2e7f46909969f9c6f;hpb=045e5491d29048a9d888559cd91d6d6f304fc171 diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index f1c913b66..9e2d4d129 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -5,41 +5,38 @@ * * 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. + * This library is free software; you can redistribute it and/or modify it + * 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 FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. + * This library is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License + * for more details. * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * You should have received a copy of the GNU Lesser General Public License + * along with this library; if not, write to the Free Software Foundation, + * 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 -/* Default unix group name for tracing. */ -#define LTTNG_DEFAULT_TRACING_GROUP "tracing" +/* Error codes that can be returned by API calls */ +#include -/* Environment variable to set session daemon binary path. */ -#define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH" - -/* Default trace output directory name */ -#define LTTNG_DEFAULT_TRACE_DIR_NAME "lttng-traces" +#ifdef __cplusplus +extern "C" { +#endif /* * Event symbol length. Copied from LTTng kernel ABI. */ -#define LTTNG_SYMBOL_NAME_LEN 256 +#define LTTNG_SYMBOL_NAME_LEN 256 /* * Every lttng_event_* structure both apply to kernel event and user-space @@ -47,14 +44,21 @@ */ /* - * Domain type are the different possible tracers. + * 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, + */ }; /* @@ -68,55 +72,120 @@ enum lttng_event_type { LTTNG_EVENT_FUNCTION_ENTRY = 3, LTTNG_EVENT_NOOP = 4, LTTNG_EVENT_SYSCALL = 5, - LTTNG_EVENT_TRACEPOINT_LOGLEVEL = 6, +}; + +/* + * Loglevel information. + */ +enum lttng_loglevel_type { + LTTNG_EVENT_LOGLEVEL_ALL = 0, + LTTNG_EVENT_LOGLEVEL_RANGE = 1, + 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 */ enum lttng_event_output { - LTTNG_EVENT_SPLICE = 0, - LTTNG_EVENT_MMAP = 1, + LTTNG_EVENT_SPLICE = 0, + LTTNG_EVENT_MMAP = 1, }; /* Event context possible type */ enum lttng_event_context_type { - LTTNG_EVENT_CONTEXT_PID = 0, - LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, - LTTNG_EVENT_CONTEXT_COMM = 2, - LTTNG_EVENT_CONTEXT_PRIO = 3, - LTTNG_EVENT_CONTEXT_NICE = 4, - LTTNG_EVENT_CONTEXT_VPID = 5, - LTTNG_EVENT_CONTEXT_TID = 6, - LTTNG_EVENT_CONTEXT_VTID = 7, - LTTNG_EVENT_CONTEXT_PPID = 8, - LTTNG_EVENT_CONTEXT_VPPID = 9, + LTTNG_EVENT_CONTEXT_PID = 0, + LTTNG_EVENT_CONTEXT_PERF_COUNTER = 1, + LTTNG_EVENT_CONTEXT_PROCNAME = 2, + LTTNG_EVENT_CONTEXT_PRIO = 3, + LTTNG_EVENT_CONTEXT_NICE = 4, + LTTNG_EVENT_CONTEXT_VPID = 5, + LTTNG_EVENT_CONTEXT_TID = 6, + LTTNG_EVENT_CONTEXT_VTID = 7, + 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, + 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. + */ +#define LTTNG_DOMAIN_PADDING1 16 +#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_domain { enum lttng_domain_type type; + char padding[LTTNG_DOMAIN_PADDING1]; + union { pid_t pid; char exec_name[NAME_MAX]; + char padding[LTTNG_DOMAIN_PADDING2]; } 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; uint64_t config; char name[LTTNG_SYMBOL_NAME_LEN]; + + 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 { enum lttng_event_context_type ctx; + char padding[LTTNG_EVENT_CONTEXT_PADDING1]; + union { struct lttng_event_perf_counter_ctx perf_counter; + char padding[LTTNG_EVENT_CONTEXT_PADDING2]; } u; }; @@ -124,41 +193,83 @@ 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 { uint64_t addr; uint64_t offset; char symbol_name[LTTNG_SYMBOL_NAME_LEN]; + + char padding[LTTNG_EVENT_PROBE_PADDING1]; }; /* * Function tracer + * + * The structures should be initialized to zero before use. */ +#define LTTNG_EVENT_FUNCTION_PADDING1 16 struct lttng_event_function_attr { char symbol_name[LTTNG_SYMBOL_NAME_LEN]; + + char padding[LTTNG_EVENT_FUNCTION_PADDING1]; }; /* * Generic lttng event + * + * The structures should be initialized to zero before use. */ +#define LTTNG_EVENT_PADDING1 15 +#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 struct lttng_event { - char name[LTTNG_SYMBOL_NAME_LEN]; - char loglevel[LTTNG_SYMBOL_NAME_LEN]; - int64_t loglevel_value; enum lttng_event_type type; - uint32_t enabled; + char name[LTTNG_SYMBOL_NAME_LEN]; + + enum lttng_loglevel_type loglevel_type; + int loglevel; + + int32_t enabled; /* Does not apply: -1 */ pid_t pid; + unsigned char filter; /* filter enabled ? */ + + char padding[LTTNG_EVENT_PADDING1]; + /* Per event type configuration */ union { struct lttng_event_probe_attr probe; struct lttng_event_function_attr ftrace; + + char padding[LTTNG_EVENT_PADDING2]; } 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 struct lttng_channel_attr { int overwrite; /* 1: overwrite, 0: discard */ uint64_t subbuf_size; /* bytes */ @@ -166,19 +277,29 @@ struct lttng_channel_attr { unsigned int switch_timer_interval; /* usec */ unsigned int read_timer_interval; /* usec */ enum lttng_event_output output; /* splice, mmap */ + + 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 { char name[LTTNG_SYMBOL_NAME_LEN]; uint32_t enabled; struct lttng_channel_attr attr; + + char padding[LTTNG_CHANNEL_PADDING1]; }; +#define LTTNG_CALIBRATE_PADDING1 16 struct lttng_calibrate { enum lttng_calibrate_type type; + + char padding[LTTNG_CALIBRATE_PADDING1]; }; /* @@ -187,123 +308,156 @@ 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 { char name[NAME_MAX]; /* The path where traces are written */ char path[PATH_MAX]; uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */ + + 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 { char session_name[NAME_MAX]; struct lttng_domain domain; + + char padding[LTTNG_HANDLE_PADDING1]; }; /* * Public LTTng control API * - * For functions having a lttng domain type as parameter, if a bad value is + * For functions having an lttng domain type as parameter, if a bad value is * given, NO default is applied and an error is returned. * * On success, all functions of the API return 0 or the size of the allocated - * array. + * array (in bytes). * * On error, a negative value is returned being a specific lttng-tools error * code which can be humanly interpreted with lttng_strerror(err). + * + * Exceptions to this are noted below. */ /* - * Create an handle used as a context for every request made to the library. + * Create a handle used as a context for every request made to the library. * * This handle contains the session name and lttng domain on which the command - * will be executed on. + * will be executed. + * The returned pointer will be NULL in case of malloc() error. */ extern struct lttng_handle *lttng_create_handle(const char *session_name, struct lttng_domain *domain); /* - * Destroy an handle. This will simply free(3) the data pointer returned by - * lttng_create_handle() and rendering it unsuable. + * Destroy a handle. This will simply free(3) the data pointer returned by + * lttng_create_handle(), rendering it unusable. */ extern void lttng_destroy_handle(struct lttng_handle *handle); /* - * Create tracing session using a name and a path where 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. */ -extern int lttng_create_session(const char *name, const char *path); +extern int lttng_create_session(const char *name, const char *url); /* - * Destroy tracing session. + * Destroy a tracing session. * - * The session will not be useable anymore, tracing will stopped for all - * registered trace and tracing buffers will be flushed. + * The session will not be usable anymore, tracing will be stopped for all + * registered traces, and the tracing buffers will be flushed. */ extern int lttng_destroy_session(const char *name); /* - * List all tracing sessions. + * List all the tracing sessions. * - * Return the size of the "lttng_session" array. Caller must free(3). + * Return the size (number of entries) of the "lttng_session" array. Caller + * must free(3). */ extern int lttng_list_sessions(struct lttng_session **sessions); /* - * List registered domain(s) of a session. + * List the registered domain(s) of a session. * - * Return the size of the "lttng_domain" array. Caller must free(3). + * Return the size (number of entries) of the "lttng_domain" array. Caller + * must free(3). */ extern int lttng_list_domains(const char *session_name, struct lttng_domain **domains); /* - * List channel(s) of a session. + * List the channel(s) of a session. * - * Return the size of the "lttng_channel" array. Caller must free(3). + * Return the size (number of entries) of the "lttng_channel" array. Caller + * must free(3). */ extern int lttng_list_channels(struct lttng_handle *handle, struct lttng_channel **channels); /* - * List event(s) of a session channel. + * List the event(s) of a session channel. * - * Return the size of the "lttng_event" array. Caller must free(3). + * Return the size (number of entries) of the "lttng_event" array. + * Caller must free(3). */ extern int lttng_list_events(struct lttng_handle *handle, const char *channel_name, struct lttng_event **events); /* - * List available tracepoints of a specific lttng domain. + * List the available tracepoints of a specific lttng domain. * - * Return the size of the "lttng_event" array. Caller must free(3). + * Return the size (number of entries) of the "lttng_event" array. + * Caller must free(3). */ 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. + * + * Return 1 if alive or 0 if not. On error returns a negative value. */ extern int lttng_session_daemon_alive(void); /* - * Set tracing group for the *current* flow of execution. + * Set the tracing group for the *current* flow of execution. + * + * On success, returns 0, on error, returns -1 (null name) or -ENOMEM. */ extern int lttng_set_tracing_group(const char *name); /* - * Return a human readable error message of a lttng-tools error code. + * Return a human-readable error message for an lttng-tools error code. * * Parameter MUST be a negative value or else you'll get a generic message. */ extern const char *lttng_strerror(int code); /* - * This call permits to register an "outside consumer" to a session and a lttng - * domain. No consumer will be spawned and all fds/commands will go through the - * socket path given (socket_path). + * This call registers an "outside consumer" for a session and an lttng domain. + * 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. @@ -312,57 +466,79 @@ extern int lttng_register_consumer(struct lttng_handle *handle, const char *socket_path); /* - * Start tracing for *all* registered trace (kernel and user-space). + * Start tracing for *all* registered traces (kernel and user-space). */ extern int lttng_start_tracing(const char *session_name); /* - * Stop tracing for *all* registered trace (kernel and user-space). + * 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. */ extern int lttng_stop_tracing(const char *session_name); /* - * Add context to event for a specific channel. + * 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 event of the channel. + * 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 on all events of all channels. + * If both are NULL, the context is applied to all events of all channels. */ 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. + * 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). */ extern int lttng_enable_event(struct lttng_handle *handle, struct lttng_event *ev, const char *channel_name); /* - * Create or enable a kernel channel. + * Apply a filter expression to an event. * - * If name is NULL, the default channel is enabled (channel0). + * If event 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, + struct lttng_event *event, const char *channel_name, + const char *filter_expression); + +/* + * Create or enable a channel. + * The channel name cannot be NULL. */ extern int lttng_enable_channel(struct lttng_handle *handle, struct lttng_channel *chan); /* - * Disable kernel event. + * Disable event(s) of a channel and domain. * + * If event_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. * - * If channel_name is NULL, the default channel is disabled (channel0). + * The channel name cannot be NULL. */ extern int lttng_disable_channel(struct lttng_handle *handle, const char *name); @@ -376,8 +552,60 @@ 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. */ 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(). + */ +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 */