2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #define BT_LOG_TAG "LIB/TRACE-CLASS"
9 #include "lib/logging.h"
11 #include "lib/assert-cond.h"
12 #include <babeltrace2/trace-ir/trace-class.h>
13 #include <babeltrace2/trace-ir/event-class.h>
14 #include "ctf-writer/functor.h"
15 #include "ctf-writer/clock.h"
16 #include "compat/compiler.h"
17 #include <babeltrace2/value.h>
18 #include "lib/value.h"
19 #include <babeltrace2/types.h>
20 #include "compat/endian.h"
21 #include "common/assert.h"
22 #include "compat/glib.h"
29 #include "clock-class.h"
30 #include "event-class.h"
32 #include "field-class.h"
33 #include "field-wrapper.h"
34 #include "resolve-field-path.h"
35 #include "stream-class.h"
39 #include "lib/value.h"
40 #include "lib/func-status.h"
42 struct bt_trace_class_destruction_listener_elem
{
43 bt_trace_class_destruction_listener_func func
;
47 #define BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(_tc) \
48 BT_ASSERT_PRE_DEV_HOT((_tc), "Trace class", ": %!+T", (_tc))
51 void destroy_trace_class(struct bt_object
*obj
)
53 struct bt_trace_class
*tc
= (void *) obj
;
55 BT_LIB_LOGD("Destroying trace class object: %!+T", tc
);
56 BT_OBJECT_PUT_REF_AND_RESET(tc
->user_attributes
);
59 * Call destruction listener functions so that everything else
60 * still exists in the trace class.
62 if (tc
->destruction_listeners
) {
64 const struct bt_error
*saved_error
;
66 BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc
);
69 * The trace class' reference count is 0 if we're here. Increment
70 * it to avoid a double-destroy (possibly infinitely recursive).
71 * This could happen for example if a destruction listener did
72 * bt_object_get_ref() (or anything that causes
73 * bt_object_get_ref() to be called) on the trace class (ref.
74 * count goes from 0 to 1), and then bt_object_put_ref(): the
75 * reference count would go from 1 to 0 again and this function
76 * would be called again.
80 saved_error
= bt_current_thread_take_error();
82 /* Call all the trace class destruction listeners */
83 for (i
= 0; i
< tc
->destruction_listeners
->len
; i
++) {
84 struct bt_trace_class_destruction_listener_elem elem
=
85 g_array_index(tc
->destruction_listeners
,
86 struct bt_trace_class_destruction_listener_elem
, i
);
89 elem
.func(tc
, elem
.data
);
90 BT_ASSERT_POST_NO_ERROR();
94 * The destruction listener should not have kept a
95 * reference to the trace class.
97 BT_ASSERT_POST(tc
->base
.ref_count
== 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc
);
99 g_array_free(tc
->destruction_listeners
, TRUE
);
100 tc
->destruction_listeners
= NULL
;
103 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error
);
107 if (tc
->stream_classes
) {
108 BT_LOGD_STR("Destroying stream classes.");
109 g_ptr_array_free(tc
->stream_classes
, TRUE
);
110 tc
->stream_classes
= NULL
;
116 struct bt_trace_class
*bt_trace_class_create(bt_self_component
*self_comp
)
118 struct bt_trace_class
*tc
= NULL
;
120 BT_ASSERT_PRE_NO_ERROR();
121 BT_ASSERT_PRE_NON_NULL(self_comp
, "Self component");
122 BT_LOGD_STR("Creating default trace class object.");
123 tc
= g_new0(struct bt_trace_class
, 1);
125 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace class.");
129 bt_object_init_shared_with_parent(&tc
->base
, destroy_trace_class
);
130 tc
->user_attributes
= bt_value_map_create();
131 if (!tc
->user_attributes
) {
132 BT_LIB_LOGE_APPEND_CAUSE(
133 "Failed to create a map value object.");
137 tc
->stream_classes
= g_ptr_array_new_with_free_func(
138 (GDestroyNotify
) bt_object_try_spec_release
);
139 if (!tc
->stream_classes
) {
140 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
144 tc
->destruction_listeners
= g_array_new(FALSE
, TRUE
,
145 sizeof(struct bt_trace_class_destruction_listener_elem
));
146 if (!tc
->destruction_listeners
) {
147 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
151 tc
->assigns_automatic_stream_class_id
= true;
152 BT_LIB_LOGD("Created trace class object: %!+T", tc
);
156 BT_OBJECT_PUT_REF_AND_RESET(tc
);
162 enum bt_trace_class_add_listener_status
bt_trace_class_add_destruction_listener(
163 const struct bt_trace_class
*_tc
,
164 bt_trace_class_destruction_listener_func listener
,
165 void *data
, bt_listener_id
*listener_id
)
167 struct bt_trace_class
*tc
= (void *) _tc
;
169 struct bt_trace_class_destruction_listener_elem new_elem
= {
174 BT_ASSERT_PRE_NO_ERROR();
175 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
176 BT_ASSERT_PRE_NON_NULL(listener
, "Listener");
178 /* Find the next available spot */
179 for (i
= 0; i
< tc
->destruction_listeners
->len
; i
++) {
180 struct bt_trace_class_destruction_listener_elem elem
=
181 g_array_index(tc
->destruction_listeners
,
182 struct bt_trace_class_destruction_listener_elem
, i
);
189 if (i
== tc
->destruction_listeners
->len
) {
190 g_array_append_val(tc
->destruction_listeners
, new_elem
);
192 g_array_insert_val(tc
->destruction_listeners
, i
, new_elem
);
199 BT_LIB_LOGD("Added trace class destruction listener: %![tc-]+T, "
200 "listener-id=%" PRIu64
, tc
, i
);
201 return BT_FUNC_STATUS_OK
;
205 bool has_listener_id(const struct bt_trace_class
*tc
, uint64_t listener_id
)
207 BT_ASSERT(listener_id
< tc
->destruction_listeners
->len
);
208 return (&g_array_index(tc
->destruction_listeners
,
209 struct bt_trace_class_destruction_listener_elem
,
213 enum bt_trace_class_remove_listener_status
bt_trace_class_remove_destruction_listener(
214 const struct bt_trace_class
*_tc
, bt_listener_id listener_id
)
216 struct bt_trace_class
*tc
= (void *) _tc
;
217 struct bt_trace_class_destruction_listener_elem
*elem
;
219 BT_ASSERT_PRE_NO_ERROR();
220 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
221 BT_ASSERT_PRE(has_listener_id(tc
, listener_id
),
222 "Trace class has no such trace class destruction listener ID: "
223 "%![tc-]+T, %" PRIu64
, tc
, listener_id
);
224 elem
= &g_array_index(tc
->destruction_listeners
,
225 struct bt_trace_class_destruction_listener_elem
,
227 BT_ASSERT(elem
->func
);
231 BT_LIB_LOGD("Removed trace class destruction listener: "
232 "%![tc-]+T, listener-id=%" PRIu64
,
234 return BT_FUNC_STATUS_OK
;
237 uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class
*tc
)
239 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
240 return (uint64_t) tc
->stream_classes
->len
;
243 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_index(
244 struct bt_trace_class
*tc
, uint64_t index
)
246 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
247 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, tc
->stream_classes
->len
);
248 return g_ptr_array_index(tc
->stream_classes
, index
);
251 const struct bt_stream_class
*
252 bt_trace_class_borrow_stream_class_by_index_const(
253 const struct bt_trace_class
*tc
, uint64_t index
)
255 return bt_trace_class_borrow_stream_class_by_index(
259 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_id(
260 struct bt_trace_class
*tc
, uint64_t id
)
262 struct bt_stream_class
*stream_class
= NULL
;
265 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
267 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
268 struct bt_stream_class
*stream_class_candidate
=
269 g_ptr_array_index(tc
->stream_classes
, i
);
271 if (stream_class_candidate
->id
== id
) {
272 stream_class
= stream_class_candidate
;
281 const struct bt_stream_class
*
282 bt_trace_class_borrow_stream_class_by_id_const(
283 const struct bt_trace_class
*tc
, uint64_t id
)
285 return bt_trace_class_borrow_stream_class_by_id((void *) tc
, id
);
289 void _bt_trace_class_freeze(const struct bt_trace_class
*tc
)
292 BT_LIB_LOGD("Freezing trace class: %!+T", tc
);
293 ((struct bt_trace_class
*) tc
)->frozen
= true;
296 bt_bool
bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class
*tc
)
298 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
299 return (bt_bool
) tc
->assigns_automatic_stream_class_id
;
302 void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class
*tc
,
305 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
306 BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(tc
);
307 tc
->assigns_automatic_stream_class_id
= (bool) value
;
308 BT_LIB_LOGD("Set trace class's automatic stream class ID "
309 "assignment property: %!+T", tc
);
312 const struct bt_value
*bt_trace_class_borrow_user_attributes_const(
313 const struct bt_trace_class
*trace_class
)
315 BT_ASSERT_PRE_DEV_NON_NULL(trace_class
, "Trace class");
316 return trace_class
->user_attributes
;
319 struct bt_value
*bt_trace_class_borrow_user_attributes(
320 struct bt_trace_class
*trace_class
)
322 return (void *) bt_trace_class_borrow_user_attributes_const(
323 (void *) trace_class
);
326 void bt_trace_class_set_user_attributes(struct bt_trace_class
*trace_class
,
327 const struct bt_value
*user_attributes
)
329 BT_ASSERT_PRE_NON_NULL(trace_class
, "Trace class");
330 BT_ASSERT_PRE_NON_NULL(user_attributes
, "User attributes");
331 BT_ASSERT_PRE(user_attributes
->type
== BT_VALUE_TYPE_MAP
,
332 "User attributes object is not a map value object.");
333 BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(trace_class
);
334 bt_object_put_ref_no_null_check(trace_class
->user_attributes
);
335 trace_class
->user_attributes
= (void *) user_attributes
;
336 bt_object_get_ref_no_null_check(trace_class
->user_attributes
);
339 void bt_trace_class_get_ref(const struct bt_trace_class
*trace_class
)
341 bt_object_get_ref(trace_class
);
344 void bt_trace_class_put_ref(const struct bt_trace_class
*trace_class
)
346 bt_object_put_ref(trace_class
);