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 if (!bt_value_is_string(value
)) {
235 /* unknown attribute */
240 /* "id" special case: >= 0 */
241 if (!strcmp(name
, "id")) {
244 ret
= bt_value_integer_get(value
, &val
);
256 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
263 int bt_ctf_event_class_get_attribute_count(
264 struct bt_ctf_event_class
*event_class
)
273 ret
= bt_ctf_attributes_get_count(event_class
->attributes
);
280 bt_ctf_event_class_get_attribute_name(
281 struct bt_ctf_event_class
*event_class
, int index
)
290 ret
= bt_ctf_attributes_get_field_name(event_class
->attributes
, index
);
297 bt_ctf_event_class_get_attribute_value(struct bt_ctf_event_class
*event_class
,
300 struct bt_value
*ret
;
307 ret
= bt_ctf_attributes_get_field_value(event_class
->attributes
, index
);
314 bt_ctf_event_class_get_attribute_value_by_name(
315 struct bt_ctf_event_class
*event_class
, const char *name
)
317 struct bt_value
*ret
;
319 if (!event_class
|| !name
) {
324 ret
= bt_ctf_attributes_get_field_value_by_name(event_class
->attributes
,
332 struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
333 struct bt_ctf_event_class
*event_class
)
335 return (struct bt_ctf_stream_class
*) bt_object_get_parent(event_class
);
338 struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
339 struct bt_ctf_event_class
*event_class
)
341 struct bt_ctf_field_type
*payload
= NULL
;
347 bt_get(event_class
->fields
);
348 payload
= event_class
->fields
;
353 int bt_ctf_event_class_set_payload_type(struct bt_ctf_event_class
*event_class
,
354 struct bt_ctf_field_type
*payload
)
358 if (!event_class
|| !payload
||
359 bt_ctf_field_type_get_type_id(payload
) !=
360 BT_CTF_TYPE_ID_STRUCT
) {
366 bt_put(event_class
->fields
);
367 event_class
->fields
= payload
;
372 int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
373 struct bt_ctf_field_type
*type
,
378 if (!event_class
|| !type
|| bt_ctf_validate_identifier(name
) ||
379 event_class
->frozen
) {
384 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
385 BT_CTF_TYPE_ID_STRUCT
) {
390 ret
= bt_ctf_field_type_structure_add_field(event_class
->fields
,
396 int bt_ctf_event_class_get_field_count(
397 struct bt_ctf_event_class
*event_class
)
406 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
407 BT_CTF_TYPE_ID_STRUCT
) {
412 ret
= bt_ctf_field_type_structure_get_field_count(event_class
->fields
);
417 int bt_ctf_event_class_get_field(struct bt_ctf_event_class
*event_class
,
418 const char **field_name
, struct bt_ctf_field_type
**field_type
,
423 if (!event_class
|| index
< 0) {
428 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
429 BT_CTF_TYPE_ID_STRUCT
) {
434 ret
= bt_ctf_field_type_structure_get_field(event_class
->fields
,
435 field_name
, field_type
, index
);
440 struct bt_ctf_field_type
*bt_ctf_event_class_get_field_by_name(
441 struct bt_ctf_event_class
*event_class
, const char *name
)
444 struct bt_ctf_field_type
*field_type
= NULL
;
446 if (!event_class
|| !name
) {
450 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
451 BT_CTF_TYPE_ID_STRUCT
) {
455 name_quark
= g_quark_try_string(name
);
461 * No need to increment field_type's reference count since getting it
462 * from the structure already does.
464 field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
465 event_class
->fields
, name
);
470 struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
471 struct bt_ctf_event_class
*event_class
)
473 struct bt_ctf_field_type
*context_type
= NULL
;
475 if (!event_class
|| !event_class
->context
) {
479 bt_get(event_class
->context
);
480 context_type
= event_class
->context
;
485 int bt_ctf_event_class_set_context_type(
486 struct bt_ctf_event_class
*event_class
,
487 struct bt_ctf_field_type
*context
)
491 if (!event_class
|| !context
|| event_class
->frozen
) {
496 if (bt_ctf_field_type_get_type_id(context
) != BT_CTF_TYPE_ID_STRUCT
) {
502 bt_put(event_class
->context
);
503 event_class
->context
= context
;
509 void bt_ctf_event_class_get(struct bt_ctf_event_class
*event_class
)
514 void bt_ctf_event_class_put(struct bt_ctf_event_class
*event_class
)
520 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class
*event_class
,
524 struct bt_value
*obj
;
526 obj
= bt_value_integer_create_init(stream_id
);
533 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
536 if (event_class
->frozen
) {
537 bt_ctf_attributes_freeze(event_class
->attributes
);
546 void bt_ctf_event_class_destroy(struct bt_object
*obj
)
548 struct bt_ctf_event_class
*event_class
;
550 event_class
= container_of(obj
, struct bt_ctf_event_class
, base
);
551 bt_ctf_attributes_destroy(event_class
->attributes
);
552 bt_put(event_class
->context
);
553 bt_put(event_class
->fields
);
558 void bt_ctf_event_class_freeze(struct bt_ctf_event_class
*event_class
)
561 event_class
->frozen
= 1;
562 event_class
->name
= bt_ctf_event_class_get_name(event_class
);
563 event_class
->id
= bt_ctf_event_class_get_id(event_class
);
564 bt_ctf_field_type_freeze(event_class
->context
);
565 bt_ctf_field_type_freeze(event_class
->fields
);
566 bt_ctf_attributes_freeze(event_class
->attributes
);
570 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
571 struct metadata_context
*context
)
576 struct bt_value
*attr_value
= NULL
;
581 context
->current_indentation_level
= 1;
582 g_string_assign(context
->field_name
, "");
583 g_string_append(context
->string
, "event {\n");
584 count
= bt_ctf_event_class_get_attribute_count(event_class
);
591 for (i
= 0; i
< count
; ++i
) {
592 const char *attr_name
= NULL
;
594 attr_name
= bt_ctf_event_class_get_attribute_name(
596 attr_value
= bt_ctf_event_class_get_attribute_value(
599 if (!attr_name
|| !attr_value
) {
604 switch (bt_value_get_type(attr_value
)) {
605 case BT_VALUE_TYPE_INTEGER
:
609 ret
= bt_value_integer_get(attr_value
, &value
);
615 g_string_append_printf(context
->string
,
616 "\t%s = %" PRId64
";\n", attr_name
, value
);
620 case BT_VALUE_TYPE_STRING
:
624 ret
= bt_value_string_get(attr_value
, &value
);
630 g_string_append_printf(context
->string
,
631 "\t%s = \"%s\";\n", attr_name
, value
);
636 /* should never happen */
644 if (event_class
->context
) {
645 g_string_append(context
->string
, "\tcontext := ");
646 ret
= bt_ctf_field_type_serialize(event_class
->context
,
651 g_string_append(context
->string
, ";\n");
654 if (event_class
->fields
) {
655 g_string_append(context
->string
, "\tfields := ");
656 ret
= bt_ctf_field_type_serialize(event_class
->fields
, context
);
660 g_string_append(context
->string
, ";\n");
663 g_string_append(context
->string
, "};\n\n");
665 context
->current_indentation_level
= 0;
670 void bt_ctf_event_class_set_native_byte_order(
671 struct bt_ctf_event_class
*event_class
,
678 assert(byte_order
== 0 || byte_order
== LITTLE_ENDIAN
||
679 byte_order
== BIG_ENDIAN
);
681 bt_ctf_field_type_set_native_byte_order(event_class
->context
,
683 bt_ctf_field_type_set_native_byte_order(event_class
->fields
,