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 "LIB/TRACE"
25 #include "lib/logging.h"
27 #include "lib/assert-pre.h"
28 #include <babeltrace2/trace-ir/trace-class.h>
29 #include <babeltrace2/trace-ir/trace-class-const.h>
30 #include <babeltrace2/trace-ir/event-class.h>
31 #include "ctf-writer/functor.h"
32 #include "ctf-writer/clock.h"
33 #include "compat/compiler.h"
34 #include <babeltrace2/value.h>
35 #include <babeltrace2/value-const.h>
36 #include "lib/value.h"
37 #include <babeltrace2/types.h>
38 #include "compat/endian.h"
39 #include "common/assert.h"
40 #include "compat/glib.h"
46 #include "clock-class.h"
47 #include "event-class.h"
49 #include "field-class.h"
50 #include "field-wrapper.h"
51 #include "resolve-field-path.h"
52 #include "stream-class.h"
56 #include "lib/func-status.h"
58 struct bt_trace_class_destruction_listener_elem
{
59 bt_trace_class_destruction_listener_func func
;
63 #define BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(_tc) \
64 BT_ASSERT_PRE_DEV_HOT((_tc), "Trace class", ": %!+T", (_tc))
67 void destroy_trace_class(struct bt_object
*obj
)
69 struct bt_trace_class
*tc
= (void *) obj
;
71 BT_LIB_LOGD("Destroying trace class object: %!+T", tc
);
73 * Call destruction listener functions so that everything else
74 * still exists in the trace class.
76 if (tc
->destruction_listeners
) {
78 BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc
);
81 * The trace class' reference count is 0 if we're here. Increment
82 * it to avoid a double-destroy (possibly infinitely recursive).
83 * This could happen for example if a destruction listener did
84 * bt_object_get_ref() (or anything that causes
85 * bt_object_get_ref() to be called) on the trace class (ref.
86 * count goes from 0 to 1), and then bt_object_put_ref(): the
87 * reference count would go from 1 to 0 again and this function
88 * would be called again.
92 /* Call all the trace class destruction listeners */
93 for (i
= 0; i
< tc
->destruction_listeners
->len
; i
++) {
94 struct bt_trace_class_destruction_listener_elem elem
=
95 g_array_index(tc
->destruction_listeners
,
96 struct bt_trace_class_destruction_listener_elem
, i
);
99 elem
.func(tc
, elem
.data
);
103 * The destruction listener should not have kept a
104 * reference to the trace class.
106 BT_ASSERT_PRE(tc
->base
.ref_count
== 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc
);
108 g_array_free(tc
->destruction_listeners
, TRUE
);
109 tc
->destruction_listeners
= NULL
;
112 if (tc
->stream_classes
) {
113 BT_LOGD_STR("Destroying stream classes.");
114 g_ptr_array_free(tc
->stream_classes
, TRUE
);
115 tc
->stream_classes
= NULL
;
121 struct bt_trace_class
*bt_trace_class_create(bt_self_component
*self_comp
)
123 struct bt_trace_class
*tc
= NULL
;
125 BT_ASSERT_PRE_NON_NULL(self_comp
, "Self component");
126 BT_LOGD_STR("Creating default trace class object.");
127 tc
= g_new0(struct bt_trace_class
, 1);
129 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace class.");
133 bt_object_init_shared_with_parent(&tc
->base
, destroy_trace_class
);
135 tc
->stream_classes
= g_ptr_array_new_with_free_func(
136 (GDestroyNotify
) bt_object_try_spec_release
);
137 if (!tc
->stream_classes
) {
138 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
142 tc
->destruction_listeners
= g_array_new(FALSE
, TRUE
,
143 sizeof(struct bt_trace_class_destruction_listener_elem
));
144 if (!tc
->destruction_listeners
) {
145 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
149 tc
->assigns_automatic_stream_class_id
= true;
150 BT_LIB_LOGD("Created trace class object: %!+T", tc
);
154 BT_OBJECT_PUT_REF_AND_RESET(tc
);
160 enum bt_trace_class_add_listener_status
bt_trace_class_add_destruction_listener(
161 const struct bt_trace_class
*_tc
,
162 bt_trace_class_destruction_listener_func listener
,
163 void *data
, uint64_t *listener_id
)
165 struct bt_trace_class
*tc
= (void *) _tc
;
167 struct bt_trace_class_destruction_listener_elem new_elem
= {
172 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
173 BT_ASSERT_PRE_NON_NULL(listener
, "Listener");
175 /* Find the next available spot */
176 for (i
= 0; i
< tc
->destruction_listeners
->len
; i
++) {
177 struct bt_trace_class_destruction_listener_elem elem
=
178 g_array_index(tc
->destruction_listeners
,
179 struct bt_trace_class_destruction_listener_elem
, i
);
186 if (i
== tc
->destruction_listeners
->len
) {
187 g_array_append_val(tc
->destruction_listeners
, new_elem
);
189 g_array_insert_val(tc
->destruction_listeners
, i
, new_elem
);
196 BT_LIB_LOGD("Added trace class destruction listener: %![tc-]+T, "
197 "listener-id=%" PRIu64
, tc
, i
);
198 return BT_FUNC_STATUS_OK
;
203 bool has_listener_id(const struct bt_trace_class
*tc
, uint64_t listener_id
)
205 BT_ASSERT(listener_id
< tc
->destruction_listeners
->len
);
206 return (&g_array_index(tc
->destruction_listeners
,
207 struct bt_trace_class_destruction_listener_elem
,
208 listener_id
))->func
!= NULL
;
211 enum bt_trace_class_remove_listener_status
bt_trace_class_remove_destruction_listener(
212 const struct bt_trace_class
*_tc
, uint64_t listener_id
)
214 struct bt_trace_class
*tc
= (void *) _tc
;
215 struct bt_trace_class_destruction_listener_elem
*elem
;
217 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
218 BT_ASSERT_PRE(has_listener_id(tc
, listener_id
),
219 "Trace class has no such trace class destruction listener ID: "
220 "%![tc-]+T, %" PRIu64
, tc
, listener_id
);
221 elem
= &g_array_index(tc
->destruction_listeners
,
222 struct bt_trace_class_destruction_listener_elem
,
224 BT_ASSERT(elem
->func
);
228 BT_LIB_LOGD("Removed trace class destruction listener: "
229 "%![tc-]+T, listener-id=%" PRIu64
,
231 return BT_FUNC_STATUS_OK
;
234 uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class
*tc
)
236 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
237 return (uint64_t) tc
->stream_classes
->len
;
240 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_index(
241 struct bt_trace_class
*tc
, uint64_t index
)
243 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
244 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, tc
->stream_classes
->len
);
245 return g_ptr_array_index(tc
->stream_classes
, index
);
248 const struct bt_stream_class
*
249 bt_trace_class_borrow_stream_class_by_index_const(
250 const struct bt_trace_class
*tc
, uint64_t index
)
252 return bt_trace_class_borrow_stream_class_by_index(
256 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_id(
257 struct bt_trace_class
*tc
, uint64_t id
)
259 struct bt_stream_class
*stream_class
= NULL
;
262 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
264 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
265 struct bt_stream_class
*stream_class_candidate
=
266 g_ptr_array_index(tc
->stream_classes
, i
);
268 if (stream_class_candidate
->id
== id
) {
269 stream_class
= stream_class_candidate
;
278 const struct bt_stream_class
*
279 bt_trace_class_borrow_stream_class_by_id_const(
280 const struct bt_trace_class
*tc
, uint64_t id
)
282 return bt_trace_class_borrow_stream_class_by_id((void *) tc
, id
);
286 void _bt_trace_class_freeze(const struct bt_trace_class
*tc
)
289 BT_LIB_LOGD("Freezing trace class: %!+T", tc
);
290 ((struct bt_trace_class
*) tc
)->frozen
= true;
293 bt_bool
bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class
*tc
)
295 BT_ASSERT_PRE_DEV_NON_NULL(tc
, "Trace class");
296 return (bt_bool
) tc
->assigns_automatic_stream_class_id
;
299 void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class
*tc
,
302 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
303 BT_ASSERT_PRE_DEV_TRACE_CLASS_HOT(tc
);
304 tc
->assigns_automatic_stream_class_id
= (bool) value
;
305 BT_LIB_LOGD("Set trace class's automatic stream class ID "
306 "assignment property: %!+T", tc
);
309 void bt_trace_class_get_ref(const struct bt_trace_class
*trace_class
)
311 bt_object_get_ref(trace_class
);
314 void bt_trace_class_put_ref(const struct bt_trace_class
*trace_class
)
316 bt_object_put_ref(trace_class
);