4 * Babeltrace CTF IR - Utilities
6 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 #define BT_LOG_TAG "CTF-IR-UTILS"
30 #include <babeltrace/lib-logging-internal.h>
34 #include <babeltrace/ctf-ir/utils.h>
35 #include <babeltrace/ctf-ir/field-types.h>
36 #include <babeltrace/ctf-ir/clock-class.h>
37 #include <babeltrace/ref.h>
38 #include <babeltrace/assert-internal.h>
41 const char * const reserved_keywords_str
[] = {"align", "callsite",
42 "const", "char", "clock", "double", "enum", "env", "event",
43 "floating_point", "float", "integer", "int", "long", "short", "signed",
44 "stream", "string", "struct", "trace", "typealias", "typedef",
45 "unsigned", "variant", "void" "_Bool", "_Complex", "_Imaginary"};
47 static GHashTable
*reserved_keywords_set
;
51 void try_init_reserved_keywords(void)
54 const size_t reserved_keywords_count
=
55 sizeof(reserved_keywords_str
) / sizeof(char *);
57 if (reserved_keywords_set
) {
61 reserved_keywords_set
= g_hash_table_new(g_direct_hash
, g_direct_equal
);
62 BT_ASSERT(reserved_keywords_set
);
64 for (i
= 0; i
< reserved_keywords_count
; i
++) {
65 gpointer quark
= GINT_TO_POINTER(g_quark_from_string(
66 reserved_keywords_str
[i
]));
68 g_hash_table_insert(reserved_keywords_set
, quark
, quark
);
74 static __attribute__((destructor
))
75 void trace_finalize(void)
77 if (reserved_keywords_set
) {
78 g_hash_table_destroy(reserved_keywords_set
);
82 int bt_validate_identifier(const char *input_string
)
86 char *save_ptr
, *token
;
89 BT_LOGV_STR("Invalid parameter: input string is NULL.");
94 try_init_reserved_keywords();
96 if (input_string
[0] == '\0') {
101 string
= strdup(input_string
);
103 BT_LOGE("strdup() failed.");
108 token
= strtok_r(string
, " ", &save_ptr
);
110 if (g_hash_table_lookup_extended(reserved_keywords_set
,
111 GINT_TO_POINTER(g_quark_from_string(token
)),
117 token
= strtok_r(NULL
, " ", &save_ptr
);
124 bt_bool
bt_identifier_is_valid(const char *identifier
)
126 return bt_validate_identifier(identifier
) == 0;
130 int bt_validate_single_clock_class(struct bt_field_type
*field_type
,
131 struct bt_clock_class
**expected_clock_class
)
139 BT_ASSERT(expected_clock_class
);
141 switch (bt_field_type_get_type_id(field_type
)) {
142 case BT_FIELD_TYPE_ID_INTEGER
:
144 struct bt_clock_class
*mapped_clock_class
=
145 bt_field_type_integer_get_mapped_clock_class(field_type
);
147 if (!mapped_clock_class
) {
151 if (!*expected_clock_class
) {
152 /* Move reference to output parameter */
153 *expected_clock_class
= mapped_clock_class
;
154 mapped_clock_class
= NULL
;
155 BT_LOGV("Setting expected clock class: "
156 "expected-clock-class-addr=%p",
157 *expected_clock_class
);
159 if (mapped_clock_class
!= *expected_clock_class
) {
160 BT_LOGW("Integer field type is not mapped to "
161 "the expected clock class: "
162 "mapped-clock-class-addr=%p, "
163 "mapped-clock-class-name=\"%s\", "
164 "expected-clock-class-addr=%p, "
165 "expected-clock-class-name=\"%s\"",
167 bt_clock_class_get_name(mapped_clock_class
),
168 *expected_clock_class
,
169 bt_clock_class_get_name(*expected_clock_class
));
170 bt_put(mapped_clock_class
);
176 bt_put(mapped_clock_class
);
179 case BT_FIELD_TYPE_ID_ENUM
:
180 case BT_FIELD_TYPE_ID_ARRAY
:
181 case BT_FIELD_TYPE_ID_SEQUENCE
:
183 struct bt_field_type
*subtype
= NULL
;
185 switch (bt_field_type_get_type_id(field_type
)) {
186 case BT_FIELD_TYPE_ID_ENUM
:
187 subtype
= bt_field_type_enumeration_get_container_type(
190 case BT_FIELD_TYPE_ID_ARRAY
:
191 subtype
= bt_field_type_array_get_element_type(
194 case BT_FIELD_TYPE_ID_SEQUENCE
:
195 subtype
= bt_field_type_sequence_get_element_type(
199 BT_LOGF("Unexpected field type ID: id=%d",
200 bt_field_type_get_type_id(field_type
));
205 ret
= bt_validate_single_clock_class(subtype
,
206 expected_clock_class
);
210 case BT_FIELD_TYPE_ID_STRUCT
:
213 int64_t count
= bt_field_type_structure_get_field_count(
216 for (i
= 0; i
< count
; i
++) {
218 struct bt_field_type
*member_type
;
220 ret
= bt_field_type_structure_get_field_by_index(
221 field_type
, &name
, &member_type
, i
);
223 ret
= bt_validate_single_clock_class(member_type
,
224 expected_clock_class
);
227 BT_LOGW("Structure field type's field's type "
228 "is not recursively mapped to the "
229 "expected clock class: "
230 "field-ft-addr=%p, field-name=\"%s\"",
238 case BT_FIELD_TYPE_ID_VARIANT
:
241 int64_t count
= bt_field_type_variant_get_field_count(
244 for (i
= 0; i
< count
; i
++) {
246 struct bt_field_type
*member_type
;
248 ret
= bt_field_type_variant_get_field_by_index(
249 field_type
, &name
, &member_type
, i
);
251 ret
= bt_validate_single_clock_class(member_type
,
252 expected_clock_class
);
255 BT_LOGW("Variant field type's field's type "
256 "is not recursively mapped to the "
257 "expected clock class: "
258 "field-ft-addr=%p, field-name=\"%s\"",