4 * Babeltrace CTF IR - Event
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-internal.h>
32 #include <babeltrace/ctf-ir/event-class.h>
33 #include <babeltrace/ctf-ir/event-class-internal.h>
34 #include <babeltrace/ctf-ir/stream-class.h>
35 #include <babeltrace/ctf-ir/stream-class-internal.h>
36 #include <babeltrace/ctf-ir/trace-internal.h>
37 #include <babeltrace/ctf-ir/validation-internal.h>
38 #include <babeltrace/ctf-ir/packet-internal.h>
39 #include <babeltrace/ctf-ir/utils.h>
40 #include <babeltrace/ref.h>
41 #include <babeltrace/ctf-ir/attributes-internal.h>
42 #include <babeltrace/compiler.h>
45 void bt_ctf_event_destroy(struct bt_object
*obj
);
47 int set_integer_field_value(struct bt_ctf_field
*field
, uint64_t value
);
49 struct bt_ctf_event
*bt_ctf_event_create(struct bt_ctf_event_class
*event_class
)
52 enum bt_ctf_validation_flag validation_flags
=
53 BT_CTF_VALIDATION_FLAG_STREAM
|
54 BT_CTF_VALIDATION_FLAG_EVENT
;
55 struct bt_ctf_event
*event
= NULL
;
56 struct bt_ctf_trace
*trace
= NULL
;
57 struct bt_ctf_stream_class
*stream_class
= NULL
;
58 struct bt_ctf_field_type
*packet_header_type
= NULL
;
59 struct bt_ctf_field_type
*packet_context_type
= NULL
;
60 struct bt_ctf_field_type
*event_header_type
= NULL
;
61 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
62 struct bt_ctf_field_type
*event_context_type
= NULL
;
63 struct bt_ctf_field_type
*event_payload_type
= NULL
;
64 struct bt_ctf_field
*event_header
= NULL
;
65 struct bt_ctf_field
*stream_event_context
= NULL
;
66 struct bt_ctf_field
*event_context
= NULL
;
67 struct bt_ctf_field
*event_payload
= NULL
;
68 struct bt_value
*environment
= NULL
;
69 struct bt_ctf_validation_output validation_output
= { 0 };
76 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
79 * We disallow the creation of an event if its event class has not been
80 * associated to a stream class.
86 /* A stream class should always have an existing event header type */
87 assert(stream_class
->event_header_type
);
89 /* The event class was frozen when added to its stream class */
90 assert(event_class
->frozen
);
92 /* Validate the trace (if any), the stream class, and the event class */
93 trace
= bt_ctf_stream_class_get_trace(stream_class
);
95 packet_header_type
= bt_ctf_trace_get_packet_header_type(trace
);
96 trace_valid
= trace
->valid
;
98 environment
= trace
->environment
;
101 packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
103 event_header_type
= bt_ctf_stream_class_get_event_header_type(
105 stream_event_ctx_type
= bt_ctf_stream_class_get_event_context_type(
107 event_context_type
= bt_ctf_event_class_get_context_type(event_class
);
108 event_payload_type
= bt_ctf_event_class_get_payload_type(event_class
);
109 ret
= bt_ctf_validate_class_types(environment
, packet_header_type
,
110 packet_context_type
, event_header_type
, stream_event_ctx_type
,
111 event_context_type
, event_payload_type
, trace_valid
,
112 stream_class
->valid
, event_class
->valid
,
113 &validation_output
, validation_flags
);
114 BT_PUT(packet_header_type
);
115 BT_PUT(packet_context_type
);
116 BT_PUT(event_header_type
);
117 BT_PUT(stream_event_ctx_type
);
118 BT_PUT(event_context_type
);
119 BT_PUT(event_payload_type
);
122 * This means something went wrong during the validation
123 * process, not that the objects are invalid.
128 if ((validation_output
.valid_flags
& validation_flags
) !=
130 /* Invalid trace/stream class/event class */
135 * At this point we know the trace (if associated to the stream
136 * class), the stream class, and the event class, with their
137 * current types, are valid. We may proceed with creating
140 event
= g_new0(struct bt_ctf_event
, 1);
145 bt_object_init(event
, bt_ctf_event_destroy
);
148 * event does not share a common ancestor with the event class; it has
149 * to guarantee its existence by holding a reference. This reference
150 * shall be released once the event is associated to a stream since,
151 * from that point, the event and its class will share the same
154 event
->event_class
= bt_get(event_class
);
156 bt_ctf_field_create(validation_output
.event_header_type
);
161 if (validation_output
.stream_event_ctx_type
) {
162 stream_event_context
= bt_ctf_field_create(
163 validation_output
.stream_event_ctx_type
);
164 if (!stream_event_context
) {
169 if (validation_output
.event_context_type
) {
170 event_context
= bt_ctf_field_create(
171 validation_output
.event_context_type
);
172 if (!event_context
) {
177 if (validation_output
.event_payload_type
) {
178 event_payload
= bt_ctf_field_create(
179 validation_output
.event_payload_type
);
180 if (!event_payload
) {
186 * At this point all the fields are created, potentially from
187 * validated copies of field types, so that the field types and
188 * fields can be replaced in the trace, stream class,
189 * event class, and created event.
191 bt_ctf_validation_replace_types(trace
, stream_class
,
192 event_class
, &validation_output
, validation_flags
);
193 BT_MOVE(event
->event_header
, event_header
);
194 BT_MOVE(event
->stream_event_context
, stream_event_context
);
195 BT_MOVE(event
->context_payload
, event_context
);
196 BT_MOVE(event
->fields_payload
, event_payload
);
199 * Put what was not moved in bt_ctf_validation_replace_types().
201 bt_ctf_validation_output_put_types(&validation_output
);
204 * Freeze the stream class since the event header must not be changed
207 bt_ctf_stream_class_freeze(stream_class
);
210 * Mark stream class, and event class as valid since
211 * they're all frozen now.
213 stream_class
->valid
= 1;
214 event_class
->valid
= 1;
216 /* Put stuff we borrowed from the event class */
217 BT_PUT(stream_class
);
223 bt_ctf_validation_output_put_types(&validation_output
);
225 BT_PUT(stream_class
);
227 BT_PUT(event_header
);
228 BT_PUT(stream_event_context
);
229 BT_PUT(event_context
);
230 BT_PUT(event_payload
);
231 assert(!packet_header_type
);
232 assert(!packet_context_type
);
233 assert(!event_header_type
);
234 assert(!stream_event_ctx_type
);
235 assert(!event_context_type
);
236 assert(!event_payload_type
);
241 struct bt_ctf_event_class
*bt_ctf_event_get_class(struct bt_ctf_event
*event
)
243 struct bt_ctf_event_class
*event_class
= NULL
;
249 event_class
= event
->event_class
;
255 struct bt_ctf_stream
*bt_ctf_event_get_stream(struct bt_ctf_event
*event
)
257 return (struct bt_ctf_stream
*) bt_object_get_parent(event
);
260 struct bt_ctf_clock
*bt_ctf_event_get_clock(struct bt_ctf_event
*event
)
262 struct bt_ctf_clock
*clock
= NULL
;
263 struct bt_ctf_event_class
*event_class
;
264 struct bt_ctf_stream_class
*stream_class
;
270 event_class
= bt_ctf_event_get_class(event
);
275 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
277 goto error_put_event_class
;
280 clock
= bt_ctf_stream_class_get_clock(stream_class
);
282 goto error_put_stream_class
;
285 error_put_stream_class
:
286 bt_put(stream_class
);
287 error_put_event_class
:
293 int bt_ctf_event_set_payload(struct bt_ctf_event
*event
,
295 struct bt_ctf_field
*payload
)
299 if (!event
|| !payload
) {
305 ret
= bt_ctf_field_structure_set_field(event
->fields_payload
,
308 struct bt_ctf_field_type
*payload_type
;
310 payload_type
= bt_ctf_field_get_type(payload
);
312 if (bt_ctf_field_type_compare(payload_type
,
313 event
->event_class
->fields
) == 0) {
314 bt_put(event
->fields_payload
);
316 event
->fields_payload
= payload
;
321 bt_put(payload_type
);
327 struct bt_ctf_field
*bt_ctf_event_get_payload_field(struct bt_ctf_event
*event
)
329 struct bt_ctf_field
*payload
= NULL
;
331 if (!event
|| !event
->fields_payload
) {
335 payload
= event
->fields_payload
;
341 int bt_ctf_event_set_payload_field(struct bt_ctf_event
*event
,
342 struct bt_ctf_field
*payload
)
345 struct bt_ctf_field_type
*payload_type
= NULL
;
347 if (!event
|| !payload
) {
352 payload_type
= bt_ctf_field_get_type(payload
);
358 if (bt_ctf_field_type_get_type_id(payload_type
) !=
359 BT_CTF_TYPE_ID_STRUCT
) {
365 bt_put(event
->fields_payload
);
366 event
->fields_payload
= payload
;
369 bt_put(payload_type
);
373 struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
376 struct bt_ctf_field
*field
= NULL
;
383 field
= bt_ctf_field_structure_get_field(event
->fields_payload
,
386 field
= event
->fields_payload
;
393 struct bt_ctf_field
*bt_ctf_event_get_payload_by_index(
394 struct bt_ctf_event
*event
, int index
)
396 struct bt_ctf_field
*field
= NULL
;
398 if (!event
|| index
< 0) {
402 field
= bt_ctf_field_structure_get_field_by_index(event
->fields_payload
,
408 struct bt_ctf_field
*bt_ctf_event_get_header(
409 struct bt_ctf_event
*event
)
411 struct bt_ctf_field
*header
= NULL
;
413 if (!event
|| !event
->event_header
) {
417 header
= event
->event_header
;
423 int bt_ctf_event_set_header(struct bt_ctf_event
*event
,
424 struct bt_ctf_field
*header
)
427 struct bt_ctf_field_type
*field_type
= NULL
;
428 struct bt_ctf_stream_class
*stream_class
= NULL
;
430 if (!event
|| !header
) {
435 stream_class
= (struct bt_ctf_stream_class
*) bt_object_get_parent(
438 * Ensure the provided header's type matches the one registered to the
441 field_type
= bt_ctf_field_get_type(header
);
442 if (bt_ctf_field_type_compare(field_type
,
443 stream_class
->event_header_type
)) {
449 bt_put(event
->event_header
);
450 event
->event_header
= header
;
452 bt_put(stream_class
);
457 struct bt_ctf_field
*bt_ctf_event_get_event_context(
458 struct bt_ctf_event
*event
)
460 struct bt_ctf_field
*context
= NULL
;
462 if (!event
|| !event
->context_payload
) {
466 context
= event
->context_payload
;
472 int bt_ctf_event_set_event_context(struct bt_ctf_event
*event
,
473 struct bt_ctf_field
*context
)
476 struct bt_ctf_field_type
*field_type
= NULL
;
478 if (!event
|| !context
) {
483 field_type
= bt_ctf_field_get_type(context
);
484 if (bt_ctf_field_type_compare(field_type
,
485 event
->event_class
->context
)) {
491 bt_put(event
->context_payload
);
492 event
->context_payload
= context
;
498 struct bt_ctf_field
*bt_ctf_event_get_stream_event_context(
499 struct bt_ctf_event
*event
)
501 struct bt_ctf_field
*stream_event_context
= NULL
;
503 if (!event
|| !event
->stream_event_context
) {
507 stream_event_context
= event
->stream_event_context
;
509 return bt_get(stream_event_context
);
512 int bt_ctf_event_set_stream_event_context(struct bt_ctf_event
*event
,
513 struct bt_ctf_field
*stream_event_context
)
516 struct bt_ctf_field_type
*field_type
= NULL
;
517 struct bt_ctf_stream_class
*stream_class
= NULL
;
519 if (!event
|| !stream_event_context
) {
524 stream_class
= bt_ctf_event_class_get_stream_class(event
->event_class
);
526 * We should not have been able to create the event without associating
527 * the event class to a stream class.
529 assert(stream_class
);
531 field_type
= bt_ctf_field_get_type(stream_event_context
);
532 if (bt_ctf_field_type_compare(field_type
,
533 stream_class
->event_context_type
)) {
538 bt_get(stream_event_context
);
539 BT_MOVE(event
->stream_event_context
, stream_event_context
);
541 BT_PUT(stream_class
);
546 void bt_ctf_event_get(struct bt_ctf_event
*event
)
551 void bt_ctf_event_put(struct bt_ctf_event
*event
)
556 void bt_ctf_event_destroy(struct bt_object
*obj
)
558 struct bt_ctf_event
*event
;
560 event
= container_of(obj
, struct bt_ctf_event
, base
);
561 if (!event
->base
.parent
) {
563 * Event was keeping a reference to its class since it shared no
564 * common ancestor with it to guarantee they would both have the
567 bt_put(event
->event_class
);
569 bt_put(event
->event_header
);
570 bt_put(event
->stream_event_context
);
571 bt_put(event
->context_payload
);
572 bt_put(event
->fields_payload
);
573 bt_put(event
->packet
);
578 int set_integer_field_value(struct bt_ctf_field
* field
, uint64_t value
)
581 struct bt_ctf_field_type
*field_type
= NULL
;
588 if (!bt_ctf_field_validate(field
)) {
589 /* Payload already set, skip! (not an error) */
593 field_type
= bt_ctf_field_get_type(field
);
596 if (bt_ctf_field_type_get_type_id(field_type
) !=
597 BT_CTF_TYPE_ID_INTEGER
) {
598 /* Not an integer and the value is unset, error. */
603 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
604 ret
= bt_ctf_field_signed_integer_set_value(field
, (int64_t) value
);
606 /* Value is out of range, error. */
610 ret
= bt_ctf_field_unsigned_integer_set_value(field
, value
);
612 /* Value is out of range, error. */
622 int bt_ctf_event_validate(struct bt_ctf_event
*event
)
624 /* Make sure each field's payload has been set */
626 struct bt_ctf_stream_class
*stream_class
= NULL
;
629 ret
= bt_ctf_field_validate(event
->event_header
);
634 stream_class
= bt_ctf_event_class_get_stream_class(event
->event_class
);
636 * We should not have been able to create the event without associating
637 * the event class to a stream class.
639 assert(stream_class
);
640 if (stream_class
->event_context_type
) {
641 ret
= bt_ctf_field_validate(event
->stream_event_context
);
647 ret
= bt_ctf_field_validate(event
->fields_payload
);
652 if (event
->event_class
->context
) {
653 ret
= bt_ctf_field_validate(event
->context_payload
);
656 bt_put(stream_class
);
661 int bt_ctf_event_serialize(struct bt_ctf_event
*event
,
662 struct ctf_stream_pos
*pos
)
668 if (event
->context_payload
) {
669 ret
= bt_ctf_field_serialize(event
->context_payload
, pos
);
675 if (event
->fields_payload
) {
676 ret
= bt_ctf_field_serialize(event
->fields_payload
, pos
);
686 int bt_ctf_event_populate_event_header(struct bt_ctf_event
*event
)
689 struct bt_ctf_field
*id_field
= NULL
, *timestamp_field
= NULL
;
696 id_field
= bt_ctf_field_structure_get_field(event
->event_header
, "id");
698 ret
= set_integer_field_value(id_field
,
699 (uint64_t) bt_ctf_event_class_get_id(
700 event
->event_class
));
706 timestamp_field
= bt_ctf_field_structure_get_field(event
->event_header
,
708 if (timestamp_field
) {
709 struct bt_ctf_field_type
*timestamp_field_type
=
710 bt_ctf_field_get_type(timestamp_field
);
711 struct bt_ctf_clock
*mapped_clock
;
713 assert(timestamp_field_type
);
714 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
715 timestamp_field_type
);
716 bt_put(timestamp_field_type
);
720 ret
= bt_ctf_clock_get_time(mapped_clock
, ×tamp
);
721 bt_put(mapped_clock
);
726 ret
= set_integer_field_value(timestamp_field
,
735 bt_put(timestamp_field
);
739 struct bt_ctf_event
*bt_ctf_event_copy(struct bt_ctf_event
*event
)
741 struct bt_ctf_event
*copy
= NULL
;
747 copy
= g_new0(struct bt_ctf_event
, 1);
752 bt_object_init(copy
, bt_ctf_event_destroy
);
753 copy
->event_class
= bt_get(event
->event_class
);
755 if (event
->event_header
) {
756 copy
->event_header
= bt_ctf_field_copy(event
->event_header
);
757 if (!copy
->event_header
) {
762 if (event
->stream_event_context
) {
763 copy
->stream_event_context
=
764 bt_ctf_field_copy(event
->stream_event_context
);
765 if (!copy
->stream_event_context
) {
770 if (event
->context_payload
) {
771 copy
->context_payload
= bt_ctf_field_copy(
772 event
->context_payload
);
773 if (!copy
->context_payload
) {
778 if (event
->fields_payload
) {
779 copy
->fields_payload
= bt_ctf_field_copy(event
->fields_payload
);
780 if (!copy
->fields_payload
) {
792 int bt_ctf_event_set_packet(struct bt_ctf_event
*event
,
793 struct bt_ctf_packet
*packet
)
795 struct bt_ctf_stream
*stream
= NULL
;
798 if (!event
|| !packet
) {
804 * Make sure the new packet was created by this event's
805 * stream, if it is set.
807 stream
= bt_ctf_event_get_stream(event
);
809 if (packet
->stream
!= stream
) {
814 /* Set the event's parent to the packet's stream */
815 bt_object_set_parent(event
, packet
->stream
);
818 bt_put(event
->packet
);
819 event
->packet
= bt_get(packet
);