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
);
68 if (event_class
->emf_uri
.str
) {
69 g_string_free(event_class
->emf_uri
.str
, TRUE
);
72 BT_LOGD_STR("Putting context field classe.");
73 bt_object_put_ref(event_class
->specific_context_fc
);
74 BT_LOGD_STR("Putting payload field classe.");
75 bt_object_put_ref(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(struct bt_stream_class
*stream_class
, uint64_t id
)
92 bool is_unique
= true;
94 for (i
= 0; i
< stream_class
->event_classes
->len
; i
++) {
95 struct bt_event_class
*ec
=
96 stream_class
->event_classes
->pdata
[i
];
109 struct bt_event_class
*create_event_class_with_id(
110 struct bt_stream_class
*stream_class
, uint64_t id
)
113 struct bt_event_class
*event_class
;
115 BT_ASSERT(stream_class
);
116 BT_ASSERT_PRE(event_class_id_is_unique(stream_class
, id
),
117 "Duplicate event class ID: %![sc-]+S, id=%" PRIu64
,
119 BT_LIB_LOGD("Creating event class object: %![sc-]+S, id=%" PRIu64
,
121 event_class
= g_new0(struct bt_event_class
, 1);
123 BT_LOGE_STR("Failed to allocate one event class.");
127 bt_object_init_shared_with_parent(&event_class
->base
,
128 destroy_event_class
);
129 event_class
->id
= id
;
130 bt_property_uint_init(&event_class
->log_level
,
131 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
, 0);
132 event_class
->name
.str
= g_string_new(NULL
);
133 if (!event_class
->name
.str
) {
134 BT_LOGE_STR("Failed to allocate a GString.");
139 event_class
->emf_uri
.str
= g_string_new(NULL
);
140 if (!event_class
->emf_uri
.str
) {
141 BT_LOGE_STR("Failed to allocate a GString.");
146 ret
= bt_object_pool_initialize(&event_class
->event_pool
,
147 (bt_object_pool_new_object_func
) bt_event_new
,
148 (bt_object_pool_destroy_object_func
) free_event
,
151 BT_LOGE("Failed to initialize event pool: ret=%d",
156 bt_object_set_parent(&event_class
->base
, &stream_class
->base
);
157 g_ptr_array_add(stream_class
->event_classes
, event_class
);
158 bt_stream_class_freeze(stream_class
);
159 BT_LIB_LOGD("Created event class object: %!+E", event_class
);
163 BT_OBJECT_PUT_REF_AND_RESET(event_class
);
169 struct bt_private_event_class
*bt_private_event_class_create(
170 struct bt_private_stream_class
*priv_stream_class
)
172 struct bt_stream_class
*stream_class
= (void *) priv_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 (void *) create_event_class_with_id((void *) stream_class
,
179 (uint64_t) stream_class
->event_classes
->len
);
182 struct bt_private_event_class
*bt_private_event_class_create_with_id(
183 struct bt_private_stream_class
*priv_stream_class
, uint64_t id
)
185 struct bt_stream_class
*stream_class
= (void *) priv_stream_class
;
187 BT_ASSERT_PRE(!stream_class
->assigns_automatic_event_class_id
,
188 "Stream class automatically assigns event class IDs: "
189 "%![sc-]+S", stream_class
);
190 return (void *) create_event_class_with_id((void *) stream_class
, id
);
193 const char *bt_event_class_get_name(struct bt_event_class
*event_class
)
195 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
196 return event_class
->name
.value
;
199 int bt_private_event_class_set_name(struct bt_private_event_class
*priv_event_class
,
202 struct bt_event_class
*event_class
= (void *) priv_event_class
;
204 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
205 BT_ASSERT_PRE_NON_NULL(name
, "Name");
206 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
207 g_string_assign(event_class
->name
.str
, name
);
208 event_class
->name
.value
= event_class
->name
.str
->str
;
209 BT_LIB_LOGV("Set event class's name: %!+E", event_class
);
213 uint64_t bt_event_class_get_id(struct bt_event_class
*event_class
)
215 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
216 return event_class
->id
;
219 enum bt_property_availability
bt_event_class_get_log_level(
220 struct bt_event_class
*event_class
,
221 enum bt_event_class_log_level
*log_level
)
223 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
224 BT_ASSERT_PRE_NON_NULL(log_level
, "Log level (output)");
225 *log_level
= (enum bt_event_class_log_level
)
226 event_class
->log_level
.value
;
227 return event_class
->log_level
.base
.avail
;
230 int bt_private_event_class_set_log_level(
231 struct bt_private_event_class
*priv_event_class
,
232 enum bt_event_class_log_level log_level
)
234 struct bt_event_class
*event_class
= (void *) priv_event_class
;
236 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
237 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
238 bt_property_uint_set(&event_class
->log_level
,
239 (uint64_t) log_level
);
240 BT_LIB_LOGV("Set event class's log level: %!+E", event_class
);
244 const char *bt_event_class_get_emf_uri(struct bt_event_class
*event_class
)
246 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
247 return event_class
->emf_uri
.value
;
250 int bt_private_event_class_set_emf_uri(
251 struct bt_private_event_class
*priv_event_class
,
254 struct bt_event_class
*event_class
= (void *) priv_event_class
;
256 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
257 BT_ASSERT_PRE_NON_NULL(emf_uri
, "EMF URI");
258 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
259 g_string_assign(event_class
->emf_uri
.str
, emf_uri
);
260 event_class
->emf_uri
.value
= event_class
->emf_uri
.str
->str
;
261 BT_LIB_LOGV("Set event class's EMF URI: %!+E", event_class
);
265 struct bt_stream_class
*bt_event_class_borrow_stream_class(
266 struct bt_event_class
*event_class
)
268 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
269 return bt_event_class_borrow_stream_class_inline(event_class
);
272 struct bt_private_stream_class
*
273 bt_private_event_class_borrow_private_stream_class(
274 struct bt_private_event_class
*event_class
)
276 return (void *) bt_event_class_borrow_stream_class(
277 (void *) event_class
);
280 struct bt_field_class
*bt_event_class_borrow_specific_context_field_class(
281 struct bt_event_class
*event_class
)
283 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
284 return event_class
->specific_context_fc
;
287 struct bt_private_field_class
*
288 bt_private_event_class_borrow_specific_context_private_field_class(
289 struct bt_private_event_class
*event_class
)
291 return (void *) bt_event_class_borrow_specific_context_field_class(
292 (void *) event_class
);
295 int bt_private_event_class_set_specific_context_private_field_class(
296 struct bt_private_event_class
*priv_event_class
,
297 struct bt_private_field_class
*priv_field_class
)
300 struct bt_event_class
*event_class
= (void *) priv_event_class
;
301 struct bt_field_class
*field_class
= (void *) priv_field_class
;
302 struct bt_stream_class
*stream_class
;
303 struct bt_trace
*trace
;
304 struct bt_resolve_field_path_context resolve_ctx
= {
305 .packet_header
= NULL
,
306 .packet_context
= NULL
,
307 .event_header
= NULL
,
308 .event_common_context
= NULL
,
309 .event_specific_context
= field_class
,
310 .event_payload
= NULL
,
313 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
314 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
315 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
316 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
317 BT_FIELD_CLASS_TYPE_STRUCTURE
,
318 "Specific context field classe is not a structure field classe: "
319 "%!+F", field_class
);
320 stream_class
= bt_event_class_borrow_stream_class_inline(
322 trace
= bt_stream_class_borrow_trace_inline(stream_class
);
323 resolve_ctx
.packet_header
= trace
->packet_header_fc
;
324 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
325 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
326 resolve_ctx
.event_common_context
=
327 stream_class
->event_common_context_fc
;
329 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
334 bt_field_class_make_part_of_trace(field_class
);
335 bt_object_put_ref(event_class
->specific_context_fc
);
336 event_class
->specific_context_fc
= bt_object_get_ref(field_class
);
337 bt_field_class_freeze(field_class
);
338 BT_LIB_LOGV("Set event class's specific context field classe: %!+E",
345 struct bt_field_class
*bt_event_class_borrow_payload_field_class(
346 struct bt_event_class
*event_class
)
348 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
349 return event_class
->payload_fc
;
352 struct bt_private_field_class
*bt_private_event_class_borrow_payload_private_field_class(
353 struct bt_private_event_class
*event_class
)
355 return (void *) bt_event_class_borrow_payload_field_class(
356 (void *) event_class
);
359 int bt_private_event_class_set_payload_private_field_class(
360 struct bt_private_event_class
*priv_event_class
,
361 struct bt_private_field_class
*priv_field_class
)
364 struct bt_event_class
*event_class
= (void *) priv_event_class
;
365 struct bt_field_class
*field_class
= (void *) priv_field_class
;
366 struct bt_stream_class
*stream_class
;
367 struct bt_trace
*trace
;
368 struct bt_resolve_field_path_context resolve_ctx
= {
369 .packet_header
= NULL
,
370 .packet_context
= NULL
,
371 .event_header
= NULL
,
372 .event_common_context
= NULL
,
373 .event_specific_context
= NULL
,
374 .event_payload
= field_class
,
377 BT_ASSERT_PRE_NON_NULL(event_class
, "Event class");
378 BT_ASSERT_PRE_NON_NULL(field_class
, "Field class");
379 BT_ASSERT_PRE_EVENT_CLASS_HOT(event_class
);
380 BT_ASSERT_PRE(bt_field_class_get_type(field_class
) ==
381 BT_FIELD_CLASS_TYPE_STRUCTURE
,
382 "Payload field classe is not a structure field classe: %!+F",
384 stream_class
= bt_event_class_borrow_stream_class_inline(
386 trace
= bt_stream_class_borrow_trace_inline(stream_class
);
387 resolve_ctx
.packet_header
= trace
->packet_header_fc
;
388 resolve_ctx
.packet_context
= stream_class
->packet_context_fc
;
389 resolve_ctx
.event_header
= stream_class
->event_header_fc
;
390 resolve_ctx
.event_common_context
=
391 stream_class
->event_common_context_fc
;
392 resolve_ctx
.event_specific_context
= event_class
->specific_context_fc
;
394 ret
= bt_resolve_field_paths(field_class
, &resolve_ctx
);
399 bt_field_class_make_part_of_trace(field_class
);
400 bt_object_put_ref(event_class
->payload_fc
);
401 event_class
->payload_fc
= bt_object_get_ref(field_class
);
402 bt_field_class_freeze(field_class
);
403 BT_LIB_LOGV("Set event class's payload field classe: %!+E", event_class
);
410 void _bt_event_class_freeze(struct bt_event_class
*event_class
)
412 /* The field classes are already frozen */
413 BT_ASSERT(event_class
);
414 BT_LIB_LOGD("Freezing event class: %!+E", event_class
);
415 event_class
->frozen
= true;
418 struct bt_event_class
*bt_event_class_borrow_from_private(
419 struct bt_private_event_class
*priv_event_class
)
421 return (void *) priv_event_class
;