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/private-event-class.h>
34 #include <babeltrace/trace-ir/event-class.h>
35 #include <babeltrace/trace-ir/event-class-internal.h>
36 #include <babeltrace/trace-ir/event-internal.h>
37 #include <babeltrace/trace-ir/private-stream-class.h>
38 #include <babeltrace/trace-ir/stream-class.h>
39 #include <babeltrace/trace-ir/stream-class-internal.h>
40 #include <babeltrace/trace-ir/trace-internal.h>
41 #include <babeltrace/trace-ir/utils-internal.h>
42 #include <babeltrace/trace-ir/resolve-field-path-internal.h>
43 #include <babeltrace/object.h>
44 #include <babeltrace/trace-ir/attributes-internal.h>
45 #include <babeltrace/compiler-internal.h>
46 #include <babeltrace/endian-internal.h>
47 #include <babeltrace/types.h>
48 #include <babeltrace/values-internal.h>
49 #include <babeltrace/assert-internal.h>
53 #define BT_ASSERT_PRE_EVENT_CLASS_HOT(_ec) \
54 BT_ASSERT_PRE_HOT(((struct bt_event_class *) (_ec)), \
55 "Event class", ": %!+E", (_ec))
58 void destroy_event_class(struct bt_object
*obj
)
60 struct bt_event_class
*event_class
= (void *) obj
;
62 BT_LIB_LOGD("Destroying event class: %!+E", event_class
);
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 classe.");
75 BT_OBJECT_PUT_REF_AND_RESET(event_class
->specific_context_fc
);
76 BT_LOGD_STR("Putting payload field classe.");
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
);
91 bool event_class_id_is_unique(struct bt_stream_class
*stream_class
, uint64_t id
)
94 bool is_unique
= true;
96 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
97 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_private_event_class
*bt_private_event_class_create(
172 struct bt_private_stream_class
*priv_stream_class
)
174 struct bt_stream_class
*stream_class
= (void *) priv_stream_class
;
176 BT_ASSERT_PRE_NON_NULL(stream_class
, "Stream class");
177 BT_ASSERT_PRE(stream_class
->assigns_automatic_event_class_id
,
178 "Stream class does not automatically assigns event class IDs: "
179 "%![sc-]+S", stream_class
);
180 return (void *) create_event_class_with_id((void *) stream_class
,
181 (uint64_t) stream_class
->event_classes
->len
);
184 struct bt_private_event_class
*bt_private_event_class_create_with_id(
185 struct bt_private_stream_class
*priv_stream_class
, uint64_t id
)
187 struct bt_stream_class
*stream_class
= (void *) priv_stream_class
;
189 BT_ASSERT_PRE(!stream_class
->assigns_automatic_event_class_id
,
190 "Stream class automatically assigns event class IDs: "
191 "%![sc-]+S", stream_class
);
192 return (void *) create_event_class_with_id((void *) stream_class
, id
);
195 const char *bt_event_class_get_name(struct bt_event_class
*event_class
)
197 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
198 return event_class
->name
.value
;
201 int bt_private_event_class_set_name(struct bt_private_event_class
*priv_event_class
,
204 struct bt_event_class
*event_class
= (void *) priv_event_class
;
206 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
207 BT_ASSERT_PRE_NON_NULL(name
, "Name");
208 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
209 g_string_assign(event_class
->name
.str
, name
);
210 event_class
->name
.value
= event_class
->name
.str
->str
;
211 BT_LIB_LOGV("Set event class's name: %!+E", event_class
);
215 uint64_t bt_event_class_get_id(struct bt_event_class
*event_class
)
217 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
218 return event_class
->id
;
221 enum bt_property_availability
bt_event_class_get_log_level(
222 struct bt_event_class
*event_class
,
223 enum bt_event_class_log_level
*log_level
)
225 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
226 BT_ASSERT_PRE_NON_NULL(log_level
, "Log level (output)");
227 *log_level
= (enum bt_event_class_log_level
)
228 event_class
->log_level
.value
;
229 return event_class
->log_level
.base
.avail
;
232 void bt_private_event_class_set_log_level(
233 struct bt_private_event_class
*priv_event_class
,
234 enum bt_event_class_log_level log_level
)
236 struct bt_event_class
*event_class
= (void *) priv_event_class
;
238 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
239 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
240 bt_property_uint_set(&event_class
->log_level
,
241 (uint64_t) log_level
);
242 BT_LIB_LOGV("Set event class's log level: %!+E", event_class
);
245 const char *bt_event_class_get_emf_uri(struct bt_event_class
*event_class
)
247 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
248 return event_class
->emf_uri
.value
;
251 int bt_private_event_class_set_emf_uri(
252 struct bt_private_event_class
*priv_event_class
,
255 struct bt_event_class
*event_class
= (void *) priv_event_class
;
257 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
258 BT_ASSERT_PRE_NON_NULL(emf_uri
, "EMF URI");
259 BT_ASSERT_PRE_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_LOGV("Set event class's EMF URI: %!+E", event_class
);
266 struct bt_stream_class
*bt_event_class_borrow_stream_class(
267 struct bt_event_class
*event_class
)
269 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
270 return bt_event_class_borrow_stream_class_inline(event_class
);
273 struct bt_private_stream_class
*
274 bt_private_event_class_borrow_stream_class(
275 struct bt_private_event_class
*event_class
)
277 return (void *) bt_event_class_borrow_stream_class(
278 (void *) event_class
);
281 struct bt_field_class
*bt_event_class_borrow_specific_context_field_class(
282 struct bt_event_class
*event_class
)
284 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
285 return event_class
->specific_context_fc
;
288 struct bt_private_field_class
*
289 bt_private_event_class_borrow_specific_context_field_class(
290 struct bt_private_event_class
*event_class
)
292 return (void *) bt_event_class_borrow_specific_context_field_class(
293 (void *) event_class
);
296 int bt_private_event_class_set_specific_context_field_class(
297 struct bt_private_event_class
*priv_event_class
,
298 struct bt_private_field_class
*priv_field_class
)
301 struct bt_event_class
*event_class
= (void *) priv_event_class
;
302 struct bt_field_class
*field_class
= (void *) priv_field_class
;
303 struct bt_stream_class
*stream_class
;
304 struct bt_trace
*trace
;
305 struct bt_resolve_field_path_context resolve_ctx
= {
306 .packet_header
= NULL
,
307 .packet_context
= NULL
,
308 .event_header
= NULL
,
309 .event_common_context
= NULL
,
310 .event_specific_context
= field_class
,
311 .event_payload
= NULL
,
314 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
315 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
316 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
317 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
318 BT_FIELD_CLASS_TYPE_STRUCTURE
,
319 "Specific context field classe is not a structure field classe: "
320 "%!+F", field_class
);
321 stream_class
= bt_event_class_borrow_stream_class_inline(
323 trace
= bt_stream_class_borrow_trace_inline(stream_class
);
324 resolve_ctx
.packet_header
= trace
->packet_header_fc
;
325 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
326 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
327 resolve_ctx
.event_common_context
=
328 stream_class
->event_common_context_fc
;
330 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
335 bt_field_class_make_part_of_trace(field_class
);
336 bt_object_put_ref(event_class
->specific_context_fc
);
337 event_class
->specific_context_fc
= field_class
;
338 bt_object_get_no_null_check(event_class
->specific_context_fc
);
339 bt_field_class_freeze(field_class
);
340 BT_LIB_LOGV("Set event class's specific context field classe: %!+E",
347 struct bt_field_class
*bt_event_class_borrow_payload_field_class(
348 struct bt_event_class
*event_class
)
350 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
351 return event_class
->payload_fc
;
354 struct bt_private_field_class
*bt_private_event_class_borrow_payload_field_class(
355 struct bt_private_event_class
*event_class
)
357 return (void *) bt_event_class_borrow_payload_field_class(
358 (void *) event_class
);
361 int bt_private_event_class_set_payload_field_class(
362 struct bt_private_event_class
*priv_event_class
,
363 struct bt_private_field_class
*priv_field_class
)
366 struct bt_event_class
*event_class
= (void *) priv_event_class
;
367 struct bt_field_class
*field_class
= (void *) priv_field_class
;
368 struct bt_stream_class
*stream_class
;
369 struct bt_trace
*trace
;
370 struct bt_resolve_field_path_context resolve_ctx
= {
371 .packet_header
= NULL
,
372 .packet_context
= NULL
,
373 .event_header
= NULL
,
374 .event_common_context
= NULL
,
375 .event_specific_context
= NULL
,
376 .event_payload
= field_class
,
379 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
380 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
381 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
382 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
383 BT_FIELD_CLASS_TYPE_STRUCTURE
,
384 "Payload field classe is not a structure field classe: %!+F",
386 stream_class
= bt_event_class_borrow_stream_class_inline(
388 trace
= bt_stream_class_borrow_trace_inline(stream_class
);
389 resolve_ctx
.packet_header
= trace
->packet_header_fc
;
390 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
391 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
392 resolve_ctx
.event_common_context
=
393 stream_class
->event_common_context_fc
;
394 resolve_ctx
.event_specific_context
= event_class
->specific_context_fc
;
396 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
401 bt_field_class_make_part_of_trace(field_class
);
402 bt_object_put_ref(event_class
->payload_fc
);
403 event_class
->payload_fc
= field_class
;
404 bt_object_get_no_null_check(event_class
->payload_fc
);
405 bt_field_class_freeze(field_class
);
406 BT_LIB_LOGV("Set event class's payload field classe: %!+E", event_class
);
413 void _bt_event_class_freeze(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: %!+E", event_class
);
418 event_class
->frozen
= true;