X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=include%2Flttng%2Flttng.h;h=c79042bf4bf0c6fe2f9eaeb21b55ddc5b9e6a430;hb=bab308e25fe3c86e385e22618cb64e68e6cf0dea;hp=bdbf5e93550ea40aa86e1da17e02badf506da3ff;hpb=8d326ab9f5a306225833ebbfec0a790b7cbc1856;p=lttng-tools.git diff --git a/include/lttng/lttng.h b/include/lttng/lttng.h index bdbf5e935..c79042bf4 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 @@ -76,6 +76,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 */ @@ -103,6 +124,9 @@ enum lttng_calibrate_type { LTTNG_CALIBRATE_FUNCTION = 0, }; +/* + * 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 { @@ -116,7 +140,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 +154,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 +175,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 +190,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,6 +202,8 @@ 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_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32 @@ -176,7 +214,7 @@ struct lttng_event { enum lttng_loglevel_type loglevel_type; int loglevel; - uint32_t enabled; + int32_t enabled; pid_t pid; char padding[LTTNG_EVENT_PADDING1]; @@ -192,6 +230,8 @@ struct lttng_event { /* * 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 { @@ -207,6 +247,8 @@ struct lttng_channel_attr { /* * 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 +272,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 +287,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 { @@ -395,7 +441,7 @@ extern int lttng_add_context(struct lttng_handle *handle, 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. @@ -406,14 +452,14 @@ extern int lttng_enable_event(struct lttng_handle *handle, struct lttng_event *ev, const char *channel_name); /* - * Create or enable a kernel channel. + * 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(s) of a channel and domain. + * 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). @@ -422,7 +468,7 @@ 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. */