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.h>
29 #include <babeltrace2/trace-ir/trace-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 "attributes.h"
47 #include "clock-class.h"
48 #include "event-class.h"
50 #include "field-class.h"
51 #include "field-wrapper.h"
52 #include "resolve-field-path.h"
53 #include "stream-class.h"
55 #include "trace-class.h"
58 #include "lib/func-status.h"
60 struct bt_trace_destruction_listener_elem
{
61 bt_trace_destruction_listener_func func
;
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 destruction listener functions so that everything else
77 * still exists in the trace.
79 if (trace
->destruction_listeners
) {
81 BT_LIB_LOGD("Calling trace destruction listener(s): %!+t", trace
);
84 * The trace's reference count is 0 if we're here. Increment
85 * it to avoid a double-destroy (possibly infinitely recursive).
86 * This could happen for example if a destruction listener did
87 * bt_object_get_ref() (or anything that causes
88 * bt_object_get_ref() to be called) on the trace (ref.
89 * count goes from 0 to 1), and then bt_object_put_ref(): the
90 * reference count would go from 1 to 0 again and this function
91 * would be called again.
93 trace
->base
.ref_count
++;
95 /* Call all the trace destruction listeners */
96 for (i
= 0; i
< trace
->destruction_listeners
->len
; i
++) {
97 struct bt_trace_destruction_listener_elem elem
=
98 g_array_index(trace
->destruction_listeners
,
99 struct bt_trace_destruction_listener_elem
, i
);
102 elem
.func(trace
, elem
.data
);
106 * The destruction listener should not have kept a
107 * reference to the trace.
109 BT_ASSERT_PRE(trace
->base
.ref_count
== 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace
);
111 g_array_free(trace
->destruction_listeners
, TRUE
);
112 trace
->destruction_listeners
= NULL
;
115 if (trace
->name
.str
) {
116 g_string_free(trace
->name
.str
, TRUE
);
117 trace
->name
.str
= NULL
;
118 trace
->name
.value
= NULL
;
121 if (trace
->streams
) {
122 BT_LOGD_STR("Destroying streams.");
123 g_ptr_array_free(trace
->streams
, TRUE
);
124 trace
->streams
= NULL
;
127 if (trace
->stream_classes_stream_count
) {
128 g_hash_table_destroy(trace
->stream_classes_stream_count
);
129 trace
->stream_classes_stream_count
= NULL
;
132 BT_LOGD_STR("Putting trace's class.");
133 bt_object_put_ref(trace
->class);
138 struct bt_trace
*bt_trace_create(struct bt_trace_class
*tc
)
140 struct bt_trace
*trace
= NULL
;
142 BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc
);
143 trace
= g_new0(struct bt_trace
, 1);
145 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace.");
149 bt_object_init_shared(&trace
->base
, destroy_trace
);
150 trace
->streams
= g_ptr_array_new_with_free_func(
151 (GDestroyNotify
) bt_object_try_spec_release
);
152 if (!trace
->streams
) {
153 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
157 trace
->stream_classes_stream_count
= g_hash_table_new(g_direct_hash
,
159 if (!trace
->stream_classes_stream_count
) {
160 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GHashTable.");
164 trace
->name
.str
= g_string_new(NULL
);
165 if (!trace
->name
.str
) {
166 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
170 trace
->destruction_listeners
= g_array_new(FALSE
, TRUE
,
171 sizeof(struct bt_trace_destruction_listener_elem
));
172 if (!trace
->destruction_listeners
) {
173 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
178 bt_object_get_no_null_check(trace
->class);
179 BT_LIB_LOGD("Created trace object: %!+t", trace
);
183 BT_OBJECT_PUT_REF_AND_RESET(trace
);
189 const char *bt_trace_get_name(const struct bt_trace
*trace
)
191 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
192 return trace
->name
.value
;
195 enum bt_trace_set_name_status
bt_trace_set_name(struct bt_trace
*trace
,
198 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
199 BT_ASSERT_PRE_NON_NULL(name
, "Name");
200 BT_ASSERT_PRE_TRACE_HOT(trace
);
201 g_string_assign(trace
->name
.str
, name
);
202 trace
->name
.value
= trace
->name
.str
->str
;
203 BT_LIB_LOGD("Set trace's name: %!+t", trace
);
204 return BT_FUNC_STATUS_OK
;
207 uint64_t bt_trace_get_stream_count(const struct bt_trace
*trace
)
209 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
210 return (uint64_t) trace
->streams
->len
;
213 struct bt_stream
*bt_trace_borrow_stream_by_index(
214 struct bt_trace
*trace
, uint64_t index
)
216 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
217 BT_ASSERT_PRE_VALID_INDEX(index
, trace
->streams
->len
);
218 return g_ptr_array_index(trace
->streams
, index
);
221 const struct bt_stream
*bt_trace_borrow_stream_by_index_const(
222 const struct bt_trace
*trace
, uint64_t index
)
224 return bt_trace_borrow_stream_by_index((void *) trace
, index
);
227 struct bt_stream
*bt_trace_borrow_stream_by_id(struct bt_trace
*trace
,
230 struct bt_stream
*stream
= NULL
;
233 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
235 for (i
= 0; i
< trace
->streams
->len
; i
++) {
236 struct bt_stream
*stream_candidate
=
237 g_ptr_array_index(trace
->streams
, i
);
239 if (stream_candidate
->id
== id
) {
240 stream
= stream_candidate
;
249 const struct bt_stream
*bt_trace_borrow_stream_by_id_const(
250 const struct bt_trace
*trace
, uint64_t id
)
252 return bt_trace_borrow_stream_by_id((void *) trace
, id
);
255 enum bt_trace_add_listener_status
bt_trace_add_destruction_listener(
256 const struct bt_trace
*c_trace
,
257 bt_trace_destruction_listener_func listener
,
258 void *data
, uint64_t *listener_id
)
260 struct bt_trace
*trace
= (void *) c_trace
;
262 struct bt_trace_destruction_listener_elem new_elem
= {
267 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
268 BT_ASSERT_PRE_NON_NULL(listener
, "Listener");
270 /* Find the next available spot */
271 for (i
= 0; i
< trace
->destruction_listeners
->len
; i
++) {
272 struct bt_trace_destruction_listener_elem elem
=
273 g_array_index(trace
->destruction_listeners
,
274 struct bt_trace_destruction_listener_elem
, i
);
281 if (i
== trace
->destruction_listeners
->len
) {
282 g_array_append_val(trace
->destruction_listeners
, new_elem
);
284 g_array_insert_val(trace
->destruction_listeners
, i
, new_elem
);
291 BT_LIB_LOGD("Added destruction listener: " "%![trace-]+t, "
292 "listener-id=%" PRIu64
, trace
, i
);
293 return BT_FUNC_STATUS_OK
;
298 bool has_listener_id(const struct bt_trace
*trace
, uint64_t listener_id
)
300 BT_ASSERT(listener_id
< trace
->destruction_listeners
->len
);
301 return (&g_array_index(trace
->destruction_listeners
,
302 struct bt_trace_destruction_listener_elem
,
303 listener_id
))->func
!= NULL
;
306 enum bt_trace_remove_listener_status
bt_trace_remove_destruction_listener(
307 const struct bt_trace
*c_trace
, uint64_t listener_id
)
309 struct bt_trace
*trace
= (void *) c_trace
;
310 struct bt_trace_destruction_listener_elem
*elem
;
312 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
313 BT_ASSERT_PRE(has_listener_id(trace
, listener_id
),
314 "Trace has no such trace destruction listener ID: "
315 "%![trace-]+t, %" PRIu64
, trace
, listener_id
);
316 elem
= &g_array_index(trace
->destruction_listeners
,
317 struct bt_trace_destruction_listener_elem
,
319 BT_ASSERT(elem
->func
);
323 BT_LIB_LOGD("Removed \"trace destruction listener: "
324 "%![trace-]+t, listener-id=%" PRIu64
,
326 return BT_FUNC_STATUS_OK
;
330 void _bt_trace_freeze(const struct bt_trace
*trace
)
333 BT_LIB_LOGD("Freezing trace's class: %!+T", trace
->class);
334 bt_trace_class_freeze(trace
->class);
335 BT_LIB_LOGD("Freezing trace: %!+t", trace
);
336 ((struct bt_trace
*) trace
)->frozen
= true;
340 void bt_trace_add_stream(struct bt_trace
*trace
, struct bt_stream
*stream
)
344 bt_object_set_parent(&stream
->base
, &trace
->base
);
345 g_ptr_array_add(trace
->streams
, stream
);
346 bt_trace_freeze(trace
);
348 if (bt_g_hash_table_contains(trace
->stream_classes_stream_count
,
350 count
= GPOINTER_TO_UINT(g_hash_table_lookup(
351 trace
->stream_classes_stream_count
, stream
->class));
354 g_hash_table_insert(trace
->stream_classes_stream_count
,
355 stream
->class, GUINT_TO_POINTER(count
+ 1));
359 uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace
*trace
,
360 const struct bt_stream_class
*stream_class
)
366 BT_ASSERT(stream_class
);
368 if (g_hash_table_lookup_extended(trace
->stream_classes_stream_count
,
369 stream_class
, &orig_key
, &value
)) {
370 id
= (uint64_t) GPOINTER_TO_UINT(value
);
376 struct bt_trace_class
*bt_trace_borrow_class(struct bt_trace
*trace
)
378 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
382 const struct bt_trace_class
*bt_trace_borrow_class_const(
383 const struct bt_trace
*trace
)
385 return bt_trace_borrow_class((void *) trace
);
388 void bt_trace_get_ref(const struct bt_trace
*trace
)
390 bt_object_get_ref(trace
);
393 void bt_trace_put_ref(const struct bt_trace
*trace
)
395 bt_object_put_ref(trace
);