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 "common/assert.h"
32 #include "common/macros.h"
33 #include <babeltrace2-ctf-writer/field-types.h>
34 #include <babeltrace2-ctf-writer/fields.h>
35 #include <babeltrace2-ctf-writer/stream-class.h>
36 #include <babeltrace2-ctf-writer/stream.h>
37 #include "ctfser/ctfser.h"
39 #include "assert-pre.h"
40 #include "event-class.h"
43 #include "field-wrapper.h"
46 #include "validation.h"
49 struct bt_ctf_stream_class
;
50 struct bt_ctf_stream_pos
;
51 struct metadata_context
;
53 struct bt_ctf_event_common
{
54 struct bt_ctf_object base
;
55 struct bt_ctf_event_class_common
*class;
56 struct bt_ctf_field_wrapper
*header_field
;
57 struct bt_ctf_field_common
*stream_event_context_field
;
58 struct bt_ctf_field_common
*context_field
;
59 struct bt_ctf_field_common
*payload_field
;
64 int _bt_ctf_event_common_validate(struct bt_ctf_event_common
*event
);
67 void _bt_ctf_event_common_set_is_frozen(struct bt_ctf_event_common
*event
,
71 # define bt_ctf_event_common_validate _bt_ctf_event_common_validate
72 # define bt_ctf_event_common_set_is_frozen _bt_ctf_event_common_set_is_frozen
74 # define bt_ctf_event_common_validate(_event) 0
75 # define bt_ctf_event_common_set_is_frozen(_event, _is_frozen)
78 #define BT_CTF_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name) \
79 BT_CTF_ASSERT_PRE_HOT((_event), (_name), ": event-addr=%p", (_event))
82 struct bt_ctf_event_class_common
*bt_ctf_event_common_borrow_class(
83 struct bt_ctf_event_common
*event
)
89 typedef void *(*create_field_func_type
)(void *);
90 typedef void (*release_field_func_type
)(void *);
91 typedef void *(*create_header_field_func_type
)(void *, void *);
92 typedef void (*release_header_field_func_type
)(void *, void *);
95 int bt_ctf_event_common_initialize(struct bt_ctf_event_common
*event
,
96 struct bt_ctf_event_class_common
*event_class
,
97 struct bt_ctf_clock_class
*init_expected_clock_class
,
98 bool is_shared_with_parent
, bt_ctf_object_release_func release_func
,
99 bt_ctf_validation_flag_copy_field_type_func field_type_copy_func
,
100 bool must_be_in_trace
,
101 int (*map_clock_classes_func
)(struct bt_ctf_stream_class_common
*stream_class
,
102 struct bt_ctf_field_type_common
*packet_context_field_type
,
103 struct bt_ctf_field_type_common
*event_header_field_type
),
104 create_field_func_type create_field_func
,
105 release_field_func_type release_field_func
,
106 create_header_field_func_type create_header_field_func
,
107 release_header_field_func_type release_header_field_func
);
110 int bt_ctf_event_common_set_payload(struct bt_ctf_event
*event
,
111 struct bt_ctf_field
*payload
);
114 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_payload(
115 struct bt_ctf_event_common
*event
)
117 struct bt_ctf_field_common
*payload
= NULL
;
119 BT_CTF_ASSERT_PRE_NON_NULL(event
, "Event");
121 if (!event
->payload_field
) {
122 BT_LOGT("Event has no current payload field: addr=%p, "
123 "event-class-name=\"%s\", event-class-id=%" PRId64
,
124 event
, bt_ctf_event_class_common_get_name(event
->class),
125 bt_ctf_event_class_common_get_id(event
->class));
129 payload
= event
->payload_field
;
136 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_header(
137 struct bt_ctf_event_common
*event
)
139 struct bt_ctf_field_common
*header
= NULL
;
141 BT_CTF_ASSERT_PRE_NON_NULL(event
, "Event");
143 if (!event
->header_field
) {
144 BT_LOGT("Event has no current header field: addr=%p, "
145 "event-class-name=\"%s\", event-class-id=%" PRId64
,
146 event
, bt_ctf_event_class_common_get_name(event
->class),
147 bt_ctf_event_class_common_get_id(event
->class));
151 header
= event
->header_field
->field
;
158 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_context(
159 struct bt_ctf_event_common
*event
)
161 struct bt_ctf_field_common
*context
= NULL
;
163 BT_CTF_ASSERT_PRE_NON_NULL(event
, "Event");
165 if (!event
->context_field
) {
166 BT_LOGT("Event has no current context field: addr=%p, "
167 "event-class-name=\"%s\", event-class-id=%" PRId64
,
168 event
, bt_ctf_event_class_common_get_name(event
->class),
169 bt_ctf_event_class_common_get_id(event
->class));
173 context
= event
->context_field
;
180 struct bt_ctf_field_common
*bt_ctf_event_common_borrow_stream_event_context(
181 struct bt_ctf_event_common
*event
)
183 struct bt_ctf_field_common
*stream_event_context
= NULL
;
185 BT_CTF_ASSERT_PRE_NON_NULL(event
, "Event");
187 if (!event
->stream_event_context_field
) {
188 BT_LOGT("Event has no current stream event context field: addr=%p, "
189 "event-class-name=\"%s\", event-class-id=%" PRId64
,
190 event
, bt_ctf_event_class_common_get_name(event
->class),
191 bt_ctf_event_class_common_get_id(event
->class));
195 stream_event_context
= event
->stream_event_context_field
;
198 return stream_event_context
;
202 void bt_ctf_event_common_finalize(struct bt_ctf_object
*obj
,
203 void (*field_release_func
)(void *),
204 void (*header_field_release_func
)(void *, struct bt_ctf_event_common
*))
206 struct bt_ctf_event_common
*event
= (void *) obj
;
208 BT_LOGD("Destroying event: addr=%p, "
209 "event-class-name=\"%s\", event-class-id=%" PRId64
,
211 event
->class ? bt_ctf_event_class_common_get_name(event
->class) : NULL
,
212 event
->class ? bt_ctf_event_class_common_get_id(event
->class) : INT64_C(-1));
214 if (event
->header_field
) {
215 BT_LOGD_STR("Releasing event's header field.");
216 header_field_release_func(event
->header_field
, event
);
219 if (event
->stream_event_context_field
) {
220 BT_LOGD_STR("Releasing event's stream event context field.");
221 field_release_func(event
->stream_event_context_field
);
224 if (event
->context_field
) {
225 BT_LOGD_STR("Releasing event's context field.");
226 field_release_func(event
->context_field
);
229 if (event
->payload_field
) {
230 BT_LOGD_STR("Releasing event's payload field.");
231 field_release_func(event
->payload_field
);
235 * Leave this after calling header_field_release_func() because
236 * this function receives the event object and could need its
237 * class to perform some cleanup.
239 if (!event
->base
.parent
) {
241 * Event was keeping a reference to its class since it shared no
242 * common ancestor with it to guarantee they would both have the
245 bt_ctf_object_put_ref(event
->class);
249 struct bt_ctf_event
{
250 struct bt_ctf_event_common common
;
253 struct bt_ctf_event_class
{
254 struct bt_ctf_event_class_common common
;
258 int bt_ctf_event_class_serialize(struct bt_ctf_event_class
*event_class
,
259 struct metadata_context
*context
);
262 int bt_ctf_event_serialize(struct bt_ctf_event
*event
,
263 struct bt_ctfser
*pos
,
264 enum bt_ctf_byte_order native_byte_order
);
267 struct bt_ctf_stream_class
*bt_ctf_event_class_borrow_stream_class(
268 struct bt_ctf_event_class
*event_class
)
270 return BT_CTF_FROM_COMMON(bt_ctf_event_class_common_borrow_stream_class(
271 BT_CTF_TO_COMMON(event_class
)));
274 #endif /* BABELTRACE_CTF_WRITER_EVENT_INTERNAL_H */