2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_TAG "TRACE"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/trace-ir/trace.h>
29 #include <babeltrace/trace-ir/trace-class-internal.h>
30 #include <babeltrace/trace-ir/trace-const.h>
31 #include <babeltrace/trace-ir/trace-internal.h>
32 #include <babeltrace/trace-ir/clock-class-internal.h>
33 #include <babeltrace/trace-ir/stream-internal.h>
34 #include <babeltrace/trace-ir/stream-class-internal.h>
35 #include <babeltrace/trace-ir/event-internal.h>
36 #include <babeltrace/trace-ir/event-class.h>
37 #include <babeltrace/trace-ir/event-class-internal.h>
38 #include <babeltrace/ctf-writer/functor-internal.h>
39 #include <babeltrace/ctf-writer/clock-internal.h>
40 #include <babeltrace/trace-ir/field-wrapper-internal.h>
41 #include <babeltrace/trace-ir/field-class-internal.h>
42 #include <babeltrace/trace-ir/attributes-internal.h>
43 #include <babeltrace/trace-ir/utils-internal.h>
44 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
45 #include <babeltrace/compiler-internal.h>
46 #include <babeltrace/value.h>
47 #include <babeltrace/value-const.h>
48 #include <babeltrace/value-internal.h>
49 #include <babeltrace/object.h>
50 #include <babeltrace/types.h>
51 #include <babeltrace/endian-internal.h>
52 #include <babeltrace/assert-internal.h>
53 #include <babeltrace/compat/glib-internal.h>
59 struct bt_trace_is_static_listener_elem
{
60 bt_trace_is_static_listener_func func
;
61 bt_trace_listener_removed_func removed
;
65 #define BT_ASSERT_PRE_TRACE_HOT(_trace) \
66 BT_ASSERT_PRE_HOT((_trace), "Trace", ": %!+t", (_trace))
69 void destroy_trace(struct bt_object
*obj
)
71 struct bt_trace
*trace
= (void *) obj
;
73 BT_LIB_LOGD("Destroying trace object: %!+t", trace
);
76 * Call remove listeners first so that everything else still
77 * exists in the trace.
79 if (trace
->is_static_listeners
) {
82 for (i
= 0; i
< trace
->is_static_listeners
->len
; i
++) {
83 struct bt_trace_is_static_listener_elem elem
=
84 g_array_index(trace
->is_static_listeners
,
85 struct bt_trace_is_static_listener_elem
, i
);
88 elem
.removed((void *) trace
, elem
.data
);
92 g_array_free(trace
->is_static_listeners
, TRUE
);
93 trace
->is_static_listeners
= NULL
;
96 if (trace
->name
.str
) {
97 g_string_free(trace
->name
.str
, TRUE
);
98 trace
->name
.str
= NULL
;
99 trace
->name
.value
= NULL
;
102 if (trace
->streams
) {
103 BT_LOGD_STR("Destroying streams.");
104 g_ptr_array_free(trace
->streams
, TRUE
);
105 trace
->streams
= NULL
;
108 if (trace
->stream_classes_stream_count
) {
109 g_hash_table_destroy(trace
->stream_classes_stream_count
);
110 trace
->stream_classes_stream_count
= NULL
;
113 BT_LOGD_STR("Putting trace's class.");
114 bt_object_put_ref(trace
->class);
119 struct bt_trace
*bt_trace_create(struct bt_trace_class
*tc
)
121 struct bt_trace
*trace
= NULL
;
123 BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc
);
124 trace
= g_new0(struct bt_trace
, 1);
126 BT_LOGE_STR("Failed to allocate one trace.");
130 bt_object_init_shared(&trace
->base
, destroy_trace
);
131 trace
->streams
= g_ptr_array_new_with_free_func(
132 (GDestroyNotify
) bt_object_try_spec_release
);
133 if (!trace
->streams
) {
134 BT_LOGE_STR("Failed to allocate one GPtrArray.");
138 trace
->stream_classes_stream_count
= g_hash_table_new(g_direct_hash
,
140 if (!trace
->stream_classes_stream_count
) {
141 BT_LOGE_STR("Failed to allocate one GHashTable.");
145 trace
->name
.str
= g_string_new(NULL
);
146 if (!trace
->name
.str
) {
147 BT_LOGE_STR("Failed to allocate one GString.");
151 trace
->is_static_listeners
= g_array_new(FALSE
, TRUE
,
152 sizeof(struct bt_trace_is_static_listener_elem
));
153 if (!trace
->is_static_listeners
) {
154 BT_LOGE_STR("Failed to allocate one GArray.");
159 bt_object_get_no_null_check(trace
->class);
160 BT_LIB_LOGD("Created trace object: %!+t", trace
);
164 BT_OBJECT_PUT_REF_AND_RESET(trace
);
170 const char *bt_trace_get_name(const struct bt_trace
*trace
)
172 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
173 return trace
->name
.value
;
176 int bt_trace_set_name(struct bt_trace
*trace
, const char *name
)
178 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
179 BT_ASSERT_PRE_NON_NULL(name
, "Name");
180 BT_ASSERT_PRE_TRACE_HOT(trace
);
181 g_string_assign(trace
->name
.str
, name
);
182 trace
->name
.value
= trace
->name
.str
->str
;
183 BT_LIB_LOGV("Set trace's name: %!+t", trace
);
187 uint64_t bt_trace_get_stream_count(const struct bt_trace
*trace
)
189 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
190 return (uint64_t) trace
->streams
->len
;
193 struct bt_stream
*bt_trace_borrow_stream_by_index(
194 struct bt_trace
*trace
, uint64_t index
)
196 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
197 BT_ASSERT_PRE_VALID_INDEX(index
, trace
->streams
->len
);
198 return g_ptr_array_index(trace
->streams
, index
);
201 const struct bt_stream
*bt_trace_borrow_stream_by_index_const(
202 const struct bt_trace
*trace
, uint64_t index
)
204 return bt_trace_borrow_stream_by_index((void *) trace
, index
);
207 struct bt_stream
*bt_trace_borrow_stream_by_id(struct bt_trace
*trace
,
210 struct bt_stream
*stream
= NULL
;
213 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
215 for (i
= 0; i
< trace
->streams
->len
; i
++) {
216 struct bt_stream
*stream_candidate
=
217 g_ptr_array_index(trace
->streams
, i
);
219 if (stream_candidate
->id
== id
) {
220 stream
= stream_candidate
;
229 const struct bt_stream
*bt_trace_borrow_stream_by_id_const(
230 const struct bt_trace
*trace
, uint64_t id
)
232 return bt_trace_borrow_stream_by_id((void *) trace
, id
);
235 bt_bool
bt_trace_is_static(const struct bt_trace
*trace
)
237 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
238 return (bt_bool
) trace
->is_static
;
241 int bt_trace_make_static(struct bt_trace
*trace
)
244 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
245 trace
->is_static
= true;
246 bt_trace_freeze(trace
);
247 BT_LIB_LOGV("Trace is now static: %!+t", trace
);
249 /* Call all the "trace is static" listeners */
250 for (i
= 0; i
< trace
->is_static_listeners
->len
; i
++) {
251 struct bt_trace_is_static_listener_elem elem
=
252 g_array_index(trace
->is_static_listeners
,
253 struct bt_trace_is_static_listener_elem
, i
);
256 elem
.func((void *) trace
, elem
.data
);
263 int bt_trace_add_is_static_listener(
264 const struct bt_trace
*c_trace
,
265 bt_trace_is_static_listener_func listener
,
266 bt_trace_listener_removed_func listener_removed
, void *data
,
267 uint64_t *listener_id
)
269 struct bt_trace
*trace
= (void *) c_trace
;
271 struct bt_trace_is_static_listener_elem new_elem
= {
273 .removed
= listener_removed
,
277 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
278 BT_ASSERT_PRE_NON_NULL(listener
, "Listener");
279 BT_ASSERT_PRE(!trace
->is_static
,
280 "Trace is already static: %!+t", trace
);
281 BT_ASSERT_PRE(trace
->in_remove_listener
,
282 "Cannot call this function while executing a "
283 "remove listener: %!+t", trace
);
285 /* Find the next available spot */
286 for (i
= 0; i
< trace
->is_static_listeners
->len
; i
++) {
287 struct bt_trace_is_static_listener_elem elem
=
288 g_array_index(trace
->is_static_listeners
,
289 struct bt_trace_is_static_listener_elem
, i
);
296 if (i
== trace
->is_static_listeners
->len
) {
297 g_array_append_val(trace
->is_static_listeners
, new_elem
);
299 g_array_insert_val(trace
->is_static_listeners
, i
, new_elem
);
306 BT_LIB_LOGV("Added \"trace is static\" listener: "
307 "%![trace-]+t, listener-id=%" PRIu64
, trace
, i
);
313 bool has_listener_id(const struct bt_trace
*trace
, uint64_t listener_id
)
315 BT_ASSERT(listener_id
< trace
->is_static_listeners
->len
);
316 return (&g_array_index(trace
->is_static_listeners
,
317 struct bt_trace_is_static_listener_elem
,
318 listener_id
))->func
!= NULL
;
321 int bt_trace_remove_is_static_listener(const struct bt_trace
*c_trace
,
322 uint64_t listener_id
)
324 struct bt_trace
*trace
= (void *) c_trace
;
325 struct bt_trace_is_static_listener_elem
*elem
;
327 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
328 BT_ASSERT_PRE(!trace
->is_static
,
329 "Trace is already static: %!+t", trace
);
330 BT_ASSERT_PRE(trace
->in_remove_listener
,
331 "Cannot call this function while executing a "
332 "remove listener: %!+t", trace
);
333 BT_ASSERT_PRE(has_listener_id(trace
, listener_id
),
334 "Trace has no such \"trace is static\" listener ID: "
335 "%![trace-]+t, %" PRIu64
, trace
, listener_id
);
336 elem
= &g_array_index(trace
->is_static_listeners
,
337 struct bt_trace_is_static_listener_elem
,
339 BT_ASSERT(elem
->func
);
342 /* Call remove listener */
343 BT_LIB_LOGV("Calling remove listener: "
344 "%![trace-]+t, listener-id=%" PRIu64
,
346 trace
->in_remove_listener
= true;
347 elem
->removed((void *) trace
, elem
->data
);
348 trace
->in_remove_listener
= false;
352 elem
->removed
= NULL
;
354 BT_LIB_LOGV("Removed \"trace is static\" listener: "
355 "%![trace-]+t, listener-id=%" PRIu64
,
361 void _bt_trace_freeze(const struct bt_trace
*trace
)
363 /* The packet header field class is already frozen */
365 BT_LIB_LOGD("Freezing trace's class: %!+T", trace
->class);
366 bt_trace_class_freeze(trace
->class);
367 BT_LIB_LOGD("Freezing trace: %!+t", trace
);
368 ((struct bt_trace
*) trace
)->frozen
= true;
372 void bt_trace_add_stream(struct bt_trace
*trace
, struct bt_stream
*stream
)
376 bt_object_set_parent(&stream
->base
, &trace
->base
);
377 g_ptr_array_add(trace
->streams
, stream
);
378 bt_trace_freeze(trace
);
380 if (bt_g_hash_table_contains(trace
->stream_classes_stream_count
,
382 count
= GPOINTER_TO_UINT(g_hash_table_lookup(
383 trace
->stream_classes_stream_count
, stream
->class));
386 g_hash_table_insert(trace
->stream_classes_stream_count
,
387 stream
->class, GUINT_TO_POINTER(count
+ 1));
391 uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace
*trace
,
392 const struct bt_stream_class
*stream_class
)
398 BT_ASSERT(stream_class
);
400 if (g_hash_table_lookup_extended(trace
->stream_classes_stream_count
,
401 stream_class
, &orig_key
, &value
)) {
402 id
= (uint64_t) GPOINTER_TO_UINT(value
);
408 struct bt_trace_class
*bt_trace_borrow_class(struct bt_trace
*trace
)
410 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
414 const struct bt_trace_class
*bt_trace_borrow_class_const(
415 const struct bt_trace
*trace
)
417 return bt_trace_borrow_class((void *) trace
);