Commit | Line | Data |
---|---|---|
16ca5ff0 PP |
1 | /* |
2 | * validation.c | |
3 | * | |
4 | * Babeltrace - CTF writer: Validation of trace, stream class, and event class | |
5 | * | |
6 | * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com> | |
7 | * | |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | */ | |
26 | ||
350ad6c1 | 27 | #define BT_LOG_TAG "CTF-WRITER/VALIDATION" |
67d2ce02 | 28 | #include "logging.h" |
16ca5ff0 | 29 | |
3fadfbc0 | 30 | #include <babeltrace2/ctf-writer/object.h> |
578e048b | 31 | |
91d81473 | 32 | #include "common/macros.h" |
578e048b MJ |
33 | |
34 | #include "assert-pre.h" | |
35 | #include "event-class.h" | |
36 | #include "field-types.h" | |
37 | #include "field-types.h" | |
38 | #include "resolve.h" | |
39 | #include "stream-class.h" | |
40 | #include "trace.h" | |
41 | #include "validation.h" | |
42 | #include "values.h" | |
16ca5ff0 PP |
43 | |
44 | /* | |
45 | * This function resolves and validates the field types of an event | |
46 | * class. Only `event_context_type` and `event_payload_type` are | |
47 | * resolved and validated; the other field types are used as eventual | |
48 | * resolving targets. | |
49 | * | |
50 | * All parameters are owned by the caller. | |
51 | */ | |
52 | static | |
e1e02a22 | 53 | int validate_event_class_types(struct bt_ctf_private_value *environment, |
16ca5ff0 PP |
54 | struct bt_ctf_field_type_common *packet_header_type, |
55 | struct bt_ctf_field_type_common *packet_context_type, | |
56 | struct bt_ctf_field_type_common *event_header_type, | |
57 | struct bt_ctf_field_type_common *stream_event_ctx_type, | |
58 | struct bt_ctf_field_type_common *event_context_type, | |
59 | struct bt_ctf_field_type_common *event_payload_type) | |
60 | { | |
61 | int ret = 0; | |
62 | ||
63 | BT_LOGV("Validating event class field types: " | |
64 | "packet-header-ft-addr=%p, " | |
65 | "packet-context-ft-addr=%p, " | |
66 | "event-header-ft-addr=%p, " | |
67 | "stream-event-context-ft-addr=%p, " | |
68 | "event-context-ft-addr=%p, " | |
69 | "event-payload-ft-addr=%p", | |
70 | packet_header_type, packet_context_type, event_header_type, | |
71 | stream_event_ctx_type, event_context_type, event_payload_type); | |
72 | ||
73 | /* Resolve sequence type lengths and variant type tags first */ | |
74 | ret = bt_ctf_resolve_types(environment, packet_header_type, | |
75 | packet_context_type, event_header_type, stream_event_ctx_type, | |
76 | event_context_type, event_payload_type, | |
77 | BT_CTF_RESOLVE_FLAG_EVENT_CONTEXT | | |
78 | BT_CTF_RESOLVE_FLAG_EVENT_PAYLOAD); | |
79 | if (ret) { | |
80 | BT_LOGW("Cannot resolve event class field types: ret=%d", | |
81 | ret); | |
82 | goto end; | |
83 | } | |
84 | ||
85 | /* Validate field types individually */ | |
86 | if (event_context_type) { | |
87 | ret = bt_ctf_field_type_common_validate(event_context_type); | |
88 | if (ret) { | |
89 | BT_LOGW("Invalid event class's context field type: " | |
90 | "ret=%d", ret); | |
91 | goto end; | |
92 | } | |
93 | } | |
94 | ||
95 | if (event_payload_type) { | |
96 | ret = bt_ctf_field_type_common_validate(event_payload_type); | |
97 | if (ret) { | |
98 | BT_LOGW("Invalid event class's payload field type: " | |
99 | "ret=%d", ret); | |
100 | goto end; | |
101 | } | |
102 | } | |
103 | ||
104 | end: | |
105 | return ret; | |
106 | } | |
107 | ||
108 | /* | |
109 | * This function resolves and validates the field types of a stream | |
110 | * class. Only `packet_context_type`, `event_header_type`, and | |
111 | * `stream_event_ctx_type` are resolved and validated; the other field | |
112 | * type is used as an eventual resolving target. | |
113 | * | |
114 | * All parameters are owned by the caller. | |
115 | */ | |
116 | static | |
e1e02a22 | 117 | int validate_stream_class_types(struct bt_ctf_private_value *environment, |
16ca5ff0 PP |
118 | struct bt_ctf_field_type_common *packet_header_type, |
119 | struct bt_ctf_field_type_common *packet_context_type, | |
120 | struct bt_ctf_field_type_common *event_header_type, | |
121 | struct bt_ctf_field_type_common *stream_event_ctx_type) | |
122 | { | |
123 | int ret = 0; | |
124 | ||
125 | BT_LOGV("Validating stream class field types: " | |
126 | "packet-header-ft-addr=%p, " | |
127 | "packet-context-ft-addr=%p, " | |
128 | "event-header-ft-addr=%p, " | |
129 | "stream-event-context-ft-addr=%p", | |
130 | packet_header_type, packet_context_type, event_header_type, | |
131 | stream_event_ctx_type); | |
132 | ||
133 | /* Resolve sequence type lengths and variant type tags first */ | |
134 | ret = bt_ctf_resolve_types(environment, packet_header_type, | |
135 | packet_context_type, event_header_type, stream_event_ctx_type, | |
136 | NULL, NULL, | |
137 | BT_CTF_RESOLVE_FLAG_PACKET_CONTEXT | | |
138 | BT_CTF_RESOLVE_FLAG_EVENT_HEADER | | |
139 | BT_CTF_RESOLVE_FLAG_STREAM_EVENT_CTX); | |
140 | if (ret) { | |
141 | BT_LOGW("Cannot resolve stream class field types: ret=%d", | |
142 | ret); | |
143 | goto end; | |
144 | } | |
145 | ||
146 | /* Validate field types individually */ | |
147 | if (packet_context_type) { | |
148 | ret = bt_ctf_field_type_common_validate(packet_context_type); | |
149 | if (ret) { | |
150 | BT_LOGW("Invalid stream class's packet context field type: " | |
151 | "ret=%d", ret); | |
152 | goto end; | |
153 | } | |
154 | } | |
155 | ||
156 | if (event_header_type) { | |
157 | ret = bt_ctf_field_type_common_validate(event_header_type); | |
158 | if (ret) { | |
159 | BT_LOGW("Invalid stream class's event header field type: " | |
160 | "ret=%d", ret); | |
161 | goto end; | |
162 | } | |
163 | } | |
164 | ||
165 | if (stream_event_ctx_type) { | |
166 | ret = bt_ctf_field_type_common_validate( | |
167 | stream_event_ctx_type); | |
168 | if (ret) { | |
169 | BT_LOGW("Invalid stream class's event context field type: " | |
170 | "ret=%d", ret); | |
171 | goto end; | |
172 | } | |
173 | } | |
174 | ||
175 | end: | |
176 | return ret; | |
177 | } | |
178 | ||
179 | /* | |
180 | * This function resolves and validates the field types of a trace. | |
181 | * | |
182 | * All parameters are owned by the caller. | |
183 | */ | |
184 | static | |
e1e02a22 | 185 | int validate_trace_types(struct bt_ctf_private_value *environment, |
16ca5ff0 PP |
186 | struct bt_ctf_field_type_common *packet_header_type) |
187 | { | |
188 | int ret = 0; | |
189 | ||
190 | BT_LOGV("Validating event class field types: " | |
191 | "packet-header-ft-addr=%p", packet_header_type); | |
192 | ||
193 | /* Resolve sequence type lengths and variant type tags first */ | |
194 | ret = bt_ctf_resolve_types(environment, packet_header_type, | |
195 | NULL, NULL, NULL, NULL, NULL, | |
196 | BT_CTF_RESOLVE_FLAG_PACKET_HEADER); | |
197 | if (ret) { | |
198 | BT_LOGW("Cannot resolve trace field types: ret=%d", | |
199 | ret); | |
200 | goto end; | |
201 | } | |
202 | ||
203 | /* Validate field types individually */ | |
204 | if (packet_header_type) { | |
205 | ret = bt_ctf_field_type_common_validate(packet_header_type); | |
206 | if (ret) { | |
207 | BT_LOGW("Invalid trace's packet header field type: " | |
208 | "ret=%d", ret); | |
209 | goto end; | |
210 | } | |
211 | } | |
212 | ||
213 | end: | |
214 | return ret; | |
215 | } | |
216 | ||
217 | /* | |
218 | * Checks whether or not `field_type` contains a variant or a sequence | |
219 | * field type, recursively. Returns 1 if it's the case. | |
220 | * | |
221 | * `field_type` is owned by the caller. | |
222 | */ | |
223 | static | |
224 | int field_type_contains_sequence_or_variant_ft(struct bt_ctf_field_type_common *type) | |
225 | { | |
226 | int ret = 0; | |
227 | enum bt_ctf_field_type_id type_id = bt_ctf_field_type_common_get_type_id(type); | |
228 | ||
229 | switch (type_id) { | |
230 | case BT_CTF_FIELD_TYPE_ID_SEQUENCE: | |
231 | case BT_CTF_FIELD_TYPE_ID_VARIANT: | |
232 | ret = 1; | |
233 | goto end; | |
234 | case BT_CTF_FIELD_TYPE_ID_ARRAY: | |
235 | case BT_CTF_FIELD_TYPE_ID_STRUCT: | |
236 | { | |
237 | int i; | |
238 | int field_count = bt_ctf_field_type_common_get_field_count(type); | |
239 | ||
240 | if (field_count < 0) { | |
241 | ret = -1; | |
242 | goto end; | |
243 | } | |
244 | ||
245 | for (i = 0; i < field_count; ++i) { | |
246 | struct bt_ctf_field_type_common *child_type = | |
247 | bt_ctf_field_type_common_borrow_field_at_index( | |
248 | type, i); | |
249 | ||
250 | ret = field_type_contains_sequence_or_variant_ft( | |
251 | child_type); | |
252 | if (ret != 0) { | |
253 | goto end; | |
254 | } | |
255 | } | |
256 | break; | |
257 | } | |
258 | default: | |
259 | break; | |
260 | } | |
261 | ||
262 | end: | |
263 | return ret; | |
264 | } | |
265 | ||
266 | BT_HIDDEN | |
e1e02a22 | 267 | int bt_ctf_validate_class_types(struct bt_ctf_private_value *environment, |
16ca5ff0 PP |
268 | struct bt_ctf_field_type_common *packet_header_type, |
269 | struct bt_ctf_field_type_common *packet_context_type, | |
270 | struct bt_ctf_field_type_common *event_header_type, | |
271 | struct bt_ctf_field_type_common *stream_event_ctx_type, | |
272 | struct bt_ctf_field_type_common *event_context_type, | |
273 | struct bt_ctf_field_type_common *event_payload_type, | |
274 | int trace_valid, int stream_class_valid, int event_class_valid, | |
275 | struct bt_ctf_validation_output *output, | |
276 | enum bt_ctf_validation_flag validate_flags, | |
277 | bt_ctf_validation_flag_copy_field_type_func copy_field_type_func) | |
278 | { | |
279 | int ret = 0; | |
280 | int contains_seq_var; | |
281 | int valid_ret; | |
282 | ||
283 | BT_LOGV("Validating field types: " | |
284 | "packet-header-ft-addr=%p, " | |
285 | "packet-context-ft-addr=%p, " | |
286 | "event-header-ft-addr=%p, " | |
287 | "stream-event-context-ft-addr=%p, " | |
288 | "event-context-ft-addr=%p, " | |
289 | "event-payload-ft-addr=%p, " | |
290 | "trace-is-valid=%d, stream-class-is-valid=%d, " | |
291 | "event-class-is-valid=%d, validation-flags=%x", | |
292 | packet_header_type, packet_context_type, event_header_type, | |
293 | stream_event_ctx_type, event_context_type, event_payload_type, | |
294 | trace_valid, stream_class_valid, event_class_valid, | |
295 | (unsigned int) validate_flags); | |
296 | ||
297 | /* Clean output values */ | |
298 | memset(output, 0, sizeof(*output)); | |
299 | ||
300 | /* Set initial valid flags according to valid parameters */ | |
301 | if (trace_valid) { | |
302 | output->valid_flags |= BT_CTF_VALIDATION_FLAG_TRACE; | |
303 | } | |
304 | ||
305 | if (stream_class_valid) { | |
306 | output->valid_flags |= BT_CTF_VALIDATION_FLAG_STREAM; | |
307 | } | |
308 | ||
309 | if (event_class_valid) { | |
310 | output->valid_flags |= BT_CTF_VALIDATION_FLAG_EVENT; | |
311 | } | |
312 | ||
313 | /* Own the type parameters */ | |
e1e02a22 PP |
314 | bt_ctf_object_get_ref(packet_header_type); |
315 | bt_ctf_object_get_ref(packet_context_type); | |
316 | bt_ctf_object_get_ref(event_header_type); | |
317 | bt_ctf_object_get_ref(stream_event_ctx_type); | |
318 | bt_ctf_object_get_ref(event_context_type); | |
319 | bt_ctf_object_get_ref(event_payload_type); | |
16ca5ff0 PP |
320 | |
321 | /* Validate trace */ | |
322 | if ((validate_flags & BT_CTF_VALIDATION_FLAG_TRACE) && !trace_valid) { | |
323 | struct bt_ctf_field_type_common *packet_header_type_copy = NULL; | |
324 | ||
325 | /* Create field type copies */ | |
326 | if (packet_header_type) { | |
327 | contains_seq_var = | |
328 | field_type_contains_sequence_or_variant_ft( | |
329 | packet_header_type); | |
330 | if (contains_seq_var < 0) { | |
331 | ret = contains_seq_var; | |
332 | goto error; | |
333 | } else if (!contains_seq_var) { | |
334 | /* No copy is needed */ | |
335 | packet_header_type_copy = packet_header_type; | |
e1e02a22 | 336 | bt_ctf_object_get_ref(packet_header_type_copy); |
16ca5ff0 PP |
337 | goto skip_packet_header_type_copy; |
338 | } | |
339 | ||
340 | BT_LOGV_STR("Copying packet header field type because it contains at least one sequence or variant field type."); | |
341 | packet_header_type_copy = | |
342 | copy_field_type_func(packet_header_type); | |
343 | if (!packet_header_type_copy) { | |
344 | ret = -1; | |
345 | BT_LOGE_STR("Cannot copy packet header field type."); | |
346 | goto error; | |
347 | } | |
348 | ||
349 | /* | |
350 | * Freeze this copy: if it's returned to the | |
351 | * caller, it cannot be modified any way since | |
352 | * it will be resolved. | |
353 | */ | |
354 | bt_ctf_field_type_common_freeze(packet_header_type_copy); | |
355 | } | |
356 | ||
357 | skip_packet_header_type_copy: | |
358 | /* Put original reference and move copy */ | |
e1e02a22 | 359 | BT_CTF_OBJECT_MOVE_REF(packet_header_type, packet_header_type_copy); |
16ca5ff0 PP |
360 | |
361 | /* Validate trace field types */ | |
362 | valid_ret = validate_trace_types(environment, | |
363 | packet_header_type); | |
364 | if (valid_ret == 0) { | |
365 | /* Trace is valid */ | |
366 | output->valid_flags |= BT_CTF_VALIDATION_FLAG_TRACE; | |
367 | } | |
368 | } | |
369 | ||
370 | /* Validate stream class */ | |
371 | if ((validate_flags & BT_CTF_VALIDATION_FLAG_STREAM) && | |
372 | !stream_class_valid) { | |
373 | struct bt_ctf_field_type_common *packet_context_type_copy = NULL; | |
374 | struct bt_ctf_field_type_common *event_header_type_copy = NULL; | |
375 | struct bt_ctf_field_type_common *stream_event_ctx_type_copy = NULL; | |
376 | ||
377 | if (packet_context_type) { | |
378 | contains_seq_var = | |
379 | field_type_contains_sequence_or_variant_ft( | |
380 | packet_context_type); | |
381 | if (contains_seq_var < 0) { | |
382 | ret = contains_seq_var; | |
383 | goto error; | |
384 | } else if (!contains_seq_var) { | |
385 | /* No copy is needed */ | |
386 | packet_context_type_copy = packet_context_type; | |
e1e02a22 | 387 | bt_ctf_object_get_ref(packet_context_type_copy); |
16ca5ff0 PP |
388 | goto skip_packet_context_type_copy; |
389 | } | |
390 | ||
391 | BT_LOGV_STR("Copying packet context field type because it contains at least one sequence or variant field type."); | |
392 | packet_context_type_copy = | |
393 | copy_field_type_func(packet_context_type); | |
394 | if (!packet_context_type_copy) { | |
395 | BT_LOGE_STR("Cannot copy packet context field type."); | |
396 | goto sc_validation_error; | |
397 | } | |
398 | ||
399 | /* | |
400 | * Freeze this copy: if it's returned to the | |
401 | * caller, it cannot be modified any way since | |
402 | * it will be resolved. | |
403 | */ | |
404 | bt_ctf_field_type_common_freeze(packet_context_type_copy); | |
405 | } | |
406 | ||
407 | skip_packet_context_type_copy: | |
408 | if (event_header_type) { | |
409 | contains_seq_var = | |
410 | field_type_contains_sequence_or_variant_ft( | |
411 | event_header_type); | |
412 | if (contains_seq_var < 0) { | |
413 | ret = contains_seq_var; | |
414 | goto error; | |
415 | } else if (!contains_seq_var) { | |
416 | /* No copy is needed */ | |
417 | event_header_type_copy = event_header_type; | |
e1e02a22 | 418 | bt_ctf_object_get_ref(event_header_type_copy); |
16ca5ff0 PP |
419 | goto skip_event_header_type_copy; |
420 | } | |
421 | ||
422 | BT_LOGV_STR("Copying event header field type because it contains at least one sequence or variant field type."); | |
423 | event_header_type_copy = | |
424 | copy_field_type_func(event_header_type); | |
425 | if (!event_header_type_copy) { | |
426 | BT_LOGE_STR("Cannot copy event header field type."); | |
427 | goto sc_validation_error; | |
428 | } | |
429 | ||
430 | /* | |
431 | * Freeze this copy: if it's returned to the | |
432 | * caller, it cannot be modified any way since | |
433 | * it will be resolved. | |
434 | */ | |
435 | bt_ctf_field_type_common_freeze(event_header_type_copy); | |
436 | } | |
437 | ||
438 | skip_event_header_type_copy: | |
439 | if (stream_event_ctx_type) { | |
440 | contains_seq_var = | |
441 | field_type_contains_sequence_or_variant_ft( | |
442 | stream_event_ctx_type); | |
443 | if (contains_seq_var < 0) { | |
444 | ret = contains_seq_var; | |
445 | goto error; | |
446 | } else if (!contains_seq_var) { | |
447 | /* No copy is needed */ | |
448 | stream_event_ctx_type_copy = | |
449 | stream_event_ctx_type; | |
e1e02a22 | 450 | bt_ctf_object_get_ref(stream_event_ctx_type_copy); |
16ca5ff0 PP |
451 | goto skip_stream_event_ctx_type_copy; |
452 | } | |
453 | ||
454 | BT_LOGV_STR("Copying stream event context field type because it contains at least one sequence or variant field type."); | |
455 | stream_event_ctx_type_copy = | |
456 | copy_field_type_func(stream_event_ctx_type); | |
457 | if (!stream_event_ctx_type_copy) { | |
458 | BT_LOGE_STR("Cannot copy stream event context field type."); | |
459 | goto sc_validation_error; | |
460 | } | |
461 | ||
462 | /* | |
463 | * Freeze this copy: if it's returned to the | |
464 | * caller, it cannot be modified any way since | |
465 | * it will be resolved. | |
466 | */ | |
467 | bt_ctf_field_type_common_freeze(stream_event_ctx_type_copy); | |
468 | } | |
469 | ||
470 | skip_stream_event_ctx_type_copy: | |
471 | /* Put original references and move copies */ | |
e1e02a22 PP |
472 | BT_CTF_OBJECT_MOVE_REF(packet_context_type, packet_context_type_copy); |
473 | BT_CTF_OBJECT_MOVE_REF(event_header_type, event_header_type_copy); | |
474 | BT_CTF_OBJECT_MOVE_REF(stream_event_ctx_type, stream_event_ctx_type_copy); | |
16ca5ff0 PP |
475 | |
476 | /* Validate stream class field types */ | |
477 | valid_ret = validate_stream_class_types(environment, | |
478 | packet_header_type, packet_context_type, | |
479 | event_header_type, stream_event_ctx_type); | |
480 | if (valid_ret == 0) { | |
481 | /* Stream class is valid */ | |
482 | output->valid_flags |= BT_CTF_VALIDATION_FLAG_STREAM; | |
483 | } | |
484 | ||
485 | goto sc_validation_done; | |
486 | ||
487 | sc_validation_error: | |
e1e02a22 PP |
488 | BT_CTF_OBJECT_PUT_REF_AND_RESET(packet_context_type_copy); |
489 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event_header_type_copy); | |
490 | BT_CTF_OBJECT_PUT_REF_AND_RESET(stream_event_ctx_type_copy); | |
16ca5ff0 PP |
491 | ret = -1; |
492 | goto error; | |
493 | } | |
494 | ||
495 | sc_validation_done: | |
496 | /* Validate event class */ | |
497 | if ((validate_flags & BT_CTF_VALIDATION_FLAG_EVENT) && | |
498 | !event_class_valid) { | |
499 | struct bt_ctf_field_type_common *event_context_type_copy = NULL; | |
500 | struct bt_ctf_field_type_common *event_payload_type_copy = NULL; | |
501 | ||
502 | if (event_context_type) { | |
503 | contains_seq_var = | |
504 | field_type_contains_sequence_or_variant_ft( | |
505 | event_context_type); | |
506 | if (contains_seq_var < 0) { | |
507 | ret = contains_seq_var; | |
508 | goto error; | |
509 | } else if (!contains_seq_var) { | |
510 | /* No copy is needed */ | |
511 | event_context_type_copy = event_context_type; | |
e1e02a22 | 512 | bt_ctf_object_get_ref(event_context_type_copy); |
16ca5ff0 PP |
513 | goto skip_event_context_type_copy; |
514 | } | |
515 | ||
516 | BT_LOGV_STR("Copying event context field type because it contains at least one sequence or variant field type."); | |
517 | event_context_type_copy = | |
518 | copy_field_type_func(event_context_type); | |
519 | if (!event_context_type_copy) { | |
520 | BT_LOGE_STR("Cannot copy event context field type."); | |
521 | goto ec_validation_error; | |
522 | } | |
523 | ||
524 | /* | |
525 | * Freeze this copy: if it's returned to the | |
526 | * caller, it cannot be modified any way since | |
527 | * it will be resolved. | |
528 | */ | |
529 | bt_ctf_field_type_common_freeze(event_context_type_copy); | |
530 | } | |
531 | ||
532 | skip_event_context_type_copy: | |
533 | if (event_payload_type) { | |
534 | contains_seq_var = | |
535 | field_type_contains_sequence_or_variant_ft( | |
536 | event_payload_type); | |
537 | if (contains_seq_var < 0) { | |
538 | ret = contains_seq_var; | |
539 | goto error; | |
540 | } else if (!contains_seq_var) { | |
541 | /* No copy is needed */ | |
542 | event_payload_type_copy = event_payload_type; | |
e1e02a22 | 543 | bt_ctf_object_get_ref(event_payload_type_copy); |
16ca5ff0 PP |
544 | goto skip_event_payload_type_copy; |
545 | } | |
546 | ||
547 | BT_LOGV_STR("Copying event payload field type because it contains at least one sequence or variant field type."); | |
548 | event_payload_type_copy = | |
549 | copy_field_type_func(event_payload_type); | |
550 | if (!event_payload_type_copy) { | |
551 | BT_LOGE_STR("Cannot copy event payload field type."); | |
552 | goto ec_validation_error; | |
553 | } | |
554 | ||
555 | /* | |
556 | * Freeze this copy: if it's returned to the | |
557 | * caller, it cannot be modified any way since | |
558 | * it will be resolved. | |
559 | */ | |
560 | bt_ctf_field_type_common_freeze(event_payload_type_copy); | |
561 | } | |
562 | ||
563 | skip_event_payload_type_copy: | |
564 | /* Put original references and move copies */ | |
e1e02a22 PP |
565 | BT_CTF_OBJECT_MOVE_REF(event_context_type, event_context_type_copy); |
566 | BT_CTF_OBJECT_MOVE_REF(event_payload_type, event_payload_type_copy); | |
16ca5ff0 PP |
567 | |
568 | /* Validate event class field types */ | |
569 | valid_ret = validate_event_class_types(environment, | |
570 | packet_header_type, packet_context_type, | |
571 | event_header_type, stream_event_ctx_type, | |
572 | event_context_type, event_payload_type); | |
573 | if (valid_ret == 0) { | |
574 | /* Event class is valid */ | |
575 | output->valid_flags |= BT_CTF_VALIDATION_FLAG_EVENT; | |
576 | } | |
577 | ||
578 | goto ec_validation_done; | |
579 | ||
580 | ec_validation_error: | |
e1e02a22 PP |
581 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event_context_type_copy); |
582 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event_payload_type_copy); | |
16ca5ff0 PP |
583 | ret = -1; |
584 | goto error; | |
585 | } | |
586 | ||
587 | ec_validation_done: | |
588 | /* | |
589 | * Validation is complete. Move the field types that were used | |
590 | * to validate (and that were possibly altered by the validation | |
591 | * process) to the output values. | |
592 | */ | |
e1e02a22 PP |
593 | BT_CTF_OBJECT_MOVE_REF(output->packet_header_type, packet_header_type); |
594 | BT_CTF_OBJECT_MOVE_REF(output->packet_context_type, packet_context_type); | |
595 | BT_CTF_OBJECT_MOVE_REF(output->event_header_type, event_header_type); | |
596 | BT_CTF_OBJECT_MOVE_REF(output->stream_event_ctx_type, stream_event_ctx_type); | |
597 | BT_CTF_OBJECT_MOVE_REF(output->event_context_type, event_context_type); | |
598 | BT_CTF_OBJECT_MOVE_REF(output->event_payload_type, event_payload_type); | |
16ca5ff0 PP |
599 | return ret; |
600 | ||
601 | error: | |
e1e02a22 PP |
602 | BT_CTF_OBJECT_PUT_REF_AND_RESET(packet_header_type); |
603 | BT_CTF_OBJECT_PUT_REF_AND_RESET(packet_context_type); | |
604 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event_header_type); | |
605 | BT_CTF_OBJECT_PUT_REF_AND_RESET(stream_event_ctx_type); | |
606 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event_context_type); | |
607 | BT_CTF_OBJECT_PUT_REF_AND_RESET(event_payload_type); | |
16ca5ff0 PP |
608 | return ret; |
609 | } | |
610 | ||
611 | BT_HIDDEN | |
612 | void bt_ctf_validation_replace_types(struct bt_ctf_trace_common *trace, | |
613 | struct bt_ctf_stream_class_common *stream_class, | |
614 | struct bt_ctf_event_class_common *event_class, | |
615 | struct bt_ctf_validation_output *output, | |
616 | enum bt_ctf_validation_flag replace_flags) | |
617 | { | |
618 | if ((replace_flags & BT_CTF_VALIDATION_FLAG_TRACE) && trace) { | |
619 | bt_ctf_field_type_common_freeze(trace->packet_header_field_type); | |
e1e02a22 | 620 | BT_CTF_OBJECT_MOVE_REF(trace->packet_header_field_type, |
16ca5ff0 PP |
621 | output->packet_header_type); |
622 | } | |
623 | ||
624 | if ((replace_flags & BT_CTF_VALIDATION_FLAG_STREAM) && stream_class) { | |
625 | bt_ctf_field_type_common_freeze(stream_class->packet_context_field_type); | |
626 | bt_ctf_field_type_common_freeze(stream_class->event_header_field_type); | |
627 | bt_ctf_field_type_common_freeze(stream_class->event_context_field_type); | |
e1e02a22 | 628 | BT_CTF_OBJECT_MOVE_REF(stream_class->packet_context_field_type, |
16ca5ff0 | 629 | output->packet_context_type); |
e1e02a22 | 630 | BT_CTF_OBJECT_MOVE_REF(stream_class->event_header_field_type, |
16ca5ff0 | 631 | output->event_header_type); |
e1e02a22 | 632 | BT_CTF_OBJECT_MOVE_REF(stream_class->event_context_field_type, |
16ca5ff0 PP |
633 | output->stream_event_ctx_type); |
634 | } | |
635 | ||
636 | if ((replace_flags & BT_CTF_VALIDATION_FLAG_EVENT) && event_class) { | |
637 | bt_ctf_field_type_common_freeze(event_class->context_field_type); | |
638 | bt_ctf_field_type_common_freeze(event_class->payload_field_type); | |
e1e02a22 PP |
639 | BT_CTF_OBJECT_MOVE_REF(event_class->context_field_type, output->event_context_type); |
640 | BT_CTF_OBJECT_MOVE_REF(event_class->payload_field_type, output->event_payload_type); | |
16ca5ff0 PP |
641 | } |
642 | } | |
643 | ||
644 | BT_HIDDEN | |
645 | void bt_ctf_validation_output_put_types( | |
646 | struct bt_ctf_validation_output *output) | |
647 | { | |
e1e02a22 PP |
648 | BT_CTF_OBJECT_PUT_REF_AND_RESET(output->packet_header_type); |
649 | BT_CTF_OBJECT_PUT_REF_AND_RESET(output->packet_context_type); | |
650 | BT_CTF_OBJECT_PUT_REF_AND_RESET(output->event_header_type); | |
651 | BT_CTF_OBJECT_PUT_REF_AND_RESET(output->stream_event_ctx_type); | |
652 | BT_CTF_OBJECT_PUT_REF_AND_RESET(output->event_context_type); | |
653 | BT_CTF_OBJECT_PUT_REF_AND_RESET(output->event_payload_type); | |
16ca5ff0 | 654 | } |