Document the fact that the structures should be initialized to zero in
lttng.h since there is no init function.
(close #135)
Signed-off-by: Raphaël Beamonte <raphael.beamonte@gmail.com>
Signed-off-by: David Goulet <dgoulet@efficios.com>
LTTNG_CALIBRATE_FUNCTION = 0,
};
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 {
#define LTTNG_DOMAIN_PADDING1 16
#define LTTNG_DOMAIN_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_domain {
-/* 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;
#define LTTNG_PERF_EVENT_PADDING1 16
struct lttng_event_perf_counter_ctx {
uint32_t type;
char padding[LTTNG_PERF_EVENT_PADDING1];
};
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 {
#define LTTNG_EVENT_CONTEXT_PADDING1 16
#define LTTNG_EVENT_CONTEXT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_event_context {
* Event probe.
*
* Either addr is used or symbol_name and offset.
* 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 {
*/
#define LTTNG_EVENT_PROBE_PADDING1 16
struct lttng_event_probe_attr {
+ *
+ * The structures should be initialized to zero before use.
*/
#define LTTNG_EVENT_FUNCTION_PADDING1 16
struct lttng_event_function_attr {
*/
#define LTTNG_EVENT_FUNCTION_PADDING1 16
struct lttng_event_function_attr {
+ *
+ * The structures should be initialized to zero before use.
*/
#define LTTNG_EVENT_PADDING1 16
#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
*/
#define LTTNG_EVENT_PADDING1 16
#define LTTNG_EVENT_PADDING2 LTTNG_SYMBOL_NAME_LEN + 32
/*
* Tracer channel attributes. For both kernel and user-space.
/*
* 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 {
*/
#define LTTNG_CHANNEL_ATTR_PADDING1 LTTNG_SYMBOL_NAME_LEN + 32
struct lttng_channel_attr {
/*
* Channel information structure. For both kernel and user-space.
/*
* 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 {
*/
#define LTTNG_CHANNEL_PADDING1 16
struct lttng_channel {
* 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).
* 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 {
*/
#define LTTNG_SESSION_PADDING1 16
struct lttng_session {
/*
* Handle used as a context for commands.
/*
* Handle used as a context for commands.
+ *
+ * The structures should be initialized to zero before use.
*/
#define LTTNG_HANDLE_PADDING1 16
struct lttng_handle {
*/
#define LTTNG_HANDLE_PADDING1 16
struct lttng_handle {