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 "EVENT-CLASS"
25 #include "lib/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/event-class-const.h>
31 #include <babeltrace2/trace-ir/stream-class.h>
32 #include "compat/compiler.h"
33 #include "compat/endian.h"
34 #include <babeltrace2/types.h>
35 #include "lib/value.h"
36 #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"
51 #define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
52 BT_ASSERT_PRE_HOT(((const struct bt_event_class *) (_ec)), \
53 "Event class", ": %!+E", (_ec))
56 void destroy_event_class(struct bt_object
*obj
)
58 struct bt_event_class
*event_class
= (void *) obj
;
60 BT_LIB_LOGD("Destroying event class: %!+E", event_class
);
62 if (event_class
->name
.str
) {
63 g_string_free(event_class
->name
.str
, TRUE
);
64 event_class
->name
.str
= NULL
;
67 if (event_class
->emf_uri
.str
) {
68 g_string_free(event_class
->emf_uri
.str
, TRUE
);
69 event_class
->emf_uri
.str
= NULL
;
72 BT_LOGD_STR("Putting context field class.");
73 BT_OBJECT_PUT_REF_AND_RESET(event_class
->specific_context_fc
);
74 BT_LOGD_STR("Putting payload field class.");
75 BT_OBJECT_PUT_REF_AND_RESET(event_class
->payload_fc
);
76 bt_object_pool_finalize(&event_class
->event_pool
);
81 void free_event(struct bt_event
*event
,
82 struct bt_event_class
*event_class
)
84 bt_event_destroy(event
);
89 bool event_class_id_is_unique(const struct bt_stream_class
*stream_class
,
93 bool is_unique
= true;
95 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
96 const struct bt_event_class
*ec
=
97 stream_class
->event_classes
->pdata
[i
];
110 struct bt_event_class
*create_event_class_with_id(
111 struct bt_stream_class
*stream_class
, uint64_t id
)
114 struct bt_event_class
*event_class
;
116 BT_ASSERT(stream_class
);
117 BT_ASSERT_PRE(event_class_id_is_unique(stream_class
, id
),
118 "Duplicate event class ID: %![sc-]+S, id=%" PRIu64
,
120 BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64
,
122 event_class
= g_new0(struct bt_event_class
, 1);
124 BT_LOGE_STR("Failed to allocate one event class.");
128 bt_object_init_shared_with_parent(&event_class
->base
,
129 destroy_event_class
);
130 event_class
->id
= id
;
131 bt_property_uint_init(&event_class
->log_level
,
132 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
, 0);
133 event_class
->name
.str
= g_string_new(NULL
);
134 if (!event_class
->name
.str
) {
135 BT_LOGE_STR("Failed to allocate a GString.");
140 event_class
->emf_uri
.str
= g_string_new(NULL
);
141 if (!event_class
->emf_uri
.str
) {
142 BT_LOGE_STR("Failed to allocate a GString.");
147 ret
= bt_object_pool_initialize(&event_class
->event_pool
,
148 (bt_object_pool_new_object_func
) bt_event_new
,
149 (bt_object_pool_destroy_object_func
) free_event
,
152 BT_LOGE("Failed to initialize event pool: ret=%d",
157 bt_object_set_parent(&event_class
->base
, &stream_class
->base
);
158 g_ptr_array_add(stream_class
->event_classes
, event_class
);
159 bt_stream_class_freeze(stream_class
);
160 BT_LIB_LOGD("Created event class object: %!+E", event_class
);
164 BT_OBJECT_PUT_REF_AND_RESET(event_class
);
170 struct bt_event_class
*bt_event_class_create(
171 struct bt_stream_class
*stream_class
)
173 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
174 BT_ASSERT_PRE(stream_class
->assigns_automatic_event_class_id
,
175 "Stream class does not automatically assigns event class IDs: "
176 "%![sc-]+S", stream_class
);
177 return create_event_class_with_id(stream_class
,
178 (uint64_t) stream_class
->event_classes
->len
);
181 struct bt_event_class
*bt_event_class_create_with_id(
182 struct bt_stream_class
*stream_class
, uint64_t id
)
184 BT_ASSERT_PRE(!stream_class
->assigns_automatic_event_class_id
,
185 "Stream class automatically assigns event class IDs: "
186 "%![sc-]+S", stream_class
);
187 return create_event_class_with_id(stream_class
, id
);
190 const char *bt_event_class_get_name(const struct bt_event_class
*event_class
)
192 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
193 return event_class
->name
.value
;
196 enum bt_event_class_status
bt_event_class_set_name(
197 struct bt_event_class
*event_class
, const char *name
)
199 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
200 BT_ASSERT_PRE_NON_NULL(name
, "Name");
201 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
202 g_string_assign(event_class
->name
.str
, name
);
203 event_class
->name
.value
= event_class
->name
.str
->str
;
204 BT_LIB_LOGD("Set event class's name: %!+E", event_class
);
205 return BT_EVENT_CLASS_STATUS_OK
;
208 uint64_t bt_event_class_get_id(const struct bt_event_class
*event_class
)
210 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
211 return event_class
->id
;
214 enum bt_property_availability
bt_event_class_get_log_level(
215 const struct bt_event_class
*event_class
,
216 enum bt_event_class_log_level
*log_level
)
218 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
219 BT_ASSERT_PRE_NON_NULL(log_level
, "Log level (output)");
220 *log_level
= (enum bt_event_class_log_level
)
221 event_class
->log_level
.value
;
222 return event_class
->log_level
.base
.avail
;
225 void bt_event_class_set_log_level(
226 struct bt_event_class
*event_class
,
227 enum bt_event_class_log_level log_level
)
229 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
230 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
231 bt_property_uint_set(&event_class
->log_level
,
232 (uint64_t) log_level
);
233 BT_LIB_LOGD("Set event class's log level: %!+E", event_class
);
236 const char *bt_event_class_get_emf_uri(const struct bt_event_class
*event_class
)
238 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
239 return event_class
->emf_uri
.value
;
242 enum bt_event_class_status
bt_event_class_set_emf_uri(
243 struct bt_event_class
*event_class
,
246 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
247 BT_ASSERT_PRE_NON_NULL(emf_uri
, "EMF URI");
248 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
249 g_string_assign(event_class
->emf_uri
.str
, emf_uri
);
250 event_class
->emf_uri
.value
= event_class
->emf_uri
.str
->str
;
251 BT_LIB_LOGD("Set event class's EMF URI: %!+E", event_class
);
252 return BT_EVENT_CLASS_STATUS_OK
;
255 struct bt_stream_class
*bt_event_class_borrow_stream_class(
256 struct bt_event_class
*event_class
)
258 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
259 return bt_event_class_borrow_stream_class_inline(event_class
);
262 const struct bt_stream_class
*
263 bt_event_class_borrow_stream_class_const(
264 const struct bt_event_class
*event_class
)
266 return bt_event_class_borrow_stream_class((void *) event_class
);
269 const struct bt_field_class
*
270 bt_event_class_borrow_specific_context_field_class_const(
271 const struct bt_event_class
*event_class
)
273 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
274 return event_class
->specific_context_fc
;
277 struct bt_field_class
*
278 bt_event_class_borrow_specific_context_field_class(
279 struct bt_event_class
*event_class
)
281 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
282 return event_class
->specific_context_fc
;
285 enum bt_event_class_status
bt_event_class_set_specific_context_field_class(
286 struct bt_event_class
*event_class
,
287 struct bt_field_class
*field_class
)
290 struct bt_stream_class
*stream_class
;
291 struct bt_resolve_field_path_context resolve_ctx
= {
292 .packet_context
= NULL
,
293 .event_common_context
= NULL
,
294 .event_specific_context
= field_class
,
295 .event_payload
= NULL
,
298 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
299 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
300 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
301 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
302 BT_FIELD_CLASS_TYPE_STRUCTURE
,
303 "Specific context field class is not a structure field class: "
304 "%!+F", field_class
);
305 stream_class
= bt_event_class_borrow_stream_class_inline(
307 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
308 resolve_ctx
.event_common_context
=
309 stream_class
->event_common_context_fc
;
311 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
314 * This is the only reason for which
315 * bt_resolve_field_paths() can fail: anything else
316 * would be because a precondition is not satisfied.
318 ret
= BT_EVENT_CLASS_STATUS_NOMEM
;
322 bt_field_class_make_part_of_trace_class(field_class
);
323 bt_object_put_ref(event_class
->specific_context_fc
);
324 event_class
->specific_context_fc
= field_class
;
325 bt_object_get_no_null_check(event_class
->specific_context_fc
);
326 bt_field_class_freeze(field_class
);
327 BT_LIB_LOGD("Set event class's specific context field class: %!+E",
334 const struct bt_field_class
*bt_event_class_borrow_payload_field_class_const(
335 const struct bt_event_class
*event_class
)
337 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
338 return event_class
->payload_fc
;
341 struct bt_field_class
*bt_event_class_borrow_payload_field_class(
342 struct bt_event_class
*event_class
)
344 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
345 return event_class
->payload_fc
;
348 enum bt_event_class_status
bt_event_class_set_payload_field_class(
349 struct bt_event_class
*event_class
,
350 struct bt_field_class
*field_class
)
353 struct bt_stream_class
*stream_class
;
354 struct bt_resolve_field_path_context resolve_ctx
= {
355 .packet_context
= NULL
,
356 .event_common_context
= NULL
,
357 .event_specific_context
= NULL
,
358 .event_payload
= field_class
,
361 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
362 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
363 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
364 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
365 BT_FIELD_CLASS_TYPE_STRUCTURE
,
366 "Payload field class is not a structure field class: %!+F",
368 stream_class
= bt_event_class_borrow_stream_class_inline(
370 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
371 resolve_ctx
.event_common_context
=
372 stream_class
->event_common_context_fc
;
373 resolve_ctx
.event_specific_context
= event_class
->specific_context_fc
;
375 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
378 * This is the only reason for which
379 * bt_resolve_field_paths() can fail: anything else
380 * would be because a precondition is not satisfied.
382 ret
= BT_EVENT_CLASS_STATUS_NOMEM
;
386 bt_field_class_make_part_of_trace_class(field_class
);
387 bt_object_put_ref(event_class
->payload_fc
);
388 event_class
->payload_fc
= field_class
;
389 bt_object_get_no_null_check(event_class
->payload_fc
);
390 bt_field_class_freeze(field_class
);
391 BT_LIB_LOGD("Set event class's payload field class: %!+E", event_class
);
398 void _bt_event_class_freeze(const struct bt_event_class
*event_class
)
400 /* The field classes are already frozen */
401 BT_ASSERT(event_class
);
402 BT_LIB_LOGD("Freezing event class: %!+E", event_class
);
403 ((struct bt_event_class
*) event_class
)->frozen
= true;
406 void bt_event_class_get_ref(const struct bt_event_class
*event_class
)
408 bt_object_get_ref(event_class
);
411 void bt_event_class_put_ref(const struct bt_event_class
*event_class
)
413 bt_object_put_ref(event_class
);