1 #ifndef BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
2 #define BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * The Common Trace Format (CTF) Specification is available at
28 * http://www.efficios.com/ctf
31 #include <babeltrace/assert-internal.h>
32 #include <babeltrace/assert-pre-internal.h>
33 #include <babeltrace/babeltrace-internal.h>
34 #include <babeltrace/ctf-writer/event-class-internal.h>
35 #include <babeltrace/ctf-writer/event-internal.h>
36 #include <babeltrace/ctf-writer/field-types.h>
37 #include <babeltrace/ctf-writer/field-wrapper-internal.h>
38 #include <babeltrace/ctf-writer/fields-internal.h>
39 #include <babeltrace/ctf-writer/fields.h>
40 #include <babeltrace/ctf-writer/stream-class.h>
41 #include <babeltrace/ctf-writer/stream-internal.h>
42 #include <babeltrace/ctf-writer/stream.h>
43 #include <babeltrace/ctf-writer/validation-internal.h>
44 #include <babeltrace/ctf-writer/object-internal.h>
45 #include <babeltrace/ctf-writer/values-internal.h>
46 #include <babeltrace/ctfser-internal.h>
48 struct bt_ctf_stream_class
;
49 struct bt_ctf_stream_pos
;
50 struct metadata_context
;
52 struct bt_ctf_event_common
{
53 struct bt_ctf_object base
;
54 struct bt_ctf_event_class_common
*class;
55 struct bt_ctf_field_wrapper
*header_field
;
56 struct bt_ctf_field_common
*stream_event_context_field
;
57 struct bt_ctf_field_common
*context_field
;
58 struct bt_ctf_field_common
*payload_field
;
63 int _bt_ctf_event_common_validate(struct bt_ctf_event_common
*event
);
66 void _bt_ctf_event_common_set_is_frozen(struct bt_ctf_event_common
*event
,
70 # define bt_ctf_event_common_validate _bt_ctf_event_common_validate
71 # define bt_ctf_event_common_set_is_frozen _bt_ctf_event_common_set_is_frozen
73 # define bt_ctf_event_common_validate(_event) 0
74 # define bt_ctf_event_common_set_is_frozen(_event, _is_frozen)
77 #define BT_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name) \
78 BT_ASSERT_PRE_HOT((_event), (_name), ": event-addr=%p", (_event))
81 struct bt_ctf_event_class_common
*bt_ctf_event_common_borrow_class(
82 struct bt_ctf_event_common
*event
)
88 typedef void *(*create_field_func
)(void *);
89 typedef void (*release_field_func
)(void *);
90 typedef void *(*create_header_field_func
)(void *, void *);
91 typedef void (*release_header_field_func
)(void *, void *);
94 int bt_ctf_event_common_initialize(struct bt_ctf_event_common
*event
,
95 struct bt_ctf_event_class_common
*event_class
,
96 struct bt_ctf_clock_class
*init_expected_clock_class
,
97 bool is_shared_with_parent
, bt_ctf_object_release_func release_func
,
98 bt_ctf_validation_flag_copy_field_type_func field_type_copy_func
,
99 bool must_be_in_trace
,
100 int (*map_clock_classes_func
)(struct bt_ctf_stream_class_common
*stream_class
,
101 struct bt_ctf_field_type_common
*packet_context_field_type
,
102 struct bt_ctf_field_type_common
*event_header_field_type
),
103 create_field_func create_field_func
,
104 release_field_func release_field_func
,
105 create_header_field_func create_header_field_func
,
106 release_header_field_func release_header_field_func
);
109 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_payload(
110 struct bt_ctf_event_common
*event
)
112 struct bt_ctf_field_common
*payload
= NULL
;
114 BT_ASSERT_PRE_NON_NULL(event
, "Event");
116 if (!event
->payload_field
) {
117 BT_LOGV("Event has no current payload field: addr=%p, "
118 "event-class-name=\"%s\", event-class-id=%" PRId64
,
119 event
, bt_ctf_event_class_common_get_name(event
->class),
120 bt_ctf_event_class_common_get_id(event
->class));
124 payload
= event
->payload_field
;
131 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_header(
132 struct bt_ctf_event_common
*event
)
134 struct bt_ctf_field_common
*header
= NULL
;
136 BT_ASSERT_PRE_NON_NULL(event
, "Event");
138 if (!event
->header_field
) {
139 BT_LOGV("Event has no current header field: addr=%p, "
140 "event-class-name=\"%s\", event-class-id=%" PRId64
,
141 event
, bt_ctf_event_class_common_get_name(event
->class),
142 bt_ctf_event_class_common_get_id(event
->class));
146 header
= event
->header_field
->field
;
153 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_context(
154 struct bt_ctf_event_common
*event
)
156 struct bt_ctf_field_common
*context
= NULL
;
158 BT_ASSERT_PRE_NON_NULL(event
, "Event");
160 if (!event
->context_field
) {
161 BT_LOGV("Event has no current context field: addr=%p, "
162 "event-class-name=\"%s\", event-class-id=%" PRId64
,
163 event
, bt_ctf_event_class_common_get_name(event
->class),
164 bt_ctf_event_class_common_get_id(event
->class));
168 context
= event
->context_field
;
175 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_stream_event_context(
176 struct bt_ctf_event_common
*event
)
178 struct bt_ctf_field_common
*stream_event_context
= NULL
;
180 BT_ASSERT_PRE_NON_NULL(event
, "Event");
182 if (!event
->stream_event_context_field
) {
183 BT_LOGV("Event has no current stream event context field: addr=%p, "
184 "event-class-name=\"%s\", event-class-id=%" PRId64
,
185 event
, bt_ctf_event_class_common_get_name(event
->class),
186 bt_ctf_event_class_common_get_id(event
->class));
190 stream_event_context
= event
->stream_event_context_field
;
193 return stream_event_context
;
197 void bt_ctf_event_common_finalize(struct bt_ctf_object
*obj
,
198 void (*field_release_func
)(void *),
199 void (*header_field_release_func
)(void *, struct bt_ctf_event_common
*))
201 struct bt_ctf_event_common
*event
= (void *) obj
;
203 BT_LOGD("Destroying event: addr=%p, "
204 "event-class-name=\"%s\", event-class-id=%" PRId64
,
206 event
->class ? bt_ctf_event_class_common_get_name(event
->class) : NULL
,
207 event
->class ? bt_ctf_event_class_common_get_id(event
->class) : INT64_C(-1));
209 if (event
->header_field
) {
210 BT_LOGD_STR("Releasing event's header field.");
211 header_field_release_func(event
->header_field
, event
);
214 if (event
->stream_event_context_field
) {
215 BT_LOGD_STR("Releasing event's stream event context field.");
216 field_release_func(event
->stream_event_context_field
);
219 if (event
->context_field
) {
220 BT_LOGD_STR("Releasing event's context field.");
221 field_release_func(event
->context_field
);
224 if (event
->payload_field
) {
225 BT_LOGD_STR("Releasing event's payload field.");
226 field_release_func(event
->payload_field
);
230 * Leave this after calling header_field_release_func() because
231 * this function receives the event object and could need its
232 * class to perform some cleanup.
234 if (!event
->base
.parent
) {
236 * Event was keeping a reference to its class since it shared no
237 * common ancestor with it to guarantee they would both have the
240 bt_ctf_object_put_ref(event
->class);
244 struct bt_ctf_event
{
245 struct bt_ctf_event_common common
;
248 struct bt_ctf_event_class
{
249 struct bt_ctf_event_class_common common
;
253 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
254 struct metadata_context
*context
);
257 int bt_ctf_event_serialize(struct bt_ctf_event
*event
,
258 struct bt_ctfser
*pos
,
259 enum bt_ctf_byte_order native_byte_order
);
262 struct bt_ctf_stream_class
*bt_ctf_event_class_borrow_stream_class(
263 struct bt_ctf_event_class
*event_class
)
265 return BT_CTF_FROM_COMMON(bt_ctf_event_class_common_borrow_stream_class(
266 BT_CTF_TO_COMMON(event_class
)));
269 #endif /* BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H */