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 #include <babeltrace2/babeltrace.h>
16 #include "common/macros.h"
17 #include "common/assert.h"
18 #include "compat/glib.h"
24 #include "common/assert.h"
26 #include "ctf-meta-visitors.h"
29 void force_update_field_class_in_ir(struct ctf_field_class
*fc
, bool in_ir
)
40 case CTF_FIELD_CLASS_TYPE_STRUCT
:
42 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
44 for (i
= 0; i
< struct_fc
->members
->len
; i
++) {
45 struct ctf_named_field_class
*named_fc
=
46 ctf_field_class_struct_borrow_member_by_index(
49 force_update_field_class_in_ir(named_fc
->fc
, in_ir
);
54 case CTF_FIELD_CLASS_TYPE_VARIANT
:
56 struct ctf_named_field_class
*named_fc
;
57 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
59 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
61 ctf_field_class_variant_borrow_option_by_index(
64 force_update_field_class_in_ir(named_fc
->fc
, in_ir
);
69 case CTF_FIELD_CLASS_TYPE_ARRAY
:
70 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
72 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
74 force_update_field_class_in_ir(array_fc
->elem_fc
, in_ir
);
86 void update_field_class_in_ir(struct ctf_field_class
*fc
,
87 GHashTable
*ft_dependents
)
96 case CTF_FIELD_CLASS_TYPE_INT
:
97 case CTF_FIELD_CLASS_TYPE_ENUM
:
99 struct ctf_field_class_int
*int_fc
= (void *) fc
;
102 * Conditions to be in trace IR; one of:
104 * 1. Does NOT have a mapped clock class AND does not
105 * have a special meaning.
106 * 2. Another field class depends on it.
108 if ((!int_fc
->mapped_clock_class
&&
109 int_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
) ||
110 bt_g_hash_table_contains(ft_dependents
, fc
)) {
116 case CTF_FIELD_CLASS_TYPE_STRUCT
:
118 struct ctf_field_class_struct
*struct_fc
= (void *) fc
;
121 * Make it part of IR if it's empty because it was
124 if (struct_fc
->members
->len
== 0) {
129 for (i
= (int64_t) struct_fc
->members
->len
- 1; i
>= 0; i
--) {
130 struct ctf_named_field_class
*named_fc
=
131 ctf_field_class_struct_borrow_member_by_index(
134 update_field_class_in_ir(named_fc
->fc
, ft_dependents
);
136 if (named_fc
->fc
->in_ir
) {
137 /* At least one member is part of IR */
144 case CTF_FIELD_CLASS_TYPE_VARIANT
:
146 struct ctf_named_field_class
*named_fc
;
147 struct ctf_field_class_variant
*var_fc
= (void *) fc
;
150 * Reverse order, although it is not important for this
151 * loop because a field class within a variant field
152 * type's option cannot depend on a field class in
153 * another option of the same variant field class.
155 for (i
= (int64_t) var_fc
->options
->len
- 1; i
>= 0; i
--) {
157 ctf_field_class_variant_borrow_option_by_index(
160 update_field_class_in_ir(named_fc
->fc
, ft_dependents
);
162 if (named_fc
->fc
->in_ir
) {
163 /* At least one option is part of IR */
170 * At least one option will make it to IR. In
171 * this case, make all options part of IR
172 * because the variant's tag could still select
173 * (dynamically) a removed option. This can mean
174 * having an empty structure as an option, for
175 * example, but at least all the options are
178 for (i
= 0; i
< var_fc
->options
->len
; i
++) {
179 ctf_field_class_variant_borrow_option_by_index(
180 var_fc
, i
)->fc
->in_ir
= true;
184 * This variant field class is part of IR and
185 * depends on a tag field class (which must also
188 g_hash_table_insert(ft_dependents
, var_fc
->tag_fc
,
194 case CTF_FIELD_CLASS_TYPE_ARRAY
:
195 case CTF_FIELD_CLASS_TYPE_SEQUENCE
:
197 struct ctf_field_class_array_base
*array_fc
= (void *) fc
;
199 update_field_class_in_ir(array_fc
->elem_fc
, ft_dependents
);
200 fc
->in_ir
= array_fc
->elem_fc
->in_ir
;
202 if (fc
->type
== CTF_FIELD_CLASS_TYPE_ARRAY
) {
203 struct ctf_field_class_array
*arr_fc
= (void *) fc
;
205 assert(arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_NONE
||
206 arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_UUID
);
209 * UUID field class: nothing depends on this, so
210 * it's not part of IR.
212 if (arr_fc
->meaning
== CTF_FIELD_CLASS_MEANING_UUID
) {
214 array_fc
->elem_fc
->in_ir
= false;
216 } else if (fc
->type
== CTF_FIELD_CLASS_TYPE_SEQUENCE
) {
218 struct ctf_field_class_sequence
*seq_fc
= (void *) fc
;
221 * This sequence field class is part of
222 * IR and depends on a length field class
223 * (which must also be part of IR).
225 g_hash_table_insert(ft_dependents
,
226 seq_fc
->length_fc
, seq_fc
->length_fc
);
242 * Scopes and field classes are processed in reverse order because we need
243 * to know if a given integer field class has dependents (sequence or
244 * variant field classes) when we reach it. Dependents can only be located
245 * after the length/tag field class in the metadata tree.
248 int ctf_trace_class_update_in_ir(struct ctf_trace_class
*ctf_tc
)
253 GHashTable
*ft_dependents
= g_hash_table_new(g_direct_hash
,
256 BT_ASSERT(ft_dependents
);
258 for (i
= 0; i
< ctf_tc
->stream_classes
->len
; i
++) {
259 struct ctf_stream_class
*sc
= ctf_tc
->stream_classes
->pdata
[i
];
262 for (j
= 0; j
< sc
->event_classes
->len
; j
++) {
263 struct ctf_event_class
*ec
= sc
->event_classes
->pdata
[j
];
265 if (ec
->is_translated
) {
269 update_field_class_in_ir(ec
->payload_fc
, ft_dependents
);
270 update_field_class_in_ir(ec
->spec_context_fc
,
274 if (!sc
->is_translated
) {
275 update_field_class_in_ir(sc
->event_common_context_fc
,
277 force_update_field_class_in_ir(sc
->event_header_fc
,
279 update_field_class_in_ir(sc
->packet_context_fc
,
284 if (!ctf_tc
->is_translated
) {
285 force_update_field_class_in_ir(ctf_tc
->packet_header_fc
,
289 g_hash_table_destroy(ft_dependents
);