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/clock-internal.h>
32 #include <babeltrace/ctf-ir/event-internal.h>
33 #include <babeltrace/ctf-ir/event-class.h>
34 #include <babeltrace/ctf-ir/event-class-internal.h>
35 #include <babeltrace/ctf-ir/stream-class.h>
36 #include <babeltrace/ctf-ir/stream-class-internal.h>
37 #include <babeltrace/ctf-ir/stream-internal.h>
38 #include <babeltrace/ctf-ir/packet.h>
39 #include <babeltrace/ctf-ir/packet-internal.h>
40 #include <babeltrace/ctf-ir/trace-internal.h>
41 #include <babeltrace/ctf-ir/validation-internal.h>
42 #include <babeltrace/ctf-ir/packet-internal.h>
43 #include <babeltrace/ctf-ir/utils.h>
44 #include <babeltrace/ref.h>
45 #include <babeltrace/ctf-ir/attributes-internal.h>
46 #include <babeltrace/compiler.h>
49 void bt_ctf_event_destroy(struct bt_object
*obj
);
51 int set_integer_field_value(struct bt_ctf_field
*field
, uint64_t value
);
53 struct bt_ctf_event
*bt_ctf_event_create(struct bt_ctf_event_class
*event_class
)
56 enum bt_ctf_validation_flag validation_flags
=
57 BT_CTF_VALIDATION_FLAG_STREAM
|
58 BT_CTF_VALIDATION_FLAG_EVENT
;
59 struct bt_ctf_event
*event
= NULL
;
60 struct bt_ctf_trace
*trace
= NULL
;
61 struct bt_ctf_stream_class
*stream_class
= NULL
;
62 struct bt_ctf_field_type
*packet_header_type
= NULL
;
63 struct bt_ctf_field_type
*packet_context_type
= NULL
;
64 struct bt_ctf_field_type
*event_header_type
= NULL
;
65 struct bt_ctf_field_type
*stream_event_ctx_type
= NULL
;
66 struct bt_ctf_field_type
*event_context_type
= NULL
;
67 struct bt_ctf_field_type
*event_payload_type
= NULL
;
68 struct bt_ctf_field
*event_header
= NULL
;
69 struct bt_ctf_field
*stream_event_context
= NULL
;
70 struct bt_ctf_field
*event_context
= NULL
;
71 struct bt_ctf_field
*event_payload
= NULL
;
72 struct bt_value
*environment
= NULL
;
73 struct bt_ctf_validation_output validation_output
= { 0 };
80 stream_class
= bt_ctf_event_class_get_stream_class(event_class
);
83 * We disallow the creation of an event if its event class has not been
84 * associated to a stream class.
90 /* A stream class should always have an existing event header type */
91 assert(stream_class
->event_header_type
);
93 /* The event class was frozen when added to its stream class */
94 assert(event_class
->frozen
);
96 /* Validate the trace (if any), the stream class, and the event class */
97 trace
= bt_ctf_stream_class_get_trace(stream_class
);
99 packet_header_type
= bt_ctf_trace_get_packet_header_type(trace
);
100 trace_valid
= trace
->valid
;
102 environment
= trace
->environment
;
105 packet_context_type
= bt_ctf_stream_class_get_packet_context_type(
107 event_header_type
= bt_ctf_stream_class_get_event_header_type(
109 stream_event_ctx_type
= bt_ctf_stream_class_get_event_context_type(
111 event_context_type
= bt_ctf_event_class_get_context_type(event_class
);
112 event_payload_type
= bt_ctf_event_class_get_payload_type(event_class
);
113 ret
= bt_ctf_validate_class_types(environment
, packet_header_type
,
114 packet_context_type
, event_header_type
, stream_event_ctx_type
,
115 event_context_type
, event_payload_type
, trace_valid
,
116 stream_class
->valid
, event_class
->valid
,
117 &validation_output
, validation_flags
);
118 BT_PUT(packet_header_type
);
119 BT_PUT(packet_context_type
);
120 BT_PUT(event_header_type
);
121 BT_PUT(stream_event_ctx_type
);
122 BT_PUT(event_context_type
);
123 BT_PUT(event_payload_type
);
126 * This means something went wrong during the validation
127 * process, not that the objects are invalid.
132 if ((validation_output
.valid_flags
& validation_flags
) !=
134 /* Invalid trace/stream class/event class */
139 * At this point we know the trace (if associated to the stream
140 * class), the stream class, and the event class, with their
141 * current types, are valid. We may proceed with creating
144 event
= g_new0(struct bt_ctf_event
, 1);
149 bt_object_init(event
, bt_ctf_event_destroy
);
152 * event does not share a common ancestor with the event class; it has
153 * to guarantee its existence by holding a reference. This reference
154 * shall be released once the event is associated to a stream since,
155 * from that point, the event and its class will share the same
158 event
->event_class
= bt_get(event_class
);
159 event
->clock_values
= g_hash_table_new_full(g_direct_hash
,
160 g_direct_equal
, bt_put
, bt_put
);
162 bt_ctf_field_create(validation_output
.event_header_type
);
167 if (validation_output
.stream_event_ctx_type
) {
168 stream_event_context
= bt_ctf_field_create(
169 validation_output
.stream_event_ctx_type
);
170 if (!stream_event_context
) {
175 if (validation_output
.event_context_type
) {
176 event_context
= bt_ctf_field_create(
177 validation_output
.event_context_type
);
178 if (!event_context
) {
183 if (validation_output
.event_payload_type
) {
184 event_payload
= bt_ctf_field_create(
185 validation_output
.event_payload_type
);
186 if (!event_payload
) {
192 * At this point all the fields are created, potentially from
193 * validated copies of field types, so that the field types and
194 * fields can be replaced in the trace, stream class,
195 * event class, and created event.
197 bt_ctf_validation_replace_types(trace
, stream_class
,
198 event_class
, &validation_output
, validation_flags
);
199 BT_MOVE(event
->event_header
, event_header
);
200 BT_MOVE(event
->stream_event_context
, stream_event_context
);
201 BT_MOVE(event
->context_payload
, event_context
);
202 BT_MOVE(event
->fields_payload
, event_payload
);
205 * Put what was not moved in bt_ctf_validation_replace_types().
207 bt_ctf_validation_output_put_types(&validation_output
);
210 * Freeze the stream class since the event header must not be changed
213 bt_ctf_stream_class_freeze(stream_class
);
216 * Mark stream class, and event class as valid since
217 * they're all frozen now.
219 stream_class
->valid
= 1;
220 event_class
->valid
= 1;
222 /* Put stuff we borrowed from the event class */
223 BT_PUT(stream_class
);
229 bt_ctf_validation_output_put_types(&validation_output
);
231 BT_PUT(stream_class
);
233 BT_PUT(event_header
);
234 BT_PUT(stream_event_context
);
235 BT_PUT(event_context
);
236 BT_PUT(event_payload
);
237 assert(!packet_header_type
);
238 assert(!packet_context_type
);
239 assert(!event_header_type
);
240 assert(!stream_event_ctx_type
);
241 assert(!event_context_type
);
242 assert(!event_payload_type
);
247 struct bt_ctf_event_class
*bt_ctf_event_get_class(struct bt_ctf_event
*event
)
249 struct bt_ctf_event_class
*event_class
= NULL
;
255 event_class
= event
->event_class
;
261 struct bt_ctf_stream
*bt_ctf_event_get_stream(struct bt_ctf_event
*event
)
263 struct bt_ctf_stream
*stream
= NULL
;
270 * If the event has a parent, then this is its (writer) stream.
271 * If the event has no parent, then if it has a packet, this
272 * is its (non-writer) stream.
274 if (event
->base
.parent
) {
275 stream
= (struct bt_ctf_stream
*) bt_object_get_parent(event
);
278 stream
= bt_get(event
->packet
->stream
);
286 int bt_ctf_event_set_payload(struct bt_ctf_event
*event
,
288 struct bt_ctf_field
*payload
)
292 if (!event
|| !payload
|| event
->frozen
) {
298 ret
= bt_ctf_field_structure_set_field(event
->fields_payload
,
301 struct bt_ctf_field_type
*payload_type
;
303 payload_type
= bt_ctf_field_get_type(payload
);
305 if (bt_ctf_field_type_compare(payload_type
,
306 event
->event_class
->fields
) == 0) {
307 bt_put(event
->fields_payload
);
309 event
->fields_payload
= payload
;
314 bt_put(payload_type
);
320 struct bt_ctf_field
*bt_ctf_event_get_payload_field(struct bt_ctf_event
*event
)
322 struct bt_ctf_field
*payload
= NULL
;
324 if (!event
|| !event
->fields_payload
) {
328 payload
= event
->fields_payload
;
334 int bt_ctf_event_set_payload_field(struct bt_ctf_event
*event
,
335 struct bt_ctf_field
*payload
)
338 struct bt_ctf_field_type
*payload_type
= NULL
;
340 if (!event
|| !payload
|| event
->frozen
) {
345 payload_type
= bt_ctf_field_get_type(payload
);
351 if (bt_ctf_field_type_get_type_id(payload_type
) !=
352 BT_CTF_TYPE_ID_STRUCT
) {
358 bt_put(event
->fields_payload
);
359 event
->fields_payload
= payload
;
362 bt_put(payload_type
);
366 struct bt_ctf_field
*bt_ctf_event_get_payload(struct bt_ctf_event
*event
,
369 struct bt_ctf_field
*field
= NULL
;
376 field
= bt_ctf_field_structure_get_field(event
->fields_payload
,
379 field
= event
->fields_payload
;
386 struct bt_ctf_field
*bt_ctf_event_get_payload_by_index(
387 struct bt_ctf_event
*event
, int index
)
389 struct bt_ctf_field
*field
= NULL
;
391 if (!event
|| index
< 0) {
395 field
= bt_ctf_field_structure_get_field_by_index(event
->fields_payload
,
401 struct bt_ctf_field
*bt_ctf_event_get_header(
402 struct bt_ctf_event
*event
)
404 struct bt_ctf_field
*header
= NULL
;
406 if (!event
|| !event
->event_header
) {
410 header
= event
->event_header
;
416 int bt_ctf_event_set_header(struct bt_ctf_event
*event
,
417 struct bt_ctf_field
*header
)
420 struct bt_ctf_field_type
*field_type
= NULL
;
421 struct bt_ctf_stream_class
*stream_class
= NULL
;
423 if (!event
|| !header
|| event
->frozen
) {
428 stream_class
= (struct bt_ctf_stream_class
*) bt_object_get_parent(
431 * Ensure the provided header's type matches the one registered to the
434 field_type
= bt_ctf_field_get_type(header
);
435 if (bt_ctf_field_type_compare(field_type
,
436 stream_class
->event_header_type
)) {
442 bt_put(event
->event_header
);
443 event
->event_header
= header
;
445 bt_put(stream_class
);
450 struct bt_ctf_field
*bt_ctf_event_get_event_context(
451 struct bt_ctf_event
*event
)
453 struct bt_ctf_field
*context
= NULL
;
455 if (!event
|| !event
->context_payload
) {
459 context
= event
->context_payload
;
465 int bt_ctf_event_set_event_context(struct bt_ctf_event
*event
,
466 struct bt_ctf_field
*context
)
469 struct bt_ctf_field_type
*field_type
= NULL
;
471 if (!event
|| !context
|| event
->frozen
) {
476 field_type
= bt_ctf_field_get_type(context
);
477 if (bt_ctf_field_type_compare(field_type
,
478 event
->event_class
->context
)) {
484 bt_put(event
->context_payload
);
485 event
->context_payload
= context
;
491 struct bt_ctf_field
*bt_ctf_event_get_stream_event_context(
492 struct bt_ctf_event
*event
)
494 struct bt_ctf_field
*stream_event_context
= NULL
;
496 if (!event
|| !event
->stream_event_context
) {
500 stream_event_context
= event
->stream_event_context
;
502 return bt_get(stream_event_context
);
505 int bt_ctf_event_set_stream_event_context(struct bt_ctf_event
*event
,
506 struct bt_ctf_field
*stream_event_context
)
509 struct bt_ctf_field_type
*field_type
= NULL
;
510 struct bt_ctf_stream_class
*stream_class
= NULL
;
512 if (!event
|| !stream_event_context
|| event
->frozen
) {
517 stream_class
= bt_ctf_event_class_get_stream_class(event
->event_class
);
519 * We should not have been able to create the event without associating
520 * the event class to a stream class.
522 assert(stream_class
);
524 field_type
= bt_ctf_field_get_type(stream_event_context
);
525 if (bt_ctf_field_type_compare(field_type
,
526 stream_class
->event_context_type
)) {
531 bt_get(stream_event_context
);
532 BT_MOVE(event
->stream_event_context
, stream_event_context
);
534 BT_PUT(stream_class
);
539 void bt_ctf_event_get(struct bt_ctf_event
*event
)
544 void bt_ctf_event_put(struct bt_ctf_event
*event
)
549 void bt_ctf_event_destroy(struct bt_object
*obj
)
551 struct bt_ctf_event
*event
;
553 event
= container_of(obj
, struct bt_ctf_event
, base
);
554 if (!event
->base
.parent
) {
556 * Event was keeping a reference to its class since it shared no
557 * common ancestor with it to guarantee they would both have the
560 bt_put(event
->event_class
);
562 g_hash_table_destroy(event
->clock_values
);
563 bt_put(event
->event_header
);
564 bt_put(event
->stream_event_context
);
565 bt_put(event
->context_payload
);
566 bt_put(event
->fields_payload
);
567 bt_put(event
->packet
);
571 struct bt_ctf_clock_value
*bt_ctf_event_get_clock_value(
572 struct bt_ctf_event
*event
, struct bt_ctf_clock
*clock
)
574 struct bt_ctf_clock_value
*clock_value
= NULL
;
576 if (!event
|| !clock
) {
580 clock_value
= g_hash_table_lookup(event
->clock_values
, clock
);
590 int bt_ctf_event_set_clock_value(struct bt_ctf_event
*event
,
591 struct bt_ctf_clock
*clock
, struct bt_ctf_clock_value
*value
)
595 if (!event
|| !clock
|| !value
|| event
->frozen
) {
600 g_hash_table_insert(event
->clock_values
, bt_get(clock
), bt_get(value
));
606 int set_integer_field_value(struct bt_ctf_field
* field
, uint64_t value
)
609 struct bt_ctf_field_type
*field_type
= NULL
;
616 field_type
= bt_ctf_field_get_type(field
);
619 if (bt_ctf_field_type_get_type_id(field_type
) !=
620 BT_CTF_TYPE_ID_INTEGER
) {
621 /* Not an integer and the value is unset, error. */
626 if (bt_ctf_field_type_integer_get_signed(field_type
)) {
627 ret
= bt_ctf_field_signed_integer_set_value(field
, (int64_t) value
);
629 /* Value is out of range, error. */
633 ret
= bt_ctf_field_unsigned_integer_set_value(field
, value
);
635 /* Value is out of range, error. */
645 int bt_ctf_event_validate(struct bt_ctf_event
*event
)
647 /* Make sure each field's payload has been set */
649 struct bt_ctf_stream_class
*stream_class
= NULL
;
652 ret
= bt_ctf_field_validate(event
->event_header
);
657 stream_class
= bt_ctf_event_class_get_stream_class(event
->event_class
);
659 * We should not have been able to create the event without associating
660 * the event class to a stream class.
662 assert(stream_class
);
663 if (stream_class
->event_context_type
) {
664 ret
= bt_ctf_field_validate(event
->stream_event_context
);
670 ret
= bt_ctf_field_validate(event
->fields_payload
);
675 if (event
->event_class
->context
) {
676 ret
= bt_ctf_field_validate(event
->context_payload
);
679 bt_put(stream_class
);
684 int bt_ctf_event_serialize(struct bt_ctf_event
*event
,
685 struct ctf_stream_pos
*pos
)
691 if (event
->context_payload
) {
692 ret
= bt_ctf_field_serialize(event
->context_payload
, pos
);
698 if (event
->fields_payload
) {
699 ret
= bt_ctf_field_serialize(event
->fields_payload
, pos
);
709 int bt_ctf_event_populate_event_header(struct bt_ctf_event
*event
)
712 struct bt_ctf_field
*id_field
= NULL
, *timestamp_field
= NULL
;
713 struct bt_ctf_clock
*mapped_clock
= NULL
;
715 if (!event
|| event
->frozen
) {
720 id_field
= bt_ctf_field_structure_get_field(event
->event_header
, "id");
721 if (id_field
&& !bt_ctf_field_is_set(id_field
)) {
722 ret
= set_integer_field_value(id_field
,
723 (uint64_t) bt_ctf_event_class_get_id(
724 event
->event_class
));
730 timestamp_field
= bt_ctf_field_structure_get_field(event
->event_header
,
732 if (timestamp_field
&& !bt_ctf_field_is_set(timestamp_field
)) {
733 struct bt_ctf_field_type
*timestamp_field_type
=
734 bt_ctf_field_get_type(timestamp_field
);
736 assert(timestamp_field_type
);
737 mapped_clock
= bt_ctf_field_type_integer_get_mapped_clock(
738 timestamp_field_type
);
739 bt_put(timestamp_field_type
);
742 * Babeltrace 2.0 introduced a notion of per-event clock
743 * values which can be queried using a "clock" instance.
745 * However, the original CTF-Writer (BT 1.x) had a
746 * notion of per-stream clock which is sampled on
747 * a call to append an event to a stream.
749 * If the event has a clock value associated with the
750 * mapped clock, we ignore the pre-2.0 behaviour and
751 * populate the timestamp field using the clock value.
753 uint64_t timestamp
= 0;
754 struct bt_ctf_clock_value
*clock_value
;
756 clock_value
= bt_ctf_event_get_clock_value(event
,
759 ret
= bt_ctf_clock_value_get_value(clock_value
,
766 ret
= bt_ctf_clock_get_value(mapped_clock
,
773 ret
= set_integer_field_value(timestamp_field
,
782 bt_put(timestamp_field
);
783 bt_put(mapped_clock
);
787 struct bt_ctf_packet
*bt_ctf_event_get_packet(struct bt_ctf_event
*event
)
789 struct bt_ctf_packet
*packet
= NULL
;
791 if (!event
|| !event
->packet
) {
795 packet
= bt_get(event
->packet
);
800 int bt_ctf_event_set_packet(struct bt_ctf_event
*event
,
801 struct bt_ctf_packet
*packet
)
803 struct bt_ctf_stream_class
*event_stream_class
= NULL
;
804 struct bt_ctf_stream_class
*packet_stream_class
= NULL
;
805 struct bt_ctf_stream
*stream
= NULL
;
808 if (!event
|| !packet
|| event
->frozen
) {
814 * Make sure the new packet was created by this event's
815 * stream, if it is set.
817 stream
= bt_ctf_event_get_stream(event
);
819 if (packet
->stream
!= stream
) {
825 bt_ctf_event_class_get_stream_class(event
->event_class
);
826 packet_stream_class
=
827 bt_ctf_stream_get_class(packet
->stream
);
829 assert(event_stream_class
);
830 assert(packet_stream_class
);
832 if (event_stream_class
!= packet_stream_class
) {
839 BT_MOVE(event
->packet
, packet
);
843 BT_PUT(event_stream_class
);
844 BT_PUT(packet_stream_class
);
850 void bt_ctf_event_freeze(struct bt_ctf_event
*event
)
853 bt_ctf_packet_freeze(event
->packet
);
854 bt_ctf_field_freeze(event
->event_header
);
855 bt_ctf_field_freeze(event
->stream_event_context
);
856 bt_ctf_field_freeze(event
->context_payload
);
857 bt_ctf_field_freeze(event
->fields_payload
);