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);
61 bt_object_init(event_class
, bt_ctf_event_class_destroy
);
62 event_class
->fields
= bt_ctf_field_type_structure_create();
63 if (!event_class
->fields
) {
67 event_class
->attributes
= bt_ctf_attributes_create();
68 if (!event_class
->attributes
) {
72 obj
= bt_value_integer_create_init(-1);
77 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
85 obj
= bt_value_string_create_init(name
);
90 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
106 const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class
*event_class
)
108 struct bt_value
*obj
= NULL
;
109 const char *name
= NULL
;
115 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
116 BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX
);
121 if (bt_value_string_get(obj
, &name
)) {
130 int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class
*event_class
)
132 struct bt_value
*obj
= NULL
;
140 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
141 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
146 if (bt_value_integer_get(obj
, &ret
)) {
151 /* means ID is not set */
161 int bt_ctf_event_class_set_id(struct bt_ctf_event_class
*event_class
,
165 struct bt_value
*obj
= NULL
;
166 struct bt_ctf_stream_class
*stream_class
= NULL
;
174 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
177 * We don't allow changing the id if the event class has already
178 * been added to a stream class.
184 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
185 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
190 if (bt_value_integer_set(obj
, id
)) {
197 BT_PUT(stream_class
);
201 int bt_ctf_event_class_set_attribute(
202 struct bt_ctf_event_class
*event_class
, const char *name
,
203 struct bt_value
*value
)
207 if (!event_class
|| !name
|| !value
|| event_class
->frozen
) {
212 if (!strcmp(name
, "id") || !strcmp(name
, "loglevel")) {
213 if (!bt_value_is_integer(value
)) {
217 } else if (!strcmp(name
, "name") || !strcmp(name
, "model.emf.uri")) {
218 if (!bt_value_is_string(value
)) {
223 /* unknown attribute */
228 /* "id" special case: >= 0 */
229 if (!strcmp(name
, "id")) {
232 ret
= bt_value_integer_get(value
, &val
);
244 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
251 int bt_ctf_event_class_get_attribute_count(
252 struct bt_ctf_event_class
*event_class
)
261 ret
= bt_ctf_attributes_get_count(event_class
->attributes
);
268 bt_ctf_event_class_get_attribute_name(
269 struct bt_ctf_event_class
*event_class
, int index
)
278 ret
= bt_ctf_attributes_get_field_name(event_class
->attributes
, index
);
285 bt_ctf_event_class_get_attribute_value(struct bt_ctf_event_class
*event_class
,
288 struct bt_value
*ret
;
295 ret
= bt_ctf_attributes_get_field_value(event_class
->attributes
, index
);
302 bt_ctf_event_class_get_attribute_value_by_name(
303 struct bt_ctf_event_class
*event_class
, const char *name
)
305 struct bt_value
*ret
;
307 if (!event_class
|| !name
) {
312 ret
= bt_ctf_attributes_get_field_value_by_name(event_class
->attributes
,
320 struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
321 struct bt_ctf_event_class
*event_class
)
323 return (struct bt_ctf_stream_class
*) bt_object_get_parent(event_class
);
326 struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
327 struct bt_ctf_event_class
*event_class
)
329 struct bt_ctf_field_type
*payload
= NULL
;
335 bt_get(event_class
->fields
);
336 payload
= event_class
->fields
;
341 int bt_ctf_event_class_set_payload_type(struct bt_ctf_event_class
*event_class
,
342 struct bt_ctf_field_type
*payload
)
346 if (!event_class
|| !payload
||
347 bt_ctf_field_type_get_type_id(payload
) !=
348 BT_CTF_TYPE_ID_STRUCT
) {
354 bt_put(event_class
->fields
);
355 event_class
->fields
= payload
;
360 int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
361 struct bt_ctf_field_type
*type
,
366 if (!event_class
|| !type
|| bt_ctf_validate_identifier(name
) ||
367 event_class
->frozen
) {
372 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
373 BT_CTF_TYPE_ID_STRUCT
) {
378 ret
= bt_ctf_field_type_structure_add_field(event_class
->fields
,
384 int bt_ctf_event_class_get_field_count(
385 struct bt_ctf_event_class
*event_class
)
394 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
395 BT_CTF_TYPE_ID_STRUCT
) {
400 ret
= bt_ctf_field_type_structure_get_field_count(event_class
->fields
);
405 int bt_ctf_event_class_get_field(struct bt_ctf_event_class
*event_class
,
406 const char **field_name
, struct bt_ctf_field_type
**field_type
,
411 if (!event_class
|| index
< 0) {
416 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
417 BT_CTF_TYPE_ID_STRUCT
) {
422 ret
= bt_ctf_field_type_structure_get_field(event_class
->fields
,
423 field_name
, field_type
, index
);
428 struct bt_ctf_field_type
*bt_ctf_event_class_get_field_by_name(
429 struct bt_ctf_event_class
*event_class
, const char *name
)
432 struct bt_ctf_field_type
*field_type
= NULL
;
434 if (!event_class
|| !name
) {
438 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
439 BT_CTF_TYPE_ID_STRUCT
) {
443 name_quark
= g_quark_try_string(name
);
449 * No need to increment field_type's reference count since getting it
450 * from the structure already does.
452 field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
453 event_class
->fields
, name
);
458 struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
459 struct bt_ctf_event_class
*event_class
)
461 struct bt_ctf_field_type
*context_type
= NULL
;
463 if (!event_class
|| !event_class
->context
) {
467 bt_get(event_class
->context
);
468 context_type
= event_class
->context
;
473 int bt_ctf_event_class_set_context_type(
474 struct bt_ctf_event_class
*event_class
,
475 struct bt_ctf_field_type
*context
)
479 if (!event_class
|| !context
|| event_class
->frozen
) {
484 if (bt_ctf_field_type_get_type_id(context
) != BT_CTF_TYPE_ID_STRUCT
) {
490 bt_put(event_class
->context
);
491 event_class
->context
= context
;
497 void bt_ctf_event_class_get(struct bt_ctf_event_class
*event_class
)
502 void bt_ctf_event_class_put(struct bt_ctf_event_class
*event_class
)
508 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class
*event_class
,
512 struct bt_value
*obj
;
514 obj
= bt_value_integer_create_init(stream_id
);
521 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
524 if (event_class
->frozen
) {
525 bt_ctf_attributes_freeze(event_class
->attributes
);
534 void bt_ctf_event_class_destroy(struct bt_object
*obj
)
536 struct bt_ctf_event_class
*event_class
;
538 event_class
= container_of(obj
, struct bt_ctf_event_class
, base
);
539 bt_ctf_attributes_destroy(event_class
->attributes
);
540 bt_put(event_class
->context
);
541 bt_put(event_class
->fields
);
546 void bt_ctf_event_class_freeze(struct bt_ctf_event_class
*event_class
)
549 event_class
->frozen
= 1;
550 bt_ctf_field_type_freeze(event_class
->context
);
551 bt_ctf_field_type_freeze(event_class
->fields
);
552 bt_ctf_attributes_freeze(event_class
->attributes
);
556 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
557 struct metadata_context
*context
)
562 struct bt_value
*attr_value
= NULL
;
567 context
->current_indentation_level
= 1;
568 g_string_assign(context
->field_name
, "");
569 g_string_append(context
->string
, "event {\n");
570 count
= bt_ctf_event_class_get_attribute_count(event_class
);
577 for (i
= 0; i
< count
; ++i
) {
578 const char *attr_name
= NULL
;
580 attr_name
= bt_ctf_event_class_get_attribute_name(
582 attr_value
= bt_ctf_event_class_get_attribute_value(
585 if (!attr_name
|| !attr_value
) {
590 switch (bt_value_get_type(attr_value
)) {
591 case BT_VALUE_TYPE_INTEGER
:
595 ret
= bt_value_integer_get(attr_value
, &value
);
601 g_string_append_printf(context
->string
,
602 "\t%s = %" PRId64
";\n", attr_name
, value
);
606 case BT_VALUE_TYPE_STRING
:
610 ret
= bt_value_string_get(attr_value
, &value
);
616 g_string_append_printf(context
->string
,
617 "\t%s = \"%s\";\n", attr_name
, value
);
622 /* should never happen */
630 if (event_class
->context
) {
631 g_string_append(context
->string
, "\tcontext := ");
632 ret
= bt_ctf_field_type_serialize(event_class
->context
,
637 g_string_append(context
->string
, ";\n");
640 if (event_class
->fields
) {
641 g_string_append(context
->string
, "\tfields := ");
642 ret
= bt_ctf_field_type_serialize(event_class
->fields
, context
);
646 g_string_append(context
->string
, ";\n");
649 g_string_append(context
->string
, "};\n\n");
651 context
->current_indentation_level
= 0;
656 void bt_ctf_event_class_set_native_byte_order(
657 struct bt_ctf_event_class
*event_class
,
664 assert(byte_order
== 0 || byte_order
== LITTLE_ENDIAN
||
665 byte_order
== BIG_ENDIAN
);
667 bt_ctf_field_type_set_native_byte_order(event_class
->context
,
669 bt_ctf_field_type_set_native_byte_order(event_class
->fields
,