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 "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"
57 #include "lib/func-status.h"
59 struct bt_trace_class_destruction_listener_elem
{
60 bt_trace_class_destruction_listener_func func
;
64 #define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc) \
65 BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc))
68 void destroy_trace_class(struct bt_object
*obj
)
70 struct bt_trace_class
*tc
= (void *) obj
;
72 BT_LIB_LOGD("Destroying trace class object: %!+T", tc
);
74 * Call destruction listener functions so that everything else
75 * still exists in the trace class.
77 if (tc
->destruction_listeners
) {
79 BT_LIB_LOGD("Calling trace class destruction listener(s): %!+T", tc
);
82 * The trace class' reference count is 0 if we're here. Increment
83 * it to avoid a double-destroy (possibly infinitely recursive).
84 * This could happen for example if a destruction listener did
85 * bt_object_get_ref() (or anything that causes
86 * bt_object_get_ref() to be called) on the trace class (ref.
87 * count goes from 0 to 1), and then bt_object_put_ref(): the
88 * reference count would go from 1 to 0 again and this function
89 * would be called again.
93 /* Call all the trace class destruction listeners */
94 for (i
= 0; i
< tc
->destruction_listeners
->len
; i
++) {
95 struct bt_trace_class_destruction_listener_elem elem
=
96 g_array_index(tc
->destruction_listeners
,
97 struct bt_trace_class_destruction_listener_elem
, i
);
100 elem
.func(tc
, elem
.data
);
104 * The destruction listener should not have kept a
105 * reference to the trace class.
107 BT_ASSERT_PRE(tc
->base
.ref_count
== 1, "Destruction listener kept a reference to the trace class being destroyed: %![tc-]+T", tc
);
109 g_array_free(tc
->destruction_listeners
, TRUE
);
110 tc
->destruction_listeners
= NULL
;
113 if (tc
->environment
) {
114 BT_LOGD_STR("Destroying environment attributes.");
115 bt_attributes_destroy(tc
->environment
);
116 tc
->environment
= NULL
;
120 g_string_free(tc
->name
.str
, TRUE
);
122 tc
->name
.value
= NULL
;
125 if (tc
->stream_classes
) {
126 BT_LOGD_STR("Destroying stream classes.");
127 g_ptr_array_free(tc
->stream_classes
, TRUE
);
128 tc
->stream_classes
= NULL
;
134 struct bt_trace_class
*bt_trace_class_create(bt_self_component
*self_comp
)
136 struct bt_trace_class
*tc
= NULL
;
138 BT_ASSERT_PRE_NON_NULL(self_comp
, "Self component");
139 BT_LOGD_STR("Creating default trace class object.");
140 tc
= g_new0(struct bt_trace_class
, 1);
142 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one trace class.");
146 bt_object_init_shared_with_parent(&tc
->base
, destroy_trace_class
);
148 tc
->stream_classes
= g_ptr_array_new_with_free_func(
149 (GDestroyNotify
) bt_object_try_spec_release
);
150 if (!tc
->stream_classes
) {
151 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
155 tc
->name
.str
= g_string_new(NULL
);
157 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GString.");
161 tc
->environment
= bt_attributes_create();
162 if (!tc
->environment
) {
163 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty attributes object.");
167 tc
->destruction_listeners
= g_array_new(FALSE
, TRUE
,
168 sizeof(struct bt_trace_class_destruction_listener_elem
));
169 if (!tc
->destruction_listeners
) {
170 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GArray.");
174 tc
->assigns_automatic_stream_class_id
= true;
175 BT_LIB_LOGD("Created trace class object: %!+T", tc
);
179 BT_OBJECT_PUT_REF_AND_RESET(tc
);
185 const char *bt_trace_class_get_name(const struct bt_trace_class
*tc
)
187 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
188 return tc
->name
.value
;
191 enum bt_trace_class_set_name_status
bt_trace_class_set_name(
192 struct bt_trace_class
*tc
, const char *name
)
194 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
195 BT_ASSERT_PRE_NON_NULL(name
, "Name");
196 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
197 g_string_assign(tc
->name
.str
, name
);
198 tc
->name
.value
= tc
->name
.str
->str
;
199 BT_LIB_LOGD("Set trace class's name: %!+T", tc
);
200 return BT_FUNC_STATUS_OK
;
203 bt_uuid
bt_trace_class_get_uuid(const struct bt_trace_class
*tc
)
205 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
206 return tc
->uuid
.value
;
209 void bt_trace_class_set_uuid(struct bt_trace_class
*tc
, bt_uuid uuid
)
211 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
212 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
213 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
214 memcpy(tc
->uuid
.uuid
, uuid
, BABELTRACE_UUID_LEN
);
215 tc
->uuid
.value
= tc
->uuid
.uuid
;
216 BT_LIB_LOGD("Set trace class's UUID: %!+T", tc
);
219 enum bt_trace_class_add_listener_status
bt_trace_class_add_destruction_listener(
220 const struct bt_trace_class
*_tc
,
221 bt_trace_class_destruction_listener_func listener
,
222 void *data
, uint64_t *listener_id
)
224 struct bt_trace_class
*tc
= (void *) _tc
;
226 struct bt_trace_class_destruction_listener_elem new_elem
= {
231 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
232 BT_ASSERT_PRE_NON_NULL(listener
, "Listener");
234 /* Find the next available spot */
235 for (i
= 0; i
< tc
->destruction_listeners
->len
; i
++) {
236 struct bt_trace_class_destruction_listener_elem elem
=
237 g_array_index(tc
->destruction_listeners
,
238 struct bt_trace_class_destruction_listener_elem
, i
);
245 if (i
== tc
->destruction_listeners
->len
) {
246 g_array_append_val(tc
->destruction_listeners
, new_elem
);
248 g_array_insert_val(tc
->destruction_listeners
, i
, new_elem
);
255 BT_LIB_LOGD("Added trace class destruction listener: %![tc-]+T, "
256 "listener-id=%" PRIu64
, tc
, i
);
257 return BT_FUNC_STATUS_OK
;
262 bool has_listener_id(const struct bt_trace_class
*tc
, uint64_t listener_id
)
264 BT_ASSERT(listener_id
< tc
->destruction_listeners
->len
);
265 return (&g_array_index(tc
->destruction_listeners
,
266 struct bt_trace_class_destruction_listener_elem
,
267 listener_id
))->func
!= NULL
;
270 enum bt_trace_class_remove_listener_status
bt_trace_class_remove_destruction_listener(
271 const struct bt_trace_class
*_tc
, uint64_t listener_id
)
273 struct bt_trace_class
*tc
= (void *) _tc
;
274 struct bt_trace_class_destruction_listener_elem
*elem
;
276 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
277 BT_ASSERT_PRE(has_listener_id(tc
, listener_id
),
278 "Trace class has no such trace class destruction listener ID: "
279 "%![tc-]+T, %" PRIu64
, tc
, listener_id
);
280 elem
= &g_array_index(tc
->destruction_listeners
,
281 struct bt_trace_class_destruction_listener_elem
,
283 BT_ASSERT(elem
->func
);
287 BT_LIB_LOGD("Removed trace class destruction listener: "
288 "%![tc-]+T, listener-id=%" PRIu64
,
290 return BT_FUNC_STATUS_OK
;
295 bool trace_has_environment_entry(const struct bt_trace_class
*tc
, const char *name
)
299 return bt_attributes_borrow_field_value_by_name(
300 tc
->environment
, name
) != NULL
;
304 enum bt_trace_class_set_environment_entry_status
set_environment_entry(
305 struct bt_trace_class
*tc
,
306 const char *name
, struct bt_value
*value
)
313 BT_ASSERT_PRE(!tc
->frozen
||
314 !trace_has_environment_entry(tc
, name
),
315 "Trace class is frozen: cannot replace environment entry: "
316 "%![tc-]+T, entry-name=\"%s\"", tc
, name
);
317 ret
= bt_attributes_set_field_value(tc
->environment
, name
,
320 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
321 BT_LIB_LOGE_APPEND_CAUSE(
322 "Cannot set trace class's environment entry: "
323 "%![tc-]+T, entry-name=\"%s\"", tc
, name
);
325 bt_value_freeze(value
);
326 BT_LIB_LOGD("Set trace class's environment entry: "
327 "%![tc-]+T, entry-name=\"%s\"", tc
, name
);
333 enum bt_trace_class_set_environment_entry_status
334 bt_trace_class_set_environment_entry_string(
335 struct bt_trace_class
*tc
, const char *name
, const char *value
)
338 struct bt_value
*value_obj
;
339 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
340 BT_ASSERT_PRE_NON_NULL(name
, "Name");
341 BT_ASSERT_PRE_NON_NULL(value
, "Value");
342 value_obj
= bt_value_string_create_init(value
);
344 BT_LIB_LOGE_APPEND_CAUSE(
345 "Cannot create a string value object.");
350 /* set_environment_entry() logs errors */
351 ret
= set_environment_entry(tc
, name
, value_obj
);
354 bt_object_put_ref(value_obj
);
358 enum bt_trace_class_set_environment_entry_status
359 bt_trace_class_set_environment_entry_integer(
360 struct bt_trace_class
*tc
, const char *name
, int64_t value
)
363 struct bt_value
*value_obj
;
364 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
365 BT_ASSERT_PRE_NON_NULL(name
, "Name");
366 value_obj
= bt_value_signed_integer_create_init(value
);
368 BT_LIB_LOGE_APPEND_CAUSE(
369 "Cannot create an integer value object.");
370 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
374 /* set_environment_entry() logs errors */
375 ret
= set_environment_entry(tc
, name
, value_obj
);
378 bt_object_put_ref(value_obj
);
382 uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class
*tc
)
386 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
387 ret
= bt_attributes_get_count(tc
->environment
);
389 return (uint64_t) ret
;
392 void bt_trace_class_borrow_environment_entry_by_index_const(
393 const struct bt_trace_class
*tc
, uint64_t index
,
394 const char **name
, const struct bt_value
**value
)
396 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
397 BT_ASSERT_PRE_NON_NULL(name
, "Name");
398 BT_ASSERT_PRE_NON_NULL(value
, "Value");
399 BT_ASSERT_PRE_VALID_INDEX(index
,
400 bt_attributes_get_count(tc
->environment
));
401 *value
= bt_attributes_borrow_field_value(tc
->environment
, index
);
403 *name
= bt_attributes_get_field_name(tc
->environment
, index
);
407 const struct bt_value
*bt_trace_class_borrow_environment_entry_value_by_name_const(
408 const struct bt_trace_class
*tc
, const char *name
)
410 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
411 BT_ASSERT_PRE_NON_NULL(name
, "Name");
412 return bt_attributes_borrow_field_value_by_name(tc
->environment
,
416 uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class
*tc
)
418 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
419 return (uint64_t) tc
->stream_classes
->len
;
422 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_index(
423 struct bt_trace_class
*tc
, uint64_t index
)
425 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
426 BT_ASSERT_PRE_VALID_INDEX(index
, tc
->stream_classes
->len
);
427 return g_ptr_array_index(tc
->stream_classes
, index
);
430 const struct bt_stream_class
*
431 bt_trace_class_borrow_stream_class_by_index_const(
432 const struct bt_trace_class
*tc
, uint64_t index
)
434 return bt_trace_class_borrow_stream_class_by_index(
438 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_id(
439 struct bt_trace_class
*tc
, uint64_t id
)
441 struct bt_stream_class
*stream_class
= NULL
;
444 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
446 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
447 struct bt_stream_class
*stream_class_candidate
=
448 g_ptr_array_index(tc
->stream_classes
, i
);
450 if (stream_class_candidate
->id
== id
) {
451 stream_class
= stream_class_candidate
;
460 const struct bt_stream_class
*
461 bt_trace_class_borrow_stream_class_by_id_const(
462 const struct bt_trace_class
*tc
, uint64_t id
)
464 return bt_trace_class_borrow_stream_class_by_id((void *) tc
, id
);
468 void _bt_trace_class_freeze(const struct bt_trace_class
*tc
)
471 BT_LIB_LOGD("Freezing trace class: %!+T", tc
);
472 ((struct bt_trace_class
*) tc
)->frozen
= true;
475 bt_bool
bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class
*tc
)
477 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
478 return (bt_bool
) tc
->assigns_automatic_stream_class_id
;
481 void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class
*tc
,
484 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
485 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
486 tc
->assigns_automatic_stream_class_id
= (bool) value
;
487 BT_LIB_LOGD("Set trace class's automatic stream class ID "
488 "assignment property: %!+T", tc
);
491 void bt_trace_class_get_ref(const struct bt_trace_class
*trace_class
)
493 bt_object_get_ref(trace_class
);
496 void bt_trace_class_put_ref(const struct bt_trace_class
*trace_class
)
498 bt_object_put_ref(trace_class
);