Fix: misplaced C++ ifdef
[babeltrace.git] / include / babeltrace / ctf / events.h
CommitLineData
9843982d
JD
1#ifndef _BABELTRACE_CTF_EVENTS_H
2#define _BABELTRACE_CTF_EVENTS_H
3
4/*
5 * BabelTrace
6 *
7 * CTF events API
8 *
9 * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
10 *
11 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
12 * Julien Desfossez <julien.desfossez@efficios.com>
13 *
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:
21 *
22 * The above copyright notice and this permission notice shall be
23 * included in all copies or substantial portions of the Software.
24 */
25
26#include <stdint.h>
e003ab50 27#include <babeltrace/context.h>
03798a93 28#include <babeltrace/clock-types.h>
9843982d 29
6946751f
JD
30#ifdef __cplusplus
31extern "C" {
32#endif
33
9843982d 34struct definition;
2bdfa4cf 35struct declaration;
c50d2a7a 36struct bt_ctf_event;
e003ab50 37struct bt_ctf_event_decl;
64c2c249 38struct bt_ctf_field_decl;
9843982d
JD
39
40/*
41 * the top-level scopes in CTF
42 */
43enum bt_ctf_scope {
44 BT_TRACE_PACKET_HEADER = 0,
45 BT_STREAM_PACKET_CONTEXT = 1,
46 BT_STREAM_EVENT_HEADER = 2,
47 BT_STREAM_EVENT_CONTEXT = 3,
48 BT_EVENT_CONTEXT = 4,
49 BT_EVENT_FIELDS = 5,
50};
51
52/*
53 * the supported CTF types
54 */
55enum ctf_type_id {
56 CTF_TYPE_UNKNOWN = 0,
57 CTF_TYPE_INTEGER,
58 CTF_TYPE_FLOAT,
59 CTF_TYPE_ENUM,
60 CTF_TYPE_STRING,
61 CTF_TYPE_STRUCT,
62 CTF_TYPE_UNTAGGED_VARIANT,
63 CTF_TYPE_VARIANT,
64 CTF_TYPE_ARRAY,
65 CTF_TYPE_SEQUENCE,
66 NR_CTF_TYPES,
67};
68
8673030f
JD
69/*
70 * the supported CTF string encodings
71 */
72enum ctf_string_encoding {
73 CTF_STRING_NONE = 0,
74 CTF_STRING_UTF8,
75 CTF_STRING_ASCII,
76 CTF_STRING_UNKNOWN,
77};
78
9843982d
JD
79/*
80 * bt_ctf_get_top_level_scope: return a definition of the top-level scope
81 *
82 * Top-level scopes are defined in the bt_ctf_scope enum.
83 * In order to get a field or a field list, the user needs to pass a
84 * scope as argument, this scope can be a top-level scope or a scope
85 * relative to an arbitrary field. This function provides the mapping
86 * between the enum and the actual definition of top-level scopes.
87 * On error return NULL.
88 */
c50d2a7a 89const struct definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *event,
9843982d
JD
90 enum bt_ctf_scope scope);
91
92/*
93 * bt_ctf_event_get_name: returns the name of the event or NULL on error
94 */
c50d2a7a 95const char *bt_ctf_event_name(const struct bt_ctf_event *event);
9843982d
JD
96
97/*
d40ee8ec 98 * bt_ctf_get_cycles: returns the timestamp of the event as written
03798a93 99 * in the packet (in cycles) or -1ULL on error.
57f3005e 100 */
d40ee8ec 101uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *event);
57f3005e
SJD
102
103/*
d40ee8ec 104 * bt_ctf_get_timestamp: returns the timestamp of the event offsetted
03798a93 105 * with the system clock source (in ns) or -1ULL on error
9843982d 106 */
d40ee8ec 107uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *event);
9843982d
JD
108
109/*
bb337d59
MD
110 * bt_ctf_get_field_list: obtain the list of fields for compound type
111 *
112 * This function can be used to obtain the list of fields
113 * contained within a compound type: array, sequence,
114 * structure, or variant.
115
116 * This function sets the "list" pointer to an array of definition
aacd0c69
JD
117 * pointers and set count to the number of elements in the array.
118 * Return 0 on success and a negative value on error.
bb337d59
MD
119 *
120 * The content pointed to by "list" should *not* be freed. It stays
121 * valid as long as the event is unchanged (as long as the iterator
122 * from which the event is extracted is unchanged).
9843982d 123 */
c50d2a7a 124int bt_ctf_get_field_list(const struct bt_ctf_event *event,
04ae3991 125 const struct definition *scope,
9843982d
JD
126 struct definition const * const **list,
127 unsigned int *count);
128
129/*
130 * bt_ctf_get_field: returns the definition of a specific field
131 */
c50d2a7a 132const struct definition *bt_ctf_get_field(const struct bt_ctf_event *event,
04ae3991 133 const struct definition *scope,
9843982d
JD
134 const char *field);
135
136/*
137 * bt_ctf_get_index: if the field is an array or a sequence, return the element
138 * at position index, otherwise return NULL;
139 */
c50d2a7a 140const struct definition *bt_ctf_get_index(const struct bt_ctf_event *event,
04ae3991 141 const struct definition *field,
9843982d
JD
142 unsigned int index);
143
144/*
145 * bt_ctf_field_name: returns the name of a field or NULL on error
146 */
147const char *bt_ctf_field_name(const struct definition *def);
148
2bdfa4cf 149/*
b14d90be
JD
150 * bt_ctf_get_decl_from_def: return the declaration of a field from
151 * its definition or NULL on error
2bdfa4cf 152 */
b14d90be
JD
153const struct declaration *bt_ctf_get_decl_from_def(const struct definition *def);
154
155/*
156 * bt_ctf_get_decl_from_field_decl: return the declaration of a field from
157 * a field_decl or NULL on error
158 */
159const struct declaration *bt_ctf_get_decl_from_field_decl(
160 const struct bt_ctf_field_decl *field);
2bdfa4cf 161
9843982d
JD
162/*
163 * bt_ctf_field_type: returns the type of a field or -1 if unknown
164 */
2bdfa4cf 165enum ctf_type_id bt_ctf_field_type(const struct declaration *decl);
9843982d 166
8673030f
JD
167/*
168 * bt_ctf_get_int_signedness: return the signedness of an integer
169 *
170 * return 0 if unsigned
171 * return 1 if signed
172 * return -1 on error
173 */
2bdfa4cf 174int bt_ctf_get_int_signedness(const struct declaration *decl);
8673030f
JD
175
176/*
177 * bt_ctf_get_int_base: return the base of an int or a negative value on error
178 */
2bdfa4cf 179int bt_ctf_get_int_base(const struct declaration *decl);
8673030f
JD
180
181/*
182 * bt_ctf_get_int_byte_order: return the byte order of an int or a negative
183 * value on error
184 */
2bdfa4cf 185int bt_ctf_get_int_byte_order(const struct declaration *decl);
8673030f 186
fef0e521
MD
187/*
188 * bt_ctf_get_int_len: return the size, in bits, of an int or a negative
189 * value on error
190 */
2bdfa4cf 191ssize_t bt_ctf_get_int_len(const struct declaration *decl);
fef0e521 192
8673030f 193/*
c22b9327
JD
194 * bt_ctf_get_encoding: return the encoding of an int, a string, or of
195 * the integer contained in a char array or a sequence.
8673030f
JD
196 * return a negative value on error
197 */
2bdfa4cf 198enum ctf_string_encoding bt_ctf_get_encoding(const struct declaration *decl);
8673030f
JD
199
200/*
201 * bt_ctf_get_array_len: return the len of an array or a negative
202 * value on error
203 */
2bdfa4cf 204int bt_ctf_get_array_len(const struct declaration *decl);
8673030f 205
9843982d
JD
206/*
207 * Field access functions
208 *
209 * These functions return the value associated with the field passed in
210 * parameter.
211 *
212 * If the field does not exist or is not of the type requested, the value
213 * returned is undefined. To check if an error occured, use the
b330165c 214 * bt_ctf_field_get_error() function after accessing a field.
4d25c350
MD
215 *
216 * bt_ctf_get_enum_int gets the integer field of an enumeration.
217 * bt_ctf_get_enum_str gets the string matching the current enumeration
218 * value, or NULL if the current value does not match any string.
9843982d 219 */
da320b83
JD
220uint64_t bt_ctf_get_uint64(const struct definition *field);
221int64_t bt_ctf_get_int64(const struct definition *field);
4d25c350
MD
222const struct definition *bt_ctf_get_enum_int(const struct definition *field);
223const char *bt_ctf_get_enum_str(const struct definition *field);
da320b83
JD
224char *bt_ctf_get_char_array(const struct definition *field);
225char *bt_ctf_get_string(const struct definition *field);
9843982d
JD
226
227/*
b330165c 228 * bt_ctf_field_get_error: returns the last error code encountered while
9843982d
JD
229 * accessing a field and reset the error flag.
230 * Return 0 if no error, a negative value otherwise.
231 */
232int bt_ctf_field_get_error(void);
233
e003ab50
JD
234/*
235 * bt_ctf_get_event_decl_list: set list pointer to an array of bt_ctf_event_decl
236 * pointers and set count to the number of elements in the array.
237 *
238 * Return 0 on success and a negative value on error.
239 */
240int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx,
64c2c249 241 struct bt_ctf_event_decl * const **list,
e003ab50
JD
242 unsigned int *count);
243
244/*
245 * bt_ctf_get_decl_event_name: return the name of the event or NULL on error
246 */
247const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
248
64c2c249
JD
249/*
250 * bt_ctf_get_decl_fields: set list pointer to an array of bt_ctf_field_decl
251 * pointers and set count to the number of elements in the array.
252 *
253 * Returns 0 on success and a negative value on error
254 */
255int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl,
256 enum bt_ctf_scope scope,
257 struct bt_ctf_field_decl const * const **list,
258 unsigned int *count);
259
260/*
261 * bt_ctf_get_decl_field_name: return the name of a field decl or NULL on error
262 */
263const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
264
6946751f
JD
265#ifdef __cplusplus
266}
267#endif
268
9843982d 269#endif /* _BABELTRACE_CTF_EVENTS_H */
This page took 0.05557 seconds and 4 git commands to generate.