Commit | Line | Data |
---|---|---|
e6938018 PP |
1 | /* |
2 | * SPDX-License-Identifier: MIT | |
3 | * | |
4 | * Copyright 2020 Philippe Proulx <pproulx@efficios.com> | |
5 | */ | |
6 | ||
7 | #include <babeltrace2/babeltrace.h> | |
8 | #include "common/macros.h" | |
9 | #include "common/assert.h" | |
10 | #include <glib.h> | |
11 | #include <stdint.h> | |
12 | #include <string.h> | |
13 | #include <inttypes.h> | |
14 | ||
087cd0f5 | 15 | #include "ctf-meta-visitors.hpp" |
e6938018 | 16 | |
4164020e | 17 | static inline int set_alignments(struct ctf_field_class *fc) |
e6938018 | 18 | { |
4164020e SM |
19 | int ret = 0; |
20 | uint64_t i; | |
21 | ||
22 | if (!fc) { | |
23 | goto end; | |
24 | } | |
25 | ||
26 | switch (fc->type) { | |
27 | case CTF_FIELD_CLASS_TYPE_STRUCT: | |
28 | { | |
29 | struct ctf_field_class_struct *struct_fc = ctf_field_class_as_struct(fc); | |
30 | ||
31 | for (i = 0; i < struct_fc->members->len; i++) { | |
32 | struct ctf_named_field_class *named_fc = | |
33 | ctf_field_class_struct_borrow_member_by_index(struct_fc, i); | |
34 | ||
35 | ret = set_alignments(named_fc->fc); | |
36 | if (ret) { | |
37 | goto end; | |
38 | } | |
39 | ||
40 | if (named_fc->fc->alignment > fc->alignment) { | |
41 | fc->alignment = named_fc->fc->alignment; | |
42 | } | |
43 | } | |
44 | ||
45 | break; | |
46 | } | |
47 | case CTF_FIELD_CLASS_TYPE_VARIANT: | |
48 | { | |
49 | struct ctf_field_class_variant *var_fc = ctf_field_class_as_variant(fc); | |
50 | ||
51 | for (i = 0; i < var_fc->options->len; i++) { | |
52 | struct ctf_named_field_class *named_fc = | |
53 | ctf_field_class_variant_borrow_option_by_index(var_fc, i); | |
54 | ||
55 | ret = set_alignments(named_fc->fc); | |
56 | if (ret) { | |
57 | goto end; | |
58 | } | |
59 | } | |
60 | ||
61 | break; | |
62 | } | |
63 | case CTF_FIELD_CLASS_TYPE_ARRAY: | |
64 | case CTF_FIELD_CLASS_TYPE_SEQUENCE: | |
65 | { | |
66 | struct ctf_field_class_array_base *array_fc = ctf_field_class_as_array_base(fc); | |
67 | ||
68 | ret = set_alignments(array_fc->elem_fc); | |
69 | if (ret) { | |
70 | goto end; | |
71 | } | |
72 | ||
73 | /* | |
74 | * Use the alignment of the array/sequence field class's | |
75 | * element FC as its own alignment. | |
76 | * | |
77 | * This is especially important when the array/sequence | |
78 | * field's effective length is zero: as per CTF 1.8, the | |
79 | * stream data decoding process still needs to align the | |
80 | * cursor using the element's alignment [1]: | |
81 | * | |
82 | * > Arrays are always aligned on their element | |
83 | * > alignment requirement. | |
84 | * | |
85 | * For example: | |
86 | * | |
87 | * struct { | |
88 | * integer { size = 8; } a; | |
89 | * integer { size = 8; align = 16; } b[0]; | |
90 | * integer { size = 8; } c; | |
91 | * }; | |
92 | * | |
93 | * When using this to decode the bytes 1, 2, and 3, then | |
94 | * the decoded values are: | |
95 | * | |
96 | * `a`: 1 | |
97 | * `b`: [] | |
98 | * `c`: 3 | |
99 | * | |
100 | * [1]: https://diamon.org/ctf/#spec4.2.3 | |
101 | */ | |
102 | array_fc->base.alignment = array_fc->elem_fc->alignment; | |
103 | break; | |
104 | } | |
105 | default: | |
106 | break; | |
107 | } | |
e6938018 PP |
108 | |
109 | end: | |
4164020e | 110 | return ret; |
e6938018 PP |
111 | } |
112 | ||
4164020e | 113 | int ctf_trace_class_update_alignments(struct ctf_trace_class *ctf_tc) |
e6938018 | 114 | { |
4164020e SM |
115 | int ret = 0; |
116 | uint64_t i; | |
117 | ||
118 | if (!ctf_tc->is_translated) { | |
119 | ret = set_alignments(ctf_tc->packet_header_fc); | |
120 | if (ret) { | |
121 | goto end; | |
122 | } | |
123 | } | |
124 | ||
125 | for (i = 0; i < ctf_tc->stream_classes->len; i++) { | |
126 | ctf_stream_class *sc = (ctf_stream_class *) ctf_tc->stream_classes->pdata[i]; | |
127 | uint64_t j; | |
128 | ||
129 | if (!sc->is_translated) { | |
130 | ret = set_alignments(sc->packet_context_fc); | |
131 | if (ret) { | |
132 | goto end; | |
133 | } | |
134 | ||
135 | ret = set_alignments(sc->event_header_fc); | |
136 | if (ret) { | |
137 | goto end; | |
138 | } | |
139 | ||
140 | ret = set_alignments(sc->event_common_context_fc); | |
141 | if (ret) { | |
142 | goto end; | |
143 | } | |
144 | } | |
145 | ||
146 | for (j = 0; j < sc->event_classes->len; j++) { | |
147 | struct ctf_event_class *ec = (ctf_event_class *) sc->event_classes->pdata[j]; | |
148 | ||
149 | if (ec->is_translated) { | |
150 | continue; | |
151 | } | |
152 | ||
153 | ret = set_alignments(ec->spec_context_fc); | |
154 | if (ret) { | |
155 | goto end; | |
156 | } | |
157 | ||
158 | ret = set_alignments(ec->payload_fc); | |
159 | if (ret) { | |
160 | goto end; | |
161 | } | |
162 | } | |
163 | } | |
e6938018 PP |
164 | |
165 | end: | |
4164020e | 166 | return ret; |
e6938018 | 167 | } |