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 <babeltrace2/babeltrace.h>
19 #include "common/macros.h"
20 #include "common/assert.h"
21 #include "compat/glib.h"
26 #include "common/assert.h"
28 #include "ctf-meta-visitors.h"
31 void force_update_field_class_in_ir(struct ctf_field_class
*fc
, bool in_ir
)
42 case CTF_FIELD_CLASS_TYPE_STRUCT
:
44 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
46 for (i
= 0; i
< struct_fc
->members
->len
; i
++) {
47 struct ctf_named_field_class
*named_fc
=
48 ctf_field_class_struct_borrow_member_by_index(
51 force_update_field_class_in_ir(named_fc
->fc
, in_ir
);
56 case CTF_FIELD_CLASS_TYPE_VARIANT
:
58 struct ctf_named_field_class
*named_fc
;
59 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
61 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
63 ctf_field_class_variant_borrow_option_by_index(
66 force_update_field_class_in_ir(named_fc
->fc
, in_ir
);
71 case CTF_FIELD_CLASS_TYPE_ARRAY
:
72 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
74 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
76 force_update_field_class_in_ir(array_fc
->elem_fc
, in_ir
);
88 void update_field_class_in_ir(struct ctf_field_class
*fc
,
89 GHashTable
*ft_dependents
)
98 case CTF_FIELD_CLASS_TYPE_INT
:
99 case CTF_FIELD_CLASS_TYPE_ENUM
:
101 struct ctf_field_class_int
*int_fc
= (void *) fc
;
104 * Conditions to be in trace IR; one of:
106 * 1. Does NOT have a mapped clock class AND does not
107 * have a special meaning.
108 * 2. Another field class depends on it.
110 if ((!int_fc
->mapped_clock_class
&&
111 int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
) ||
112 bt_g_hash_table_contains(ft_dependents
, fc
)) {
118 case CTF_FIELD_CLASS_TYPE_STRUCT
:
120 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
123 * Make it part of IR if it's empty because it was
126 if (struct_fc
->members
->len
== 0) {
131 for (i
= (int64_t) struct_fc
->members
->len
- 1; i
>= 0; i
--) {
132 struct ctf_named_field_class
*named_fc
=
133 ctf_field_class_struct_borrow_member_by_index(
136 update_field_class_in_ir(named_fc
->fc
, ft_dependents
);
138 if (named_fc
->fc
->in_ir
) {
139 /* At least one member is part of IR */
146 case CTF_FIELD_CLASS_TYPE_VARIANT
:
148 struct ctf_named_field_class
*named_fc
;
149 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
152 * Reverse order, although it is not important for this
153 * loop because a field class within a variant field
154 * type's option cannot depend on a field class in
155 * another option of the same variant field class.
157 for (i
= (int64_t) var_fc
->options
->len
- 1; i
>= 0; i
--) {
159 ctf_field_class_variant_borrow_option_by_index(
162 update_field_class_in_ir(named_fc
->fc
, ft_dependents
);
164 if (named_fc
->fc
->in_ir
) {
165 /* At least one option is part of IR */
172 * At least one option will make it to IR. In
173 * this case, make all options part of IR
174 * because the variant's tag could still select
175 * (dynamically) a removed option. This can mean
176 * having an empty structure as an option, for
177 * example, but at least all the options are
180 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
181 ctf_field_class_variant_borrow_option_by_index(
182 var_fc
, i
)->fc
->in_ir
= true;
186 * This variant field class is part of IR and
187 * depends on a tag field class (which must also
190 g_hash_table_insert(ft_dependents
, var_fc
->tag_fc
,
196 case CTF_FIELD_CLASS_TYPE_ARRAY
:
197 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
199 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
201 update_field_class_in_ir(array_fc
->elem_fc
, ft_dependents
);
202 fc
->in_ir
= array_fc
->elem_fc
->in_ir
;
204 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
) {
205 struct ctf_field_class_array
*arr_fc
= (void *) fc
;
207 assert(arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
||
208 arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_UUID
);
211 * UUID field class: nothing depends on this, so
212 * it's not part of IR.
214 if (arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_UUID
) {
216 array_fc
->elem_fc
->in_ir
= false;
218 } else if (fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
220 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
223 * This sequence field class is part of
224 * IR and depends on a length field class
225 * (which must also be part of IR).
227 g_hash_table_insert(ft_dependents
,
228 seq_fc
->length_fc
, seq_fc
->length_fc
);
244 * Scopes and field classes are processed in reverse order because we need
245 * to know if a given integer field class has dependents (sequence or
246 * variant field classes) when we reach it. Dependents can only be located
247 * after the length/tag field class in the metadata tree.
250 int ctf_trace_class_update_in_ir(struct ctf_trace_class
*ctf_tc
)
255 GHashTable
*ft_dependents
= g_hash_table_new(g_direct_hash
,
258 BT_ASSERT(ft_dependents
);
260 for (i
= 0; i
< ctf_tc
->stream_classes
->len
; i
++) {
261 struct ctf_stream_class
*sc
= ctf_tc
->stream_classes
->pdata
[i
];
264 for (j
= 0; j
< sc
->event_classes
->len
; j
++) {
265 struct ctf_event_class
*ec
= sc
->event_classes
->pdata
[j
];
267 if (ec
->is_translated
) {
271 update_field_class_in_ir(ec
->payload_fc
, ft_dependents
);
272 update_field_class_in_ir(ec
->spec_context_fc
,
276 if (!sc
->is_translated
) {
277 update_field_class_in_ir(sc
->event_common_context_fc
,
279 force_update_field_class_in_ir(sc
->event_header_fc
,
281 update_field_class_in_ir(sc
->packet_context_fc
,
286 if (!ctf_tc
->is_translated
) {
287 force_update_field_class_in_ir(ctf_tc
->packet_header_fc
,
291 g_hash_table_destroy(ft_dependents
);