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-internal.h>
41 #include <babeltrace/endian-internal.h>
45 void bt_ctf_event_class_destroy(struct bt_object
*obj
);
47 struct bt_ctf_event_class
*bt_ctf_event_class_create(const char *name
)
50 struct bt_value
*obj
= NULL
;
51 struct bt_ctf_event_class
*event_class
= NULL
;
53 if (bt_ctf_validate_identifier(name
)) {
57 event_class
= g_new0(struct bt_ctf_event_class
, 1);
63 bt_object_init(event_class
, bt_ctf_event_class_destroy
);
64 event_class
->fields
= bt_ctf_field_type_structure_create();
65 if (!event_class
->fields
) {
69 event_class
->context
= bt_ctf_field_type_structure_create();
70 if (!event_class
->context
) {
74 event_class
->attributes
= bt_ctf_attributes_create();
75 if (!event_class
->attributes
) {
79 obj
= bt_value_integer_create_init(-1);
84 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
92 obj
= bt_value_string_create_init(name
);
97 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
113 const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class
*event_class
)
115 struct bt_value
*obj
= NULL
;
116 const char *name
= NULL
;
122 if (event_class
->name
) {
123 name
= event_class
->name
;
127 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
128 BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX
);
133 if (bt_value_string_get(obj
, &name
)) {
142 int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class
*event_class
)
144 struct bt_value
*obj
= NULL
;
152 if (event_class
->id
>= 0) {
153 ret
= (int64_t) event_class
->id
;
157 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
158 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
163 if (bt_value_integer_get(obj
, &ret
)) {
168 /* means ID is not set */
178 int bt_ctf_event_class_set_id(struct bt_ctf_event_class
*event_class
,
182 struct bt_value
*obj
= NULL
;
183 struct bt_ctf_stream_class
*stream_class
= NULL
;
184 int64_t id
= (int64_t) id_param
;
186 if (!event_class
|| id
< 0) {
191 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
194 * We don't allow changing the id if the event class has already
195 * been added to a stream class.
201 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
202 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
207 if (bt_value_integer_set(obj
, id
)) {
214 BT_PUT(stream_class
);
218 int bt_ctf_event_class_set_attribute(
219 struct bt_ctf_event_class
*event_class
, const char *name
,
220 struct bt_value
*value
)
224 if (!event_class
|| !name
|| !value
|| event_class
->frozen
) {
229 if (!strcmp(name
, "id") || !strcmp(name
, "loglevel") ||
230 !strcmp(name
, "stream_id")) {
231 if (!bt_value_is_integer(value
)) {
235 } else if (!strcmp(name
, "name") || !strcmp(name
, "model.emf.uri") ||
236 !strcmp(name
, "loglevel_string")) {
237 if (!bt_value_is_string(value
)) {
242 /* unknown attribute */
247 /* "id" special case: >= 0 */
248 if (!strcmp(name
, "id")) {
251 ret
= bt_value_integer_get(value
, &val
);
263 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
270 int64_t bt_ctf_event_class_get_attribute_count(
271 struct bt_ctf_event_class
*event_class
)
280 ret
= bt_ctf_attributes_get_count(event_class
->attributes
);
287 bt_ctf_event_class_get_attribute_name_by_index(
288 struct bt_ctf_event_class
*event_class
, uint64_t index
)
297 ret
= bt_ctf_attributes_get_field_name(event_class
->attributes
, index
);
304 bt_ctf_event_class_get_attribute_value_by_index(
305 struct bt_ctf_event_class
*event_class
, uint64_t index
)
307 struct bt_value
*ret
;
314 ret
= bt_ctf_attributes_get_field_value(event_class
->attributes
, index
);
321 bt_ctf_event_class_get_attribute_value_by_name(
322 struct bt_ctf_event_class
*event_class
, const char *name
)
324 struct bt_value
*ret
;
326 if (!event_class
|| !name
) {
331 ret
= bt_ctf_attributes_get_field_value_by_name(event_class
->attributes
,
339 struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
340 struct bt_ctf_event_class
*event_class
)
343 bt_get(bt_ctf_event_class_borrow_stream_class(event_class
)) :
347 struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
348 struct bt_ctf_event_class
*event_class
)
350 struct bt_ctf_field_type
*payload
= NULL
;
356 bt_get(event_class
->fields
);
357 payload
= event_class
->fields
;
362 int bt_ctf_event_class_set_payload_type(struct bt_ctf_event_class
*event_class
,
363 struct bt_ctf_field_type
*payload
)
372 if (payload
&& bt_ctf_field_type_get_type_id(payload
) !=
373 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
378 bt_put(event_class
->fields
);
379 event_class
->fields
= bt_get(payload
);
384 int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
385 struct bt_ctf_field_type
*type
,
390 if (!event_class
|| !type
|| bt_ctf_validate_identifier(name
) ||
391 event_class
->frozen
) {
396 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
397 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
402 ret
= bt_ctf_field_type_structure_add_field(event_class
->fields
,
408 int64_t bt_ctf_event_class_get_payload_type_field_count(
409 struct bt_ctf_event_class
*event_class
)
418 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
419 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
424 ret
= bt_ctf_field_type_structure_get_field_count(event_class
->fields
);
429 int bt_ctf_event_class_get_payload_type_field_by_index(
430 struct bt_ctf_event_class
*event_class
,
431 const char **field_name
, struct bt_ctf_field_type
**field_type
,
441 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
442 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
447 ret
= bt_ctf_field_type_structure_get_field(event_class
->fields
,
448 field_name
, field_type
, index
);
453 struct bt_ctf_field_type
*
454 bt_ctf_event_class_get_payload_type_field_type_by_name(
455 struct bt_ctf_event_class
*event_class
, const char *name
)
458 struct bt_ctf_field_type
*field_type
= NULL
;
460 if (!event_class
|| !name
) {
464 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
465 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
469 name_quark
= g_quark_try_string(name
);
475 * No need to increment field_type's reference count since getting it
476 * from the structure already does.
478 field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
479 event_class
->fields
, name
);
484 struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
485 struct bt_ctf_event_class
*event_class
)
487 struct bt_ctf_field_type
*context_type
= NULL
;
489 if (!event_class
|| !event_class
->context
) {
493 bt_get(event_class
->context
);
494 context_type
= event_class
->context
;
499 int bt_ctf_event_class_set_context_type(
500 struct bt_ctf_event_class
*event_class
,
501 struct bt_ctf_field_type
*context
)
505 if (!event_class
|| event_class
->frozen
) {
510 if (context
&& bt_ctf_field_type_get_type_id(context
) !=
511 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
516 bt_put(event_class
->context
);
517 event_class
->context
= bt_get(context
);
523 void bt_ctf_event_class_get(struct bt_ctf_event_class
*event_class
)
528 void bt_ctf_event_class_put(struct bt_ctf_event_class
*event_class
)
534 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class
*event_class
,
535 uint64_t stream_id_param
)
538 struct bt_value
*obj
= NULL
;
539 int64_t stream_id
= (int64_t) stream_id_param
;
548 obj
= bt_value_integer_create_init(stream_id
);
555 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
558 if (event_class
->frozen
) {
559 bt_ctf_attributes_freeze(event_class
->attributes
);
568 void bt_ctf_event_class_destroy(struct bt_object
*obj
)
570 struct bt_ctf_event_class
*event_class
;
572 event_class
= container_of(obj
, struct bt_ctf_event_class
, base
);
573 bt_ctf_attributes_destroy(event_class
->attributes
);
574 bt_put(event_class
->context
);
575 bt_put(event_class
->fields
);
580 void bt_ctf_event_class_freeze(struct bt_ctf_event_class
*event_class
)
583 event_class
->frozen
= 1;
584 event_class
->name
= bt_ctf_event_class_get_name(event_class
);
585 event_class
->id
= bt_ctf_event_class_get_id(event_class
);
586 bt_ctf_field_type_freeze(event_class
->context
);
587 bt_ctf_field_type_freeze(event_class
->fields
);
588 bt_ctf_attributes_freeze(event_class
->attributes
);
592 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
593 struct metadata_context
*context
)
598 struct bt_value
*attr_value
= NULL
;
603 context
->current_indentation_level
= 1;
604 g_string_assign(context
->field_name
, "");
605 g_string_append(context
->string
, "event {\n");
606 count
= bt_ctf_event_class_get_attribute_count(event_class
);
613 for (i
= 0; i
< count
; ++i
) {
614 const char *attr_name
= NULL
;
616 attr_name
= bt_ctf_event_class_get_attribute_name_by_index(
618 attr_value
= bt_ctf_event_class_get_attribute_value_by_index(
621 if (!attr_name
|| !attr_value
) {
626 switch (bt_value_get_type(attr_value
)) {
627 case BT_VALUE_TYPE_INTEGER
:
631 ret
= bt_value_integer_get(attr_value
, &value
);
637 g_string_append_printf(context
->string
,
638 "\t%s = %" PRId64
";\n", attr_name
, value
);
642 case BT_VALUE_TYPE_STRING
:
646 ret
= bt_value_string_get(attr_value
, &value
);
652 g_string_append_printf(context
->string
,
653 "\t%s = \"%s\";\n", attr_name
, value
);
658 /* should never happen */
666 if (event_class
->context
) {
667 g_string_append(context
->string
, "\tcontext := ");
668 ret
= bt_ctf_field_type_serialize(event_class
->context
,
673 g_string_append(context
->string
, ";\n");
676 if (event_class
->fields
) {
677 g_string_append(context
->string
, "\tfields := ");
678 ret
= bt_ctf_field_type_serialize(event_class
->fields
, context
);
682 g_string_append(context
->string
, ";\n");
685 g_string_append(context
->string
, "};\n\n");
687 context
->current_indentation_level
= 0;