2 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_TAG "EVENT-CLASS"
26 #include <babeltrace/lib-logging-internal.h>
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/trace-ir/clock-value-internal.h>
30 #include <babeltrace/trace-ir/fields-internal.h>
31 #include <babeltrace/trace-ir/field-classes.h>
32 #include <babeltrace/trace-ir/field-classes-internal.h>
33 #include <babeltrace/trace-ir/event-class.h>
34 #include <babeltrace/trace-ir/event-class-const.h>
35 #include <babeltrace/trace-ir/event-class-internal.h>
36 #include <babeltrace/trace-ir/event-internal.h>
37 #include <babeltrace/trace-ir/stream-class.h>
38 #include <babeltrace/trace-ir/stream-class-internal.h>
39 #include <babeltrace/trace-ir/trace-internal.h>
40 #include <babeltrace/trace-ir/utils-internal.h>
41 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
42 #include <babeltrace/object.h>
43 #include <babeltrace/trace-ir/attributes-internal.h>
44 #include <babeltrace/compiler-internal.h>
45 #include <babeltrace/endian-internal.h>
46 #include <babeltrace/types.h>
47 #include <babeltrace/values-internal.h>
48 #include <babeltrace/assert-internal.h>
52 #define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
53 BT_ASSERT_PRE_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
);
63 if (event_class
->name
.str
) {
64 g_string_free(event_class
->name
.str
, TRUE
);
65 event_class
->name
.str
= NULL
;
68 if (event_class
->emf_uri
.str
) {
69 g_string_free(event_class
->emf_uri
.str
, TRUE
);
70 event_class
->emf_uri
.str
= NULL
;
73 BT_LOGD_STR("Putting context field classe.");
74 BT_OBJECT_PUT_REF_AND_RESET(event_class
->specific_context_fc
);
75 BT_LOGD_STR("Putting payload field classe.");
76 BT_OBJECT_PUT_REF_AND_RESET(event_class
->payload_fc
);
77 bt_object_pool_finalize(&event_class
->event_pool
);
82 void free_event(struct bt_event
*event
,
83 struct bt_event_class
*event_class
)
85 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_LOGE_STR("Failed to allocate one event class.");
129 bt_object_init_shared_with_parent(&event_class
->base
,
130 destroy_event_class
);
131 event_class
->id
= id
;
132 bt_property_uint_init(&event_class
->log_level
,
133 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
, 0);
134 event_class
->name
.str
= g_string_new(NULL
);
135 if (!event_class
->name
.str
) {
136 BT_LOGE_STR("Failed to allocate a GString.");
141 event_class
->emf_uri
.str
= g_string_new(NULL
);
142 if (!event_class
->emf_uri
.str
) {
143 BT_LOGE_STR("Failed to allocate a GString.");
148 ret
= bt_object_pool_initialize(&event_class
->event_pool
,
149 (bt_object_pool_new_object_func
) bt_event_new
,
150 (bt_object_pool_destroy_object_func
) free_event
,
153 BT_LOGE("Failed to initialize event pool: ret=%d",
158 bt_object_set_parent(&event_class
->base
, &stream_class
->base
);
159 g_ptr_array_add(stream_class
->event_classes
, event_class
);
160 bt_stream_class_freeze(stream_class
);
161 BT_LIB_LOGD("Created event class object: %!+E", event_class
);
165 BT_OBJECT_PUT_REF_AND_RESET(event_class
);
171 struct bt_event_class
*bt_event_class_create(
172 struct bt_stream_class
*stream_class
)
174 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
175 BT_ASSERT_PRE(stream_class
->assigns_automatic_event_class_id
,
176 "Stream class does not automatically assigns event class IDs: "
177 "%![sc-]+S", stream_class
);
178 return create_event_class_with_id(stream_class
,
179 (uint64_t) stream_class
->event_classes
->len
);
182 struct bt_event_class
*bt_event_class_create_with_id(
183 struct bt_stream_class
*stream_class
, uint64_t id
)
185 BT_ASSERT_PRE(!stream_class
->assigns_automatic_event_class_id
,
186 "Stream class automatically assigns event class IDs: "
187 "%![sc-]+S", stream_class
);
188 return create_event_class_with_id(stream_class
, id
);
191 const char *bt_event_class_get_name(const struct bt_event_class
*event_class
)
193 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
194 return event_class
->name
.value
;
197 int bt_event_class_set_name(struct bt_event_class
*event_class
,
200 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
201 BT_ASSERT_PRE_NON_NULL(name
, "Name");
202 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
203 g_string_assign(event_class
->name
.str
, name
);
204 event_class
->name
.value
= event_class
->name
.str
->str
;
205 BT_LIB_LOGV("Set event class's name: %!+E", event_class
);
209 uint64_t bt_event_class_get_id(const struct bt_event_class
*event_class
)
211 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
212 return event_class
->id
;
215 enum bt_property_availability
bt_event_class_get_log_level(
216 const struct bt_event_class
*event_class
,
217 enum bt_event_class_log_level
*log_level
)
219 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
220 BT_ASSERT_PRE_NON_NULL(log_level
, "Log level (output)");
221 *log_level
= (enum bt_event_class_log_level
)
222 event_class
->log_level
.value
;
223 return event_class
->log_level
.base
.avail
;
226 void bt_event_class_set_log_level(
227 struct bt_event_class
*event_class
,
228 enum bt_event_class_log_level log_level
)
230 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
231 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
232 bt_property_uint_set(&event_class
->log_level
,
233 (uint64_t) log_level
);
234 BT_LIB_LOGV("Set event class's log level: %!+E", event_class
);
237 const char *bt_event_class_get_emf_uri(const struct bt_event_class
*event_class
)
239 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
240 return event_class
->emf_uri
.value
;
243 int bt_event_class_set_emf_uri(
244 struct bt_event_class
*event_class
,
247 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
248 BT_ASSERT_PRE_NON_NULL(emf_uri
, "EMF URI");
249 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
250 g_string_assign(event_class
->emf_uri
.str
, emf_uri
);
251 event_class
->emf_uri
.value
= event_class
->emf_uri
.str
->str
;
252 BT_LIB_LOGV("Set event class's EMF URI: %!+E", event_class
);
256 struct bt_stream_class
*bt_event_class_borrow_stream_class(
257 struct bt_event_class
*event_class
)
259 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
260 return bt_event_class_borrow_stream_class_inline(event_class
);
263 const struct bt_stream_class
*
264 bt_event_class_borrow_stream_class_const(
265 const struct bt_event_class
*event_class
)
267 return bt_event_class_borrow_stream_class((void *) event_class
);
270 const struct bt_field_class
*
271 bt_event_class_borrow_specific_context_field_class_const(
272 const struct bt_event_class
*event_class
)
274 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
275 return event_class
->specific_context_fc
;
278 int bt_event_class_set_specific_context_field_class(
279 struct bt_event_class
*event_class
,
280 struct bt_field_class
*field_class
)
283 struct bt_stream_class
*stream_class
;
284 struct bt_trace_class
*trace_class
;
285 struct bt_resolve_field_path_context resolve_ctx
= {
286 .packet_header
= NULL
,
287 .packet_context
= NULL
,
288 .event_header
= NULL
,
289 .event_common_context
= NULL
,
290 .event_specific_context
= field_class
,
291 .event_payload
= NULL
,
294 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
295 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
296 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
297 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
298 BT_FIELD_CLASS_TYPE_STRUCTURE
,
299 "Specific context field classe is not a structure field classe: "
300 "%!+F", field_class
);
301 stream_class
= bt_event_class_borrow_stream_class_inline(
303 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
304 resolve_ctx
.packet_header
= trace_class
->packet_header_fc
;
305 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
306 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
307 resolve_ctx
.event_common_context
=
308 stream_class
->event_common_context_fc
;
310 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
315 bt_field_class_make_part_of_trace_class(field_class
);
316 bt_object_put_ref(event_class
->specific_context_fc
);
317 event_class
->specific_context_fc
= field_class
;
318 bt_object_get_no_null_check(event_class
->specific_context_fc
);
319 bt_field_class_freeze(field_class
);
320 BT_LIB_LOGV("Set event class's specific context field classe: %!+E",
327 const struct bt_field_class
*bt_event_class_borrow_payload_field_class_const(
328 const struct bt_event_class
*event_class
)
330 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
331 return event_class
->payload_fc
;
334 int bt_event_class_set_payload_field_class(
335 struct bt_event_class
*event_class
,
336 struct bt_field_class
*field_class
)
339 struct bt_stream_class
*stream_class
;
340 struct bt_trace_class
*trace_class
;
341 struct bt_resolve_field_path_context resolve_ctx
= {
342 .packet_header
= NULL
,
343 .packet_context
= NULL
,
344 .event_header
= NULL
,
345 .event_common_context
= NULL
,
346 .event_specific_context
= NULL
,
347 .event_payload
= field_class
,
350 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
351 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
352 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
353 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
354 BT_FIELD_CLASS_TYPE_STRUCTURE
,
355 "Payload field classe is not a structure field classe: %!+F",
357 stream_class
= bt_event_class_borrow_stream_class_inline(
359 trace_class
= bt_stream_class_borrow_trace_class_inline(stream_class
);
360 resolve_ctx
.packet_header
= trace_class
->packet_header_fc
;
361 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
362 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
363 resolve_ctx
.event_common_context
=
364 stream_class
->event_common_context_fc
;
365 resolve_ctx
.event_specific_context
= event_class
->specific_context_fc
;
367 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
372 bt_field_class_make_part_of_trace_class(field_class
);
373 bt_object_put_ref(event_class
->payload_fc
);
374 event_class
->payload_fc
= field_class
;
375 bt_object_get_no_null_check(event_class
->payload_fc
);
376 bt_field_class_freeze(field_class
);
377 BT_LIB_LOGV("Set event class's payload field classe: %!+E", event_class
);
384 void _bt_event_class_freeze(const struct bt_event_class
*event_class
)
386 /* The field classes are already frozen */
387 BT_ASSERT(event_class
);
388 BT_LIB_LOGD("Freezing event class: %!+E", event_class
);
389 ((struct bt_event_class
*) event_class
)->frozen
= true;