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 "TRACE"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-pre-internal.h>
28 #include <babeltrace/trace-ir/trace-class.h>
29 #include <babeltrace/trace-ir/trace-class-const.h>
30 #include <babeltrace/trace-ir/trace-internal.h>
31 #include <babeltrace/trace-ir/clock-class-internal.h>
32 #include <babeltrace/trace-ir/stream-internal.h>
33 #include <babeltrace/trace-ir/stream-class-internal.h>
34 #include <babeltrace/trace-ir/event-internal.h>
35 #include <babeltrace/trace-ir/event-class.h>
36 #include <babeltrace/trace-ir/event-class-internal.h>
37 #include <babeltrace/ctf-writer/functor-internal.h>
38 #include <babeltrace/ctf-writer/clock-internal.h>
39 #include <babeltrace/trace-ir/field-wrapper-internal.h>
40 #include <babeltrace/trace-ir/field-class-internal.h>
41 #include <babeltrace/trace-ir/attributes-internal.h>
42 #include <babeltrace/trace-ir/utils-internal.h>
43 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
44 #include <babeltrace/compiler-internal.h>
45 #include <babeltrace/value.h>
46 #include <babeltrace/value-const.h>
47 #include <babeltrace/value-internal.h>
48 #include <babeltrace/types.h>
49 #include <babeltrace/endian-internal.h>
50 #include <babeltrace/assert-internal.h>
51 #include <babeltrace/compat/glib-internal.h>
57 #define BT_ASSERT_PRE_TRACE_CLASS_HOT(_tc) \
58 BT_ASSERT_PRE_HOT((_tc), "Trace class", ": %!+T", (_tc))
61 void destroy_trace_class(struct bt_object
*obj
)
63 struct bt_trace_class
*tc
= (void *) obj
;
65 BT_LIB_LOGD("Destroying trace class object: %!+T", tc
);
66 bt_object_pool_finalize(&tc
->packet_header_field_pool
);
68 if (tc
->environment
) {
69 BT_LOGD_STR("Destroying environment attributes.");
70 bt_attributes_destroy(tc
->environment
);
71 tc
->environment
= NULL
;
75 g_string_free(tc
->name
.str
, TRUE
);
77 tc
->name
.value
= NULL
;
80 if (tc
->stream_classes
) {
81 BT_LOGD_STR("Destroying stream classes.");
82 g_ptr_array_free(tc
->stream_classes
, TRUE
);
83 tc
->stream_classes
= NULL
;
86 BT_LOGD_STR("Putting packet header field class.");
87 bt_object_put_ref(tc
->packet_header_fc
);
88 tc
->packet_header_fc
= NULL
;
93 void free_packet_header_field(struct bt_field_wrapper
*field_wrapper
,
94 struct bt_trace_class
*tc
)
96 bt_field_wrapper_destroy(field_wrapper
);
99 struct bt_trace_class
*bt_trace_class_create(bt_self_component
*self_comp
)
101 struct bt_trace_class
*tc
= NULL
;
104 BT_ASSERT_PRE_NON_NULL(self_comp
, "Self component");
105 BT_LOGD_STR("Creating default trace class object.");
106 tc
= g_new0(struct bt_trace_class
, 1);
108 BT_LOGE_STR("Failed to allocate one trace class.");
112 bt_object_init_shared_with_parent(&tc
->base
, destroy_trace_class
);
114 tc
->stream_classes
= g_ptr_array_new_with_free_func(
115 (GDestroyNotify
) bt_object_try_spec_release
);
116 if (!tc
->stream_classes
) {
117 BT_LOGE_STR("Failed to allocate one GPtrArray.");
121 tc
->name
.str
= g_string_new(NULL
);
123 BT_LOGE_STR("Failed to allocate one GString.");
127 tc
->environment
= bt_attributes_create();
128 if (!tc
->environment
) {
129 BT_LOGE_STR("Cannot create empty attributes object.");
133 tc
->assigns_automatic_stream_class_id
= true;
134 ret
= bt_object_pool_initialize(&tc
->packet_header_field_pool
,
135 (bt_object_pool_new_object_func
) bt_field_wrapper_new
,
136 (bt_object_pool_destroy_object_func
) free_packet_header_field
,
139 BT_LOGE("Failed to initialize packet header field pool: ret=%d",
144 BT_LIB_LOGD("Created trace class object: %!+T", tc
);
148 BT_OBJECT_PUT_REF_AND_RESET(tc
);
154 const char *bt_trace_class_get_name(const struct bt_trace_class
*tc
)
156 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
157 return tc
->name
.value
;
160 enum bt_trace_class_status
bt_trace_class_set_name(
161 struct bt_trace_class
*tc
, const char *name
)
163 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
164 BT_ASSERT_PRE_NON_NULL(name
, "Name");
165 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
166 g_string_assign(tc
->name
.str
, name
);
167 tc
->name
.value
= tc
->name
.str
->str
;
168 BT_LIB_LOGV("Set trace class's name: %!+T", tc
);
169 return BT_TRACE_CLASS_STATUS_OK
;
172 bt_uuid
bt_trace_class_get_uuid(const struct bt_trace_class
*tc
)
174 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
175 return tc
->uuid
.value
;
178 void bt_trace_class_set_uuid(struct bt_trace_class
*tc
, bt_uuid uuid
)
180 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
181 BT_ASSERT_PRE_NON_NULL(uuid
, "UUID");
182 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
183 memcpy(tc
->uuid
.uuid
, uuid
, BABELTRACE_UUID_LEN
);
184 tc
->uuid
.value
= tc
->uuid
.uuid
;
185 BT_LIB_LOGV("Set trace class's UUID: %!+T", tc
);
190 bool trace_has_environment_entry(const struct bt_trace_class
*tc
, const char *name
)
194 return bt_attributes_borrow_field_value_by_name(
195 tc
->environment
, name
) != NULL
;
199 enum bt_trace_class_status
set_environment_entry(struct bt_trace_class
*tc
,
200 const char *name
, struct bt_value
*value
)
207 BT_ASSERT_PRE(!tc
->frozen
||
208 !trace_has_environment_entry(tc
, name
),
209 "Trace class is frozen: cannot replace environment entry: "
210 "%![tc-]+T, entry-name=\"%s\"", tc
, name
);
211 ret
= bt_attributes_set_field_value(tc
->environment
, name
,
214 ret
= BT_TRACE_CLASS_STATUS_NOMEM
;
215 BT_LIB_LOGE("Cannot set trace class's environment entry: "
216 "%![tc-]+T, entry-name=\"%s\"", tc
, name
);
218 bt_value_freeze(value
);
219 BT_LIB_LOGV("Set trace class's environment entry: "
220 "%![tc-]+T, entry-name=\"%s\"", tc
, name
);
226 enum bt_trace_class_status
bt_trace_class_set_environment_entry_string(
227 struct bt_trace_class
*tc
, const char *name
, const char *value
)
230 struct bt_value
*value_obj
;
231 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
232 BT_ASSERT_PRE_NON_NULL(name
, "Name");
233 BT_ASSERT_PRE_NON_NULL(value
, "Value");
234 value_obj
= bt_value_string_create_init(value
);
236 BT_LOGE_STR("Cannot create a string value object.");
241 /* set_environment_entry() logs errors */
242 ret
= set_environment_entry(tc
, name
, value_obj
);
245 bt_object_put_ref(value_obj
);
249 enum bt_trace_class_status
bt_trace_class_set_environment_entry_integer(
250 struct bt_trace_class
*tc
, const char *name
, int64_t value
)
253 struct bt_value
*value_obj
;
254 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
255 BT_ASSERT_PRE_NON_NULL(name
, "Name");
256 value_obj
= bt_value_integer_create_init(value
);
258 BT_LOGE_STR("Cannot create an integer value object.");
259 ret
= BT_TRACE_CLASS_STATUS_NOMEM
;
263 /* set_environment_entry() logs errors */
264 ret
= set_environment_entry(tc
, name
, value_obj
);
267 bt_object_put_ref(value_obj
);
271 uint64_t bt_trace_class_get_environment_entry_count(const struct bt_trace_class
*tc
)
275 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
276 ret
= bt_attributes_get_count(tc
->environment
);
278 return (uint64_t) ret
;
281 void bt_trace_class_borrow_environment_entry_by_index_const(
282 const struct bt_trace_class
*tc
, uint64_t index
,
283 const char **name
, const struct bt_value
**value
)
285 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
286 BT_ASSERT_PRE_NON_NULL(name
, "Name");
287 BT_ASSERT_PRE_NON_NULL(value
, "Value");
288 BT_ASSERT_PRE_VALID_INDEX(index
,
289 bt_attributes_get_count(tc
->environment
));
290 *value
= bt_attributes_borrow_field_value(tc
->environment
, index
);
292 *name
= bt_attributes_get_field_name(tc
->environment
, index
);
296 const struct bt_value
*bt_trace_class_borrow_environment_entry_value_by_name_const(
297 const struct bt_trace_class
*tc
, const char *name
)
299 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
300 BT_ASSERT_PRE_NON_NULL(name
, "Name");
301 return bt_attributes_borrow_field_value_by_name(tc
->environment
,
305 uint64_t bt_trace_class_get_stream_class_count(const struct bt_trace_class
*tc
)
307 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
308 return (uint64_t) tc
->stream_classes
->len
;
311 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_index(
312 struct bt_trace_class
*tc
, uint64_t index
)
314 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
315 BT_ASSERT_PRE_VALID_INDEX(index
, tc
->stream_classes
->len
);
316 return g_ptr_array_index(tc
->stream_classes
, index
);
319 const struct bt_stream_class
*
320 bt_trace_class_borrow_stream_class_by_index_const(
321 const struct bt_trace_class
*tc
, uint64_t index
)
323 return bt_trace_class_borrow_stream_class_by_index(
327 struct bt_stream_class
*bt_trace_class_borrow_stream_class_by_id(
328 struct bt_trace_class
*tc
, uint64_t id
)
330 struct bt_stream_class
*stream_class
= NULL
;
333 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
335 for (i
= 0; i
< tc
->stream_classes
->len
; i
++) {
336 struct bt_stream_class
*stream_class_candidate
=
337 g_ptr_array_index(tc
->stream_classes
, i
);
339 if (stream_class_candidate
->id
== id
) {
340 stream_class
= stream_class_candidate
;
349 const struct bt_stream_class
*
350 bt_trace_class_borrow_stream_class_by_id_const(
351 const struct bt_trace_class
*tc
, uint64_t id
)
353 return bt_trace_class_borrow_stream_class_by_id((void *) tc
, id
);
356 const struct bt_field_class
*bt_trace_class_borrow_packet_header_field_class_const(
357 const struct bt_trace_class
*tc
)
359 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
360 return tc
->packet_header_fc
;
363 enum bt_trace_class_status
bt_trace_class_set_packet_header_field_class(
364 struct bt_trace_class
*tc
,
365 struct bt_field_class
*field_class
)
368 struct bt_resolve_field_path_context resolve_ctx
= {
369 .packet_header
= field_class
,
370 .packet_context
= NULL
,
371 .event_header
= NULL
,
372 .event_common_context
= NULL
,
373 .event_specific_context
= NULL
,
374 .event_payload
= NULL
,
377 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
378 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
379 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
380 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
381 BT_FIELD_CLASS_TYPE_STRUCTURE
,
382 "Packet header field class is not a structure field class: %!+F",
384 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
387 * This is the only reason for which
388 * bt_resolve_field_paths() can fail: anything else
389 * would be because a precondition is not satisfied.
391 ret
= BT_TRACE_CLASS_STATUS_NOMEM
;
395 bt_field_class_make_part_of_trace_class(field_class
);
396 bt_object_put_ref(tc
->packet_header_fc
);
397 tc
->packet_header_fc
= field_class
;
398 bt_object_get_no_null_check(tc
->packet_header_fc
);
399 bt_field_class_freeze(field_class
);
400 BT_LIB_LOGV("Set trace class's packet header field class: %!+T", tc
);
407 void _bt_trace_class_freeze(const struct bt_trace_class
*tc
)
409 /* The packet header field class is already frozen */
411 BT_LIB_LOGD("Freezing trace class: %!+T", tc
);
412 ((struct bt_trace_class
*) tc
)->frozen
= true;
415 bt_bool
bt_trace_class_assigns_automatic_stream_class_id(const struct bt_trace_class
*tc
)
417 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
418 return (bt_bool
) tc
->assigns_automatic_stream_class_id
;
421 void bt_trace_class_set_assigns_automatic_stream_class_id(struct bt_trace_class
*tc
,
424 BT_ASSERT_PRE_NON_NULL(tc
, "Trace class");
425 BT_ASSERT_PRE_TRACE_CLASS_HOT(tc
);
426 tc
->assigns_automatic_stream_class_id
= (bool) value
;
427 BT_LIB_LOGV("Set trace class's automatic stream class ID "
428 "assignment property: %!+T", tc
);
431 void bt_trace_class_get_ref(const struct bt_trace_class
*trace_class
)
433 bt_object_get_ref(trace_class
);
436 void bt_trace_class_put_ref(const struct bt_trace_class
*trace_class
)
438 bt_object_put_ref(trace_class
);