2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2013, 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/EVENT-CLASS"
25 #include "lib/logging.h"
27 #include "lib/assert-pre.h"
28 #include <babeltrace2/trace-ir/field-class.h>
29 #include <babeltrace2/trace-ir/event-class.h>
30 #include <babeltrace2/trace-ir/stream-class.h>
31 #include "compat/compiler.h"
32 #include "compat/endian.h"
33 #include <babeltrace2/types.h>
34 #include "lib/value.h"
35 #include "common/assert.h"
40 #include "attributes.h"
41 #include "clock-snapshot.h"
42 #include "event-class.h"
44 #include "field-class.h"
46 #include "resolve-field-path.h"
47 #include "stream-class.h"
50 #include "lib/func-status.h"
52 #define BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(_ec) \
53 BT_ASSERT_PRE_DEV_HOT(((const struct bt_event_class *) (_ec)), \
54 "Event class", ": %!+E", (_ec))
57 void destroy_event_class(struct bt_object
*obj
)
59 struct bt_event_class
*event_class
= (void *) obj
;
61 BT_LIB_LOGD("Destroying event class: %!+E", event_class
);
62 BT_OBJECT_PUT_REF_AND_RESET(event_class
->user_attributes
);
64 if (event_class
->name
.str
) {
65 g_string_free(event_class
->name
.str
, TRUE
);
66 event_class
->name
.str
= NULL
;
69 if (event_class
->emf_uri
.str
) {
70 g_string_free(event_class
->emf_uri
.str
, TRUE
);
71 event_class
->emf_uri
.str
= NULL
;
74 BT_LOGD_STR("Putting context field class.");
75 BT_OBJECT_PUT_REF_AND_RESET(event_class
->specific_context_fc
);
76 BT_LOGD_STR("Putting payload field class.");
77 BT_OBJECT_PUT_REF_AND_RESET(event_class
->payload_fc
);
78 bt_object_pool_finalize(&event_class
->event_pool
);
83 void free_event(struct bt_event
*event
,
84 struct bt_event_class
*event_class
)
86 bt_event_destroy(event
);
90 bool event_class_id_is_unique(const struct bt_stream_class
*stream_class
,
94 bool is_unique
= true;
96 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
97 const struct bt_event_class
*ec
=
98 stream_class
->event_classes
->pdata
[i
];
111 struct bt_event_class
*create_event_class_with_id(
112 struct bt_stream_class
*stream_class
, uint64_t id
)
115 struct bt_event_class
*event_class
;
117 BT_ASSERT(stream_class
);
118 BT_ASSERT_PRE(event_class_id_is_unique(stream_class
, id
),
119 "Duplicate event class ID: %![sc-]+S, id=%" PRIu64
,
121 BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64
,
123 event_class
= g_new0(struct bt_event_class
, 1);
125 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one event class.");
129 bt_object_init_shared_with_parent(&event_class
->base
,
130 destroy_event_class
);
131 event_class
->user_attributes
= bt_value_map_create();
132 if (!event_class
->user_attributes
) {
133 BT_LIB_LOGE_APPEND_CAUSE(
134 "Failed to create a map value object.");
138 event_class
->id
= id
;
139 bt_property_uint_init(&event_class
->log_level
,
140 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
, 0);
141 event_class
->name
.str
= g_string_new(NULL
);
142 if (!event_class
->name
.str
) {
143 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
147 event_class
->emf_uri
.str
= g_string_new(NULL
);
148 if (!event_class
->emf_uri
.str
) {
149 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
153 ret
= bt_object_pool_initialize(&event_class
->event_pool
,
154 (bt_object_pool_new_object_func
) bt_event_new
,
155 (bt_object_pool_destroy_object_func
) free_event
,
158 BT_LIB_LOGE_APPEND_CAUSE(
159 "Failed to initialize event pool: ret=%d",
164 bt_object_set_parent(&event_class
->base
, &stream_class
->base
);
165 g_ptr_array_add(stream_class
->event_classes
, event_class
);
166 bt_stream_class_freeze(stream_class
);
167 BT_LIB_LOGD("Created event class object: %!+E", event_class
);
171 BT_OBJECT_PUT_REF_AND_RESET(event_class
);
177 struct bt_event_class
*bt_event_class_create(
178 struct bt_stream_class
*stream_class
)
180 BT_ASSERT_PRE_NO_ERROR();
181 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
182 BT_ASSERT_PRE(stream_class
->assigns_automatic_event_class_id
,
183 "Stream class does not automatically assigns event class IDs: "
184 "%![sc-]+S", stream_class
);
185 return create_event_class_with_id(stream_class
,
186 (uint64_t) stream_class
->event_classes
->len
);
189 struct bt_event_class
*bt_event_class_create_with_id(
190 struct bt_stream_class
*stream_class
, uint64_t id
)
192 BT_ASSERT_PRE_NO_ERROR();
193 BT_ASSERT_PRE(!stream_class
->assigns_automatic_event_class_id
,
194 "Stream class automatically assigns event class IDs: "
195 "%![sc-]+S", stream_class
);
196 return create_event_class_with_id(stream_class
, id
);
199 const char *bt_event_class_get_name(const struct bt_event_class
*event_class
)
201 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
202 return event_class
->name
.value
;
205 enum bt_event_class_set_name_status
bt_event_class_set_name(
206 struct bt_event_class
*event_class
, const char *name
)
208 BT_ASSERT_PRE_NO_ERROR();
209 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
210 BT_ASSERT_PRE_NON_NULL(name
, "Name");
211 BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class
);
212 g_string_assign(event_class
->name
.str
, name
);
213 event_class
->name
.value
= event_class
->name
.str
->str
;
214 BT_LIB_LOGD("Set event class's name: %!+E", event_class
);
215 return BT_FUNC_STATUS_OK
;
218 uint64_t bt_event_class_get_id(const struct bt_event_class
*event_class
)
220 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
221 return event_class
->id
;
224 enum bt_property_availability
bt_event_class_get_log_level(
225 const struct bt_event_class
*event_class
,
226 enum bt_event_class_log_level
*log_level
)
228 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
229 BT_ASSERT_PRE_DEV_NON_NULL(log_level
, "Log level (output)");
230 *log_level
= (enum bt_event_class_log_level
)
231 event_class
->log_level
.value
;
232 return event_class
->log_level
.base
.avail
;
235 void bt_event_class_set_log_level(
236 struct bt_event_class
*event_class
,
237 enum bt_event_class_log_level log_level
)
239 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
240 BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class
);
241 bt_property_uint_set(&event_class
->log_level
,
242 (uint64_t) log_level
);
243 BT_LIB_LOGD("Set event class's log level: %!+E", event_class
);
246 const char *bt_event_class_get_emf_uri(const struct bt_event_class
*event_class
)
248 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
249 return event_class
->emf_uri
.value
;
252 enum bt_event_class_set_emf_uri_status
bt_event_class_set_emf_uri(
253 struct bt_event_class
*event_class
,
256 BT_ASSERT_PRE_NO_ERROR();
257 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
258 BT_ASSERT_PRE_NON_NULL(emf_uri
, "EMF URI");
259 BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class
);
260 g_string_assign(event_class
->emf_uri
.str
, emf_uri
);
261 event_class
->emf_uri
.value
= event_class
->emf_uri
.str
->str
;
262 BT_LIB_LOGD("Set event class's EMF URI: %!+E", event_class
);
263 return BT_FUNC_STATUS_OK
;
266 struct bt_stream_class
*bt_event_class_borrow_stream_class(
267 struct bt_event_class
*event_class
)
269 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
270 return bt_event_class_borrow_stream_class_inline(event_class
);
273 const struct bt_stream_class
*
274 bt_event_class_borrow_stream_class_const(
275 const struct bt_event_class
*event_class
)
277 return bt_event_class_borrow_stream_class((void *) event_class
);
280 const struct bt_field_class
*
281 bt_event_class_borrow_specific_context_field_class_const(
282 const struct bt_event_class
*event_class
)
284 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
285 return event_class
->specific_context_fc
;
288 struct bt_field_class
*
289 bt_event_class_borrow_specific_context_field_class(
290 struct bt_event_class
*event_class
)
292 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
293 return event_class
->specific_context_fc
;
296 enum bt_event_class_set_field_class_status
297 bt_event_class_set_specific_context_field_class(
298 struct bt_event_class
*event_class
,
299 struct bt_field_class
*field_class
)
302 struct bt_stream_class
*stream_class
;
303 struct bt_resolve_field_path_context resolve_ctx
= {
304 .packet_context
= NULL
,
305 .event_common_context
= NULL
,
306 .event_specific_context
= field_class
,
307 .event_payload
= NULL
,
310 BT_ASSERT_PRE_NO_ERROR();
311 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
312 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
313 BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class
);
314 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
315 BT_FIELD_CLASS_TYPE_STRUCTURE
,
316 "Specific context field class is not a structure field class: "
317 "%!+F", field_class
);
318 stream_class
= bt_event_class_borrow_stream_class_inline(
320 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
321 resolve_ctx
.event_common_context
=
322 stream_class
->event_common_context_fc
;
324 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
327 * This is the only reason for which
328 * bt_resolve_field_paths() can fail: anything else
329 * would be because a precondition is not satisfied.
331 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
335 bt_field_class_make_part_of_trace_class(field_class
);
336 bt_object_put_ref(event_class
->specific_context_fc
);
337 event_class
->specific_context_fc
= field_class
;
338 bt_object_get_ref_no_null_check(event_class
->specific_context_fc
);
339 bt_field_class_freeze(field_class
);
340 BT_LIB_LOGD("Set event class's specific context field class: %!+E",
347 const struct bt_field_class
*bt_event_class_borrow_payload_field_class_const(
348 const struct bt_event_class
*event_class
)
350 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
351 return event_class
->payload_fc
;
354 struct bt_field_class
*bt_event_class_borrow_payload_field_class(
355 struct bt_event_class
*event_class
)
357 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
358 return event_class
->payload_fc
;
361 enum bt_event_class_set_field_class_status
362 bt_event_class_set_payload_field_class(
363 struct bt_event_class
*event_class
,
364 struct bt_field_class
*field_class
)
367 struct bt_stream_class
*stream_class
;
368 struct bt_resolve_field_path_context resolve_ctx
= {
369 .packet_context
= NULL
,
370 .event_common_context
= NULL
,
371 .event_specific_context
= NULL
,
372 .event_payload
= field_class
,
375 BT_ASSERT_PRE_NO_ERROR();
376 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
377 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
378 BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class
);
379 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
380 BT_FIELD_CLASS_TYPE_STRUCTURE
,
381 "Payload field class is not a structure field class: %!+F",
383 stream_class
= bt_event_class_borrow_stream_class_inline(
385 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
386 resolve_ctx
.event_common_context
=
387 stream_class
->event_common_context_fc
;
388 resolve_ctx
.event_specific_context
= event_class
->specific_context_fc
;
390 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
393 * This is the only reason for which
394 * bt_resolve_field_paths() can fail: anything else
395 * would be because a precondition is not satisfied.
397 ret
= BT_FUNC_STATUS_MEMORY_ERROR
;
401 bt_field_class_make_part_of_trace_class(field_class
);
402 bt_object_put_ref(event_class
->payload_fc
);
403 event_class
->payload_fc
= field_class
;
404 bt_object_get_ref_no_null_check(event_class
->payload_fc
);
405 bt_field_class_freeze(field_class
);
406 BT_LIB_LOGD("Set event class's payload field class: %!+E", event_class
);
413 void _bt_event_class_freeze(const struct bt_event_class
*event_class
)
415 /* The field classes are already frozen */
416 BT_ASSERT(event_class
);
417 BT_LIB_LOGD("Freezing event class's user attributes: %!+v",
418 event_class
->user_attributes
);
419 bt_value_freeze(event_class
->user_attributes
);
420 BT_LIB_LOGD("Freezing event class: %!+E", event_class
);
421 ((struct bt_event_class
*) event_class
)->frozen
= true;
424 const struct bt_value
*bt_event_class_borrow_user_attributes_const(
425 const struct bt_event_class
*event_class
)
427 BT_ASSERT_PRE_DEV_NON_NULL(event_class
, "Event class");
428 return event_class
->user_attributes
;
431 struct bt_value
*bt_event_class_borrow_user_attributes(
432 struct bt_event_class
*event_class
)
434 return (void *) bt_event_class_borrow_user_attributes_const(
435 (void *) event_class
);
438 void bt_event_class_set_user_attributes(
439 struct bt_event_class
*event_class
,
440 const struct bt_value
*user_attributes
)
442 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
443 BT_ASSERT_PRE_NON_NULL(user_attributes
, "User attributes");
444 BT_ASSERT_PRE(user_attributes
->type
== BT_VALUE_TYPE_MAP
,
445 "User attributes object is not a map value object.");
446 BT_ASSERT_PRE_DEV_EVENT_CLASS_HOT(event_class
);
447 bt_object_put_ref_no_null_check(event_class
->user_attributes
);
448 event_class
->user_attributes
= (void *) user_attributes
;
449 bt_object_get_ref_no_null_check(event_class
->user_attributes
);
452 void bt_event_class_get_ref(const struct bt_event_class
*event_class
)
454 bt_object_get_ref(event_class
);
457 void bt_event_class_put_ref(const struct bt_event_class
*event_class
)
459 bt_object_put_ref(event_class
);