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
->attributes
= bt_ctf_attributes_create();
70 if (!event_class
->attributes
) {
74 obj
= bt_value_integer_create_init(-1);
79 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
87 obj
= bt_value_string_create_init(name
);
92 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
108 const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class
*event_class
)
110 struct bt_value
*obj
= NULL
;
111 const char *name
= NULL
;
117 if (event_class
->name
) {
118 name
= event_class
->name
;
122 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
123 BT_CTF_EVENT_CLASS_ATTR_NAME_INDEX
);
128 if (bt_value_string_get(obj
, &name
)) {
137 int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class
*event_class
)
139 struct bt_value
*obj
= NULL
;
147 if (event_class
->id
>= 0) {
148 ret
= (int64_t) event_class
->id
;
152 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
153 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
158 if (bt_value_integer_get(obj
, &ret
)) {
163 /* means ID is not set */
173 int bt_ctf_event_class_set_id(struct bt_ctf_event_class
*event_class
,
177 struct bt_value
*obj
= NULL
;
178 struct bt_ctf_stream_class
*stream_class
= NULL
;
179 int64_t id
= (int64_t) id_param
;
181 if (!event_class
|| id
< 0) {
186 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
189 * We don't allow changing the id if the event class has already
190 * been added to a stream class.
196 obj
= bt_ctf_attributes_get_field_value(event_class
->attributes
,
197 BT_CTF_EVENT_CLASS_ATTR_ID_INDEX
);
202 if (bt_value_integer_set(obj
, id
)) {
209 BT_PUT(stream_class
);
213 int bt_ctf_event_class_set_attribute(
214 struct bt_ctf_event_class
*event_class
, const char *name
,
215 struct bt_value
*value
)
219 if (!event_class
|| !name
|| !value
|| event_class
->frozen
) {
224 if (!strcmp(name
, "id") || !strcmp(name
, "loglevel") ||
225 !strcmp(name
, "stream_id")) {
226 if (!bt_value_is_integer(value
)) {
230 } else if (!strcmp(name
, "name") || !strcmp(name
, "model.emf.uri") ||
231 !strcmp(name
, "loglevel_string")) {
232 if (!bt_value_is_string(value
)) {
237 /* unknown attribute */
242 /* "id" special case: >= 0 */
243 if (!strcmp(name
, "id")) {
246 ret
= bt_value_integer_get(value
, &val
);
258 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
265 int64_t bt_ctf_event_class_get_attribute_count(
266 struct bt_ctf_event_class
*event_class
)
275 ret
= bt_ctf_attributes_get_count(event_class
->attributes
);
282 bt_ctf_event_class_get_attribute_name_by_index(
283 struct bt_ctf_event_class
*event_class
, uint64_t index
)
292 ret
= bt_ctf_attributes_get_field_name(event_class
->attributes
, index
);
299 bt_ctf_event_class_get_attribute_value_by_index(
300 struct bt_ctf_event_class
*event_class
, uint64_t index
)
302 struct bt_value
*ret
;
309 ret
= bt_ctf_attributes_get_field_value(event_class
->attributes
, index
);
316 bt_ctf_event_class_get_attribute_value_by_name(
317 struct bt_ctf_event_class
*event_class
, const char *name
)
319 struct bt_value
*ret
;
321 if (!event_class
|| !name
) {
326 ret
= bt_ctf_attributes_get_field_value_by_name(event_class
->attributes
,
334 struct bt_ctf_stream_class
*bt_ctf_event_class_get_stream_class(
335 struct bt_ctf_event_class
*event_class
)
338 bt_get(bt_ctf_event_class_borrow_stream_class(event_class
)) :
342 struct bt_ctf_field_type
*bt_ctf_event_class_get_payload_type(
343 struct bt_ctf_event_class
*event_class
)
345 struct bt_ctf_field_type
*payload
= NULL
;
351 bt_get(event_class
->fields
);
352 payload
= event_class
->fields
;
357 int bt_ctf_event_class_set_payload_type(struct bt_ctf_event_class
*event_class
,
358 struct bt_ctf_field_type
*payload
)
367 if (payload
&& bt_ctf_field_type_get_type_id(payload
) !=
368 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
373 bt_put(event_class
->fields
);
374 event_class
->fields
= bt_get(payload
);
379 int bt_ctf_event_class_add_field(struct bt_ctf_event_class
*event_class
,
380 struct bt_ctf_field_type
*type
,
385 if (!event_class
|| !type
|| bt_ctf_validate_identifier(name
) ||
386 event_class
->frozen
) {
391 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
392 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
397 ret
= bt_ctf_field_type_structure_add_field(event_class
->fields
,
403 int64_t bt_ctf_event_class_get_payload_type_field_count(
404 struct bt_ctf_event_class
*event_class
)
413 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
414 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
419 ret
= bt_ctf_field_type_structure_get_field_count(event_class
->fields
);
424 int bt_ctf_event_class_get_payload_type_field_by_index(
425 struct bt_ctf_event_class
*event_class
,
426 const char **field_name
, struct bt_ctf_field_type
**field_type
,
436 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
437 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
442 ret
= bt_ctf_field_type_structure_get_field(event_class
->fields
,
443 field_name
, field_type
, index
);
448 struct bt_ctf_field_type
*
449 bt_ctf_event_class_get_payload_type_field_type_by_name(
450 struct bt_ctf_event_class
*event_class
, const char *name
)
453 struct bt_ctf_field_type
*field_type
= NULL
;
455 if (!event_class
|| !name
) {
459 if (bt_ctf_field_type_get_type_id(event_class
->fields
) !=
460 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
464 name_quark
= g_quark_try_string(name
);
470 * No need to increment field_type's reference count since getting it
471 * from the structure already does.
473 field_type
= bt_ctf_field_type_structure_get_field_type_by_name(
474 event_class
->fields
, name
);
479 struct bt_ctf_field_type
*bt_ctf_event_class_get_context_type(
480 struct bt_ctf_event_class
*event_class
)
482 struct bt_ctf_field_type
*context_type
= NULL
;
484 if (!event_class
|| !event_class
->context
) {
488 bt_get(event_class
->context
);
489 context_type
= event_class
->context
;
494 int bt_ctf_event_class_set_context_type(
495 struct bt_ctf_event_class
*event_class
,
496 struct bt_ctf_field_type
*context
)
500 if (!event_class
|| event_class
->frozen
) {
505 if (context
&& bt_ctf_field_type_get_type_id(context
) !=
506 BT_CTF_FIELD_TYPE_ID_STRUCT
) {
511 bt_put(event_class
->context
);
512 event_class
->context
= bt_get(context
);
518 void bt_ctf_event_class_get(struct bt_ctf_event_class
*event_class
)
523 void bt_ctf_event_class_put(struct bt_ctf_event_class
*event_class
)
529 int bt_ctf_event_class_set_stream_id(struct bt_ctf_event_class
*event_class
,
530 uint64_t stream_id_param
)
533 struct bt_value
*obj
= NULL
;
534 int64_t stream_id
= (int64_t) stream_id_param
;
543 obj
= bt_value_integer_create_init(stream_id
);
550 ret
= bt_ctf_attributes_set_field_value(event_class
->attributes
,
553 if (event_class
->frozen
) {
554 bt_ctf_attributes_freeze(event_class
->attributes
);
563 void bt_ctf_event_class_destroy(struct bt_object
*obj
)
565 struct bt_ctf_event_class
*event_class
;
567 event_class
= container_of(obj
, struct bt_ctf_event_class
, base
);
568 bt_ctf_attributes_destroy(event_class
->attributes
);
569 bt_put(event_class
->context
);
570 bt_put(event_class
->fields
);
575 void bt_ctf_event_class_freeze(struct bt_ctf_event_class
*event_class
)
578 event_class
->frozen
= 1;
579 event_class
->name
= bt_ctf_event_class_get_name(event_class
);
580 event_class
->id
= bt_ctf_event_class_get_id(event_class
);
581 bt_ctf_field_type_freeze(event_class
->context
);
582 bt_ctf_field_type_freeze(event_class
->fields
);
583 bt_ctf_attributes_freeze(event_class
->attributes
);
587 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
588 struct metadata_context
*context
)
593 struct bt_value
*attr_value
= NULL
;
598 context
->current_indentation_level
= 1;
599 g_string_assign(context
->field_name
, "");
600 g_string_append(context
->string
, "event {\n");
601 count
= bt_ctf_event_class_get_attribute_count(event_class
);
608 for (i
= 0; i
< count
; ++i
) {
609 const char *attr_name
= NULL
;
611 attr_name
= bt_ctf_event_class_get_attribute_name_by_index(
613 attr_value
= bt_ctf_event_class_get_attribute_value_by_index(
616 if (!attr_name
|| !attr_value
) {
621 switch (bt_value_get_type(attr_value
)) {
622 case BT_VALUE_TYPE_INTEGER
:
626 ret
= bt_value_integer_get(attr_value
, &value
);
632 g_string_append_printf(context
->string
,
633 "\t%s = %" PRId64
";\n", attr_name
, value
);
637 case BT_VALUE_TYPE_STRING
:
641 ret
= bt_value_string_get(attr_value
, &value
);
647 g_string_append_printf(context
->string
,
648 "\t%s = \"%s\";\n", attr_name
, value
);
653 /* should never happen */
661 if (event_class
->context
) {
662 g_string_append(context
->string
, "\tcontext := ");
663 ret
= bt_ctf_field_type_serialize(event_class
->context
,
668 g_string_append(context
->string
, ";\n");
671 if (event_class
->fields
) {
672 g_string_append(context
->string
, "\tfields := ");
673 ret
= bt_ctf_field_type_serialize(event_class
->fields
, context
);
677 g_string_append(context
->string
, ";\n");
680 g_string_append(context
->string
, "};\n\n");
682 context
->current_indentation_level
= 0;