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/packet.h>
37 #include <babeltrace/ctf-ir/packet-internal.h>
38 #include <babeltrace/ctf-ir/trace-internal.h>
39 #include <babeltrace/ctf-ir/validation-internal.h>
40 #include <babeltrace/ctf-ir/packet-internal.h>
41 #include <babeltrace/ctf-ir/utils.h>
42 #include <babeltrace/ref.h>
43 #include <babeltrace/ctf-ir/attributes-internal.h>
44 #include <babeltrace/compiler.h>
47 void bt_ctf_event_destroy(struct bt_object
*obj
);
49 int set_integer_field_value(struct bt_ctf_field
*field
, uint64_t value
);
51 struct bt_ctf_event
*bt_ctf_event_create(struct bt_ctf_event_class
*event_class
)
54 enum bt_ctf_validation_flag validation_flags
=
55 BT_CTF_VALIDATION_FLAG_STREAM
|
56 BT_CTF_VALIDATION_FLAG_EVENT
;
57 struct bt_ctf_event
*event
= NULL
;
58 struct bt_ctf_trace
*trace
= NULL
;
59 struct bt_ctf_stream_class
*stream_class
= NULL
;
60 struct bt_ctf_field_type
*packet_header_type
= NULL
;
61 struct bt_ctf_field_type
*packet_context_type
= NULL
;
62 struct bt_ctf_field_type
*event_header_type
= NULL
;
63 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
64 struct bt_ctf_field_type
*event_context_type
= NULL
;
65 struct bt_ctf_field_type
*event_payload_type
= NULL
;
66 struct bt_ctf_field
*event_header
= NULL
;
67 struct bt_ctf_field
*stream_event_context
= NULL
;
68 struct bt_ctf_field
*event_context
= NULL
;
69 struct bt_ctf_field
*event_payload
= NULL
;
70 struct bt_value
*environment
= NULL
;
71 struct bt_ctf_validation_output validation_output
= { 0 };
78 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
81 * We disallow the creation of an event if its event class has not been
82 * associated to a stream class.
88 /* A stream class should always have an existing event header type */
89 assert(stream_class
->event_header_type
);
91 /* The event class was frozen when added to its stream class */
92 assert(event_class
->frozen
);
94 /* Validate the trace (if any), the stream class, and the event class */
95 trace
= bt_ctf_stream_class_get_trace(stream_class
);
97 packet_header_type
= bt_ctf_trace_get_packet_header_type(trace
);
98 trace_valid
= trace
->valid
;
100 environment
= trace
->environment
;
103 packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
105 event_header_type
= bt_ctf_stream_class_get_event_header_type(
107 stream_event_ctx_type
= bt_ctf_stream_class_get_event_context_type(
109 event_context_type
= bt_ctf_event_class_get_context_type(event_class
);
110 event_payload_type
= bt_ctf_event_class_get_payload_type(event_class
);
111 ret
= bt_ctf_validate_class_types(environment
, packet_header_type
,
112 packet_context_type
, event_header_type
, stream_event_ctx_type
,
113 event_context_type
, event_payload_type
, trace_valid
,
114 stream_class
->valid
, event_class
->valid
,
115 &validation_output
, validation_flags
);
116 BT_PUT(packet_header_type
);
117 BT_PUT(packet_context_type
);
118 BT_PUT(event_header_type
);
119 BT_PUT(stream_event_ctx_type
);
120 BT_PUT(event_context_type
);
121 BT_PUT(event_payload_type
);
124 * This means something went wrong during the validation
125 * process, not that the objects are invalid.
130 if ((validation_output
.valid_flags
& validation_flags
) !=
132 /* Invalid trace/stream class/event class */
137 * At this point we know the trace (if associated to the stream
138 * class), the stream class, and the event class, with their
139 * current types, are valid. We may proceed with creating
142 event
= g_new0(struct bt_ctf_event
, 1);
147 bt_object_init(event
, bt_ctf_event_destroy
);
150 * event does not share a common ancestor with the event class; it has
151 * to guarantee its existence by holding a reference. This reference
152 * shall be released once the event is associated to a stream since,
153 * from that point, the event and its class will share the same
156 event
->event_class
= bt_get(event_class
);
158 bt_ctf_field_create(validation_output
.event_header_type
);
163 if (validation_output
.stream_event_ctx_type
) {
164 stream_event_context
= bt_ctf_field_create(
165 validation_output
.stream_event_ctx_type
);
166 if (!stream_event_context
) {
171 if (validation_output
.event_context_type
) {
172 event_context
= bt_ctf_field_create(
173 validation_output
.event_context_type
);
174 if (!event_context
) {
179 if (validation_output
.event_payload_type
) {
180 event_payload
= bt_ctf_field_create(
181 validation_output
.event_payload_type
);
182 if (!event_payload
) {
188 * At this point all the fields are created, potentially from
189 * validated copies of field types, so that the field types and
190 * fields can be replaced in the trace, stream class,
191 * event class, and created event.
193 bt_ctf_validation_replace_types(trace
, stream_class
,
194 event_class
, &validation_output
, validation_flags
);
195 BT_MOVE(event
->event_header
, event_header
);
196 BT_MOVE(event
->stream_event_context
, stream_event_context
);
197 BT_MOVE(event
->context_payload
, event_context
);
198 BT_MOVE(event
->fields_payload
, event_payload
);
201 * Put what was not moved in bt_ctf_validation_replace_types().
203 bt_ctf_validation_output_put_types(&validation_output
);
206 * Freeze the stream class since the event header must not be changed
209 bt_ctf_stream_class_freeze(stream_class
);
212 * Mark stream class, and event class as valid since
213 * they're all frozen now.
215 stream_class
->valid
= 1;
216 event_class
->valid
= 1;
218 /* Put stuff we borrowed from the event class */
219 BT_PUT(stream_class
);
225 bt_ctf_validation_output_put_types(&validation_output
);
227 BT_PUT(stream_class
);
229 BT_PUT(event_header
);
230 BT_PUT(stream_event_context
);
231 BT_PUT(event_context
);
232 BT_PUT(event_payload
);
233 assert(!packet_header_type
);
234 assert(!packet_context_type
);
235 assert(!event_header_type
);
236 assert(!stream_event_ctx_type
);
237 assert(!event_context_type
);
238 assert(!event_payload_type
);
243 struct bt_ctf_event_class
*bt_ctf_event_get_class(struct bt_ctf_event
*event
)
245 struct bt_ctf_event_class
*event_class
= NULL
;
251 event_class
= event
->event_class
;
257 struct bt_ctf_stream
*bt_ctf_event_get_stream(struct bt_ctf_event
*event
)
259 return (struct bt_ctf_stream
*) bt_object_get_parent(event
);
262 struct bt_ctf_clock
*bt_ctf_event_get_clock(struct bt_ctf_event
*event
)
264 struct bt_ctf_clock
*clock
= NULL
;
265 struct bt_ctf_event_class
*event_class
;
266 struct bt_ctf_stream_class
*stream_class
;
272 event_class
= bt_ctf_event_get_class(event
);
277 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
279 goto error_put_event_class
;
282 clock
= bt_ctf_stream_class_get_clock(stream_class
);
284 goto error_put_stream_class
;
287 error_put_stream_class
:
288 bt_put(stream_class
);
289 error_put_event_class
:
295 int bt_ctf_event_set_payload(struct bt_ctf_event
*event
,
297 struct bt_ctf_field
*payload
)
301 if (!event
|| !payload
|| event
->frozen
) {
307 ret
= bt_ctf_field_structure_set_field(event
->fields_payload
,
310 struct bt_ctf_field_type
*payload_type
;
312 payload_type
= bt_ctf_field_get_type(payload
);
314 if (bt_ctf_field_type_compare(payload_type
,
315 event
->event_class
->fields
) == 0) {
316 bt_put(event
->fields_payload
);
318 event
->fields_payload
= payload
;
323 bt_put(payload_type
);
329 struct bt_ctf_field
*bt_ctf_event_get_payload_field(struct bt_ctf_event
*event
)
331 struct bt_ctf_field
*payload
= NULL
;
333 if (!event
|| !event
->fields_payload
) {
337 payload
= event
->fields_payload
;
343 int bt_ctf_event_set_payload_field(struct bt_ctf_event
*event
,
344 struct bt_ctf_field
*payload
)
347 struct bt_ctf_field_type
*payload_type
= NULL
;
349 if (!event
|| !payload
|| event
->frozen
) {
354 payload_type
= bt_ctf_field_get_type(payload
);
360 if (bt_ctf_field_type_get_type_id(payload_type
) !=
361 BT_CTF_TYPE_ID_STRUCT
) {
367 bt_put(event
->fields_payload
);
368 event
->fields_payload
= payload
;
371 bt_put(payload_type
);
375 struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
378 struct bt_ctf_field
*field
= NULL
;
385 field
= bt_ctf_field_structure_get_field(event
->fields_payload
,
388 field
= event
->fields_payload
;
395 struct bt_ctf_field
*bt_ctf_event_get_payload_by_index(
396 struct bt_ctf_event
*event
, int index
)
398 struct bt_ctf_field
*field
= NULL
;
400 if (!event
|| index
< 0) {
404 field
= bt_ctf_field_structure_get_field_by_index(event
->fields_payload
,
410 struct bt_ctf_field
*bt_ctf_event_get_header(
411 struct bt_ctf_event
*event
)
413 struct bt_ctf_field
*header
= NULL
;
415 if (!event
|| !event
->event_header
) {
419 header
= event
->event_header
;
425 int bt_ctf_event_set_header(struct bt_ctf_event
*event
,
426 struct bt_ctf_field
*header
)
429 struct bt_ctf_field_type
*field_type
= NULL
;
430 struct bt_ctf_stream_class
*stream_class
= NULL
;
432 if (!event
|| !header
|| event
->frozen
) {
437 stream_class
= (struct bt_ctf_stream_class
*) bt_object_get_parent(
440 * Ensure the provided header's type matches the one registered to the
443 field_type
= bt_ctf_field_get_type(header
);
444 if (bt_ctf_field_type_compare(field_type
,
445 stream_class
->event_header_type
)) {
451 bt_put(event
->event_header
);
452 event
->event_header
= header
;
454 bt_put(stream_class
);
459 struct bt_ctf_field
*bt_ctf_event_get_event_context(
460 struct bt_ctf_event
*event
)
462 struct bt_ctf_field
*context
= NULL
;
464 if (!event
|| !event
->context_payload
) {
468 context
= event
->context_payload
;
474 int bt_ctf_event_set_event_context(struct bt_ctf_event
*event
,
475 struct bt_ctf_field
*context
)
478 struct bt_ctf_field_type
*field_type
= NULL
;
480 if (!event
|| !context
|| event
->frozen
) {
485 field_type
= bt_ctf_field_get_type(context
);
486 if (bt_ctf_field_type_compare(field_type
,
487 event
->event_class
->context
)) {
493 bt_put(event
->context_payload
);
494 event
->context_payload
= context
;
500 struct bt_ctf_field
*bt_ctf_event_get_stream_event_context(
501 struct bt_ctf_event
*event
)
503 struct bt_ctf_field
*stream_event_context
= NULL
;
505 if (!event
|| !event
->stream_event_context
) {
509 stream_event_context
= event
->stream_event_context
;
511 return bt_get(stream_event_context
);
514 int bt_ctf_event_set_stream_event_context(struct bt_ctf_event
*event
,
515 struct bt_ctf_field
*stream_event_context
)
518 struct bt_ctf_field_type
*field_type
= NULL
;
519 struct bt_ctf_stream_class
*stream_class
= NULL
;
521 if (!event
|| !stream_event_context
|| event
->frozen
) {
526 stream_class
= bt_ctf_event_class_get_stream_class(event
->event_class
);
528 * We should not have been able to create the event without associating
529 * the event class to a stream class.
531 assert(stream_class
);
533 field_type
= bt_ctf_field_get_type(stream_event_context
);
534 if (bt_ctf_field_type_compare(field_type
,
535 stream_class
->event_context_type
)) {
540 bt_get(stream_event_context
);
541 BT_MOVE(event
->stream_event_context
, stream_event_context
);
543 BT_PUT(stream_class
);
548 void bt_ctf_event_get(struct bt_ctf_event
*event
)
553 void bt_ctf_event_put(struct bt_ctf_event
*event
)
558 void bt_ctf_event_destroy(struct bt_object
*obj
)
560 struct bt_ctf_event
*event
;
562 event
= container_of(obj
, struct bt_ctf_event
, base
);
563 if (!event
->base
.parent
) {
565 * Event was keeping a reference to its class since it shared no
566 * common ancestor with it to guarantee they would both have the
569 bt_put(event
->event_class
);
571 bt_put(event
->event_header
);
572 bt_put(event
->stream_event_context
);
573 bt_put(event
->context_payload
);
574 bt_put(event
->fields_payload
);
575 bt_put(event
->packet
);
580 int set_integer_field_value(struct bt_ctf_field
* field
, uint64_t value
)
583 struct bt_ctf_field_type
*field_type
= NULL
;
590 if (!bt_ctf_field_validate(field
)) {
591 /* Payload already set, skip! (not an error) */
595 field_type
= bt_ctf_field_get_type(field
);
598 if (bt_ctf_field_type_get_type_id(field_type
) !=
599 BT_CTF_TYPE_ID_INTEGER
) {
600 /* Not an integer and the value is unset, error. */
605 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
606 ret
= bt_ctf_field_signed_integer_set_value(field
, (int64_t) value
);
608 /* Value is out of range, error. */
612 ret
= bt_ctf_field_unsigned_integer_set_value(field
, value
);
614 /* Value is out of range, error. */
624 int bt_ctf_event_validate(struct bt_ctf_event
*event
)
626 /* Make sure each field's payload has been set */
628 struct bt_ctf_stream_class
*stream_class
= NULL
;
631 ret
= bt_ctf_field_validate(event
->event_header
);
636 stream_class
= bt_ctf_event_class_get_stream_class(event
->event_class
);
638 * We should not have been able to create the event without associating
639 * the event class to a stream class.
641 assert(stream_class
);
642 if (stream_class
->event_context_type
) {
643 ret
= bt_ctf_field_validate(event
->stream_event_context
);
649 ret
= bt_ctf_field_validate(event
->fields_payload
);
654 if (event
->event_class
->context
) {
655 ret
= bt_ctf_field_validate(event
->context_payload
);
658 bt_put(stream_class
);
663 int bt_ctf_event_serialize(struct bt_ctf_event
*event
,
664 struct ctf_stream_pos
*pos
)
670 if (event
->context_payload
) {
671 ret
= bt_ctf_field_serialize(event
->context_payload
, pos
);
677 if (event
->fields_payload
) {
678 ret
= bt_ctf_field_serialize(event
->fields_payload
, pos
);
688 int bt_ctf_event_populate_event_header(struct bt_ctf_event
*event
)
691 struct bt_ctf_field
*id_field
= NULL
, *timestamp_field
= NULL
;
693 if (!event
|| event
->frozen
) {
698 id_field
= bt_ctf_field_structure_get_field(event
->event_header
, "id");
700 ret
= set_integer_field_value(id_field
,
701 (uint64_t) bt_ctf_event_class_get_id(
702 event
->event_class
));
708 timestamp_field
= bt_ctf_field_structure_get_field(event
->event_header
,
710 if (timestamp_field
) {
711 struct bt_ctf_field_type
*timestamp_field_type
=
712 bt_ctf_field_get_type(timestamp_field
);
713 struct bt_ctf_clock
*mapped_clock
;
715 assert(timestamp_field_type
);
716 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
717 timestamp_field_type
);
718 bt_put(timestamp_field_type
);
722 ret
= bt_ctf_clock_get_time(mapped_clock
, ×tamp
);
723 bt_put(mapped_clock
);
728 ret
= set_integer_field_value(timestamp_field
,
737 bt_put(timestamp_field
);
741 struct bt_ctf_event
*bt_ctf_event_copy(struct bt_ctf_event
*event
)
743 struct bt_ctf_event
*copy
= NULL
;
749 copy
= g_new0(struct bt_ctf_event
, 1);
754 bt_object_init(copy
, bt_ctf_event_destroy
);
755 copy
->event_class
= bt_get(event
->event_class
);
757 if (event
->event_header
) {
758 copy
->event_header
= bt_ctf_field_copy(event
->event_header
);
759 if (!copy
->event_header
) {
764 if (event
->stream_event_context
) {
765 copy
->stream_event_context
=
766 bt_ctf_field_copy(event
->stream_event_context
);
767 if (!copy
->stream_event_context
) {
772 if (event
->context_payload
) {
773 copy
->context_payload
= bt_ctf_field_copy(
774 event
->context_payload
);
775 if (!copy
->context_payload
) {
780 if (event
->fields_payload
) {
781 copy
->fields_payload
= bt_ctf_field_copy(event
->fields_payload
);
782 if (!copy
->fields_payload
) {
794 int bt_ctf_event_set_packet(struct bt_ctf_event
*event
,
795 struct bt_ctf_packet
*packet
)
797 struct bt_ctf_stream
*stream
= NULL
;
800 if (!event
|| !packet
|| event
->frozen
) {
806 * Make sure the new packet was created by this event's
807 * stream, if it is set.
809 stream
= bt_ctf_event_get_stream(event
);
811 if (packet
->stream
!= stream
) {
816 /* Set the event's parent to the packet's stream */
817 bt_object_set_parent(event
, packet
->stream
);
820 bt_put(event
->packet
);
821 event
->packet
= bt_get(packet
);
830 void bt_ctf_event_freeze(struct bt_ctf_event
*event
)
833 bt_ctf_packet_freeze(event
->packet
);
834 bt_ctf_field_freeze(event
->event_header
);
835 bt_ctf_field_freeze(event
->stream_event_context
);
836 bt_ctf_field_freeze(event
->context_payload
);
837 bt_ctf_field_freeze(event
->fields_payload
);