6 * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
8 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * Julien Desfossez <julien.desfossez@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
22 #include <babeltrace/babeltrace.h>
23 #include <babeltrace/format.h>
24 #include <babeltrace/ctf/events.h>
25 #include <babeltrace/ctf-ir/metadata.h>
26 #include <babeltrace/prio_heap.h>
27 #include <babeltrace/iterator-internal.h>
28 #include <babeltrace/ctf/events-internal.h>
29 #include <babeltrace/ctf/metadata.h>
33 * thread local storage to store the last error that occured
34 * while reading a field, this variable must be accessed by
35 * bt_ctf_field_error only
37 __thread
int bt_ctf_last_field_error
= 0;
39 struct bt_ctf_iter
*bt_ctf_iter_create(struct bt_context
*ctx
,
40 struct bt_iter_pos
*begin_pos
,
41 struct bt_iter_pos
*end_pos
)
43 struct bt_ctf_iter
*iter
;
46 iter
= g_new0(struct bt_ctf_iter
, 1);
47 ret
= bt_iter_init(&iter
->parent
, ctx
, begin_pos
, end_pos
);
55 void bt_ctf_iter_destroy(struct bt_ctf_iter
*iter
)
57 bt_iter_fini(&iter
->parent
);
61 struct bt_iter
*bt_ctf_get_iter(struct bt_ctf_iter
*iter
)
66 struct bt_ctf_event
*bt_ctf_iter_read_event(struct bt_ctf_iter
*iter
)
68 struct ctf_file_stream
*file_stream
;
69 struct bt_ctf_event
*ret
= &iter
->current_ctf_event
;
71 file_stream
= heap_maximum(iter
->parent
.stream_heap
);
73 /* end of file for all streams */
76 ret
->stream
= &file_stream
->parent
;
77 ret
->event
= g_ptr_array_index(ret
->stream
->events_by_id
,
78 ret
->stream
->event_id
);
80 if (ret
->stream
->stream_id
> iter
->parent
.callbacks
->len
)
83 process_callbacks(&iter
->parent
, ret
->stream
);
91 struct definition
*bt_ctf_get_top_level_scope(struct bt_ctf_event
*event
,
92 enum bt_ctf_scope scope
)
94 struct definition
*tmp
= NULL
;
97 case BT_TRACE_PACKET_HEADER
:
100 if (event
->stream
->trace_packet_header
)
101 tmp
= &event
->stream
->trace_packet_header
->p
;
103 case BT_STREAM_PACKET_CONTEXT
:
106 if (event
->stream
->stream_packet_context
)
107 tmp
= &event
->stream
->stream_packet_context
->p
;
109 case BT_STREAM_EVENT_HEADER
:
112 if (event
->stream
->stream_event_header
)
113 tmp
= &event
->stream
->stream_event_header
->p
;
115 case BT_STREAM_EVENT_CONTEXT
:
118 if (event
->stream
->stream_event_context
)
119 tmp
= &event
->stream
->stream_event_context
->p
;
121 case BT_EVENT_CONTEXT
:
124 if (event
->event
->event_context
)
125 tmp
= &event
->event
->event_context
->p
;
127 case BT_EVENT_FIELDS
:
130 if (event
->event
->event_fields
)
131 tmp
= &event
->event
->event_fields
->p
;
140 struct definition
*bt_ctf_get_field(struct bt_ctf_event
*event
,
141 struct definition
*scope
,
144 struct definition
*def
;
147 def
= lookup_definition(scope
, field
);
148 if (bt_ctf_field_type(def
) == CTF_TYPE_VARIANT
) {
149 struct definition_variant
*variant_definition
;
150 variant_definition
= container_of(def
,
151 struct definition_variant
, p
);
152 return variant_definition
->current_field
;
159 struct definition
*bt_ctf_get_index(struct bt_ctf_event
*event
,
160 struct definition
*field
,
163 struct definition
*ret
= NULL
;
165 if (bt_ctf_field_type(field
) == CTF_TYPE_ARRAY
) {
166 struct definition_array
*array_definition
;
167 array_definition
= container_of(field
,
168 struct definition_array
, p
);
169 ret
= array_index(array_definition
, index
);
170 } else if (bt_ctf_field_type(field
) == CTF_TYPE_SEQUENCE
) {
171 struct definition_sequence
*sequence_definition
;
172 sequence_definition
= container_of(field
,
173 struct definition_sequence
, p
);
174 ret
= sequence_index(sequence_definition
, index
);
179 const char *bt_ctf_event_name(struct bt_ctf_event
*event
)
181 struct ctf_event
*event_class
;
182 struct ctf_stream_class
*stream_class
;
186 stream_class
= event
->stream
->stream_class
;
187 event_class
= g_ptr_array_index(stream_class
->events_by_id
,
188 event
->stream
->event_id
);
189 return g_quark_to_string(event_class
->name
);
192 const char *bt_ctf_field_name(const struct definition
*def
)
195 return g_quark_to_string(def
->name
);
199 enum ctf_type_id
bt_ctf_field_type(struct definition
*def
)
202 return def
->declaration
->id
;
203 return CTF_TYPE_UNKNOWN
;
206 int bt_ctf_get_field_list(struct bt_ctf_event
*event
,
207 struct definition
*scope
,
208 struct definition
const * const **list
,
211 switch (bt_ctf_field_type(scope
)) {
212 case CTF_TYPE_INTEGER
:
214 case CTF_TYPE_STRING
:
217 case CTF_TYPE_STRUCT
:
219 struct definition_struct
*def_struct
;
221 def_struct
= container_of(scope
, struct definition_struct
, p
);
224 if (def_struct
->fields
->pdata
) {
225 *list
= (struct definition
const* const*) def_struct
->fields
->pdata
;
226 *count
= def_struct
->fields
->len
;
232 case CTF_TYPE_UNTAGGED_VARIANT
:
234 case CTF_TYPE_VARIANT
:
236 struct definition_variant
*def_variant
;
238 def_variant
= container_of(scope
, struct definition_variant
, p
);
241 if (def_variant
->fields
->pdata
) {
242 *list
= (struct definition
const* const*) def_variant
->fields
->pdata
;
243 *count
= def_variant
->fields
->len
;
251 struct definition_array
*def_array
;
253 def_array
= container_of(scope
, struct definition_array
, p
);
256 if (def_array
->elems
->pdata
) {
257 *list
= (struct definition
const* const*) def_array
->elems
->pdata
;
258 *count
= def_array
->elems
->len
;
264 case CTF_TYPE_SEQUENCE
:
266 struct definition_sequence
*def_sequence
;
268 def_sequence
= container_of(scope
, struct definition_sequence
, p
);
271 if (def_sequence
->elems
->pdata
) {
272 *list
= (struct definition
const* const*) def_sequence
->elems
->pdata
;
273 *count
= def_sequence
->elems
->len
;
292 uint64_t bt_ctf_get_timestamp(struct bt_ctf_event
*event
)
294 if (event
&& event
->stream
->has_timestamp
)
295 return event
->stream
->timestamp
;
300 static void bt_ctf_field_set_error(int error
)
302 bt_ctf_last_field_error
= error
;
305 int bt_ctf_field_get_error(void)
308 ret
= bt_ctf_last_field_error
;
309 bt_ctf_last_field_error
= 0;
314 uint64_t bt_ctf_get_uint64(struct definition
*field
)
316 unsigned int ret
= 0;
318 if (field
&& bt_ctf_field_type(field
) == CTF_TYPE_INTEGER
)
319 ret
= get_unsigned_int(field
);
321 bt_ctf_field_set_error(-EINVAL
);
326 int64_t bt_ctf_get_int64(struct definition
*field
)
330 if (field
&& bt_ctf_field_type(field
) == CTF_TYPE_INTEGER
)
331 ret
= get_signed_int(field
);
333 bt_ctf_field_set_error(-EINVAL
);
339 char *bt_ctf_get_char_array(struct definition
*field
)
343 if (field
&& bt_ctf_field_type(field
) == CTF_TYPE_ARRAY
)
344 ret
= get_char_array(field
)->str
;
346 bt_ctf_field_set_error(-EINVAL
);
351 char *bt_ctf_get_string(struct definition
*field
)
355 if (field
&& bt_ctf_field_type(field
) == CTF_TYPE_STRING
)
356 ret
= get_string(field
);
358 bt_ctf_field_set_error(-EINVAL
);