Commit | Line | Data |
---|---|---|
273b65be JG |
1 | /* |
2 | * event.c | |
3 | * | |
d2dc44b6 | 4 | * Babeltrace CTF IR - Event |
273b65be | 5 | * |
de9dd397 | 6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
7 | * |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
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: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
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 | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
7b010242 PP |
29 | #define BT_LOG_TAG "EVENT" |
30 | #include <babeltrace/lib-logging-internal.h> | |
31 | ||
3dca2276 | 32 | #include <babeltrace/assert-pre-internal.h> |
2e33ac5a PP |
33 | #include <babeltrace/ctf-ir/fields-internal.h> |
34 | #include <babeltrace/ctf-ir/field-types-internal.h> | |
ac0c6bdd | 35 | #include <babeltrace/ctf-ir/clock-class.h> |
c057dea0 PP |
36 | #include <babeltrace/ctf-ir/clock-value.h> |
37 | #include <babeltrace/ctf-ir/clock-value-internal.h> | |
7b010242 | 38 | #include <babeltrace/ctf-ir/clock-class-internal.h> |
adc315b8 | 39 | #include <babeltrace/ctf-ir/event-internal.h> |
272df73e PP |
40 | #include <babeltrace/ctf-ir/event-class.h> |
41 | #include <babeltrace/ctf-ir/event-class-internal.h> | |
2f100782 | 42 | #include <babeltrace/ctf-ir/stream-class.h> |
c35a1669 | 43 | #include <babeltrace/ctf-ir/stream-class-internal.h> |
41ac640a | 44 | #include <babeltrace/ctf-ir/stream-internal.h> |
4ce9f9d0 PP |
45 | #include <babeltrace/ctf-ir/packet.h> |
46 | #include <babeltrace/ctf-ir/packet-internal.h> | |
3dca2276 | 47 | #include <babeltrace/ctf-ir/trace.h> |
bc37ae52 | 48 | #include <babeltrace/ctf-ir/trace-internal.h> |
09840de5 | 49 | #include <babeltrace/ctf-ir/validation-internal.h> |
5c3b707d | 50 | #include <babeltrace/ctf-ir/packet-internal.h> |
654c1444 | 51 | #include <babeltrace/ctf-ir/utils.h> |
83509119 | 52 | #include <babeltrace/ref.h> |
44e0a4f5 | 53 | #include <babeltrace/ctf-ir/attributes-internal.h> |
3d9990ac | 54 | #include <babeltrace/compiler-internal.h> |
f6ccaed9 | 55 | #include <babeltrace/assert-internal.h> |
7b010242 | 56 | #include <inttypes.h> |
273b65be | 57 | |
3dca2276 PP |
58 | static |
59 | int bt_event_common_validate_types_for_create( | |
60 | struct bt_event_class_common *event_class, | |
61 | struct bt_validation_output *validation_output, | |
62 | bt_validation_flag_copy_field_type_func copy_field_type_func) | |
273b65be | 63 | { |
09840de5 | 64 | int ret; |
50842bdc PP |
65 | enum bt_validation_flag validation_flags = |
66 | BT_VALIDATION_FLAG_STREAM | | |
67 | BT_VALIDATION_FLAG_EVENT; | |
3dca2276 PP |
68 | struct bt_trace_common *trace = NULL; |
69 | struct bt_stream_class_common *stream_class = NULL; | |
70 | struct bt_field_type_common *packet_header_type = NULL; | |
71 | struct bt_field_type_common *packet_context_type = NULL; | |
72 | struct bt_field_type_common *event_header_type = NULL; | |
73 | struct bt_field_type_common *stream_event_ctx_type = NULL; | |
74 | struct bt_field_type_common *event_context_type = NULL; | |
75 | struct bt_field_type_common *event_payload_type = NULL; | |
09840de5 | 76 | int trace_valid = 0; |
3dca2276 | 77 | struct bt_value *environment = NULL; |
2a3ced3c | 78 | |
3dca2276 PP |
79 | stream_class = bt_event_class_common_borrow_stream_class(event_class); |
80 | BT_ASSERT(stream_class); | |
81 | trace = bt_stream_class_common_borrow_trace(stream_class); | |
09840de5 | 82 | if (trace) { |
3dca2276 | 83 | BT_LOGD_STR("Event class is part of a trace."); |
094ff7c0 PP |
84 | packet_header_type = |
85 | bt_trace_common_borrow_packet_header_field_type(trace); | |
09840de5 | 86 | trace_valid = trace->valid; |
f6ccaed9 | 87 | BT_ASSERT(trace_valid); |
09840de5 PP |
88 | environment = trace->environment; |
89 | } | |
90 | ||
094ff7c0 PP |
91 | packet_context_type = |
92 | bt_stream_class_common_borrow_packet_context_field_type( | |
93 | stream_class); | |
94 | event_header_type = | |
95 | bt_stream_class_common_borrow_event_header_field_type( | |
96 | stream_class); | |
97 | stream_event_ctx_type = | |
98 | bt_stream_class_common_borrow_event_context_field_type( | |
99 | stream_class); | |
100 | event_context_type = | |
101 | bt_event_class_common_borrow_context_field_type(event_class); | |
102 | event_payload_type = | |
103 | bt_event_class_common_borrow_payload_field_type(event_class); | |
50842bdc | 104 | ret = bt_validate_class_types(environment, packet_header_type, |
09840de5 PP |
105 | packet_context_type, event_header_type, stream_event_ctx_type, |
106 | event_context_type, event_payload_type, trace_valid, | |
107 | stream_class->valid, event_class->valid, | |
3dca2276 | 108 | validation_output, validation_flags, copy_field_type_func); |
09840de5 PP |
109 | if (ret) { |
110 | /* | |
111 | * This means something went wrong during the validation | |
112 | * process, not that the objects are invalid. | |
113 | */ | |
e0bcd1b0 | 114 | BT_LOGE("Failed to validate event and parents: ret=%d", ret); |
09840de5 PP |
115 | goto error; |
116 | } | |
117 | ||
3dca2276 | 118 | if ((validation_output->valid_flags & validation_flags) != |
09840de5 PP |
119 | validation_flags) { |
120 | /* Invalid trace/stream class/event class */ | |
3ee09f3a | 121 | BT_LOGW("Invalid trace, stream class, or event class: " |
3dca2276 | 122 | "valid-flags=0x%x", validation_output->valid_flags); |
09840de5 PP |
123 | goto error; |
124 | } | |
125 | ||
3dca2276 | 126 | goto end; |
0c1fafed | 127 | |
3dca2276 PP |
128 | error: |
129 | bt_validation_output_put_types(validation_output); | |
130 | ret = -1; | |
b8248cc0 | 131 | |
3dca2276 | 132 | end: |
3dca2276 PP |
133 | return ret; |
134 | } | |
09840de5 | 135 | |
3dca2276 PP |
136 | static |
137 | int bt_event_common_create_fields( | |
312c056a | 138 | struct bt_stream_class_common *stream_class, |
3dca2276 | 139 | struct bt_validation_output *validation_output, |
2dd764c1 PP |
140 | create_field_func create_field_func, |
141 | release_field_func release_field_func, | |
142 | create_header_field_func create_header_field_func, | |
143 | release_header_field_func release_header_field_func, | |
312c056a | 144 | struct bt_field_wrapper **header_field, |
3dca2276 PP |
145 | struct bt_field_common **stream_event_context_field, |
146 | struct bt_field_common **context_field, | |
147 | struct bt_field_common **payload_field) | |
148 | { | |
149 | int ret = 0; | |
be514b0c | 150 | |
3dca2276 | 151 | if (validation_output->event_header_type) { |
be514b0c | 152 | BT_LOGD("Creating initial event header field: ft-addr=%p", |
3dca2276 PP |
153 | validation_output->event_header_type); |
154 | *header_field = | |
312c056a PP |
155 | create_header_field_func(stream_class, |
156 | validation_output->event_header_type); | |
3dca2276 | 157 | if (!*header_field) { |
be514b0c PP |
158 | BT_LOGE_STR("Cannot create initial event header field object."); |
159 | goto error; | |
160 | } | |
662e778c | 161 | } |
09840de5 | 162 | |
3dca2276 | 163 | if (validation_output->stream_event_ctx_type) { |
be514b0c | 164 | BT_LOGD("Creating initial stream event context field: ft-addr=%p", |
3dca2276 PP |
165 | validation_output->stream_event_ctx_type); |
166 | *stream_event_context_field = create_field_func( | |
167 | validation_output->stream_event_ctx_type); | |
168 | if (!*stream_event_context_field) { | |
7b010242 | 169 | BT_LOGE_STR("Cannot create initial stream event context field object."); |
5fd2e9fd PP |
170 | goto error; |
171 | } | |
172 | } | |
173 | ||
3dca2276 | 174 | if (validation_output->event_context_type) { |
be514b0c | 175 | BT_LOGD("Creating initial event context field: ft-addr=%p", |
3dca2276 PP |
176 | validation_output->event_context_type); |
177 | *context_field = create_field_func( | |
178 | validation_output->event_context_type); | |
179 | if (!*context_field) { | |
7b010242 | 180 | BT_LOGE_STR("Cannot create initial event context field object."); |
83509119 | 181 | goto error; |
662e778c | 182 | } |
f655a84d | 183 | } |
09840de5 | 184 | |
3dca2276 | 185 | if (validation_output->event_payload_type) { |
be514b0c | 186 | BT_LOGD("Creating initial event payload field: ft-addr=%p", |
3dca2276 PP |
187 | validation_output->event_payload_type); |
188 | *payload_field = create_field_func( | |
189 | validation_output->event_payload_type); | |
190 | if (!*payload_field) { | |
7b010242 | 191 | BT_LOGE_STR("Cannot create initial event payload field object."); |
09840de5 PP |
192 | goto error; |
193 | } | |
662e778c JG |
194 | } |
195 | ||
3dca2276 PP |
196 | goto end; |
197 | ||
198 | error: | |
312c056a | 199 | if (*header_field) { |
2dd764c1 | 200 | release_header_field_func(*header_field, stream_class); |
312c056a PP |
201 | } |
202 | ||
203 | if (*stream_event_context_field) { | |
204 | release_field_func(*stream_event_context_field); | |
205 | } | |
206 | ||
207 | if (*context_field) { | |
208 | release_field_func(*context_field); | |
209 | } | |
210 | ||
211 | if (*payload_field) { | |
212 | release_field_func(*payload_field); | |
213 | } | |
214 | ||
3dca2276 PP |
215 | ret = -1; |
216 | ||
217 | end: | |
218 | return ret; | |
219 | } | |
220 | ||
221 | BT_HIDDEN | |
222 | int _bt_event_common_validate(struct bt_event_common *event) | |
223 | { | |
224 | int ret = 0; | |
225 | struct bt_stream_class_common *stream_class; | |
226 | ||
227 | BT_ASSERT(event); | |
228 | if (event->header_field) { | |
312c056a PP |
229 | ret = bt_field_common_validate_recursive( |
230 | event->header_field->field); | |
3dca2276 PP |
231 | if (ret) { |
232 | BT_ASSERT_PRE_MSG("Invalid event's header field: " | |
233 | "%![event-]+_e, %![field-]+_f", | |
312c056a | 234 | event, event->header_field->field); |
3dca2276 PP |
235 | goto end; |
236 | } | |
237 | } | |
238 | ||
239 | stream_class = bt_event_class_common_borrow_stream_class(event->class); | |
240 | ||
241 | /* | |
242 | * We should not have been able to create the event without associating | |
243 | * the event class to a stream class. | |
244 | */ | |
245 | BT_ASSERT(stream_class); | |
246 | ||
247 | if (stream_class->event_context_field_type) { | |
248 | ret = bt_field_common_validate_recursive( | |
249 | event->stream_event_context_field); | |
250 | if (ret) { | |
251 | BT_ASSERT_PRE_MSG("Invalid event's stream event context field: " | |
252 | "%![event-]+_e, %![field-]+_f", | |
253 | event, event->stream_event_context_field); | |
254 | goto end; | |
255 | } | |
256 | } | |
257 | ||
258 | if (event->class->context_field_type) { | |
259 | ret = bt_field_common_validate_recursive(event->context_field); | |
260 | if (ret) { | |
261 | BT_ASSERT_PRE_MSG("Invalid event's payload field: " | |
262 | "%![event-]+_e, %![field-]+_f", | |
263 | event, event->context_field); | |
264 | goto end; | |
265 | } | |
266 | } | |
267 | ||
268 | ret = bt_field_common_validate_recursive(event->payload_field); | |
269 | if (ret) { | |
270 | BT_ASSERT_PRE_MSG("Invalid event's payload field: " | |
271 | "%![event-]+_e, %![field-]+_f", | |
272 | event, event->payload_field); | |
273 | goto end; | |
274 | } | |
275 | ||
276 | end: | |
277 | return ret; | |
278 | } | |
279 | ||
280 | BT_HIDDEN | |
6c677fb5 PP |
281 | void _bt_event_common_set_is_frozen(struct bt_event_common *event, |
282 | bool is_frozen) | |
3dca2276 PP |
283 | { |
284 | BT_ASSERT(event); | |
3dca2276 PP |
285 | BT_LOGD("Freezing event: addr=%p, " |
286 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
287 | event, bt_event_class_common_get_name(event->class), | |
288 | bt_event_class_common_get_id(event->class)); | |
312c056a PP |
289 | |
290 | if (event->header_field) { | |
291 | BT_LOGD_STR("Freezing event's header field."); | |
292 | bt_field_common_set_is_frozen_recursive( | |
6c677fb5 | 293 | event->header_field->field, is_frozen); |
312c056a PP |
294 | } |
295 | ||
296 | if (event->stream_event_context_field) { | |
297 | BT_LOGD_STR("Freezing event's stream event context field."); | |
298 | bt_field_common_set_is_frozen_recursive( | |
6c677fb5 | 299 | event->stream_event_context_field, is_frozen); |
312c056a PP |
300 | } |
301 | ||
302 | if (event->context_field) { | |
303 | BT_LOGD_STR("Freezing event's context field."); | |
6c677fb5 PP |
304 | bt_field_common_set_is_frozen_recursive(event->context_field, |
305 | is_frozen); | |
312c056a PP |
306 | } |
307 | ||
308 | if (event->payload_field) { | |
309 | BT_LOGD_STR("Freezing event's payload field."); | |
6c677fb5 PP |
310 | bt_field_common_set_is_frozen_recursive(event->payload_field, |
311 | is_frozen); | |
312c056a PP |
312 | } |
313 | ||
6c677fb5 | 314 | event->frozen = is_frozen; |
3dca2276 PP |
315 | } |
316 | ||
317 | BT_HIDDEN | |
318 | int bt_event_common_initialize(struct bt_event_common *event, | |
319 | struct bt_event_class_common *event_class, | |
320 | struct bt_clock_class *init_expected_clock_class, | |
3fea54f6 | 321 | bool is_shared_with_parent, bt_object_release_func release_func, |
3dca2276 PP |
322 | bt_validation_flag_copy_field_type_func field_type_copy_func, |
323 | bool must_be_in_trace, | |
324 | int (*map_clock_classes_func)(struct bt_stream_class_common *stream_class, | |
325 | struct bt_field_type_common *packet_context_field_type, | |
326 | struct bt_field_type_common *event_header_field_type), | |
2dd764c1 PP |
327 | create_field_func create_field_func, |
328 | release_field_func release_field_func, | |
329 | create_header_field_func create_header_field_func, | |
330 | release_header_field_func release_header_field_func) | |
3dca2276 PP |
331 | { |
332 | int ret; | |
333 | struct bt_trace_common *trace = NULL; | |
334 | struct bt_stream_class_common *stream_class = NULL; | |
312c056a | 335 | struct bt_field_wrapper *event_header = NULL; |
3dca2276 PP |
336 | struct bt_field_common *stream_event_context = NULL; |
337 | struct bt_field_common *event_context = NULL; | |
338 | struct bt_field_common *event_payload = NULL; | |
339 | struct bt_validation_output validation_output = { 0 }; | |
340 | struct bt_clock_class *expected_clock_class = | |
341 | init_expected_clock_class ? bt_get(init_expected_clock_class) : | |
342 | NULL; | |
343 | ||
344 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); | |
345 | BT_LOGD("Initializing common event object: event-class-addr=%p, " | |
346 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
347 | event_class, bt_event_class_common_get_name(event_class), | |
348 | bt_event_class_common_get_id(event_class)); | |
349 | ||
350 | stream_class = bt_event_class_common_borrow_stream_class(event_class); | |
351 | BT_ASSERT_PRE(stream_class, | |
352 | "Event class is not part of a stream class: %!+_E", event_class); | |
353 | ||
354 | /* The event class was frozen when added to its stream class */ | |
355 | BT_ASSERT(event_class->frozen); | |
356 | trace = bt_stream_class_common_borrow_trace(stream_class); | |
357 | ||
358 | if (must_be_in_trace) { | |
359 | BT_ASSERT_PRE(trace, | |
360 | "Event class's stream class is not part of a trace: " | |
361 | "%![ec-]+_E, %![ec-]+_S", event_class, stream_class); | |
362 | } | |
363 | ||
364 | /* | |
365 | * This must be called before anything that can fail because on | |
366 | * failure, the caller releases the reference to `event` to | |
367 | * destroy it. | |
368 | */ | |
3fea54f6 PP |
369 | if (is_shared_with_parent) { |
370 | bt_object_init_shared_with_parent(&event->base, release_func); | |
371 | } else { | |
372 | bt_object_init_unique(&event->base); | |
373 | } | |
3dca2276 PP |
374 | |
375 | if (!stream_class->frozen) { | |
376 | /* | |
377 | * Because this function freezes the stream class, | |
378 | * validate that this stream class contains at most a | |
379 | * single clock class so that we set its expected clock | |
380 | * class for future checks. | |
381 | */ | |
382 | ret = bt_stream_class_common_validate_single_clock_class( | |
383 | stream_class, &expected_clock_class); | |
384 | if (ret) { | |
385 | BT_LOGW("Event class's stream class or one of its event " | |
386 | "classes contains a field type which is not " | |
387 | "recursively mapped to the expected " | |
388 | "clock class: " | |
389 | "stream-class-addr=%p, " | |
390 | "stream-class-id=%" PRId64 ", " | |
391 | "stream-class-name=\"%s\", " | |
392 | "expected-clock-class-addr=%p, " | |
393 | "expected-clock-class-name=\"%s\"", | |
394 | stream_class, | |
395 | bt_stream_class_common_get_id(stream_class), | |
396 | bt_stream_class_common_get_name(stream_class), | |
397 | expected_clock_class, | |
398 | expected_clock_class ? | |
399 | bt_clock_class_get_name(expected_clock_class) : | |
400 | NULL); | |
401 | goto error; | |
402 | } | |
403 | } | |
404 | ||
405 | /* Validate the trace, the stream class, and the event class */ | |
406 | ret = bt_event_common_validate_types_for_create( | |
407 | event_class, &validation_output, field_type_copy_func); | |
408 | if (ret) { | |
409 | /* bt_event_common_validate_types_for_create() logs errors */ | |
410 | goto error; | |
411 | } | |
412 | ||
413 | if (map_clock_classes_func) { | |
414 | /* | |
415 | * Safe to automatically map selected fields to the | |
416 | * stream's clock's class here because the stream class | |
417 | * is about to be frozen. | |
418 | */ | |
419 | if (map_clock_classes_func(stream_class, | |
420 | validation_output.packet_context_type, | |
421 | validation_output.event_header_type)) { | |
422 | BT_LOGW_STR("Cannot automatically map selected stream class's " | |
423 | "field types to stream class's clock's class."); | |
424 | goto error; | |
425 | } | |
426 | } | |
427 | ||
428 | /* | |
429 | * event does not share a common ancestor with the event class; it has | |
430 | * to guarantee its existence by holding a reference. This reference | |
431 | * shall be released once the event is associated to a stream since, | |
432 | * from that point, the event and its class will share the same | |
433 | * lifetime. | |
434 | */ | |
435 | event->class = bt_get(event_class); | |
436 | ||
312c056a PP |
437 | ret = bt_event_common_create_fields(stream_class, |
438 | &validation_output, | |
439 | create_field_func, release_field_func, | |
440 | create_header_field_func, release_header_field_func, | |
441 | &event_header, &stream_event_context, &event_context, | |
442 | &event_payload); | |
3dca2276 PP |
443 | if (ret) { |
444 | /* bt_event_common_create_fields() logs errors */ | |
445 | goto error; | |
446 | } | |
447 | ||
09840de5 PP |
448 | /* |
449 | * At this point all the fields are created, potentially from | |
450 | * validated copies of field types, so that the field types and | |
451 | * fields can be replaced in the trace, stream class, | |
452 | * event class, and created event. | |
453 | */ | |
3dca2276 PP |
454 | bt_validation_replace_types(trace, stream_class, event_class, |
455 | &validation_output, | |
456 | BT_VALIDATION_FLAG_STREAM | BT_VALIDATION_FLAG_EVENT); | |
312c056a PP |
457 | event->header_field = event_header; |
458 | event_header = NULL; | |
459 | event->stream_event_context_field = stream_event_context; | |
460 | stream_event_context = NULL; | |
461 | event->context_field = event_context; | |
462 | event_context = NULL; | |
463 | event->payload_field = event_payload; | |
464 | event_payload = NULL; | |
09840de5 PP |
465 | |
466 | /* | |
50842bdc | 467 | * Put what was not moved in bt_validation_replace_types(). |
09840de5 | 468 | */ |
50842bdc | 469 | bt_validation_output_put_types(&validation_output); |
09840de5 | 470 | |
662e778c JG |
471 | /* |
472 | * Freeze the stream class since the event header must not be changed | |
473 | * anymore. | |
474 | */ | |
3dca2276 | 475 | bt_stream_class_common_freeze(stream_class); |
09840de5 | 476 | |
2a3ced3c PP |
477 | /* |
478 | * It is safe to set the stream class's unique clock class | |
479 | * now because the stream class is frozen. | |
480 | */ | |
481 | if (expected_clock_class) { | |
482 | BT_MOVE(stream_class->clock_class, expected_clock_class); | |
483 | } | |
484 | ||
09840de5 PP |
485 | /* |
486 | * Mark stream class, and event class as valid since | |
487 | * they're all frozen now. | |
488 | */ | |
489 | stream_class->valid = 1; | |
490 | event_class->valid = 1; | |
491 | ||
492 | /* Put stuff we borrowed from the event class */ | |
3dca2276 | 493 | BT_LOGD("Initialized event object: addr=%p, event-class-name=\"%s\", " |
7b010242 | 494 | "event-class-id=%" PRId64, |
3dca2276 PP |
495 | event, bt_event_class_common_get_name(event->class), |
496 | bt_event_class_common_get_id(event->class)); | |
497 | goto end; | |
09840de5 | 498 | |
83509119 | 499 | error: |
50842bdc | 500 | bt_validation_output_put_types(&validation_output); |
2a3ced3c | 501 | bt_put(expected_clock_class); |
312c056a PP |
502 | |
503 | if (event_header) { | |
2dd764c1 | 504 | release_header_field_func(event_header, stream_class); |
312c056a PP |
505 | } |
506 | ||
507 | if (stream_event_context) { | |
508 | release_field_func(stream_event_context); | |
509 | } | |
510 | ||
511 | if (event_context) { | |
512 | release_field_func(event_context); | |
513 | } | |
514 | ||
515 | if (event_payload) { | |
516 | release_field_func(event_payload); | |
517 | } | |
518 | ||
3dca2276 PP |
519 | ret = -1; |
520 | ||
521 | end: | |
522 | return ret; | |
523 | } | |
524 | ||
312c056a PP |
525 | static |
526 | void bt_event_header_field_recycle(struct bt_field_wrapper *field_wrapper, | |
527 | struct bt_stream_class *stream_class) | |
528 | { | |
529 | BT_ASSERT(field_wrapper); | |
530 | BT_LIB_LOGD("Recycling event header field: " | |
531 | "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper, | |
532 | stream_class, field_wrapper->field); | |
533 | bt_object_pool_recycle_object( | |
534 | &stream_class->event_header_field_pool, | |
535 | field_wrapper); | |
536 | } | |
537 | ||
538 | static | |
539 | struct bt_field_wrapper *create_event_header_field( | |
540 | struct bt_stream_class *stream_class, | |
541 | struct bt_field_type_common *ft) | |
542 | { | |
543 | struct bt_field_wrapper *field_wrapper = NULL; | |
544 | ||
545 | field_wrapper = bt_field_wrapper_create( | |
546 | &stream_class->event_header_field_pool, (void *) ft); | |
547 | if (!field_wrapper) { | |
548 | goto error; | |
549 | } | |
550 | ||
551 | goto end; | |
552 | ||
553 | error: | |
554 | if (field_wrapper) { | |
555 | bt_event_header_field_recycle(field_wrapper, stream_class); | |
556 | field_wrapper = NULL; | |
557 | } | |
558 | ||
559 | end: | |
560 | return field_wrapper; | |
561 | } | |
562 | ||
563 | BT_HIDDEN | |
564 | struct bt_event *bt_event_new(struct bt_event_class *event_class) | |
3dca2276 PP |
565 | { |
566 | int ret; | |
567 | struct bt_event *event = NULL; | |
312c056a | 568 | struct bt_stream_class *stream_class; |
3dca2276 PP |
569 | |
570 | event = g_new0(struct bt_event, 1); | |
571 | if (!event) { | |
572 | BT_LOGE_STR("Failed to allocate one event."); | |
573 | goto error; | |
574 | } | |
575 | ||
576 | ret = bt_event_common_initialize(BT_TO_COMMON(event), | |
3fea54f6 | 577 | BT_TO_COMMON(event_class), NULL, false, NULL, |
3dca2276 | 578 | (bt_validation_flag_copy_field_type_func) bt_field_type_copy, |
312c056a | 579 | true, NULL, |
2dd764c1 PP |
580 | (create_field_func) bt_field_create_recursive, |
581 | (release_field_func) bt_field_destroy_recursive, | |
582 | (create_header_field_func) create_event_header_field, | |
583 | (release_header_field_func) bt_event_header_field_recycle); | |
3dca2276 PP |
584 | if (ret) { |
585 | /* bt_event_common_initialize() logs errors */ | |
586 | goto error; | |
587 | } | |
588 | ||
312c056a PP |
589 | stream_class = bt_event_class_borrow_stream_class(event_class); |
590 | BT_ASSERT(stream_class); | |
e22b45d0 PP |
591 | ret = bt_clock_value_set_initialize(&event->cv_set); |
592 | if (ret) { | |
593 | goto error; | |
312c056a PP |
594 | } |
595 | ||
3dca2276 PP |
596 | goto end; |
597 | ||
598 | error: | |
312c056a PP |
599 | if (event) { |
600 | bt_event_destroy(event); | |
601 | event = NULL; | |
602 | } | |
603 | ||
604 | end: | |
605 | return event; | |
606 | } | |
607 | ||
094ff7c0 | 608 | struct bt_event_class *bt_event_borrow_class(struct bt_event *event) |
2f100782 | 609 | { |
f6ccaed9 | 610 | BT_ASSERT_PRE_NON_NULL(event, "Event"); |
094ff7c0 PP |
611 | return BT_FROM_COMMON( |
612 | bt_event_common_borrow_class(BT_TO_COMMON(event))); | |
2f100782 JG |
613 | } |
614 | ||
f6ccaed9 | 615 | struct bt_stream *bt_event_borrow_stream(struct bt_event *event) |
f6ccaed9 PP |
616 | { |
617 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
094ff7c0 | 618 | return event->packet ? event->packet->stream : NULL; |
f6ccaed9 PP |
619 | } |
620 | ||
094ff7c0 | 621 | struct bt_field *bt_event_borrow_payload(struct bt_event *event) |
e5e6eb3a | 622 | { |
094ff7c0 PP |
623 | return BT_FROM_COMMON( |
624 | bt_event_common_borrow_payload(BT_TO_COMMON(event))); | |
e5e6eb3a JG |
625 | } |
626 | ||
094ff7c0 | 627 | struct bt_field *bt_event_borrow_header(struct bt_event *event) |
662e778c | 628 | { |
094ff7c0 PP |
629 | return BT_FROM_COMMON( |
630 | bt_event_common_borrow_header(BT_TO_COMMON(event))); | |
662e778c JG |
631 | } |
632 | ||
094ff7c0 | 633 | struct bt_field *bt_event_borrow_context(struct bt_event *event) |
f655a84d | 634 | { |
094ff7c0 PP |
635 | return BT_FROM_COMMON( |
636 | bt_event_common_borrow_context(BT_TO_COMMON(event))); | |
f655a84d JG |
637 | } |
638 | ||
094ff7c0 | 639 | struct bt_field *bt_event_borrow_stream_event_context( |
50842bdc | 640 | struct bt_event *event) |
5fd2e9fd | 641 | { |
094ff7c0 | 642 | return BT_FROM_COMMON(bt_event_common_borrow_stream_event_context( |
3dca2276 | 643 | BT_TO_COMMON(event))); |
5fd2e9fd PP |
644 | } |
645 | ||
312c056a PP |
646 | static |
647 | void release_event_header_field(struct bt_field_wrapper *field_wrapper, | |
648 | struct bt_event_common *event_common) | |
273b65be | 649 | { |
312c056a PP |
650 | struct bt_event *event = BT_FROM_COMMON(event_common); |
651 | struct bt_event_class *event_class = bt_event_borrow_class(event); | |
652 | ||
653 | if (!event_class) { | |
654 | bt_field_wrapper_destroy(field_wrapper); | |
655 | } else { | |
656 | struct bt_stream_class *stream_class = | |
657 | bt_event_class_borrow_stream_class(event_class); | |
658 | ||
659 | BT_ASSERT(stream_class); | |
660 | bt_event_header_field_recycle(field_wrapper, stream_class); | |
661 | } | |
273b65be JG |
662 | } |
663 | ||
312c056a PP |
664 | BT_HIDDEN |
665 | void bt_event_destroy(struct bt_event *event) | |
273b65be | 666 | { |
312c056a PP |
667 | BT_ASSERT(event); |
668 | bt_event_common_finalize((void *) event, | |
669 | (void *) bt_field_destroy_recursive, | |
670 | (void *) release_event_header_field); | |
e22b45d0 | 671 | bt_clock_value_set_finalize(&event->cv_set); |
03039f21 | 672 | BT_LOGD_STR("Putting event's packet."); |
5c3b707d | 673 | bt_put(event->packet); |
273b65be JG |
674 | g_free(event); |
675 | } | |
676 | ||
e22b45d0 PP |
677 | int bt_event_set_clock_value(struct bt_event *event, |
678 | struct bt_clock_class *clock_class, uint64_t raw_value, | |
679 | bt_bool is_default) | |
680 | { | |
681 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
682 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); | |
683 | BT_ASSERT_PRE_HOT(BT_TO_COMMON(event), "Event", ": %!+e", event); | |
684 | BT_ASSERT_PRE(is_default, | |
685 | "You can only set a default clock value as of this version."); | |
686 | return bt_clock_value_set_set_clock_value(&event->cv_set, clock_class, | |
687 | raw_value, is_default); | |
688 | } | |
689 | ||
690 | struct bt_clock_value *bt_event_borrow_default_clock_value( | |
691 | struct bt_event *event) | |
78586d8a | 692 | { |
50842bdc | 693 | struct bt_clock_value *clock_value = NULL; |
78586d8a | 694 | |
f6ccaed9 | 695 | BT_ASSERT_PRE_NON_NULL(event, "Event"); |
e22b45d0 | 696 | clock_value = event->cv_set.default_cv; |
78586d8a | 697 | if (!clock_value) { |
e22b45d0 | 698 | BT_LIB_LOGV("No default clock value: %![event-]+e", event); |
78586d8a JG |
699 | } |
700 | ||
1556a1af JG |
701 | return clock_value; |
702 | } | |
703 | ||
094ff7c0 | 704 | struct bt_packet *bt_event_borrow_packet(struct bt_event *event) |
5c0f40f4 | 705 | { |
50842bdc | 706 | struct bt_packet *packet = NULL; |
5c0f40f4 | 707 | |
f6ccaed9 | 708 | BT_ASSERT_PRE_NON_NULL(event, "Event"); |
7b010242 PP |
709 | if (!event->packet) { |
710 | BT_LOGV("Event has no current packet: addr=%p, " | |
711 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
3dca2276 PP |
712 | event, bt_event_class_common_get_name(event->common.class), |
713 | bt_event_class_common_get_id(event->common.class)); | |
5c0f40f4 JG |
714 | goto end; |
715 | } | |
716 | ||
094ff7c0 | 717 | packet = event->packet; |
f6ccaed9 | 718 | |
5c0f40f4 JG |
719 | end: |
720 | return packet; | |
721 | } | |
722 | ||
312c056a | 723 | BT_HIDDEN |
6c677fb5 | 724 | void _bt_event_set_is_frozen(struct bt_event *event, bool is_frozen) |
5c3b707d | 725 | { |
6c677fb5 | 726 | bt_event_common_set_is_frozen(BT_TO_COMMON(event), is_frozen); |
3dca2276 | 727 | BT_LOGD_STR("Freezing event's packet."); |
6c677fb5 | 728 | bt_packet_set_is_frozen(event->packet, is_frozen); |
312c056a PP |
729 | } |
730 | ||
731 | int bt_event_move_header(struct bt_event *event, | |
732 | struct bt_event_header_field *header_field) | |
733 | { | |
734 | struct bt_stream_class *stream_class; | |
735 | struct bt_field_wrapper *field_wrapper = (void *) header_field; | |
736 | ||
737 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
738 | BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field"); | |
e22b45d0 | 739 | BT_ASSERT_PRE_HOT(BT_TO_COMMON(event), "Event", ": %!+e", event); |
312c056a PP |
740 | stream_class = bt_event_class_borrow_stream_class( |
741 | bt_event_borrow_class(event)); | |
742 | BT_ASSERT_PRE(stream_class->common.event_header_field_type, | |
743 | "Stream class has no event header field type: %!+S", | |
744 | stream_class); | |
745 | ||
746 | /* Recycle current header field: always exists */ | |
747 | BT_ASSERT(event->common.header_field); | |
748 | bt_event_header_field_recycle(event->common.header_field, | |
749 | stream_class); | |
750 | ||
751 | /* Move new field */ | |
752 | event->common.header_field = (void *) field_wrapper; | |
753 | return 0; | |
754 | } |