1 #ifndef _BABELTRACE_CTF_EVENTS_H
2 #define _BABELTRACE_CTF_EVENTS_H
9 * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
11 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 * Julien Desfossez <julien.desfossez@efficios.com>
14 * Permission is hereby granted, free of charge, to any person obtaining
15 * a copy of this software and associated documentation files (the
16 * "Software"), to deal in the Software without restriction, including
17 * without limitation the rights to use, copy, modify, merge, publish,
18 * distribute, sublicense, and/or sell copies of the Software, and to
19 * permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice shall be
23 * included in all copies or substantial portions of the Software.
27 #include <babeltrace/context.h>
31 struct bt_ctf_event_decl
;
34 * the top-level scopes in CTF
37 BT_TRACE_PACKET_HEADER
= 0,
38 BT_STREAM_PACKET_CONTEXT
= 1,
39 BT_STREAM_EVENT_HEADER
= 2,
40 BT_STREAM_EVENT_CONTEXT
= 3,
46 * the supported CTF types
55 CTF_TYPE_UNTAGGED_VARIANT
,
63 * the supported CTF string encodings
65 enum ctf_string_encoding
{
73 * bt_ctf_get_top_level_scope: return a definition of the top-level scope
75 * Top-level scopes are defined in the bt_ctf_scope enum.
76 * In order to get a field or a field list, the user needs to pass a
77 * scope as argument, this scope can be a top-level scope or a scope
78 * relative to an arbitrary field. This function provides the mapping
79 * between the enum and the actual definition of top-level scopes.
80 * On error return NULL.
82 const struct definition
*bt_ctf_get_top_level_scope(const struct bt_ctf_event
*event
,
83 enum bt_ctf_scope scope
);
86 * bt_ctf_event_get_name: returns the name of the event or NULL on error
88 const char *bt_ctf_event_name(const struct bt_ctf_event
*event
);
91 * bt_ctf_get_timestamp_raw: returns the timestamp of the event as written in
92 * the packet or -1ULL on error
94 uint64_t bt_ctf_get_timestamp_raw(const struct bt_ctf_event
*event
);
97 * bt_ctf_get_timestamp: returns the timestamp of the event offsetted with the
98 * system clock source or -1ULL on error
100 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event
*event
);
103 * bt_ctf_get_field_list: set list pointer to an array of definition
104 * pointers and set count to the number of elements in the array.
105 * Return 0 on success and a negative value on error.
107 int bt_ctf_get_field_list(const struct bt_ctf_event
*event
,
108 const struct definition
*scope
,
109 struct definition
const * const **list
,
110 unsigned int *count
);
113 * bt_ctf_get_field: returns the definition of a specific field
115 const struct definition
*bt_ctf_get_field(const struct bt_ctf_event
*event
,
116 const struct definition
*scope
,
120 * bt_ctf_get_index: if the field is an array or a sequence, return the element
121 * at position index, otherwise return NULL;
123 const struct definition
*bt_ctf_get_index(const struct bt_ctf_event
*event
,
124 const struct definition
*field
,
128 * bt_ctf_field_name: returns the name of a field or NULL on error
130 const char *bt_ctf_field_name(const struct definition
*def
);
133 * bt_ctf_field_type: returns the type of a field or -1 if unknown
135 enum ctf_type_id
bt_ctf_field_type(const struct definition
*def
);
138 * bt_ctf_get_int_signedness: return the signedness of an integer
140 * return 0 if unsigned
144 int bt_ctf_get_int_signedness(const struct definition
*field
);
147 * bt_ctf_get_int_base: return the base of an int or a negative value on error
149 int bt_ctf_get_int_base(const struct definition
*field
);
152 * bt_ctf_get_int_byte_order: return the byte order of an int or a negative
155 int bt_ctf_get_int_byte_order(const struct definition
*field
);
158 * bt_ctf_get_encoding: return the encoding of an int or a string.
159 * return a negative value on error
161 enum ctf_string_encoding
bt_ctf_get_encoding(const struct definition
*field
);
164 * bt_ctf_get_array_len: return the len of an array or a negative
167 int bt_ctf_get_array_len(const struct definition
*field
);
170 * Field access functions
172 * These functions return the value associated with the field passed in
175 * If the field does not exist or is not of the type requested, the value
176 * returned is undefined. To check if an error occured, use the
177 * bt_ctf_field_error() function after accessing a field.
179 uint64_t bt_ctf_get_uint64(const struct definition
*field
);
180 int64_t bt_ctf_get_int64(const struct definition
*field
);
181 char *bt_ctf_get_char_array(const struct definition
*field
);
182 char *bt_ctf_get_string(const struct definition
*field
);
185 * bt_ctf_field_error: returns the last error code encountered while
186 * accessing a field and reset the error flag.
187 * Return 0 if no error, a negative value otherwise.
189 int bt_ctf_field_get_error(void);
192 * bt_ctf_get_event_decl_list: set list pointer to an array of bt_ctf_event_decl
193 * pointers and set count to the number of elements in the array.
195 * Return 0 on success and a negative value on error.
197 int bt_ctf_get_event_decl_list(int handle_id
, struct bt_context
*ctx
,
198 struct bt_ctf_event_decl
const * const **list
,
199 unsigned int *count
);
202 * bt_ctf_get_decl_event_name: return the name of the event or NULL on error
204 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl
*event
);
206 #endif /* _BABELTRACE_CTF_EVENTS_H */