Commit | Line | Data |
---|---|---|
adc315b8 JG |
1 | #ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H |
2 | #define BABELTRACE_CTF_IR_EVENT_INTERNAL_H | |
273b65be JG |
3 | |
4 | /* | |
272df73e | 5 | * Babeltrace - CTF IR: Event internal |
273b65be | 6 | * |
de9dd397 | 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
21 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
22 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
23 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
24 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
25 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
26 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
3dca2276 | 30 | #include <babeltrace/assert-pre-internal.h> |
273b65be | 31 | #include <babeltrace/babeltrace-internal.h> |
dac5c838 | 32 | #include <babeltrace/values.h> |
123fbdec JG |
33 | #include <babeltrace/ctf-ir/stream-class.h> |
34 | #include <babeltrace/ctf-ir/stream.h> | |
5c3b707d | 35 | #include <babeltrace/ctf-ir/packet.h> |
3dca2276 PP |
36 | #include <babeltrace/ctf-ir/fields.h> |
37 | #include <babeltrace/ctf-ir/fields-internal.h> | |
38 | #include <babeltrace/ctf-ir/event-class-internal.h> | |
312c056a | 39 | #include <babeltrace/ctf-ir/field-wrapper-internal.h> |
3dca2276 | 40 | #include <babeltrace/ctf-ir/validation-internal.h> |
83509119 | 41 | #include <babeltrace/object-internal.h> |
f6ccaed9 | 42 | #include <babeltrace/assert-internal.h> |
273b65be JG |
43 | #include <glib.h> |
44 | ||
50842bdc | 45 | struct bt_stream_pos; |
dc3fffef | 46 | |
3dca2276 | 47 | struct bt_event_common { |
83509119 | 48 | struct bt_object base; |
3dca2276 | 49 | struct bt_event_class_common *class; |
312c056a | 50 | struct bt_field_wrapper *header_field; |
3dca2276 PP |
51 | struct bt_field_common *stream_event_context_field; |
52 | struct bt_field_common *context_field; | |
53 | struct bt_field_common *payload_field; | |
54 | int frozen; | |
55 | }; | |
56 | ||
57 | struct bt_event { | |
58 | struct bt_event_common common; | |
59 | ||
50842bdc | 60 | /* Maps clock classes to bt_clock_value. */ |
1556a1af | 61 | GHashTable *clock_values; |
3dca2276 | 62 | struct bt_packet *packet; |
273b65be JG |
63 | }; |
64 | ||
273b65be | 65 | BT_HIDDEN |
3dca2276 | 66 | int _bt_event_common_validate(struct bt_event_common *event); |
273b65be | 67 | |
4ce9f9d0 | 68 | BT_HIDDEN |
3dca2276 | 69 | void _bt_event_common_freeze(struct bt_event_common *event); |
4ce9f9d0 | 70 | |
f6ccaed9 PP |
71 | BT_HIDDEN |
72 | void _bt_event_freeze(struct bt_event *event); | |
73 | ||
74 | #ifdef BT_DEV_MODE | |
3dca2276 PP |
75 | # define bt_event_common_validate _bt_event_common_validate |
76 | # define bt_event_common_freeze _bt_event_common_freeze | |
77 | # define bt_event_freeze _bt_event_freeze | |
f6ccaed9 | 78 | #else |
3dca2276 PP |
79 | # define bt_event_common_validate(_event) 0 |
80 | # define bt_event_common_freeze(_event) | |
f6ccaed9 PP |
81 | # define bt_event_freeze(_event) |
82 | #endif | |
83 | ||
3dca2276 PP |
84 | #define BT_ASSERT_PRE_EVENT_COMMON_HOT(_event, _name) \ |
85 | BT_ASSERT_PRE_HOT((_event), (_name), ": +%!+_e", (_event)) | |
86 | ||
dc3fffef | 87 | static inline |
3dca2276 PP |
88 | struct bt_event_class_common *bt_event_common_borrow_class( |
89 | struct bt_event_common *event) | |
dc3fffef | 90 | { |
f6ccaed9 | 91 | BT_ASSERT(event); |
3dca2276 PP |
92 | return event->class; |
93 | } | |
94 | ||
2dd764c1 PP |
95 | typedef void *(*create_field_func)(void *); |
96 | typedef void (*release_field_func)(void *); | |
97 | typedef void *(*create_header_field_func)(void *, void *); | |
98 | typedef void (*release_header_field_func)(void *, void *); | |
99 | ||
3dca2276 PP |
100 | BT_HIDDEN |
101 | int bt_event_common_initialize(struct bt_event_common *event, | |
102 | struct bt_event_class_common *event_class, | |
103 | struct bt_clock_class *init_expected_clock_class, | |
104 | bt_object_release_func release_func, | |
105 | bt_validation_flag_copy_field_type_func field_type_copy_func, | |
106 | bool must_be_in_trace, | |
107 | int (*map_clock_classes_func)(struct bt_stream_class_common *stream_class, | |
108 | struct bt_field_type_common *packet_context_field_type, | |
109 | struct bt_field_type_common *event_header_field_type), | |
2dd764c1 PP |
110 | create_field_func create_field_func, |
111 | release_field_func release_field_func, | |
112 | create_header_field_func create_header_field_func, | |
113 | release_header_field_func release_header_field_func); | |
3dca2276 PP |
114 | |
115 | static inline | |
094ff7c0 | 116 | struct bt_field_common *bt_event_common_borrow_payload( |
3dca2276 PP |
117 | struct bt_event_common *event) |
118 | { | |
119 | struct bt_field_common *payload = NULL; | |
120 | ||
121 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
122 | ||
123 | if (!event->payload_field) { | |
124 | BT_LOGV("Event has no current payload field: addr=%p, " | |
125 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
126 | event, bt_event_class_common_get_name(event->class), | |
127 | bt_event_class_common_get_id(event->class)); | |
128 | goto end; | |
129 | } | |
130 | ||
131 | payload = event->payload_field; | |
3dca2276 PP |
132 | |
133 | end: | |
134 | return payload; | |
135 | } | |
136 | ||
3dca2276 | 137 | static inline |
094ff7c0 | 138 | struct bt_field_common *bt_event_common_borrow_header( |
3dca2276 PP |
139 | struct bt_event_common *event) |
140 | { | |
141 | struct bt_field_common *header = NULL; | |
142 | ||
143 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
144 | ||
145 | if (!event->header_field) { | |
146 | BT_LOGV("Event has no current header field: addr=%p, " | |
147 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
148 | event, bt_event_class_common_get_name(event->class), | |
149 | bt_event_class_common_get_id(event->class)); | |
150 | goto end; | |
151 | } | |
152 | ||
312c056a | 153 | header = event->header_field->field; |
3dca2276 PP |
154 | |
155 | end: | |
156 | return header; | |
157 | } | |
158 | ||
3dca2276 | 159 | static inline |
094ff7c0 | 160 | struct bt_field_common *bt_event_common_borrow_context( |
3dca2276 PP |
161 | struct bt_event_common *event) |
162 | { | |
163 | struct bt_field_common *context = NULL; | |
164 | ||
165 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
166 | ||
167 | if (!event->context_field) { | |
168 | BT_LOGV("Event has no current context field: addr=%p, " | |
169 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
170 | event, bt_event_class_common_get_name(event->class), | |
171 | bt_event_class_common_get_id(event->class)); | |
172 | goto end; | |
173 | } | |
174 | ||
175 | context = event->context_field; | |
3dca2276 PP |
176 | |
177 | end: | |
178 | return context; | |
179 | } | |
180 | ||
3dca2276 | 181 | static inline |
094ff7c0 | 182 | struct bt_field_common *bt_event_common_borrow_stream_event_context( |
3dca2276 PP |
183 | struct bt_event_common *event) |
184 | { | |
185 | struct bt_field_common *stream_event_context = NULL; | |
186 | ||
187 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
188 | ||
189 | if (!event->stream_event_context_field) { | |
190 | BT_LOGV("Event has no current stream event context field: addr=%p, " | |
191 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
192 | event, bt_event_class_common_get_name(event->class), | |
193 | bt_event_class_common_get_id(event->class)); | |
194 | goto end; | |
195 | } | |
196 | ||
197 | stream_event_context = event->stream_event_context_field; | |
198 | ||
199 | end: | |
094ff7c0 | 200 | return stream_event_context; |
3dca2276 PP |
201 | } |
202 | ||
203 | static inline | |
312c056a PP |
204 | void bt_event_common_finalize(struct bt_object *obj, |
205 | void (*field_release_func)(void *), | |
206 | void (*header_field_release_func)(void *, struct bt_event_common *)) | |
3dca2276 PP |
207 | { |
208 | struct bt_event_common *event = (void *) obj; | |
209 | ||
210 | BT_LOGD("Destroying event: addr=%p, " | |
211 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
312c056a PP |
212 | event, |
213 | event->class ? bt_event_class_common_get_name(event->class) : NULL, | |
214 | event->class ? bt_event_class_common_get_id(event->class) : INT64_C(-1)); | |
215 | ||
216 | if (event->header_field) { | |
217 | BT_LOGD_STR("Releasing event's header field."); | |
218 | header_field_release_func(event->header_field, event); | |
219 | } | |
220 | ||
221 | if (event->stream_event_context_field) { | |
222 | BT_LOGD_STR("Releasing event's stream event context field."); | |
223 | field_release_func(event->stream_event_context_field); | |
224 | } | |
225 | ||
226 | if (event->context_field) { | |
227 | BT_LOGD_STR("Releasing event's context field."); | |
228 | field_release_func(event->context_field); | |
229 | } | |
230 | ||
231 | if (event->payload_field) { | |
232 | BT_LOGD_STR("Releasing event's payload field."); | |
233 | field_release_func(event->payload_field); | |
234 | } | |
3dca2276 | 235 | |
312c056a PP |
236 | /* |
237 | * Leave this after calling header_field_release_func() because | |
238 | * this function receives the event object and could need its | |
239 | * class to perform some cleanup. | |
240 | */ | |
3dca2276 PP |
241 | if (!event->base.parent) { |
242 | /* | |
243 | * Event was keeping a reference to its class since it shared no | |
244 | * common ancestor with it to guarantee they would both have the | |
245 | * same lifetime. | |
246 | */ | |
247 | bt_put(event->class); | |
248 | } | |
dc3fffef PP |
249 | } |
250 | ||
312c056a PP |
251 | BT_HIDDEN |
252 | struct bt_event *bt_event_new(struct bt_event_class *event_class); | |
253 | ||
254 | BT_HIDDEN | |
255 | struct bt_event *bt_event_create(struct bt_event_class *event_class, | |
256 | struct bt_packet *packet); | |
257 | ||
258 | BT_HIDDEN | |
259 | void bt_event_recycle(struct bt_event *event); | |
260 | ||
261 | BT_HIDDEN | |
262 | void bt_event_destroy(struct bt_event *event); | |
263 | ||
264 | BT_HIDDEN | |
265 | int bt_event_set_packet(struct bt_event *event, struct bt_packet *packet); | |
266 | ||
adc315b8 | 267 | #endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */ |