4 * Babeltrace CTF IR - Event class
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #include <babeltrace/ctf-ir/fields-internal.h>
30 #include <babeltrace/ctf-ir/field-types-internal.h>
31 #include <babeltrace/ctf-ir/event-class.h>
32 #include <babeltrace/ctf-ir/event-class-internal.h>
33 #include <babeltrace/ctf-ir/stream-class.h>
34 #include <babeltrace/ctf-ir/stream-class-internal.h>
35 #include <babeltrace/ctf-ir/trace-internal.h>
36 #include <babeltrace/ctf-ir/validation-internal.h>
37 #include <babeltrace/ctf-ir/utils.h>
38 #include <babeltrace/ref.h>
39 #include <babeltrace/ctf-ir/attributes-internal.h>
40 #include <babeltrace/compiler.h>
41 #include <babeltrace/endian.h>
44 void bt_ctf_event_class_destroy(struct bt_object
*obj
);
46 struct bt_ctf_event_class
*bt_ctf_event_class_create(const char *name
)
49 struct bt_value
*obj
= NULL
;
50 struct bt_ctf_event_class
*event_class
= NULL
;
52 if (bt_ctf_validate_identifier(name
)) {
56 event_class
= g_new0(struct bt_ctf_event_class
, 1);
62 bt_object_init(event_class
, bt_ctf_event_class_destroy
);
63 event_class
->fields
= bt_ctf_field_type_structure_create();
64 if (!event_class
->fields
) {
68 event_class
->attributes
= bt_ctf_attributes_create();
69 if (!event_class
->attributes
) {
73 obj
= bt_value_integer_create_init(-1);
78 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
86 obj
= bt_value_string_create_init(name
);
91 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
107 const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class
*event_class
)
109 struct bt_value
*obj
= NULL
;
110 const char *name
= NULL
;
116 if (event_class
->name
) {
117 name
= event_class
->name
;
121 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
122 BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX
);
127 if (bt_value_string_get(obj
, &name
)) {
136 int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class
*event_class
)
138 struct bt_value
*obj
= NULL
;
146 if (event_class
->id
>= 0) {
147 ret
= event_class
->id
;
151 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
152 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
157 if (bt_value_integer_get(obj
, &ret
)) {
162 /* means ID is not set */
172 int bt_ctf_event_class_set_id(struct bt_ctf_event_class
*event_class
,
176 struct bt_value
*obj
= NULL
;
177 struct bt_ctf_stream_class
*stream_class
= NULL
;
185 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
188 * We don't allow changing the id if the event class has already
189 * been added to a stream class.
195 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
196 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
201 if (bt_value_integer_set(obj
, id
)) {
208 BT_PUT(stream_class
);
212 int bt_ctf_event_class_set_attribute(
213 struct bt_ctf_event_class
*event_class
, const char *name
,
214 struct bt_value
*value
)
218 if (!event_class
|| !name
|| !value
|| event_class
->frozen
) {
223 if (!strcmp(name
, "id") || !strcmp(name
, "loglevel") ||
224 !strcmp(name
, "stream_id")) {
225 if (!bt_value_is_integer(value
)) {
229 } else if (!strcmp(name
, "name") || !strcmp(name
, "model.emf.uri") ||
230 !strcmp(name
, "loglevel_string")) {
231 if (!bt_value_is_string(value
)) {
236 /* unknown attribute */
241 /* "id" special case: >= 0 */
242 if (!strcmp(name
, "id")) {
245 ret
= bt_value_integer_get(value
, &val
);
257 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
264 int bt_ctf_event_class_get_attribute_count(
265 struct bt_ctf_event_class
*event_class
)
274 ret
= bt_ctf_attributes_get_count(event_class
->attributes
);
281 bt_ctf_event_class_get_attribute_name(
282 struct bt_ctf_event_class
*event_class
, int index
)
291 ret
= bt_ctf_attributes_get_field_name(event_class
->attributes
, index
);
298 bt_ctf_event_class_get_attribute_value(struct bt_ctf_event_class
*event_class
,
301 struct bt_value
*ret
;
308 ret
= bt_ctf_attributes_get_field_value(event_class
->attributes
, index
);
315 bt_ctf_event_class_get_attribute_value_by_name(
316 struct bt_ctf_event_class
*event_class
, const char *name
)
318 struct bt_value
*ret
;
320 if (!event_class
|| !name
) {
325 ret
= bt_ctf_attributes_get_field_value_by_name(event_class
->attributes
,
333 struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
334 struct bt_ctf_event_class
*event_class
)
336 return (struct bt_ctf_stream_class
*) bt_object_get_parent(event_class
);
339 struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
340 struct bt_ctf_event_class
*event_class
)
342 struct bt_ctf_field_type
*payload
= NULL
;
348 bt_get(event_class
->fields
);
349 payload
= event_class
->fields
;
354 int bt_ctf_event_class_set_payload_type(struct bt_ctf_event_class
*event_class
,
355 struct bt_ctf_field_type
*payload
)
364 if (payload
&& bt_ctf_field_type_get_type_id(payload
) !=
365 BT_CTF_TYPE_ID_STRUCT
) {
370 bt_put(event_class
->fields
);
371 event_class
->fields
= bt_get(payload
);
376 int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
377 struct bt_ctf_field_type
*type
,
382 if (!event_class
|| !type
|| bt_ctf_validate_identifier(name
) ||
383 event_class
->frozen
) {
388 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
389 BT_CTF_TYPE_ID_STRUCT
) {
394 ret
= bt_ctf_field_type_structure_add_field(event_class
->fields
,
400 int bt_ctf_event_class_get_field_count(
401 struct bt_ctf_event_class
*event_class
)
410 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
411 BT_CTF_TYPE_ID_STRUCT
) {
416 ret
= bt_ctf_field_type_structure_get_field_count(event_class
->fields
);
421 int bt_ctf_event_class_get_field(struct bt_ctf_event_class
*event_class
,
422 const char **field_name
, struct bt_ctf_field_type
**field_type
,
427 if (!event_class
|| index
< 0) {
432 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
433 BT_CTF_TYPE_ID_STRUCT
) {
438 ret
= bt_ctf_field_type_structure_get_field(event_class
->fields
,
439 field_name
, field_type
, index
);
444 struct bt_ctf_field_type
*bt_ctf_event_class_get_field_by_name(
445 struct bt_ctf_event_class
*event_class
, const char *name
)
448 struct bt_ctf_field_type
*field_type
= NULL
;
450 if (!event_class
|| !name
) {
454 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
455 BT_CTF_TYPE_ID_STRUCT
) {
459 name_quark
= g_quark_try_string(name
);
465 * No need to increment field_type's reference count since getting it
466 * from the structure already does.
468 field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
469 event_class
->fields
, name
);
474 struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
475 struct bt_ctf_event_class
*event_class
)
477 struct bt_ctf_field_type
*context_type
= NULL
;
479 if (!event_class
|| !event_class
->context
) {
483 bt_get(event_class
->context
);
484 context_type
= event_class
->context
;
489 int bt_ctf_event_class_set_context_type(
490 struct bt_ctf_event_class
*event_class
,
491 struct bt_ctf_field_type
*context
)
495 if (!event_class
|| event_class
->frozen
) {
500 if (context
&& bt_ctf_field_type_get_type_id(context
) !=
501 BT_CTF_TYPE_ID_STRUCT
) {
506 bt_put(event_class
->context
);
507 event_class
->context
= bt_get(context
);
513 void bt_ctf_event_class_get(struct bt_ctf_event_class
*event_class
)
518 void bt_ctf_event_class_put(struct bt_ctf_event_class
*event_class
)
524 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class
*event_class
,
528 struct bt_value
*obj
;
530 obj
= bt_value_integer_create_init(stream_id
);
537 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
540 if (event_class
->frozen
) {
541 bt_ctf_attributes_freeze(event_class
->attributes
);
550 void bt_ctf_event_class_destroy(struct bt_object
*obj
)
552 struct bt_ctf_event_class
*event_class
;
554 event_class
= container_of(obj
, struct bt_ctf_event_class
, base
);
555 bt_ctf_attributes_destroy(event_class
->attributes
);
556 bt_put(event_class
->context
);
557 bt_put(event_class
->fields
);
562 void bt_ctf_event_class_freeze(struct bt_ctf_event_class
*event_class
)
565 event_class
->frozen
= 1;
566 event_class
->name
= bt_ctf_event_class_get_name(event_class
);
567 event_class
->id
= bt_ctf_event_class_get_id(event_class
);
568 bt_ctf_field_type_freeze(event_class
->context
);
569 bt_ctf_field_type_freeze(event_class
->fields
);
570 bt_ctf_attributes_freeze(event_class
->attributes
);
574 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
575 struct metadata_context
*context
)
580 struct bt_value
*attr_value
= NULL
;
585 context
->current_indentation_level
= 1;
586 g_string_assign(context
->field_name
, "");
587 g_string_append(context
->string
, "event {\n");
588 count
= bt_ctf_event_class_get_attribute_count(event_class
);
595 for (i
= 0; i
< count
; ++i
) {
596 const char *attr_name
= NULL
;
598 attr_name
= bt_ctf_event_class_get_attribute_name(
600 attr_value
= bt_ctf_event_class_get_attribute_value(
603 if (!attr_name
|| !attr_value
) {
608 switch (bt_value_get_type(attr_value
)) {
609 case BT_VALUE_TYPE_INTEGER
:
613 ret
= bt_value_integer_get(attr_value
, &value
);
619 g_string_append_printf(context
->string
,
620 "\t%s = %" PRId64
";\n", attr_name
, value
);
624 case BT_VALUE_TYPE_STRING
:
628 ret
= bt_value_string_get(attr_value
, &value
);
634 g_string_append_printf(context
->string
,
635 "\t%s = \"%s\";\n", attr_name
, value
);
640 /* should never happen */
648 if (event_class
->context
) {
649 g_string_append(context
->string
, "\tcontext := ");
650 ret
= bt_ctf_field_type_serialize(event_class
->context
,
655 g_string_append(context
->string
, ";\n");
658 if (event_class
->fields
) {
659 g_string_append(context
->string
, "\tfields := ");
660 ret
= bt_ctf_field_type_serialize(event_class
->fields
, context
);
664 g_string_append(context
->string
, ";\n");
667 g_string_append(context
->string
, "};\n\n");
669 context
->current_indentation_level
= 0;
674 void bt_ctf_event_class_set_native_byte_order(
675 struct bt_ctf_event_class
*event_class
,
682 assert(byte_order
== 0 || byte_order
== LITTLE_ENDIAN
||
683 byte_order
== BIG_ENDIAN
);
685 bt_ctf_field_type_set_native_byte_order(event_class
->context
,
687 bt_ctf_field_type_set_native_byte_order(event_class
->fields
,