Commit | Line | Data |
---|---|---|
09840de5 PP |
1 | /* |
2 | * resolve.c | |
3 | * | |
4 | * Babeltrace - CTF IR: Type resolving internal | |
5 | * | |
6 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
7 | * Copyright 2016 Philippe Proulx <pproulx@efficios.com> | |
8 | * | |
9 | * Authors: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * Philippe Proulx <pproulx@efficios.com> | |
11 | * | |
12 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
13 | * of this software and associated documentation files (the "Software"), to deal | |
14 | * in the Software without restriction, including without limitation the rights | |
15 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
16 | * copies of the Software, and to permit persons to whom the Software is | |
17 | * furnished to do so, subject to the following conditions: | |
18 | * | |
19 | * The above copyright notice and this permission notice shall be included in | |
20 | * all copies or substantial portions of the Software. | |
21 | * | |
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
25 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
26 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
27 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
28 | * SOFTWARE. | |
29 | */ | |
30 | ||
c2db73d1 PP |
31 | #define BT_LOG_TAG "RESOLVE" |
32 | #include <babeltrace/lib-logging-internal.h> | |
33 | ||
09840de5 PP |
34 | #include <babeltrace/ctf-ir/stream-class.h> |
35 | #include <babeltrace/ctf-ir/resolve-internal.h> | |
2e33ac5a | 36 | #include <babeltrace/ctf-ir/field-types.h> |
b011f6b0 PP |
37 | #include <babeltrace/ctf-ir/field-path.h> |
38 | #include <babeltrace/ctf-ir/field-path-internal.h> | |
09840de5 PP |
39 | #include <babeltrace/ref.h> |
40 | #include <babeltrace/babeltrace-internal.h> | |
41 | #include <babeltrace/values.h> | |
c55a9f58 | 42 | #include <babeltrace/types.h> |
f6ccaed9 | 43 | #include <babeltrace/assert-internal.h> |
09840de5 | 44 | #include <limits.h> |
c2db73d1 | 45 | #include <inttypes.h> |
0fbb9a9f | 46 | #include <stdlib.h> |
09840de5 PP |
47 | #include <glib.h> |
48 | ||
09840de5 PP |
49 | typedef GPtrArray type_stack; |
50 | ||
51 | /* | |
52 | * A stack frame. | |
53 | * | |
54 | * `type` contains a compound field type (structure, variant, array, | |
55 | * or sequence) and `index` indicates the index of the field type in | |
56 | * the upper frame (-1 for array and sequence field types). | |
57 | * | |
58 | * `type` is owned by the stack frame. | |
59 | */ | |
60 | struct type_stack_frame { | |
cb6f1f7d | 61 | struct bt_field_type *type; |
09840de5 PP |
62 | int index; |
63 | }; | |
64 | ||
65 | /* | |
66 | * The current context of the resolving engine. | |
67 | * | |
68 | * `scopes` contain the 6 CTF scope field types (see CTF, sect. 7.3.2) | |
69 | * in the following order: | |
70 | * | |
71 | * * Packet header | |
72 | * * Packet context | |
73 | * * Event header | |
74 | * * Stream event context | |
75 | * * Event context | |
76 | * * Event payload | |
77 | */ | |
78 | struct resolve_context { | |
79 | struct bt_value *environment; | |
cb6f1f7d | 80 | struct bt_field_type *scopes[6]; |
09840de5 | 81 | |
46df6b28 | 82 | /* Root scope being visited */ |
50842bdc | 83 | enum bt_scope root_scope; |
09840de5 | 84 | type_stack *type_stack; |
cb6f1f7d | 85 | struct bt_field_type *cur_field_type; |
09840de5 PP |
86 | }; |
87 | ||
88 | /* TSDL dynamic scope prefixes as defined in CTF Section 7.3.2 */ | |
89 | static const char * const absolute_path_prefixes[] = { | |
3dca2276 PP |
90 | [BT_SCOPE_ENV] = "env.", |
91 | [BT_SCOPE_TRACE_PACKET_HEADER] = "trace.packet.header.", | |
50842bdc | 92 | [BT_SCOPE_STREAM_PACKET_CONTEXT] = "stream.packet.context.", |
3dca2276 PP |
93 | [BT_SCOPE_STREAM_EVENT_HEADER] = "stream.event.header.", |
94 | [BT_SCOPE_STREAM_EVENT_CONTEXT] = "stream.event.context.", | |
50842bdc | 95 | [BT_SCOPE_EVENT_CONTEXT] = "event.context.", |
3dca2276 | 96 | [BT_SCOPE_EVENT_FIELDS] = "event.fields.", |
09840de5 PP |
97 | }; |
98 | ||
99 | /* Number of path tokens used for the absolute prefixes */ | |
100 | static const int absolute_path_prefix_ptoken_counts[] = { | |
50842bdc PP |
101 | [BT_SCOPE_ENV] = 1, |
102 | [BT_SCOPE_TRACE_PACKET_HEADER] = 3, | |
103 | [BT_SCOPE_STREAM_PACKET_CONTEXT] = 3, | |
104 | [BT_SCOPE_STREAM_EVENT_HEADER] = 3, | |
105 | [BT_SCOPE_STREAM_EVENT_CONTEXT] = 3, | |
106 | [BT_SCOPE_EVENT_CONTEXT] = 2, | |
107 | [BT_SCOPE_EVENT_FIELDS] = 2, | |
09840de5 PP |
108 | }; |
109 | ||
110 | /* | |
111 | * Destroys a type stack frame. | |
112 | */ | |
113 | static | |
114 | void type_stack_destroy_notify(gpointer data) | |
115 | { | |
116 | struct type_stack_frame *frame = data; | |
117 | ||
118 | BT_PUT(frame->type); | |
119 | g_free(frame); | |
120 | } | |
121 | ||
122 | /* | |
123 | * Creates a type stack. | |
124 | * | |
125 | * Return value is owned by the caller. | |
126 | */ | |
127 | static | |
128 | type_stack *type_stack_create(void) | |
129 | { | |
130 | return g_ptr_array_new_with_free_func(type_stack_destroy_notify); | |
131 | } | |
132 | ||
133 | /* | |
134 | * Destroys a type stack. | |
135 | */ | |
136 | static | |
137 | void type_stack_destroy(type_stack *stack) | |
138 | { | |
139 | g_ptr_array_free(stack, TRUE); | |
140 | } | |
141 | ||
142 | /* | |
143 | * Pushes a field type onto a type stack. | |
144 | * | |
145 | * `type` is owned by the caller (stack frame gets a new reference). | |
146 | */ | |
147 | static | |
cb6f1f7d | 148 | int type_stack_push(type_stack *stack, struct bt_field_type *type) |
09840de5 PP |
149 | { |
150 | int ret = 0; | |
151 | struct type_stack_frame *frame = NULL; | |
152 | ||
153 | if (!stack || !type) { | |
c2db73d1 | 154 | BT_LOGW("Invalid parameter: stack or type is NULL."); |
09840de5 PP |
155 | ret = -1; |
156 | goto end; | |
157 | } | |
158 | ||
159 | frame = g_new0(struct type_stack_frame, 1); | |
160 | if (!frame) { | |
c2db73d1 | 161 | BT_LOGE_STR("Failed to allocate one field type stack frame."); |
09840de5 PP |
162 | ret = -1; |
163 | goto end; | |
164 | } | |
165 | ||
c2db73d1 PP |
166 | BT_LOGV("Pushing field type on context's stack: " |
167 | "ft-addr=%p, stack-size-before=%u", type, stack->len); | |
09840de5 PP |
168 | frame->type = bt_get(type); |
169 | g_ptr_array_add(stack, frame); | |
170 | ||
171 | end: | |
172 | return ret; | |
173 | } | |
174 | ||
175 | /* | |
176 | * Checks whether or not `stack` is empty. | |
177 | */ | |
178 | static | |
c55a9f58 | 179 | bt_bool type_stack_empty(type_stack *stack) |
09840de5 PP |
180 | { |
181 | return stack->len == 0; | |
182 | } | |
183 | ||
184 | /* | |
185 | * Returns the number of frames in `stack`. | |
186 | */ | |
187 | static | |
188 | size_t type_stack_size(type_stack *stack) | |
189 | { | |
190 | return stack->len; | |
191 | } | |
192 | ||
193 | /* | |
194 | * Returns the top frame of `stack`. | |
195 | * | |
196 | * Return value is owned by `stack`. | |
197 | */ | |
198 | static | |
199 | struct type_stack_frame *type_stack_peek(type_stack *stack) | |
200 | { | |
201 | struct type_stack_frame *entry = NULL; | |
202 | ||
203 | if (!stack || type_stack_empty(stack)) { | |
204 | goto end; | |
205 | } | |
206 | ||
207 | entry = g_ptr_array_index(stack, stack->len - 1); | |
208 | end: | |
209 | return entry; | |
210 | } | |
211 | ||
212 | /* | |
213 | * Returns the frame at index `index` in `stack`. | |
214 | * | |
215 | * Return value is owned by `stack`. | |
216 | */ | |
217 | static | |
218 | struct type_stack_frame *type_stack_at(type_stack *stack, | |
219 | size_t index) | |
220 | { | |
221 | struct type_stack_frame *entry = NULL; | |
222 | ||
223 | if (!stack || index >= stack->len) { | |
224 | goto end; | |
225 | } | |
226 | ||
227 | entry = g_ptr_array_index(stack, index); | |
228 | ||
229 | end: | |
230 | return entry; | |
231 | } | |
232 | ||
233 | /* | |
234 | * Removes the top frame of `stack`. | |
235 | */ | |
236 | static | |
237 | void type_stack_pop(type_stack *stack) | |
238 | { | |
239 | if (!type_stack_empty(stack)) { | |
240 | /* | |
241 | * This will call the frame's destructor and free it, as | |
242 | * well as put its contained field type. | |
243 | */ | |
c2db73d1 PP |
244 | BT_LOGV("Popping context's stack: stack-size-before=%u", |
245 | stack->len); | |
09840de5 PP |
246 | g_ptr_array_set_size(stack, stack->len - 1); |
247 | } | |
248 | } | |
249 | ||
250 | /* | |
251 | * Returns the scope field type of `scope` in the context `ctx`. | |
252 | * | |
253 | * Return value is owned by `ctx` on success. | |
254 | */ | |
255 | static | |
cb6f1f7d | 256 | struct bt_field_type *get_type_from_ctx(struct resolve_context *ctx, |
50842bdc | 257 | enum bt_scope scope) |
09840de5 | 258 | { |
f6ccaed9 | 259 | BT_ASSERT(scope >= BT_SCOPE_TRACE_PACKET_HEADER && |
50842bdc | 260 | scope <= BT_SCOPE_EVENT_FIELDS); |
09840de5 | 261 | |
50842bdc | 262 | return ctx->scopes[scope - BT_SCOPE_TRACE_PACKET_HEADER]; |
09840de5 PP |
263 | } |
264 | ||
265 | /* | |
266 | * Returns the CTF scope from a path string. May return | |
267 | * CTF_NODE_UNKNOWN if the path is found to be relative. | |
268 | */ | |
269 | static | |
50842bdc | 270 | enum bt_scope get_root_scope_from_absolute_pathstr(const char *pathstr) |
09840de5 | 271 | { |
50842bdc PP |
272 | enum bt_scope scope; |
273 | enum bt_scope ret = BT_SCOPE_UNKNOWN; | |
09840de5 PP |
274 | const size_t prefixes_count = sizeof(absolute_path_prefixes) / |
275 | sizeof(*absolute_path_prefixes); | |
276 | ||
50842bdc | 277 | for (scope = BT_SCOPE_ENV; scope < BT_SCOPE_ENV + |
46df6b28 | 278 | prefixes_count; scope++) { |
09840de5 PP |
279 | /* |
280 | * Chech if path string starts with a known absolute | |
281 | * path prefix. | |
282 | * | |
283 | * Refer to CTF 7.3.2 STATIC AND DYNAMIC SCOPES. | |
284 | */ | |
46df6b28 PP |
285 | if (strncmp(pathstr, absolute_path_prefixes[scope], |
286 | strlen(absolute_path_prefixes[scope]))) { | |
09840de5 | 287 | /* Prefix does not match: try the next one */ |
c2db73d1 PP |
288 | BT_LOGV("Prefix does not match: trying the next one: " |
289 | "path=\"%s\", path-prefix=\"%s\", scope=%s", | |
290 | pathstr, absolute_path_prefixes[scope], | |
3dca2276 | 291 | bt_common_scope_string(scope)); |
09840de5 PP |
292 | continue; |
293 | } | |
294 | ||
295 | /* Found it! */ | |
46df6b28 | 296 | ret = scope; |
c2db73d1 PP |
297 | BT_LOGV("Found root scope from absolute path: " |
298 | "path=\"%s\", scope=%s", pathstr, | |
3dca2276 | 299 | bt_common_scope_string(scope)); |
09840de5 PP |
300 | goto end; |
301 | } | |
302 | ||
303 | end: | |
304 | return ret; | |
305 | } | |
306 | ||
307 | /* | |
308 | * Destroys a path token. | |
309 | */ | |
310 | static | |
311 | void ptokens_destroy_func(gpointer ptoken, gpointer data) | |
312 | { | |
313 | g_string_free(ptoken, TRUE); | |
314 | } | |
315 | ||
316 | /* | |
317 | * Destroys a path token list. | |
318 | */ | |
319 | static | |
320 | void ptokens_destroy(GList *ptokens) | |
321 | { | |
322 | if (!ptokens) { | |
323 | return; | |
324 | } | |
325 | ||
326 | g_list_foreach(ptokens, ptokens_destroy_func, NULL); | |
327 | g_list_free(ptokens); | |
328 | } | |
329 | ||
330 | /* | |
331 | * Returns the string contained in a path token. | |
332 | */ | |
333 | static | |
334 | const char *ptoken_get_string(GList *ptoken) | |
335 | { | |
336 | GString *tokenstr = (GString *) ptoken->data; | |
337 | ||
338 | return tokenstr->str; | |
339 | } | |
340 | ||
341 | /* | |
342 | * Converts a path string to a path token list, that is, splits the | |
343 | * individual words of a path string into a list of individual | |
344 | * strings. | |
345 | * | |
346 | * Return value is owned by the caller on success. | |
347 | */ | |
348 | static | |
349 | GList *pathstr_to_ptokens(const char *pathstr) | |
350 | { | |
351 | const char *at = pathstr; | |
352 | const char *last = at; | |
353 | GList *ptokens = NULL; | |
354 | ||
355 | for (;;) { | |
356 | if (*at == '.' || *at == '\0') { | |
357 | GString *tokenstr; | |
358 | ||
359 | if (at == last) { | |
360 | /* Error: empty token */ | |
c2db73d1 PP |
361 | BT_LOGW("Empty path token: path=\"%s\", pos=%u", |
362 | pathstr, (int) (at - pathstr)); | |
09840de5 PP |
363 | goto error; |
364 | } | |
365 | ||
366 | tokenstr = g_string_new(NULL); | |
367 | g_string_append_len(tokenstr, last, at - last); | |
368 | ptokens = g_list_append(ptokens, tokenstr); | |
369 | last = at + 1; | |
370 | } | |
371 | ||
372 | if (*at == '\0') { | |
373 | break; | |
374 | } | |
375 | ||
376 | at++; | |
377 | } | |
378 | ||
379 | return ptokens; | |
380 | ||
381 | error: | |
382 | ptokens_destroy(ptokens); | |
383 | return NULL; | |
384 | } | |
385 | ||
386 | /* | |
387 | * Converts a path token list to a field path object. The path token | |
388 | * list is relative from `type`. The index of the source looking for | |
389 | * its target within `type` is indicated by `src_index`. This can be | |
390 | * `INT_MAX` if the source is contained in `type`. | |
391 | * | |
392 | * `ptokens` is owned by the caller. `field_path` is an output parameter | |
393 | * owned by the caller that must be filled here. `type` is owned by the | |
394 | * caller. | |
395 | */ | |
396 | static | |
50842bdc | 397 | int ptokens_to_field_path(GList *ptokens, struct bt_field_path *field_path, |
cb6f1f7d | 398 | struct bt_field_type *type, int src_index) |
09840de5 PP |
399 | { |
400 | int ret = 0; | |
401 | GList *cur_ptoken = ptokens; | |
c55a9f58 | 402 | bt_bool first_level_done = BT_FALSE; |
09840de5 PP |
403 | |
404 | /* Get our own reference */ | |
405 | bt_get(type); | |
406 | ||
407 | /* Locate target */ | |
408 | while (cur_ptoken) { | |
409 | int child_index; | |
cb6f1f7d | 410 | struct bt_field_type *child_type; |
09840de5 | 411 | const char *field_name = ptoken_get_string(cur_ptoken); |
50842bdc | 412 | enum bt_field_type_id type_id = |
cb6f1f7d | 413 | bt_field_type_get_type_id(type); |
09840de5 | 414 | |
c2db73d1 PP |
415 | BT_LOGV("Current path token: token=\"%s\"", field_name); |
416 | ||
09840de5 | 417 | /* Find to which index corresponds the current path token */ |
50842bdc PP |
418 | if (type_id == BT_FIELD_TYPE_ID_ARRAY || |
419 | type_id == BT_FIELD_TYPE_ID_SEQUENCE) { | |
09840de5 PP |
420 | child_index = -1; |
421 | } else { | |
cb6f1f7d | 422 | child_index = bt_field_type_get_field_index(type, |
09840de5 PP |
423 | field_name); |
424 | if (child_index < 0) { | |
425 | /* | |
426 | * Error: field name does not exist or | |
427 | * wrong current type. | |
428 | */ | |
c2db73d1 PP |
429 | BT_LOGW("Cannot get index of field type: " |
430 | "field-name=\"%s\", src-index=%d, child-index=%d, first-level-done=%d", | |
431 | field_name, src_index, child_index, first_level_done); | |
09840de5 PP |
432 | ret = -1; |
433 | goto end; | |
434 | } else if (child_index > src_index && | |
435 | !first_level_done) { | |
c2db73d1 PP |
436 | BT_LOGW("Child field type is located after source field type: " |
437 | "field-name=\"%s\", src-index=%d, child-index=%d, first-level-done=%d", | |
438 | field_name, src_index, child_index, first_level_done); | |
09840de5 PP |
439 | ret = -1; |
440 | goto end; | |
441 | } | |
442 | ||
443 | /* Next path token */ | |
444 | cur_ptoken = g_list_next(cur_ptoken); | |
c55a9f58 | 445 | first_level_done = BT_TRUE; |
09840de5 PP |
446 | } |
447 | ||
448 | /* Create new field path entry */ | |
b011f6b0 | 449 | g_array_append_val(field_path->indexes, child_index); |
09840de5 PP |
450 | |
451 | /* Get child field type */ | |
cb6f1f7d | 452 | child_type = bt_field_type_borrow_field_at_index(type, |
09840de5 PP |
453 | child_index); |
454 | if (!child_type) { | |
c2db73d1 PP |
455 | BT_LOGW("Cannot get child field type: " |
456 | "field-name=\"%s\", src-index=%d, child-index=%d, first-level-done=%d", | |
457 | field_name, src_index, child_index, first_level_done); | |
09840de5 PP |
458 | ret = -1; |
459 | goto end; | |
460 | } | |
461 | ||
462 | /* Move child type to current type */ | |
094ff7c0 | 463 | bt_get(child_type); |
09840de5 PP |
464 | BT_MOVE(type, child_type); |
465 | } | |
466 | ||
467 | end: | |
468 | bt_put(type); | |
469 | return ret; | |
470 | } | |
471 | ||
472 | /* | |
473 | * Converts a known absolute path token list to a field path object | |
474 | * within the resolving context `ctx`. | |
475 | * | |
476 | * `ptokens` is owned by the caller. `field_path` is an output parameter | |
477 | * owned by the caller that must be filled here. | |
478 | */ | |
479 | static | |
480 | int absolute_ptokens_to_field_path(GList *ptokens, | |
50842bdc | 481 | struct bt_field_path *field_path, |
09840de5 PP |
482 | struct resolve_context *ctx) |
483 | { | |
484 | int ret = 0; | |
485 | GList *cur_ptoken; | |
cb6f1f7d | 486 | struct bt_field_type *type; |
09840de5 PP |
487 | |
488 | /* Skip absolute path tokens */ | |
489 | cur_ptoken = g_list_nth(ptokens, | |
490 | absolute_path_prefix_ptoken_counts[field_path->root]); | |
491 | ||
492 | /* Start with root type */ | |
493 | type = get_type_from_ctx(ctx, field_path->root); | |
494 | if (!type) { | |
495 | /* Error: root type is not available */ | |
c2db73d1 PP |
496 | BT_LOGW("Root field type is not available: " |
497 | "root-scope=%s", | |
3dca2276 | 498 | bt_common_scope_string(field_path->root)); |
09840de5 PP |
499 | ret = -1; |
500 | goto end; | |
501 | } | |
502 | ||
503 | /* Locate target */ | |
504 | ret = ptokens_to_field_path(cur_ptoken, field_path, type, INT_MAX); | |
505 | ||
506 | end: | |
507 | return ret; | |
508 | } | |
509 | ||
510 | /* | |
511 | * Converts a known relative path token list to a field path object | |
512 | * within the resolving context `ctx`. | |
513 | * | |
514 | * `ptokens` is owned by the caller. `field_path` is an output parameter | |
515 | * owned by the caller that must be filled here. | |
516 | */ | |
517 | static | |
518 | int relative_ptokens_to_field_path(GList *ptokens, | |
50842bdc | 519 | struct bt_field_path *field_path, |
09840de5 PP |
520 | struct resolve_context *ctx) |
521 | { | |
522 | int ret = 0; | |
523 | int parent_pos_in_stack; | |
50842bdc | 524 | struct bt_field_path *tail_field_path = bt_field_path_create(); |
09840de5 PP |
525 | |
526 | if (!tail_field_path) { | |
c2db73d1 | 527 | BT_LOGE_STR("Cannot create empty field path."); |
09840de5 PP |
528 | ret = -1; |
529 | goto end; | |
530 | } | |
531 | ||
532 | parent_pos_in_stack = type_stack_size(ctx->type_stack) - 1; | |
533 | ||
534 | while (parent_pos_in_stack >= 0) { | |
cb6f1f7d | 535 | struct bt_field_type *parent_type = |
09840de5 PP |
536 | type_stack_at(ctx->type_stack, |
537 | parent_pos_in_stack)->type; | |
538 | int cur_index = type_stack_at(ctx->type_stack, | |
539 | parent_pos_in_stack)->index; | |
540 | ||
c2db73d1 PP |
541 | BT_LOGV("Locating target field type from current parent field type: " |
542 | "parent-pos=%d, parent-ft-addr=%p, cur-index=%d", | |
543 | parent_pos_in_stack, parent_type, cur_index); | |
544 | ||
09840de5 PP |
545 | /* Locate target from current parent type */ |
546 | ret = ptokens_to_field_path(ptokens, tail_field_path, | |
547 | parent_type, cur_index); | |
548 | if (ret) { | |
549 | /* Not found... yet */ | |
c2db73d1 | 550 | BT_LOGV_STR("Not found at this point."); |
50842bdc | 551 | bt_field_path_clear(tail_field_path); |
09840de5 PP |
552 | } else { |
553 | /* Found: stitch tail field path to head field path */ | |
554 | int i = 0; | |
555 | int tail_field_path_len = | |
b011f6b0 | 556 | tail_field_path->indexes->len; |
09840de5 | 557 | |
c55a9f58 | 558 | while (BT_TRUE) { |
cb6f1f7d | 559 | struct bt_field_type *cur_type = |
09840de5 PP |
560 | type_stack_at(ctx->type_stack, i)->type; |
561 | int index = type_stack_at( | |
562 | ctx->type_stack, i)->index; | |
563 | ||
564 | if (cur_type == parent_type) { | |
565 | break; | |
566 | } | |
567 | ||
b011f6b0 | 568 | g_array_append_val(field_path->indexes, |
09840de5 PP |
569 | index); |
570 | i++; | |
571 | } | |
572 | ||
573 | for (i = 0; i < tail_field_path_len; i++) { | |
574 | int index = g_array_index( | |
b011f6b0 | 575 | tail_field_path->indexes, |
09840de5 PP |
576 | int, i); |
577 | ||
b011f6b0 | 578 | g_array_append_val(field_path->indexes, |
09840de5 PP |
579 | index); |
580 | } | |
581 | break; | |
582 | } | |
583 | ||
584 | parent_pos_in_stack--; | |
585 | } | |
586 | ||
587 | if (parent_pos_in_stack < 0) { | |
588 | /* Not found: look in previous scopes */ | |
589 | field_path->root--; | |
590 | ||
50842bdc | 591 | while (field_path->root >= BT_SCOPE_TRACE_PACKET_HEADER) { |
cb6f1f7d | 592 | struct bt_field_type *root_type; |
50842bdc | 593 | bt_field_path_clear(field_path); |
09840de5 | 594 | |
c2db73d1 | 595 | BT_LOGV("Looking into potential root scope: scope=%s", |
3dca2276 | 596 | bt_common_scope_string(field_path->root)); |
09840de5 PP |
597 | root_type = get_type_from_ctx(ctx, field_path->root); |
598 | if (!root_type) { | |
599 | field_path->root--; | |
600 | continue; | |
601 | } | |
602 | ||
603 | /* Locate target in previous scope */ | |
604 | ret = ptokens_to_field_path(ptokens, field_path, | |
605 | root_type, INT_MAX); | |
606 | if (ret) { | |
607 | /* Not found yet */ | |
c2db73d1 | 608 | BT_LOGV_STR("Not found in this scope."); |
09840de5 PP |
609 | field_path->root--; |
610 | continue; | |
611 | } | |
612 | ||
613 | /* Found */ | |
c2db73d1 | 614 | BT_LOGV_STR("Found in this scope."); |
09840de5 PP |
615 | break; |
616 | } | |
617 | } | |
618 | ||
619 | end: | |
b011f6b0 | 620 | BT_PUT(tail_field_path); |
09840de5 PP |
621 | return ret; |
622 | } | |
623 | ||
624 | /* | |
625 | * Converts a path string to a field path object within the resolving | |
626 | * context `ctx`. | |
627 | * | |
628 | * Return value is owned by the caller on success. | |
629 | */ | |
630 | static | |
50842bdc | 631 | struct bt_field_path *pathstr_to_field_path(const char *pathstr, |
09840de5 PP |
632 | struct resolve_context *ctx) |
633 | { | |
634 | int ret; | |
50842bdc | 635 | enum bt_scope root_scope; |
09840de5 | 636 | GList *ptokens = NULL; |
50842bdc | 637 | struct bt_field_path *field_path = NULL; |
09840de5 PP |
638 | |
639 | /* Create field path */ | |
50842bdc | 640 | field_path = bt_field_path_create(); |
09840de5 | 641 | if (!field_path) { |
c2db73d1 | 642 | BT_LOGE_STR("Cannot create empty field path."); |
09840de5 PP |
643 | ret = -1; |
644 | goto end; | |
645 | } | |
646 | ||
647 | /* Convert path string to path tokens */ | |
648 | ptokens = pathstr_to_ptokens(pathstr); | |
649 | if (!ptokens) { | |
c2db73d1 PP |
650 | BT_LOGW("Cannot convert path string to path tokens: " |
651 | "path=\"%s\"", pathstr); | |
09840de5 PP |
652 | ret = -1; |
653 | goto end; | |
654 | } | |
655 | ||
656 | /* Absolute or relative path? */ | |
46df6b28 | 657 | root_scope = get_root_scope_from_absolute_pathstr(pathstr); |
09840de5 | 658 | |
50842bdc | 659 | if (root_scope == BT_SCOPE_UNKNOWN) { |
46df6b28 PP |
660 | /* Relative path: start with current root scope */ |
661 | field_path->root = ctx->root_scope; | |
c2db73d1 | 662 | BT_LOGV("Detected relative path: starting with current root scope: " |
3dca2276 | 663 | "scope=%s", bt_common_scope_string(field_path->root)); |
09840de5 PP |
664 | ret = relative_ptokens_to_field_path(ptokens, field_path, ctx); |
665 | if (ret) { | |
c2db73d1 PP |
666 | BT_LOGW("Cannot get relative field path of path string: " |
667 | "path=\"%s\", start-scope=%s, end-scope=%s", | |
3dca2276 PP |
668 | pathstr, bt_common_scope_string(ctx->root_scope), |
669 | bt_common_scope_string(field_path->root)); | |
09840de5 PP |
670 | goto end; |
671 | } | |
50842bdc | 672 | } else if (root_scope == BT_SCOPE_ENV) { |
c2db73d1 PP |
673 | BT_LOGW("Sequence field types referring the trace environment are not supported as of this version: " |
674 | "path=\"%s\"", pathstr); | |
09840de5 PP |
675 | ret = -1; |
676 | goto end; | |
677 | } else { | |
46df6b28 PP |
678 | /* Absolute path: use found root scope */ |
679 | field_path->root = root_scope; | |
c2db73d1 | 680 | BT_LOGV("Detected absolute path: using root scope: " |
3dca2276 | 681 | "scope=%s", bt_common_scope_string(field_path->root)); |
09840de5 PP |
682 | ret = absolute_ptokens_to_field_path(ptokens, field_path, ctx); |
683 | if (ret) { | |
c2db73d1 PP |
684 | BT_LOGW("Cannot get absolute field path of path string: " |
685 | "path=\"%s\", root-scope=%s", | |
3dca2276 | 686 | pathstr, bt_common_scope_string(root_scope)); |
09840de5 PP |
687 | goto end; |
688 | } | |
689 | } | |
690 | ||
c2db73d1 PP |
691 | if (ret == 0) { |
692 | GString *field_path_pretty = | |
50842bdc | 693 | bt_field_path_string(field_path); |
c2db73d1 PP |
694 | const char *field_path_pretty_str = |
695 | field_path_pretty ? field_path_pretty->str : NULL; | |
696 | ||
697 | BT_LOGV("Found field path: path=\"%s\", field-path=\"%s\"", | |
698 | pathstr, field_path_pretty_str); | |
699 | ||
700 | if (field_path_pretty) { | |
701 | g_string_free(field_path_pretty, TRUE); | |
702 | } | |
703 | } | |
704 | ||
09840de5 PP |
705 | end: |
706 | if (ret) { | |
b011f6b0 | 707 | BT_PUT(field_path); |
09840de5 PP |
708 | } |
709 | ||
710 | ptokens_destroy(ptokens); | |
09840de5 PP |
711 | return field_path; |
712 | } | |
713 | ||
714 | /* | |
715 | * Retrieves a field type by following the field path `field_path` in | |
716 | * the resolving context `ctx`. | |
717 | * | |
718 | * Return value is owned by the caller on success. | |
719 | */ | |
720 | static | |
cb6f1f7d | 721 | struct bt_field_type *field_path_to_field_type( |
50842bdc | 722 | struct bt_field_path *field_path, |
09840de5 PP |
723 | struct resolve_context *ctx) |
724 | { | |
725 | int i; | |
cb6f1f7d | 726 | struct bt_field_type *type; |
09840de5 PP |
727 | |
728 | /* Start with root type */ | |
729 | type = get_type_from_ctx(ctx, field_path->root); | |
730 | bt_get(type); | |
731 | if (!type) { | |
732 | /* Error: root type is not available */ | |
c2db73d1 | 733 | BT_LOGW("Root field type is not available: root-scope=%s", |
3dca2276 | 734 | bt_common_scope_string(field_path->root)); |
09840de5 PP |
735 | goto error; |
736 | } | |
737 | ||
738 | /* Locate target */ | |
b011f6b0 | 739 | for (i = 0; i < field_path->indexes->len; i++) { |
cb6f1f7d | 740 | struct bt_field_type *child_type; |
09840de5 | 741 | int child_index = |
b011f6b0 | 742 | g_array_index(field_path->indexes, int, i); |
09840de5 PP |
743 | |
744 | /* Get child field type */ | |
cb6f1f7d | 745 | child_type = bt_field_type_borrow_field_at_index(type, |
09840de5 PP |
746 | child_index); |
747 | if (!child_type) { | |
c2db73d1 PP |
748 | BT_LOGW("Cannot get field type: " |
749 | "parent-ft-addr=%p, index=%d", type, i); | |
09840de5 PP |
750 | goto error; |
751 | } | |
752 | ||
753 | /* Move child type to current type */ | |
094ff7c0 | 754 | bt_get(child_type); |
09840de5 PP |
755 | BT_MOVE(type, child_type); |
756 | } | |
757 | ||
758 | return type; | |
759 | ||
760 | error: | |
761 | BT_PUT(type); | |
762 | return type; | |
763 | } | |
764 | ||
765 | /* | |
766 | * Returns the equivalent field path object of the context type stack. | |
767 | * | |
768 | * Return value is owned by the caller on success. | |
769 | */ | |
770 | static | |
50842bdc | 771 | struct bt_field_path *get_ctx_stack_field_path(struct resolve_context *ctx) |
09840de5 PP |
772 | { |
773 | int i; | |
50842bdc | 774 | struct bt_field_path *field_path; |
09840de5 PP |
775 | |
776 | /* Create field path */ | |
50842bdc | 777 | field_path = bt_field_path_create(); |
09840de5 | 778 | if (!field_path) { |
c2db73d1 | 779 | BT_LOGE_STR("Cannot create empty field path."); |
09840de5 PP |
780 | goto error; |
781 | } | |
782 | ||
46df6b28 | 783 | field_path->root = ctx->root_scope; |
09840de5 PP |
784 | |
785 | for (i = 0; i < type_stack_size(ctx->type_stack); i++) { | |
786 | struct type_stack_frame *frame; | |
787 | ||
788 | frame = type_stack_at(ctx->type_stack, i); | |
b011f6b0 | 789 | g_array_append_val(field_path->indexes, frame->index); |
09840de5 PP |
790 | } |
791 | ||
792 | return field_path; | |
793 | ||
794 | error: | |
b011f6b0 PP |
795 | BT_PUT(field_path); |
796 | return field_path; | |
09840de5 PP |
797 | } |
798 | ||
799 | /* | |
800 | * Returns the lowest common ancestor of two field path objects | |
801 | * having the same root scope. | |
802 | * | |
803 | * `field_path1` and `field_path2` are owned by the caller. | |
804 | */ | |
50842bdc PP |
805 | int get_field_paths_lca_index(struct bt_field_path *field_path1, |
806 | struct bt_field_path *field_path2) | |
09840de5 PP |
807 | { |
808 | int lca_index = 0; | |
809 | int field_path1_len, field_path2_len; | |
810 | ||
c2db73d1 PP |
811 | if (BT_LOG_ON_VERBOSE) { |
812 | GString *field_path1_pretty = | |
50842bdc | 813 | bt_field_path_string(field_path1); |
c2db73d1 | 814 | GString *field_path2_pretty = |
50842bdc | 815 | bt_field_path_string(field_path2); |
c2db73d1 PP |
816 | const char *field_path1_pretty_str = |
817 | field_path1_pretty ? field_path1_pretty->str : NULL; | |
818 | const char *field_path2_pretty_str = | |
819 | field_path2_pretty ? field_path2_pretty->str : NULL; | |
820 | ||
821 | BT_LOGV("Finding lowest common ancestor (LCA) between two field paths: " | |
822 | "field-path-1=\"%s\", field-path-2=\"%s\"", | |
823 | field_path1_pretty_str, field_path2_pretty_str); | |
824 | ||
825 | if (field_path1_pretty) { | |
826 | g_string_free(field_path1_pretty, TRUE); | |
827 | } | |
828 | ||
829 | if (field_path2_pretty) { | |
830 | g_string_free(field_path2_pretty, TRUE); | |
831 | } | |
832 | } | |
833 | ||
09840de5 PP |
834 | /* |
835 | * Start from both roots and find the first mismatch. | |
836 | */ | |
f6ccaed9 | 837 | BT_ASSERT(field_path1->root == field_path2->root); |
b011f6b0 PP |
838 | field_path1_len = field_path1->indexes->len; |
839 | field_path2_len = field_path2->indexes->len; | |
09840de5 | 840 | |
c55a9f58 | 841 | while (BT_TRUE) { |
09840de5 PP |
842 | int target_index, ctx_index; |
843 | ||
844 | if (lca_index == field_path2_len || | |
845 | lca_index == field_path1_len) { | |
846 | /* | |
847 | * This means that both field paths never split. | |
848 | * This is invalid because the target cannot be | |
849 | * an ancestor of the source. | |
850 | */ | |
c2db73d1 PP |
851 | BT_LOGW("Source field type is an ancestor of target field type or vice versa: " |
852 | "lca-index=%d, field-path-1-len=%d, " | |
853 | "field-path-2-len=%d", | |
854 | lca_index, field_path1_len, field_path2_len); | |
09840de5 PP |
855 | lca_index = -1; |
856 | break; | |
857 | } | |
858 | ||
b011f6b0 | 859 | target_index = g_array_index(field_path1->indexes, int, |
09840de5 | 860 | lca_index); |
b011f6b0 | 861 | ctx_index = g_array_index(field_path2->indexes, int, |
09840de5 PP |
862 | lca_index); |
863 | ||
864 | if (target_index != ctx_index) { | |
865 | /* LCA index is the previous */ | |
866 | break; | |
867 | } | |
868 | ||
869 | lca_index++; | |
870 | } | |
871 | ||
c2db73d1 | 872 | BT_LOGV("Found LCA: lca-index=%d", lca_index); |
09840de5 PP |
873 | return lca_index; |
874 | } | |
875 | ||
876 | /* | |
877 | * Validates a target field path. | |
878 | * | |
879 | * `target_field_path` and `target_type` are owned by the caller. | |
880 | */ | |
881 | static | |
50842bdc | 882 | int validate_target_field_path(struct bt_field_path *target_field_path, |
cb6f1f7d | 883 | struct bt_field_type *target_type, |
09840de5 PP |
884 | struct resolve_context *ctx) |
885 | { | |
886 | int ret = 0; | |
50842bdc | 887 | struct bt_field_path *ctx_field_path; |
b011f6b0 | 888 | int target_field_path_len = target_field_path->indexes->len; |
09840de5 | 889 | int lca_index; |
50842bdc PP |
890 | enum bt_field_type_id ctx_cur_field_type_id; |
891 | enum bt_field_type_id target_type_id; | |
09840de5 PP |
892 | |
893 | /* Get context field path */ | |
894 | ctx_field_path = get_ctx_stack_field_path(ctx); | |
895 | if (!ctx_field_path) { | |
c2db73d1 | 896 | BT_LOGW_STR("Cannot get field path from context's stack."); |
09840de5 PP |
897 | ret = -1; |
898 | goto end; | |
899 | } | |
900 | ||
901 | /* | |
902 | * Make sure the target is not a root. | |
903 | */ | |
904 | if (target_field_path_len == 0) { | |
c2db73d1 | 905 | BT_LOGW_STR("Target field path's length is 0 (targeting the root)."); |
09840de5 PP |
906 | ret = -1; |
907 | goto end; | |
908 | } | |
909 | ||
910 | /* | |
911 | * Make sure the root of the target field path is not located | |
912 | * after the context field path's root. | |
913 | */ | |
914 | if (target_field_path->root > ctx_field_path->root) { | |
c2db73d1 PP |
915 | BT_LOGW("Target field type is located after source field type: " |
916 | "target-root=%s, source-root=%s", | |
3dca2276 PP |
917 | bt_common_scope_string(target_field_path->root), |
918 | bt_common_scope_string(ctx_field_path->root)); | |
09840de5 PP |
919 | ret = -1; |
920 | goto end; | |
921 | } | |
922 | ||
923 | if (target_field_path->root == ctx_field_path->root) { | |
924 | int target_index, ctx_index; | |
925 | ||
926 | /* | |
927 | * Find the index of the lowest common ancestor of both field | |
928 | * paths. | |
929 | */ | |
930 | lca_index = get_field_paths_lca_index(target_field_path, | |
931 | ctx_field_path); | |
932 | if (lca_index < 0) { | |
c2db73d1 | 933 | BT_LOGW_STR("Cannot get least common ancestor."); |
09840de5 PP |
934 | ret = -1; |
935 | goto end; | |
936 | } | |
937 | ||
938 | /* | |
939 | * Make sure the target field path is located before the | |
940 | * context field path. | |
941 | */ | |
b011f6b0 | 942 | target_index = g_array_index(target_field_path->indexes, |
09840de5 | 943 | int, lca_index); |
b011f6b0 | 944 | ctx_index = g_array_index(ctx_field_path->indexes, |
09840de5 PP |
945 | int, lca_index); |
946 | ||
947 | if (target_index >= ctx_index) { | |
c2db73d1 PP |
948 | BT_LOGW("Target field type's index is greater than or equal to source field type's index in LCA: " |
949 | "lca-index=%d, target-index=%d, source-index=%d", | |
950 | lca_index, target_index, ctx_index); | |
09840de5 PP |
951 | ret = -1; |
952 | goto end; | |
953 | } | |
954 | } | |
955 | ||
956 | /* | |
957 | * Make sure the target type has the right type and properties. | |
958 | */ | |
cb6f1f7d | 959 | ctx_cur_field_type_id = bt_field_type_get_type_id( |
09840de5 | 960 | ctx->cur_field_type); |
cb6f1f7d | 961 | target_type_id = bt_field_type_get_type_id(target_type); |
09840de5 | 962 | |
ed36359d | 963 | switch (ctx_cur_field_type_id) { |
50842bdc PP |
964 | case BT_FIELD_TYPE_ID_VARIANT: |
965 | if (target_type_id != BT_FIELD_TYPE_ID_ENUM) { | |
c2db73d1 PP |
966 | BT_LOGW("Variant field type's tag field type is not an enumeration field type: " |
967 | "tag-ft-addr=%p, tag-ft-id=%s", | |
968 | target_type, | |
3dca2276 | 969 | bt_common_field_type_id_string(target_type_id)); |
09840de5 PP |
970 | ret = -1; |
971 | goto end; | |
972 | } | |
ed36359d | 973 | break; |
50842bdc PP |
974 | case BT_FIELD_TYPE_ID_SEQUENCE: |
975 | if (target_type_id != BT_FIELD_TYPE_ID_INTEGER || | |
cb6f1f7d | 976 | bt_field_type_integer_is_signed(target_type)) { |
c2db73d1 PP |
977 | BT_LOGW("Sequence field type's length field type is not an unsigned integer field type: " |
978 | "length-ft-addr=%p, length-ft-id=%s", | |
979 | target_type, | |
3dca2276 | 980 | bt_common_field_type_id_string(target_type_id)); |
09840de5 PP |
981 | ret = -1; |
982 | goto end; | |
983 | } | |
ed36359d MD |
984 | break; |
985 | default: | |
0fbb9a9f | 986 | abort(); |
09840de5 PP |
987 | } |
988 | ||
989 | end: | |
b011f6b0 | 990 | BT_PUT(ctx_field_path); |
09840de5 PP |
991 | return ret; |
992 | } | |
993 | ||
994 | /* | |
995 | * Resolves a variant or sequence field type `type`. | |
996 | * | |
997 | * `type` is owned by the caller. | |
998 | */ | |
999 | static | |
cb6f1f7d | 1000 | int resolve_sequence_or_variant_type(struct bt_field_type *type, |
09840de5 PP |
1001 | struct resolve_context *ctx) |
1002 | { | |
1003 | int ret = 0; | |
1004 | const char *pathstr; | |
cb6f1f7d | 1005 | enum bt_field_type_id type_id = bt_field_type_get_type_id(type); |
50842bdc | 1006 | struct bt_field_path *target_field_path = NULL; |
cb6f1f7d | 1007 | struct bt_field_type *target_type = NULL; |
c2db73d1 PP |
1008 | GString *target_field_path_pretty = NULL; |
1009 | const char *target_field_path_pretty_str; | |
1010 | ||
09840de5 PP |
1011 | |
1012 | /* Get path string */ | |
1013 | switch (type_id) { | |
50842bdc | 1014 | case BT_FIELD_TYPE_ID_SEQUENCE: |
09840de5 | 1015 | pathstr = |
cb6f1f7d | 1016 | bt_field_type_sequence_get_length_field_name(type); |
09840de5 | 1017 | break; |
50842bdc | 1018 | case BT_FIELD_TYPE_ID_VARIANT: |
09840de5 | 1019 | pathstr = |
cb6f1f7d | 1020 | bt_field_type_variant_get_tag_name(type); |
09840de5 PP |
1021 | break; |
1022 | default: | |
0fbb9a9f | 1023 | abort(); |
09840de5 PP |
1024 | } |
1025 | ||
21a4db91 MD |
1026 | if (!pathstr) { |
1027 | BT_LOGW_STR("Cannot get path string."); | |
1028 | ret = -1; | |
1029 | goto end; | |
1030 | } | |
1031 | ||
09840de5 PP |
1032 | /* Get target field path out of path string */ |
1033 | target_field_path = pathstr_to_field_path(pathstr, ctx); | |
1034 | if (!target_field_path) { | |
c2db73d1 PP |
1035 | BT_LOGW("Cannot get target field path for path string: " |
1036 | "path=\"%s\"", pathstr); | |
09840de5 PP |
1037 | ret = -1; |
1038 | goto end; | |
1039 | } | |
1040 | ||
50842bdc | 1041 | target_field_path_pretty = bt_field_path_string(target_field_path); |
c2db73d1 PP |
1042 | target_field_path_pretty_str = |
1043 | target_field_path_pretty ? target_field_path_pretty->str : NULL; | |
1044 | ||
09840de5 PP |
1045 | /* Get target field type */ |
1046 | target_type = field_path_to_field_type(target_field_path, ctx); | |
1047 | if (!target_type) { | |
c2db73d1 PP |
1048 | BT_LOGW("Cannot get target field type for path string: " |
1049 | "path=\"%s\", target-field-path=\"%s\"", | |
1050 | pathstr, target_field_path_pretty_str); | |
09840de5 PP |
1051 | ret = -1; |
1052 | goto end; | |
1053 | } | |
1054 | ||
1055 | ret = validate_target_field_path(target_field_path, target_type, ctx); | |
1056 | if (ret) { | |
c2db73d1 PP |
1057 | BT_LOGW("Invalid target field path for path string: " |
1058 | "path=\"%s\", target-field-path=\"%s\"", | |
1059 | pathstr, target_field_path_pretty_str); | |
09840de5 PP |
1060 | goto end; |
1061 | } | |
1062 | ||
1063 | /* Set target field path and target field type */ | |
ed36359d | 1064 | switch (type_id) { |
50842bdc | 1065 | case BT_FIELD_TYPE_ID_SEQUENCE: |
cb6f1f7d | 1066 | ret = bt_field_type_sequence_set_length_field_path( |
09840de5 PP |
1067 | type, target_field_path); |
1068 | if (ret) { | |
c2db73d1 PP |
1069 | BT_LOGW("Cannot set sequence field type's length field path: " |
1070 | "ret=%d, ft-addr=%p, path=\"%s\", target-field-path=\"%s\"", | |
1071 | ret, type, pathstr, | |
1072 | target_field_path_pretty_str); | |
09840de5 PP |
1073 | goto end; |
1074 | } | |
ed36359d | 1075 | break; |
50842bdc | 1076 | case BT_FIELD_TYPE_ID_VARIANT: |
cb6f1f7d | 1077 | ret = bt_field_type_variant_set_tag_field_path( |
09840de5 PP |
1078 | type, target_field_path); |
1079 | if (ret) { | |
c2db73d1 PP |
1080 | BT_LOGW("Cannot set varaint field type's tag field path: " |
1081 | "ret=%d, ft-addr=%p, path=\"%s\", target-field-path=\"%s\"", | |
1082 | ret, type, pathstr, | |
1083 | target_field_path_pretty_str); | |
09840de5 PP |
1084 | goto end; |
1085 | } | |
1086 | ||
cb6f1f7d | 1087 | ret = bt_field_type_variant_set_tag_field_type( |
4b5fcb78 | 1088 | type, target_type); |
09840de5 | 1089 | if (ret) { |
c2db73d1 PP |
1090 | BT_LOGW("Cannot set varaint field type's tag field type: " |
1091 | "ret=%d, ft-addr=%p, path=\"%s\", target-field-path=\"%s\"", | |
1092 | ret, type, pathstr, | |
1093 | target_field_path_pretty_str); | |
09840de5 PP |
1094 | goto end; |
1095 | } | |
ed36359d MD |
1096 | break; |
1097 | default: | |
0fbb9a9f | 1098 | abort(); |
09840de5 PP |
1099 | } |
1100 | ||
1101 | end: | |
c2db73d1 PP |
1102 | if (target_field_path_pretty) { |
1103 | g_string_free(target_field_path_pretty, TRUE); | |
1104 | } | |
1105 | ||
b011f6b0 | 1106 | BT_PUT(target_field_path); |
09840de5 PP |
1107 | BT_PUT(target_type); |
1108 | return ret; | |
1109 | } | |
1110 | ||
1111 | /* | |
1112 | * Resolves a field type `type`. | |
1113 | * | |
1114 | * `type` is owned by the caller. | |
1115 | */ | |
1116 | static | |
cb6f1f7d | 1117 | int resolve_type(struct bt_field_type *type, struct resolve_context *ctx) |
09840de5 PP |
1118 | { |
1119 | int ret = 0; | |
50842bdc | 1120 | enum bt_field_type_id type_id; |
09840de5 PP |
1121 | |
1122 | if (!type) { | |
1123 | /* Type is not available; still valid */ | |
1124 | goto end; | |
1125 | } | |
1126 | ||
cb6f1f7d | 1127 | type_id = bt_field_type_get_type_id(type); |
09840de5 PP |
1128 | ctx->cur_field_type = type; |
1129 | ||
1130 | /* Resolve sequence/variant field type */ | |
1131 | switch (type_id) { | |
50842bdc PP |
1132 | case BT_FIELD_TYPE_ID_SEQUENCE: |
1133 | case BT_FIELD_TYPE_ID_VARIANT: | |
09840de5 PP |
1134 | ret = resolve_sequence_or_variant_type(type, ctx); |
1135 | if (ret) { | |
c2db73d1 PP |
1136 | BT_LOGW("Cannot resolve sequence field type's length or variant field type's tag: " |
1137 | "ret=%d, ft-addr=%p", ret, type); | |
09840de5 PP |
1138 | goto end; |
1139 | } | |
1140 | break; | |
1141 | default: | |
1142 | break; | |
1143 | } | |
1144 | ||
1145 | /* Recurse into compound types */ | |
1146 | switch (type_id) { | |
50842bdc PP |
1147 | case BT_FIELD_TYPE_ID_STRUCT: |
1148 | case BT_FIELD_TYPE_ID_VARIANT: | |
1149 | case BT_FIELD_TYPE_ID_SEQUENCE: | |
1150 | case BT_FIELD_TYPE_ID_ARRAY: | |
09840de5 | 1151 | { |
c2db73d1 | 1152 | int64_t field_count, f_index; |
09840de5 PP |
1153 | |
1154 | ret = type_stack_push(ctx->type_stack, type); | |
1155 | if (ret) { | |
c2db73d1 PP |
1156 | BT_LOGW("Cannot push field type on context's stack: " |
1157 | "ft-addr=%p", type); | |
09840de5 PP |
1158 | goto end; |
1159 | } | |
1160 | ||
cb6f1f7d | 1161 | field_count = bt_field_type_get_field_count(type); |
09840de5 | 1162 | if (field_count < 0) { |
c2db73d1 PP |
1163 | BT_LOGW("Cannot get field type's field count: " |
1164 | "ret=%" PRId64 ", ft-addr=%p", | |
1165 | field_count, type); | |
09840de5 PP |
1166 | ret = field_count; |
1167 | goto end; | |
1168 | } | |
1169 | ||
1170 | for (f_index = 0; f_index < field_count; f_index++) { | |
cb6f1f7d PP |
1171 | struct bt_field_type *child_type = |
1172 | bt_field_type_borrow_field_at_index(type, | |
09840de5 PP |
1173 | f_index); |
1174 | ||
1175 | if (!child_type) { | |
c2db73d1 PP |
1176 | BT_LOGW("Cannot get field type's child field: " |
1177 | "ft-addr=%p, index=%" PRId64 ", " | |
1178 | "count=%" PRId64, type, f_index, | |
1179 | field_count); | |
09840de5 PP |
1180 | ret = -1; |
1181 | goto end; | |
1182 | } | |
1183 | ||
50842bdc PP |
1184 | if (type_id == BT_FIELD_TYPE_ID_ARRAY|| |
1185 | type_id == BT_FIELD_TYPE_ID_SEQUENCE) { | |
09840de5 PP |
1186 | type_stack_peek(ctx->type_stack)->index = -1; |
1187 | } else { | |
1188 | type_stack_peek(ctx->type_stack)->index = | |
1189 | f_index; | |
1190 | } | |
1191 | ||
c2db73d1 PP |
1192 | BT_LOGV("Resolving field type's child field type: " |
1193 | "parent-ft-addr=%p, child-ft-addr=%p, " | |
1194 | "index=%" PRId64 ", count=%" PRId64, | |
1195 | type, child_type, f_index, field_count); | |
09840de5 | 1196 | ret = resolve_type(child_type, ctx); |
09840de5 PP |
1197 | if (ret) { |
1198 | goto end; | |
1199 | } | |
1200 | } | |
1201 | ||
1202 | type_stack_pop(ctx->type_stack); | |
1203 | break; | |
1204 | } | |
1205 | default: | |
1206 | break; | |
1207 | } | |
1208 | ||
1209 | end: | |
1210 | return ret; | |
1211 | } | |
1212 | ||
1213 | /* | |
1214 | * Resolves the root field type corresponding to the scope `root_scope`. | |
1215 | */ | |
1216 | static | |
50842bdc | 1217 | int resolve_root_type(enum bt_scope root_scope, struct resolve_context *ctx) |
09840de5 PP |
1218 | { |
1219 | int ret; | |
1220 | ||
f6ccaed9 | 1221 | BT_ASSERT(type_stack_size(ctx->type_stack) == 0); |
46df6b28 PP |
1222 | ctx->root_scope = root_scope; |
1223 | ret = resolve_type(get_type_from_ctx(ctx, root_scope), ctx); | |
50842bdc | 1224 | ctx->root_scope = BT_SCOPE_UNKNOWN; |
09840de5 PP |
1225 | |
1226 | return ret; | |
1227 | } | |
1228 | ||
1229 | BT_HIDDEN | |
50842bdc | 1230 | int bt_resolve_types( |
09840de5 | 1231 | struct bt_value *environment, |
cb6f1f7d PP |
1232 | struct bt_field_type *packet_header_type, |
1233 | struct bt_field_type *packet_context_type, | |
1234 | struct bt_field_type *event_header_type, | |
1235 | struct bt_field_type *stream_event_ctx_type, | |
1236 | struct bt_field_type *event_context_type, | |
1237 | struct bt_field_type *event_payload_type, | |
50842bdc | 1238 | enum bt_resolve_flag flags) |
09840de5 PP |
1239 | { |
1240 | int ret = 0; | |
1241 | struct resolve_context ctx = { | |
1242 | .environment = environment, | |
1243 | .scopes = { | |
1244 | packet_header_type, | |
1245 | packet_context_type, | |
1246 | event_header_type, | |
1247 | stream_event_ctx_type, | |
1248 | event_context_type, | |
1249 | event_payload_type, | |
1250 | }, | |
50842bdc | 1251 | .root_scope = BT_SCOPE_UNKNOWN, |
09840de5 PP |
1252 | }; |
1253 | ||
c2db73d1 PP |
1254 | BT_LOGV("Resolving field types: " |
1255 | "packet-header-ft-addr=%p, " | |
1256 | "packet-context-ft-addr=%p, " | |
1257 | "event-header-ft-addr=%p, " | |
1258 | "stream-event-context-ft-addr=%p, " | |
1259 | "event-context-ft-addr=%p, " | |
1260 | "event-payload-ft-addr=%p", | |
1261 | packet_header_type, packet_context_type, event_header_type, | |
1262 | stream_event_ctx_type, event_context_type, event_payload_type); | |
1263 | ||
09840de5 PP |
1264 | /* Initialize type stack */ |
1265 | ctx.type_stack = type_stack_create(); | |
1266 | if (!ctx.type_stack) { | |
c2db73d1 | 1267 | BT_LOGE_STR("Cannot create field type stack."); |
09840de5 PP |
1268 | ret = -1; |
1269 | goto end; | |
1270 | } | |
1271 | ||
1272 | /* Resolve packet header type */ | |
50842bdc PP |
1273 | if (flags & BT_RESOLVE_FLAG_PACKET_HEADER) { |
1274 | ret = resolve_root_type(BT_SCOPE_TRACE_PACKET_HEADER, &ctx); | |
09840de5 | 1275 | if (ret) { |
c2db73d1 PP |
1276 | BT_LOGW("Cannot resolve trace packet header field type: " |
1277 | "ret=%d", ret); | |
09840de5 PP |
1278 | goto end; |
1279 | } | |
1280 | } | |
1281 | ||
1282 | /* Resolve packet context type */ | |
50842bdc PP |
1283 | if (flags & BT_RESOLVE_FLAG_PACKET_CONTEXT) { |
1284 | ret = resolve_root_type(BT_SCOPE_STREAM_PACKET_CONTEXT, &ctx); | |
09840de5 | 1285 | if (ret) { |
c2db73d1 PP |
1286 | BT_LOGW("Cannot resolve stream packet context field type: " |
1287 | "ret=%d", ret); | |
09840de5 PP |
1288 | goto end; |
1289 | } | |
1290 | } | |
1291 | ||
1292 | /* Resolve event header type */ | |
50842bdc PP |
1293 | if (flags & BT_RESOLVE_FLAG_EVENT_HEADER) { |
1294 | ret = resolve_root_type(BT_SCOPE_STREAM_EVENT_HEADER, &ctx); | |
09840de5 | 1295 | if (ret) { |
c2db73d1 PP |
1296 | BT_LOGW("Cannot resolve stream event header field type: " |
1297 | "ret=%d", ret); | |
09840de5 PP |
1298 | goto end; |
1299 | } | |
1300 | } | |
1301 | ||
1302 | /* Resolve stream event context type */ | |
50842bdc PP |
1303 | if (flags & BT_RESOLVE_FLAG_STREAM_EVENT_CTX) { |
1304 | ret = resolve_root_type(BT_SCOPE_STREAM_EVENT_CONTEXT, &ctx); | |
09840de5 | 1305 | if (ret) { |
c2db73d1 PP |
1306 | BT_LOGW("Cannot resolve stream event context field type: " |
1307 | "ret=%d", ret); | |
09840de5 PP |
1308 | goto end; |
1309 | } | |
1310 | } | |
1311 | ||
1312 | /* Resolve event context type */ | |
50842bdc PP |
1313 | if (flags & BT_RESOLVE_FLAG_EVENT_CONTEXT) { |
1314 | ret = resolve_root_type(BT_SCOPE_EVENT_CONTEXT, &ctx); | |
09840de5 | 1315 | if (ret) { |
c2db73d1 PP |
1316 | BT_LOGW("Cannot resolve event context field type: " |
1317 | "ret=%d", ret); | |
09840de5 PP |
1318 | goto end; |
1319 | } | |
1320 | } | |
1321 | ||
1322 | /* Resolve event payload type */ | |
50842bdc PP |
1323 | if (flags & BT_RESOLVE_FLAG_EVENT_PAYLOAD) { |
1324 | ret = resolve_root_type(BT_SCOPE_EVENT_FIELDS, &ctx); | |
09840de5 | 1325 | if (ret) { |
c2db73d1 PP |
1326 | BT_LOGW("Cannot resolve event payload field type: " |
1327 | "ret=%d", ret); | |
09840de5 PP |
1328 | goto end; |
1329 | } | |
1330 | } | |
1331 | ||
c2db73d1 PP |
1332 | BT_LOGV_STR("Resolved field types."); |
1333 | ||
09840de5 PP |
1334 | end: |
1335 | type_stack_destroy(ctx.type_stack); | |
1336 | ||
1337 | return ret; | |
1338 | } |