2 * Copyright 2018 - Philippe Proulx <pproulx@efficios.com>
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
15 #define BT_LOG_TAG "PLUGIN-CTF-METADATA-META-UPDATE-IN-IR"
18 #include <babeltrace/babeltrace.h>
19 #include <babeltrace/babeltrace-internal.h>
20 #include <babeltrace/assert-internal.h>
21 #include <babeltrace/compat/glib-internal.h>
27 #include "ctf-meta-visitors.h"
30 void force_update_field_class_in_ir(struct ctf_field_class
*fc
, bool in_ir
)
41 case CTF_FIELD_CLASS_TYPE_STRUCT
:
43 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
45 for (i
= 0; i
< struct_fc
->members
->len
; i
++) {
46 struct ctf_named_field_class
*named_fc
=
47 ctf_field_class_struct_borrow_member_by_index(
50 force_update_field_class_in_ir(named_fc
->fc
, in_ir
);
55 case CTF_FIELD_CLASS_TYPE_VARIANT
:
57 struct ctf_named_field_class
*named_fc
;
58 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
60 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
62 ctf_field_class_variant_borrow_option_by_index(
65 force_update_field_class_in_ir(named_fc
->fc
, in_ir
);
70 case CTF_FIELD_CLASS_TYPE_ARRAY
:
71 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
73 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
75 force_update_field_class_in_ir(array_fc
->elem_fc
, in_ir
);
87 void update_field_class_in_ir(struct ctf_field_class
*fc
,
88 GHashTable
*ft_dependents
)
97 case CTF_FIELD_CLASS_TYPE_INT
:
98 case CTF_FIELD_CLASS_TYPE_ENUM
:
100 struct ctf_field_class_int
*int_fc
= (void *) fc
;
102 if (int_fc
->mapped_clock_class
||
103 int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
||
104 bt_g_hash_table_contains(ft_dependents
, fc
)) {
106 * Field class does not update a clock, has no
107 * special meaning, and no sequence/variant
108 * field class which is part of IR depends on it.
115 case CTF_FIELD_CLASS_TYPE_STRUCT
:
117 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
120 for (i
= (int64_t) struct_fc
->members
->len
- 1; i
>= 0; i
--) {
121 struct ctf_named_field_class
*named_fc
=
122 ctf_field_class_struct_borrow_member_by_index(
125 update_field_class_in_ir(named_fc
->fc
, ft_dependents
);
127 if (named_fc
->fc
->in_ir
) {
128 /* At least one member is part of IR */
135 case CTF_FIELD_CLASS_TYPE_VARIANT
:
137 struct ctf_named_field_class
*named_fc
;
138 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
141 * Reverse order, although it is not important for this
142 * loop because a field class within a variant field
143 * type's option cannot depend on a field class in
144 * another option of the same variant field class.
146 for (i
= (int64_t) var_fc
->options
->len
- 1; i
>= 0; i
--) {
148 ctf_field_class_variant_borrow_option_by_index(
151 update_field_class_in_ir(named_fc
->fc
, ft_dependents
);
153 if (named_fc
->fc
->in_ir
) {
154 /* At least one option is part of IR */
161 * At least one option will make it to IR. In
162 * this case, make all options part of IR
163 * because the variant's tag could still select
164 * (dynamically) a removed option. This can mean
165 * having an empty structure as an option, for
166 * example, but at least all the options are
169 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
170 ctf_field_class_variant_borrow_option_by_index(
171 var_fc
, i
)->fc
->in_ir
= true;
175 * This variant field class is part of IR and
176 * depends on a tag field class (which must also
179 g_hash_table_insert(ft_dependents
, var_fc
->tag_fc
,
185 case CTF_FIELD_CLASS_TYPE_ARRAY
:
186 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
188 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
190 update_field_class_in_ir(array_fc
->elem_fc
, ft_dependents
);
191 fc
->in_ir
= array_fc
->elem_fc
->in_ir
;
193 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
) {
194 struct ctf_field_class_array
*arr_fc
= (void *) fc
;
196 assert(arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
||
197 arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_UUID
);
200 * UUID field class: nothing depends on this, so
201 * it's not part of IR.
203 if (arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_UUID
) {
205 array_fc
->elem_fc
->in_ir
= false;
207 } else if (fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
209 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
212 * This sequence field class is part of
213 * IR and depends on a length field class
214 * (which must also be part of IR).
216 g_hash_table_insert(ft_dependents
,
217 seq_fc
->length_fc
, seq_fc
->length_fc
);
233 * Scopes and field classes are processed in reverse order because we need
234 * to know if a given integer field class has dependents (sequence or
235 * variant field classes) when we reach it. Dependents can only be located
236 * after the length/tag field class in the metadata tree.
239 int ctf_trace_class_update_in_ir(struct ctf_trace_class
*ctf_tc
)
244 GHashTable
*ft_dependents
= g_hash_table_new(g_direct_hash
,
247 BT_ASSERT(ft_dependents
);
249 for (i
= 0; i
< ctf_tc
->stream_classes
->len
; i
++) {
250 struct ctf_stream_class
*sc
= ctf_tc
->stream_classes
->pdata
[i
];
253 for (j
= 0; j
< sc
->event_classes
->len
; j
++) {
254 struct ctf_event_class
*ec
= sc
->event_classes
->pdata
[j
];
256 if (ec
->is_translated
) {
260 update_field_class_in_ir(ec
->payload_fc
, ft_dependents
);
261 update_field_class_in_ir(ec
->spec_context_fc
,
265 if (!sc
->is_translated
) {
266 update_field_class_in_ir(sc
->event_common_context_fc
,
268 force_update_field_class_in_ir(sc
->event_header_fc
,
270 update_field_class_in_ir(sc
->packet_context_fc
,
275 if (!ctf_tc
->is_translated
) {
276 force_update_field_class_in_ir(ctf_tc
->packet_header_fc
,
280 g_hash_table_destroy(ft_dependents
);