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 "lib/assert-post.h"
29 #include <babeltrace2/trace-ir/trace.h>
30 #include <babeltrace2/trace-ir/trace-const.h>
31 #include <babeltrace2/trace-ir/event-class.h>
32 #include "ctf-writer/functor.h"
33 #include "ctf-writer/clock.h"
34 #include "compat/compiler.h"
35 #include <babeltrace2/value.h>
36 #include <babeltrace2/value-const.h>
37 #include "lib/value.h"
38 #include <babeltrace2/types.h>
39 #include "compat/endian.h"
40 #include "common/assert.h"
41 #include "compat/glib.h"
48 #include "attributes.h"
49 #include "clock-class.h"
50 #include "event-class.h"
52 #include "field-class.h"
53 #include "field-wrapper.h"
54 #include "resolve-field-path.h"
55 #include "stream-class.h"
57 #include "trace-class.h"
60 #include "lib/value.h"
61 #include "lib/func-status.h"
63 struct bt_trace_destruction_listener_elem
{
64 bt_trace_destruction_listener_func func
;
68 #define BT_ASSERT_PRE_DEV_TRACE_HOT(_trace) \
69 BT_ASSERT_PRE_DEV_HOT((_trace), "Trace", ": %!+t", (_trace))
72 void destroy_trace(struct bt_object
*obj
)
74 struct bt_trace
*trace
= (void *) obj
;
76 BT_LIB_LOGD("Destroying trace object: %!+t", trace
);
77 BT_OBJECT_PUT_REF_AND_RESET(trace
->user_attributes
);
80 * Call destruction listener functions so that everything else
81 * still exists in the trace.
83 if (trace
->destruction_listeners
) {
85 BT_LIB_LOGD("Calling trace destruction listener(s): %!+t", trace
);
88 * The trace's reference count is 0 if we're here. Increment
89 * it to avoid a double-destroy (possibly infinitely recursive).
90 * This could happen for example if a destruction listener did
91 * bt_object_get_ref() (or anything that causes
92 * bt_object_get_ref() to be called) on the trace (ref.
93 * count goes from 0 to 1), and then bt_object_put_ref(): the
94 * reference count would go from 1 to 0 again and this function
95 * would be called again.
97 trace
->base
.ref_count
++;
99 /* Call all the trace destruction listeners */
100 for (i
= 0; i
< trace
->destruction_listeners
->len
; i
++) {
101 struct bt_trace_destruction_listener_elem elem
=
102 g_array_index(trace
->destruction_listeners
,
103 struct bt_trace_destruction_listener_elem
, i
);
106 elem
.func(trace
, elem
.data
);
107 BT_ASSERT_POST_NO_ERROR();
111 * The destruction listener should not have kept a
112 * reference to the trace.
114 BT_ASSERT_POST(trace
->base
.ref_count
== 1, "Destruction listener kept a reference to the trace being destroyed: %![trace-]+t", trace
);
116 g_array_free(trace
->destruction_listeners
, TRUE
);
117 trace
->destruction_listeners
= NULL
;
120 if (trace
->name
.str
) {
121 g_string_free(trace
->name
.str
, TRUE
);
122 trace
->name
.str
= NULL
;
123 trace
->name
.value
= NULL
;
126 if (trace
->environment
) {
127 BT_LOGD_STR("Destroying environment attributes.");
128 bt_attributes_destroy(trace
->environment
);
129 trace
->environment
= NULL
;
132 if (trace
->streams
) {
133 BT_LOGD_STR("Destroying streams.");
134 g_ptr_array_free(trace
->streams
, TRUE
);
135 trace
->streams
= NULL
;
138 if (trace
->stream_classes_stream_count
) {
139 g_hash_table_destroy(trace
->stream_classes_stream_count
);
140 trace
->stream_classes_stream_count
= NULL
;
143 BT_LOGD_STR("Putting trace's class.");
144 bt_object_put_ref(trace
->class);
149 struct bt_trace
*bt_trace_create(struct bt_trace_class
*tc
)
151 struct bt_trace
*trace
= NULL
;
153 BT_ASSERT_PRE_NO_ERROR();
155 BT_LIB_LOGD("Creating trace object: %![tc-]+T", tc
);
156 trace
= g_new0(struct bt_trace
, 1);
158 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace.");
162 bt_object_init_shared(&trace
->base
, destroy_trace
);
163 trace
->user_attributes
= bt_value_map_create();
164 if (!trace
->user_attributes
) {
165 BT_LIB_LOGE_APPEND_CAUSE(
166 "Failed to create a map value object.");
170 trace
->streams
= g_ptr_array_new_with_free_func(
171 (GDestroyNotify
) bt_object_try_spec_release
);
172 if (!trace
->streams
) {
173 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
177 trace
->stream_classes_stream_count
= g_hash_table_new(g_direct_hash
,
179 if (!trace
->stream_classes_stream_count
) {
180 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GHashTable.");
184 trace
->name
.str
= g_string_new(NULL
);
185 if (!trace
->name
.str
) {
186 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
190 trace
->environment
= bt_attributes_create();
191 if (!trace
->environment
) {
192 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty attributes object.");
196 trace
->destruction_listeners
= g_array_new(FALSE
, TRUE
,
197 sizeof(struct bt_trace_destruction_listener_elem
));
198 if (!trace
->destruction_listeners
) {
199 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
204 bt_object_get_ref_no_null_check(trace
->class);
205 BT_LIB_LOGD("Created trace object: %!+t", trace
);
209 BT_OBJECT_PUT_REF_AND_RESET(trace
);
215 const char *bt_trace_get_name(const struct bt_trace
*trace
)
217 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
218 return trace
->name
.value
;
221 enum bt_trace_set_name_status
bt_trace_set_name(struct bt_trace
*trace
,
224 BT_ASSERT_PRE_NO_ERROR();
225 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
226 BT_ASSERT_PRE_NON_NULL(name
, "Name");
227 BT_ASSERT_PRE_DEV_TRACE_HOT(trace
);
228 g_string_assign(trace
->name
.str
, name
);
229 trace
->name
.value
= trace
->name
.str
->str
;
230 BT_LIB_LOGD("Set trace's name: %!+t", trace
);
231 return BT_FUNC_STATUS_OK
;
234 bt_uuid
bt_trace_get_uuid(const struct bt_trace
*trace
)
236 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
237 return trace
->uuid
.value
;
240 void bt_trace_set_uuid(struct bt_trace
*trace
, bt_uuid uuid
)
242 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
243 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
244 BT_ASSERT_PRE_DEV_TRACE_HOT(trace
);
245 bt_uuid_copy(trace
->uuid
.uuid
, uuid
);
246 trace
->uuid
.value
= trace
->uuid
.uuid
;
247 BT_LIB_LOGD("Set trace's UUID: %!+t", trace
);
251 bool trace_has_environment_entry(const struct bt_trace
*trace
, const char *name
)
255 return bt_attributes_borrow_field_value_by_name(
256 trace
->environment
, name
);
260 enum bt_trace_set_environment_entry_status
set_environment_entry(
261 struct bt_trace
*trace
,
262 const char *name
, struct bt_value
*value
)
269 BT_ASSERT_PRE(!trace
->frozen
||
270 !trace_has_environment_entry(trace
, name
),
271 "Trace is frozen: cannot replace environment entry: "
272 "%![trace-]+t, entry-name=\"%s\"", trace
, name
);
273 ret
= bt_attributes_set_field_value(trace
->environment
, name
,
276 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
277 BT_LIB_LOGE_APPEND_CAUSE(
278 "Cannot set trace's environment entry: "
279 "%![trace-]+t, entry-name=\"%s\"", trace
, name
);
281 bt_value_freeze(value
);
282 BT_LIB_LOGD("Set trace's environment entry: "
283 "%![trace-]+t, entry-name=\"%s\"", trace
, name
);
289 enum bt_trace_set_environment_entry_status
290 bt_trace_set_environment_entry_string(
291 struct bt_trace
*trace
, const char *name
, const char *value
)
294 struct bt_value
*value_obj
;
296 BT_ASSERT_PRE_NO_ERROR();
297 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
298 BT_ASSERT_PRE_NON_NULL(name
, "Name");
299 BT_ASSERT_PRE_NON_NULL(value
, "Value");
301 value_obj
= bt_value_string_create_init(value
);
303 BT_LIB_LOGE_APPEND_CAUSE(
304 "Cannot create a string value object.");
309 /* set_environment_entry() logs errors */
310 ret
= set_environment_entry(trace
, name
, value_obj
);
313 bt_object_put_ref(value_obj
);
317 enum bt_trace_set_environment_entry_status
318 bt_trace_set_environment_entry_integer(
319 struct bt_trace
*trace
, const char *name
, int64_t value
)
322 struct bt_value
*value_obj
;
324 BT_ASSERT_PRE_NO_ERROR();
325 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
326 BT_ASSERT_PRE_NON_NULL(name
, "Name");
328 value_obj
= bt_value_integer_signed_create_init(value
);
330 BT_LIB_LOGE_APPEND_CAUSE(
331 "Cannot create an integer value object.");
332 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
336 /* set_environment_entry() logs errors */
337 ret
= set_environment_entry(trace
, name
, value_obj
);
340 bt_object_put_ref(value_obj
);
344 uint64_t bt_trace_get_environment_entry_count(const struct bt_trace
*trace
)
346 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
347 return bt_attributes_get_count(trace
->environment
);
350 void bt_trace_borrow_environment_entry_by_index_const(
351 const struct bt_trace
*trace
, uint64_t index
,
352 const char **name
, const struct bt_value
**value
)
354 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
355 BT_ASSERT_PRE_DEV_NON_NULL(name
, "Name");
356 BT_ASSERT_PRE_DEV_NON_NULL(value
, "Value");
357 BT_ASSERT_PRE_DEV_VALID_INDEX(index
,
358 bt_attributes_get_count(trace
->environment
));
359 *value
= bt_attributes_borrow_field_value(trace
->environment
, index
);
361 *name
= bt_attributes_get_field_name(trace
->environment
, index
);
365 const struct bt_value
*bt_trace_borrow_environment_entry_value_by_name_const(
366 const struct bt_trace
*trace
, const char *name
)
368 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
369 BT_ASSERT_PRE_DEV_NON_NULL(name
, "Name");
370 return bt_attributes_borrow_field_value_by_name(trace
->environment
,
374 uint64_t bt_trace_get_stream_count(const struct bt_trace
*trace
)
376 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
377 return (uint64_t) trace
->streams
->len
;
380 struct bt_stream
*bt_trace_borrow_stream_by_index(
381 struct bt_trace
*trace
, uint64_t index
)
383 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
384 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, trace
->streams
->len
);
385 return g_ptr_array_index(trace
->streams
, index
);
388 const struct bt_stream
*bt_trace_borrow_stream_by_index_const(
389 const struct bt_trace
*trace
, uint64_t index
)
391 return bt_trace_borrow_stream_by_index((void *) trace
, index
);
394 struct bt_stream
*bt_trace_borrow_stream_by_id(struct bt_trace
*trace
,
397 struct bt_stream
*stream
= NULL
;
400 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
402 for (i
= 0; i
< trace
->streams
->len
; i
++) {
403 struct bt_stream
*stream_candidate
=
404 g_ptr_array_index(trace
->streams
, i
);
406 if (stream_candidate
->id
== id
) {
407 stream
= stream_candidate
;
416 const struct bt_stream
*bt_trace_borrow_stream_by_id_const(
417 const struct bt_trace
*trace
, uint64_t id
)
419 return bt_trace_borrow_stream_by_id((void *) trace
, id
);
422 enum bt_trace_add_listener_status
bt_trace_add_destruction_listener(
423 const struct bt_trace
*c_trace
,
424 bt_trace_destruction_listener_func listener
,
425 void *data
, bt_listener_id
*listener_id
)
427 struct bt_trace
*trace
= (void *) c_trace
;
429 struct bt_trace_destruction_listener_elem new_elem
= {
434 BT_ASSERT_PRE_NO_ERROR();
435 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
436 BT_ASSERT_PRE_NON_NULL(listener
, "Listener");
438 /* Find the next available spot */
439 for (i
= 0; i
< trace
->destruction_listeners
->len
; i
++) {
440 struct bt_trace_destruction_listener_elem elem
=
441 g_array_index(trace
->destruction_listeners
,
442 struct bt_trace_destruction_listener_elem
, i
);
449 if (i
== trace
->destruction_listeners
->len
) {
450 g_array_append_val(trace
->destruction_listeners
, new_elem
);
452 g_array_insert_val(trace
->destruction_listeners
, i
, new_elem
);
459 BT_LIB_LOGD("Added destruction listener: " "%![trace-]+t, "
460 "listener-id=%" PRIu64
, trace
, i
);
461 return BT_FUNC_STATUS_OK
;
465 bool has_listener_id(const struct bt_trace
*trace
, uint64_t listener_id
)
467 BT_ASSERT(listener_id
< trace
->destruction_listeners
->len
);
468 return (&g_array_index(trace
->destruction_listeners
,
469 struct bt_trace_destruction_listener_elem
,
473 enum bt_trace_remove_listener_status
bt_trace_remove_destruction_listener(
474 const struct bt_trace
*c_trace
, bt_listener_id listener_id
)
476 struct bt_trace
*trace
= (void *) c_trace
;
477 struct bt_trace_destruction_listener_elem
*elem
;
479 BT_ASSERT_PRE_NO_ERROR();
480 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
481 BT_ASSERT_PRE(has_listener_id(trace
, listener_id
),
482 "Trace has no such trace destruction listener ID: "
483 "%![trace-]+t, %" PRIu64
, trace
, listener_id
);
484 elem
= &g_array_index(trace
->destruction_listeners
,
485 struct bt_trace_destruction_listener_elem
,
487 BT_ASSERT(elem
->func
);
491 BT_LIB_LOGD("Removed \"trace destruction listener: "
492 "%![trace-]+t, listener-id=%" PRIu64
,
494 return BT_FUNC_STATUS_OK
;
498 void _bt_trace_freeze(const struct bt_trace
*trace
)
501 BT_LIB_LOGD("Freezing trace's class: %!+T", trace
->class);
502 bt_trace_class_freeze(trace
->class);
503 BT_LIB_LOGD("Freezing trace's user attributes: %!+v",
504 trace
->user_attributes
);
505 bt_value_freeze(trace
->user_attributes
);
506 BT_LIB_LOGD("Freezing trace: %!+t", trace
);
507 ((struct bt_trace
*) trace
)->frozen
= true;
511 void bt_trace_add_stream(struct bt_trace
*trace
, struct bt_stream
*stream
)
515 bt_object_set_parent(&stream
->base
, &trace
->base
);
516 g_ptr_array_add(trace
->streams
, stream
);
517 bt_trace_freeze(trace
);
519 if (bt_g_hash_table_contains(trace
->stream_classes_stream_count
,
521 count
= GPOINTER_TO_UINT(g_hash_table_lookup(
522 trace
->stream_classes_stream_count
, stream
->class));
525 g_hash_table_insert(trace
->stream_classes_stream_count
,
526 stream
->class, GUINT_TO_POINTER(count
+ 1));
530 uint64_t bt_trace_get_automatic_stream_id(const struct bt_trace
*trace
,
531 const struct bt_stream_class
*stream_class
)
537 BT_ASSERT(stream_class
);
539 if (g_hash_table_lookup_extended(trace
->stream_classes_stream_count
,
540 stream_class
, &orig_key
, &value
)) {
541 id
= (uint64_t) GPOINTER_TO_UINT(value
);
547 struct bt_trace_class
*bt_trace_borrow_class(struct bt_trace
*trace
)
549 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
553 const struct bt_trace_class
*bt_trace_borrow_class_const(
554 const struct bt_trace
*trace
)
556 return bt_trace_borrow_class((void *) trace
);
559 const struct bt_value
*bt_trace_borrow_user_attributes_const(
560 const struct bt_trace
*trace
)
562 BT_ASSERT_PRE_DEV_NON_NULL(trace
, "Trace");
563 return trace
->user_attributes
;
566 struct bt_value
*bt_trace_borrow_user_attributes(struct bt_trace
*trace
)
568 return (void *) bt_trace_borrow_user_attributes_const((void *) trace
);
571 void bt_trace_set_user_attributes(
572 struct bt_trace
*trace
,
573 const struct bt_value
*user_attributes
)
575 BT_ASSERT_PRE_NON_NULL(trace
, "Trace");
576 BT_ASSERT_PRE_NON_NULL(user_attributes
, "User attributes");
577 BT_ASSERT_PRE(user_attributes
->type
== BT_VALUE_TYPE_MAP
,
578 "User attributes object is not a map value object.");
579 BT_ASSERT_PRE_DEV_TRACE_HOT(trace
);
580 bt_object_put_ref_no_null_check(trace
->user_attributes
);
581 trace
->user_attributes
= (void *) user_attributes
;
582 bt_object_get_ref_no_null_check(trace
->user_attributes
);
585 void bt_trace_get_ref(const struct bt_trace
*trace
)
587 bt_object_get_ref(trace
);
590 void bt_trace_put_ref(const struct bt_trace
*trace
)
592 bt_object_put_ref(trace
);