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); | |
285 | ||
286 | if (event->frozen) { | |
287 | return; | |
288 | } | |
289 | ||
290 | BT_LOGD("Freezing event: addr=%p, " | |
291 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
292 | event, bt_event_class_common_get_name(event->class), | |
293 | bt_event_class_common_get_id(event->class)); | |
312c056a PP |
294 | |
295 | if (event->header_field) { | |
296 | BT_LOGD_STR("Freezing event's header field."); | |
297 | bt_field_common_set_is_frozen_recursive( | |
6c677fb5 | 298 | event->header_field->field, is_frozen); |
312c056a PP |
299 | } |
300 | ||
301 | if (event->stream_event_context_field) { | |
302 | BT_LOGD_STR("Freezing event's stream event context field."); | |
303 | bt_field_common_set_is_frozen_recursive( | |
6c677fb5 | 304 | event->stream_event_context_field, is_frozen); |
312c056a PP |
305 | } |
306 | ||
307 | if (event->context_field) { | |
308 | BT_LOGD_STR("Freezing event's context field."); | |
6c677fb5 PP |
309 | bt_field_common_set_is_frozen_recursive(event->context_field, |
310 | is_frozen); | |
312c056a PP |
311 | } |
312 | ||
313 | if (event->payload_field) { | |
314 | BT_LOGD_STR("Freezing event's payload field."); | |
6c677fb5 PP |
315 | bt_field_common_set_is_frozen_recursive(event->payload_field, |
316 | is_frozen); | |
312c056a PP |
317 | } |
318 | ||
6c677fb5 | 319 | event->frozen = is_frozen; |
3dca2276 PP |
320 | } |
321 | ||
322 | BT_HIDDEN | |
323 | int bt_event_common_initialize(struct bt_event_common *event, | |
324 | struct bt_event_class_common *event_class, | |
325 | struct bt_clock_class *init_expected_clock_class, | |
3fea54f6 | 326 | bool is_shared_with_parent, bt_object_release_func release_func, |
3dca2276 PP |
327 | bt_validation_flag_copy_field_type_func field_type_copy_func, |
328 | bool must_be_in_trace, | |
329 | int (*map_clock_classes_func)(struct bt_stream_class_common *stream_class, | |
330 | struct bt_field_type_common *packet_context_field_type, | |
331 | struct bt_field_type_common *event_header_field_type), | |
2dd764c1 PP |
332 | create_field_func create_field_func, |
333 | release_field_func release_field_func, | |
334 | create_header_field_func create_header_field_func, | |
335 | release_header_field_func release_header_field_func) | |
3dca2276 PP |
336 | { |
337 | int ret; | |
338 | struct bt_trace_common *trace = NULL; | |
339 | struct bt_stream_class_common *stream_class = NULL; | |
312c056a | 340 | struct bt_field_wrapper *event_header = NULL; |
3dca2276 PP |
341 | struct bt_field_common *stream_event_context = NULL; |
342 | struct bt_field_common *event_context = NULL; | |
343 | struct bt_field_common *event_payload = NULL; | |
344 | struct bt_validation_output validation_output = { 0 }; | |
345 | struct bt_clock_class *expected_clock_class = | |
346 | init_expected_clock_class ? bt_get(init_expected_clock_class) : | |
347 | NULL; | |
348 | ||
349 | BT_ASSERT_PRE_NON_NULL(event_class, "Event class"); | |
350 | BT_LOGD("Initializing common event object: event-class-addr=%p, " | |
351 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
352 | event_class, bt_event_class_common_get_name(event_class), | |
353 | bt_event_class_common_get_id(event_class)); | |
354 | ||
355 | stream_class = bt_event_class_common_borrow_stream_class(event_class); | |
356 | BT_ASSERT_PRE(stream_class, | |
357 | "Event class is not part of a stream class: %!+_E", event_class); | |
358 | ||
359 | /* The event class was frozen when added to its stream class */ | |
360 | BT_ASSERT(event_class->frozen); | |
361 | trace = bt_stream_class_common_borrow_trace(stream_class); | |
362 | ||
363 | if (must_be_in_trace) { | |
364 | BT_ASSERT_PRE(trace, | |
365 | "Event class's stream class is not part of a trace: " | |
366 | "%![ec-]+_E, %![ec-]+_S", event_class, stream_class); | |
367 | } | |
368 | ||
369 | /* | |
370 | * This must be called before anything that can fail because on | |
371 | * failure, the caller releases the reference to `event` to | |
372 | * destroy it. | |
373 | */ | |
3fea54f6 PP |
374 | if (is_shared_with_parent) { |
375 | bt_object_init_shared_with_parent(&event->base, release_func); | |
376 | } else { | |
377 | bt_object_init_unique(&event->base); | |
378 | } | |
3dca2276 PP |
379 | |
380 | if (!stream_class->frozen) { | |
381 | /* | |
382 | * Because this function freezes the stream class, | |
383 | * validate that this stream class contains at most a | |
384 | * single clock class so that we set its expected clock | |
385 | * class for future checks. | |
386 | */ | |
387 | ret = bt_stream_class_common_validate_single_clock_class( | |
388 | stream_class, &expected_clock_class); | |
389 | if (ret) { | |
390 | BT_LOGW("Event class's stream class or one of its event " | |
391 | "classes contains a field type which is not " | |
392 | "recursively mapped to the expected " | |
393 | "clock class: " | |
394 | "stream-class-addr=%p, " | |
395 | "stream-class-id=%" PRId64 ", " | |
396 | "stream-class-name=\"%s\", " | |
397 | "expected-clock-class-addr=%p, " | |
398 | "expected-clock-class-name=\"%s\"", | |
399 | stream_class, | |
400 | bt_stream_class_common_get_id(stream_class), | |
401 | bt_stream_class_common_get_name(stream_class), | |
402 | expected_clock_class, | |
403 | expected_clock_class ? | |
404 | bt_clock_class_get_name(expected_clock_class) : | |
405 | NULL); | |
406 | goto error; | |
407 | } | |
408 | } | |
409 | ||
410 | /* Validate the trace, the stream class, and the event class */ | |
411 | ret = bt_event_common_validate_types_for_create( | |
412 | event_class, &validation_output, field_type_copy_func); | |
413 | if (ret) { | |
414 | /* bt_event_common_validate_types_for_create() logs errors */ | |
415 | goto error; | |
416 | } | |
417 | ||
418 | if (map_clock_classes_func) { | |
419 | /* | |
420 | * Safe to automatically map selected fields to the | |
421 | * stream's clock's class here because the stream class | |
422 | * is about to be frozen. | |
423 | */ | |
424 | if (map_clock_classes_func(stream_class, | |
425 | validation_output.packet_context_type, | |
426 | validation_output.event_header_type)) { | |
427 | BT_LOGW_STR("Cannot automatically map selected stream class's " | |
428 | "field types to stream class's clock's class."); | |
429 | goto error; | |
430 | } | |
431 | } | |
432 | ||
433 | /* | |
434 | * event does not share a common ancestor with the event class; it has | |
435 | * to guarantee its existence by holding a reference. This reference | |
436 | * shall be released once the event is associated to a stream since, | |
437 | * from that point, the event and its class will share the same | |
438 | * lifetime. | |
439 | */ | |
440 | event->class = bt_get(event_class); | |
441 | ||
312c056a PP |
442 | ret = bt_event_common_create_fields(stream_class, |
443 | &validation_output, | |
444 | create_field_func, release_field_func, | |
445 | create_header_field_func, release_header_field_func, | |
446 | &event_header, &stream_event_context, &event_context, | |
447 | &event_payload); | |
3dca2276 PP |
448 | if (ret) { |
449 | /* bt_event_common_create_fields() logs errors */ | |
450 | goto error; | |
451 | } | |
452 | ||
09840de5 PP |
453 | /* |
454 | * At this point all the fields are created, potentially from | |
455 | * validated copies of field types, so that the field types and | |
456 | * fields can be replaced in the trace, stream class, | |
457 | * event class, and created event. | |
458 | */ | |
3dca2276 PP |
459 | bt_validation_replace_types(trace, stream_class, event_class, |
460 | &validation_output, | |
461 | BT_VALIDATION_FLAG_STREAM | BT_VALIDATION_FLAG_EVENT); | |
312c056a PP |
462 | event->header_field = event_header; |
463 | event_header = NULL; | |
464 | event->stream_event_context_field = stream_event_context; | |
465 | stream_event_context = NULL; | |
466 | event->context_field = event_context; | |
467 | event_context = NULL; | |
468 | event->payload_field = event_payload; | |
469 | event_payload = NULL; | |
09840de5 PP |
470 | |
471 | /* | |
50842bdc | 472 | * Put what was not moved in bt_validation_replace_types(). |
09840de5 | 473 | */ |
50842bdc | 474 | bt_validation_output_put_types(&validation_output); |
09840de5 | 475 | |
662e778c JG |
476 | /* |
477 | * Freeze the stream class since the event header must not be changed | |
478 | * anymore. | |
479 | */ | |
3dca2276 | 480 | bt_stream_class_common_freeze(stream_class); |
09840de5 | 481 | |
2a3ced3c PP |
482 | /* |
483 | * It is safe to set the stream class's unique clock class | |
484 | * now because the stream class is frozen. | |
485 | */ | |
486 | if (expected_clock_class) { | |
487 | BT_MOVE(stream_class->clock_class, expected_clock_class); | |
488 | } | |
489 | ||
09840de5 PP |
490 | /* |
491 | * Mark stream class, and event class as valid since | |
492 | * they're all frozen now. | |
493 | */ | |
494 | stream_class->valid = 1; | |
495 | event_class->valid = 1; | |
496 | ||
497 | /* Put stuff we borrowed from the event class */ | |
3dca2276 | 498 | BT_LOGD("Initialized event object: addr=%p, event-class-name=\"%s\", " |
7b010242 | 499 | "event-class-id=%" PRId64, |
3dca2276 PP |
500 | event, bt_event_class_common_get_name(event->class), |
501 | bt_event_class_common_get_id(event->class)); | |
502 | goto end; | |
09840de5 | 503 | |
83509119 | 504 | error: |
50842bdc | 505 | bt_validation_output_put_types(&validation_output); |
2a3ced3c | 506 | bt_put(expected_clock_class); |
312c056a PP |
507 | |
508 | if (event_header) { | |
2dd764c1 | 509 | release_header_field_func(event_header, stream_class); |
312c056a PP |
510 | } |
511 | ||
512 | if (stream_event_context) { | |
513 | release_field_func(stream_event_context); | |
514 | } | |
515 | ||
516 | if (event_context) { | |
517 | release_field_func(event_context); | |
518 | } | |
519 | ||
520 | if (event_payload) { | |
521 | release_field_func(event_payload); | |
522 | } | |
523 | ||
3dca2276 PP |
524 | ret = -1; |
525 | ||
526 | end: | |
527 | return ret; | |
528 | } | |
529 | ||
312c056a PP |
530 | static |
531 | void bt_event_header_field_recycle(struct bt_field_wrapper *field_wrapper, | |
532 | struct bt_stream_class *stream_class) | |
533 | { | |
534 | BT_ASSERT(field_wrapper); | |
535 | BT_LIB_LOGD("Recycling event header field: " | |
536 | "addr=%p, %![sc-]+S, %![field-]+f", field_wrapper, | |
537 | stream_class, field_wrapper->field); | |
538 | bt_object_pool_recycle_object( | |
539 | &stream_class->event_header_field_pool, | |
540 | field_wrapper); | |
541 | } | |
542 | ||
543 | static | |
544 | struct bt_field_wrapper *create_event_header_field( | |
545 | struct bt_stream_class *stream_class, | |
546 | struct bt_field_type_common *ft) | |
547 | { | |
548 | struct bt_field_wrapper *field_wrapper = NULL; | |
549 | ||
550 | field_wrapper = bt_field_wrapper_create( | |
551 | &stream_class->event_header_field_pool, (void *) ft); | |
552 | if (!field_wrapper) { | |
553 | goto error; | |
554 | } | |
555 | ||
556 | goto end; | |
557 | ||
558 | error: | |
559 | if (field_wrapper) { | |
560 | bt_event_header_field_recycle(field_wrapper, stream_class); | |
561 | field_wrapper = NULL; | |
562 | } | |
563 | ||
564 | end: | |
565 | return field_wrapper; | |
566 | } | |
567 | ||
568 | BT_HIDDEN | |
569 | struct bt_event *bt_event_new(struct bt_event_class *event_class) | |
3dca2276 PP |
570 | { |
571 | int ret; | |
572 | struct bt_event *event = NULL; | |
312c056a | 573 | struct bt_stream_class *stream_class; |
3dca2276 PP |
574 | |
575 | event = g_new0(struct bt_event, 1); | |
576 | if (!event) { | |
577 | BT_LOGE_STR("Failed to allocate one event."); | |
578 | goto error; | |
579 | } | |
580 | ||
581 | ret = bt_event_common_initialize(BT_TO_COMMON(event), | |
3fea54f6 | 582 | BT_TO_COMMON(event_class), NULL, false, NULL, |
3dca2276 | 583 | (bt_validation_flag_copy_field_type_func) bt_field_type_copy, |
312c056a | 584 | true, NULL, |
2dd764c1 PP |
585 | (create_field_func) bt_field_create_recursive, |
586 | (release_field_func) bt_field_destroy_recursive, | |
587 | (create_header_field_func) create_event_header_field, | |
588 | (release_header_field_func) bt_event_header_field_recycle); | |
3dca2276 PP |
589 | if (ret) { |
590 | /* bt_event_common_initialize() logs errors */ | |
591 | goto error; | |
592 | } | |
593 | ||
594 | event->clock_values = g_hash_table_new_full(g_direct_hash, | |
312c056a PP |
595 | g_direct_equal, NULL, |
596 | (GDestroyNotify) bt_clock_value_recycle); | |
597 | BT_ASSERT(event->clock_values); | |
598 | stream_class = bt_event_class_borrow_stream_class(event_class); | |
599 | BT_ASSERT(stream_class); | |
600 | ||
601 | if (stream_class->common.clock_class) { | |
602 | struct bt_clock_value *clock_value; | |
603 | ||
604 | clock_value = bt_clock_value_create( | |
605 | stream_class->common.clock_class); | |
606 | if (!clock_value) { | |
607 | BT_LIB_LOGE("Cannot create clock value from clock class: " | |
608 | "%![cc-]+K", stream_class->common.clock_class); | |
609 | goto error; | |
610 | } | |
611 | ||
612 | g_hash_table_insert(event->clock_values, | |
613 | stream_class->common.clock_class, clock_value); | |
614 | } | |
615 | ||
3dca2276 PP |
616 | goto end; |
617 | ||
618 | error: | |
312c056a PP |
619 | if (event) { |
620 | bt_event_destroy(event); | |
621 | event = NULL; | |
622 | } | |
623 | ||
624 | end: | |
625 | return event; | |
626 | } | |
627 | ||
094ff7c0 | 628 | struct bt_event_class *bt_event_borrow_class(struct bt_event *event) |
2f100782 | 629 | { |
f6ccaed9 | 630 | BT_ASSERT_PRE_NON_NULL(event, "Event"); |
094ff7c0 PP |
631 | return BT_FROM_COMMON( |
632 | bt_event_common_borrow_class(BT_TO_COMMON(event))); | |
2f100782 JG |
633 | } |
634 | ||
f6ccaed9 | 635 | struct bt_stream *bt_event_borrow_stream(struct bt_event *event) |
f6ccaed9 PP |
636 | { |
637 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
094ff7c0 | 638 | return event->packet ? event->packet->stream : NULL; |
f6ccaed9 PP |
639 | } |
640 | ||
094ff7c0 | 641 | struct bt_field *bt_event_borrow_payload(struct bt_event *event) |
e5e6eb3a | 642 | { |
094ff7c0 PP |
643 | return BT_FROM_COMMON( |
644 | bt_event_common_borrow_payload(BT_TO_COMMON(event))); | |
e5e6eb3a JG |
645 | } |
646 | ||
094ff7c0 | 647 | struct bt_field *bt_event_borrow_header(struct bt_event *event) |
662e778c | 648 | { |
094ff7c0 PP |
649 | return BT_FROM_COMMON( |
650 | bt_event_common_borrow_header(BT_TO_COMMON(event))); | |
662e778c JG |
651 | } |
652 | ||
094ff7c0 | 653 | struct bt_field *bt_event_borrow_context(struct bt_event *event) |
f655a84d | 654 | { |
094ff7c0 PP |
655 | return BT_FROM_COMMON( |
656 | bt_event_common_borrow_context(BT_TO_COMMON(event))); | |
f655a84d JG |
657 | } |
658 | ||
094ff7c0 | 659 | struct bt_field *bt_event_borrow_stream_event_context( |
50842bdc | 660 | struct bt_event *event) |
5fd2e9fd | 661 | { |
094ff7c0 | 662 | return BT_FROM_COMMON(bt_event_common_borrow_stream_event_context( |
3dca2276 | 663 | BT_TO_COMMON(event))); |
5fd2e9fd PP |
664 | } |
665 | ||
312c056a PP |
666 | static |
667 | void release_event_header_field(struct bt_field_wrapper *field_wrapper, | |
668 | struct bt_event_common *event_common) | |
273b65be | 669 | { |
312c056a PP |
670 | struct bt_event *event = BT_FROM_COMMON(event_common); |
671 | struct bt_event_class *event_class = bt_event_borrow_class(event); | |
672 | ||
673 | if (!event_class) { | |
674 | bt_field_wrapper_destroy(field_wrapper); | |
675 | } else { | |
676 | struct bt_stream_class *stream_class = | |
677 | bt_event_class_borrow_stream_class(event_class); | |
678 | ||
679 | BT_ASSERT(stream_class); | |
680 | bt_event_header_field_recycle(field_wrapper, stream_class); | |
681 | } | |
273b65be JG |
682 | } |
683 | ||
312c056a PP |
684 | BT_HIDDEN |
685 | void bt_event_destroy(struct bt_event *event) | |
273b65be | 686 | { |
312c056a PP |
687 | BT_ASSERT(event); |
688 | bt_event_common_finalize((void *) event, | |
689 | (void *) bt_field_destroy_recursive, | |
690 | (void *) release_event_header_field); | |
41ac640a | 691 | g_hash_table_destroy(event->clock_values); |
03039f21 | 692 | BT_LOGD_STR("Putting event's packet."); |
5c3b707d | 693 | bt_put(event->packet); |
273b65be JG |
694 | g_free(event); |
695 | } | |
696 | ||
094ff7c0 | 697 | struct bt_clock_value *bt_event_borrow_clock_value( |
50842bdc | 698 | struct bt_event *event, struct bt_clock_class *clock_class) |
78586d8a | 699 | { |
50842bdc | 700 | struct bt_clock_value *clock_value = NULL; |
78586d8a | 701 | |
f6ccaed9 PP |
702 | BT_ASSERT_PRE_NON_NULL(event, "Event"); |
703 | BT_ASSERT_PRE_NON_NULL(clock_class, "Clock class"); | |
ac0c6bdd | 704 | clock_value = g_hash_table_lookup(event->clock_values, clock_class); |
78586d8a | 705 | if (!clock_value) { |
7b010242 PP |
706 | BT_LOGV("No clock value associated to the given clock class: " |
707 | "event-addr=%p, event-class-name=\"%s\", " | |
708 | "event-class-id=%" PRId64 ", clock-class-addr=%p, " | |
709 | "clock-class-name=\"%s\"", event, | |
3dca2276 PP |
710 | bt_event_class_common_get_name(event->common.class), |
711 | bt_event_class_common_get_id(event->common.class), | |
50842bdc | 712 | clock_class, bt_clock_class_get_name(clock_class)); |
78586d8a JG |
713 | goto end; |
714 | } | |
715 | ||
1556a1af JG |
716 | end: |
717 | return clock_value; | |
718 | } | |
719 | ||
094ff7c0 | 720 | struct bt_packet *bt_event_borrow_packet(struct bt_event *event) |
5c0f40f4 | 721 | { |
50842bdc | 722 | struct bt_packet *packet = NULL; |
5c0f40f4 | 723 | |
f6ccaed9 | 724 | BT_ASSERT_PRE_NON_NULL(event, "Event"); |
7b010242 PP |
725 | if (!event->packet) { |
726 | BT_LOGV("Event has no current packet: addr=%p, " | |
727 | "event-class-name=\"%s\", event-class-id=%" PRId64, | |
3dca2276 PP |
728 | event, bt_event_class_common_get_name(event->common.class), |
729 | bt_event_class_common_get_id(event->common.class)); | |
5c0f40f4 JG |
730 | goto end; |
731 | } | |
732 | ||
094ff7c0 | 733 | packet = event->packet; |
f6ccaed9 | 734 | |
5c0f40f4 JG |
735 | end: |
736 | return packet; | |
737 | } | |
738 | ||
312c056a | 739 | BT_HIDDEN |
6c677fb5 | 740 | void _bt_event_set_is_frozen(struct bt_event *event, bool is_frozen) |
5c3b707d | 741 | { |
6c677fb5 | 742 | bt_event_common_set_is_frozen(BT_TO_COMMON(event), is_frozen); |
3dca2276 | 743 | BT_LOGD_STR("Freezing event's packet."); |
6c677fb5 | 744 | bt_packet_set_is_frozen(event->packet, is_frozen); |
312c056a PP |
745 | } |
746 | ||
747 | int bt_event_move_header(struct bt_event *event, | |
748 | struct bt_event_header_field *header_field) | |
749 | { | |
750 | struct bt_stream_class *stream_class; | |
751 | struct bt_field_wrapper *field_wrapper = (void *) header_field; | |
752 | ||
753 | BT_ASSERT_PRE_NON_NULL(event, "Event"); | |
754 | BT_ASSERT_PRE_NON_NULL(field_wrapper, "Header field"); | |
755 | BT_ASSERT_PRE_HOT(BT_TO_COMMON(event), "Event", ": +%!+e", event); | |
756 | stream_class = bt_event_class_borrow_stream_class( | |
757 | bt_event_borrow_class(event)); | |
758 | BT_ASSERT_PRE(stream_class->common.event_header_field_type, | |
759 | "Stream class has no event header field type: %!+S", | |
760 | stream_class); | |
761 | ||
762 | /* Recycle current header field: always exists */ | |
763 | BT_ASSERT(event->common.header_field); | |
764 | bt_event_header_field_recycle(event->common.header_field, | |
765 | stream_class); | |
766 | ||
767 | /* Move new field */ | |
768 | event->common.header_field = (void *) field_wrapper; | |
769 | return 0; | |
770 | } |