X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=280075037abdf9515111b90f4cb0756f33d752c3;hp=2cbb7f7ed38ddcda2f5efb0ac926d89b9e1f9863;hb=464dd62d5617322366e321877b440951e00a0152;hpb=8f0d098bc0b14f00c4d6ea3f48809626fa1c416f diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index 2cbb7f7ed..280075037 100644 --- a/include/lttng/lttng.h +++ b/include/lttng/lttng.h @@ -23,10 +23,9 @@ #ifndef _LTTNG_H #define _LTTNG_H -#include -#include -#include #include +#include +#include /* Default unix group name for tracing. */ #define LTTNG_DEFAULT_TRACING_GROUP "tracing" @@ -51,29 +50,24 @@ * Domain type are the different possible tracers. */ enum lttng_domain_type { - LTTNG_DOMAIN_KERNEL, - LTTNG_DOMAIN_UST, - LTTNG_DOMAIN_UST_EXEC_NAME, - LTTNG_DOMAIN_UST_PID, - LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN, -}; - -struct lttng_domain { - enum lttng_domain_type type; - union { - pid_t pid; - char exec_name[NAME_MAX]; - } attr; + LTTNG_DOMAIN_KERNEL = 1, + LTTNG_DOMAIN_UST = 2, + LTTNG_DOMAIN_UST_EXEC_NAME = 3, + LTTNG_DOMAIN_UST_PID = 4, + LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN = 5, }; /* * Instrumentation type of tracing event. */ enum lttng_event_type { - LTTNG_EVENT_TRACEPOINT, - LTTNG_EVENT_PROBE, - LTTNG_EVENT_FUNCTION, - LTTNG_EVENT_FUNCTION_ENTRY, + LTTNG_EVENT_ALL = -1, + LTTNG_EVENT_TRACEPOINT = 0, + LTTNG_EVENT_PROBE = 1, + LTTNG_EVENT_FUNCTION = 2, + LTTNG_EVENT_FUNCTION_ENTRY = 3, + LTTNG_EVENT_NOOP = 4, + LTTNG_EVENT_SYSCALL = 5, }; /* @@ -98,6 +92,18 @@ enum lttng_event_context_type { LTTNG_EVENT_CONTEXT_VPPID = 9, }; +enum lttng_calibrate_type { + LTTNG_CALIBRATE_FUNCTION = 0, +}; + +struct lttng_domain { + enum lttng_domain_type type; + union { + pid_t pid; + char exec_name[NAME_MAX]; + } attr; +}; + /* Perf counter attributes */ struct lttng_event_perf_counter_ctx { uint32_t type; @@ -138,6 +144,8 @@ struct lttng_event_function_attr { struct lttng_event { char name[LTTNG_SYMBOL_NAME_LEN]; enum lttng_event_type type; + uint32_t enabled; + pid_t pid; /* Per event type configuration */ union { struct lttng_event_probe_attr probe; @@ -162,9 +170,14 @@ struct lttng_channel_attr { */ struct lttng_channel { char name[NAME_MAX]; + uint32_t enabled; struct lttng_channel_attr attr; }; +struct lttng_calibrate { + enum lttng_calibrate_type type; +}; + /* * Basic session information. * @@ -176,6 +189,15 @@ 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 */ +}; + +/* + * Handle used as a context for commands. + */ +struct lttng_handle { + char session_name[NAME_MAX]; + struct lttng_domain domain; }; /* @@ -188,12 +210,23 @@ struct lttng_session { * array. * * On error, a negative value is returned being a specific lttng-tools error - * code which can be humanly interpreted with lttng_get_readable_code(err). + * code which can be humanly interpreted with lttng_strerror(err). */ /* - * Session daemon control + * Create an 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. + */ +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. */ +extern void lttng_destroy_handle(struct lttng_handle *handle); /* * Create tracing session using a name and a path where trace will be written. @@ -206,16 +239,47 @@ extern int lttng_create_session(const char *name, const char *path); * The session will not be useable anymore, tracing will stopped for all * registered trace and tracing buffers will be flushed. */ -extern int lttng_destroy_session(const char *name); +extern int lttng_destroy_session(struct lttng_handle *handle); /* - * List tracing sessions. + * List all tracing sessions. * - * Return the size of the "lttng_session" array. Caller must free(3) the - * returned data. + * Return the size 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. + * + * Return the size of the "lttng_domain" array. Caller must free(3). + */ +extern int lttng_list_domains(struct lttng_handle *handle, + struct lttng_domain **domains); + +/* + * List channel(s) of a session. + * + * Return the size 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. + * + * Return the size 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. + * + * Return the size of the "lttng_event" array. Caller must free(3). + */ +extern int lttng_list_tracepoints(struct lttng_handle *handle, + struct lttng_event **events); + /* * Check if a session daemon is alive. */ @@ -227,30 +291,32 @@ extern int lttng_session_daemon_alive(void); extern int lttng_set_tracing_group(const char *name); /* - * Set the session name of the *current* flow of execution. + * Return a human readable error message of a lttng-tools error code. * - * This is a VERY important things to do before doing any tracing actions. If - * it's not done, you'll get an error saying that the session is not found. - * It avoids the use of a session name on every API call. + * Parameter MUST be a negative value or else you'll get a generic message. */ -extern void lttng_set_session_name(const char *name); +extern const char *lttng_strerror(int code); /* - * Return a human readable error message of a lttng-tools error 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). * - * Parameter MUST be a negative value or else you'll get a generic message. + * 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. */ -extern const char *lttng_get_readable_code(int code); +extern int lttng_register_consumer(struct lttng_handle *handle, + const char *socket_path); /* * Start tracing for *all* registered trace (kernel and user-space). */ -extern int lttng_start_tracing(const char *session_name); +extern int lttng_start_tracing(struct lttng_handle *handle); /* * Stop tracing for *all* registered trace (kernel and user-space). */ -extern int lttng_stop_tracing(const char *session_name); +extern int lttng_stop_tracing(struct lttng_handle *handle); /* * Add context to event for a specific channel. @@ -259,8 +325,7 @@ extern int lttng_stop_tracing(const char *session_name); * 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. */ - -extern int lttng_add_context(struct lttng_domain *domain, +extern int lttng_add_context(struct lttng_handle *handle, struct lttng_event_context *ctx, const char *event_name, const char *channel_name); @@ -272,15 +337,15 @@ extern int lttng_add_context(struct lttng_domain *domain, * * If channel_name is NULL, the default channel is used (channel0). */ -extern int lttng_enable_event(struct lttng_domain *domain, struct lttng_event *ev, - const char *channel_name); +extern int lttng_enable_event(struct lttng_handle *handle, + struct lttng_event *ev, const char *channel_name); /* * Create or enable a kernel channel. * * If name is NULL, the default channel is enabled (channel0). */ -extern int lttng_enable_channel(struct lttng_domain *domain, +extern int lttng_enable_channel(struct lttng_handle *handle, struct lttng_channel *chan); /* @@ -288,22 +353,21 @@ extern int lttng_enable_channel(struct lttng_domain *domain, * * If channel_name is NULL, the default channel is used (channel0). */ -extern int lttng_disable_event(struct lttng_domain *domain, const char *name, - const char *channel_name); +extern int lttng_disable_event(struct lttng_handle *handle, + const char *name, const char *channel_name); /* * Disable kernel channel. * * If channel_name is NULL, the default channel is disabled (channel0). */ -extern int lttng_disable_channel(struct lttng_domain *domain, +extern int lttng_disable_channel(struct lttng_handle *handle, const char *name); /* - * List kernel events. - * - * Return the size of the allocated event list. Caller must free(3) the data. + * Calibrate LTTng overhead. */ -extern int lttng_list_events(struct lttng_domain *domain, char **event_list); +extern int lttng_calibrate(struct lttng_handle *handle, + struct lttng_calibrate *calibrate); #endif /* _LTTNG_H */